IA-Connect 会话

IA-Connect 是机器人流程自动化“RPA”平台，可将 RPA 功能从云添加到本地虚拟机，或通过 Citrix 或Microsoft远程桌面“RDS”连接。这是用于自动执行环境、会话、文件管理和配置 IA-Connect 的模块。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	Ultima Labs
URL	https://www.ultima.com/ultima-labs
Email	IAConnect@ultima.com

连接器元数据
发布者	Ultima Business
网站	https://www.ultima.com/ultima-labs
隐私策略	https://www.ultima.com/privacy-policy
类别	IT作;生产力

IA-Connect 是一个机器人过程自动化（RPA）平台，可将 RPA 功能从 Power Automate 云流添加到本地虚拟机或通过 Citrix 或Microsoft远程桌面（RDS）连接。 IA-Connect 连接器提供 800 多个作，使你可以直接从 Power Automate 云流自动执行各种类型的本地应用程序。所有 IA-Connect作都可以直接从 Power Automate Cloud Flow 获取，可在基于云的应用程序与本地应用程序之间轻松集成，从而利用 RPA 进程中现有的 Power Automate 条件、循环、动态内容、表达式和异常处理。利用 IA-Connect 连接器还提供流运行历史记录的完整执行历史记录和可审核性，同时无需使用单独的应用程序/控制台/工作室来开发 RPA 进程。

先决条件

若要使用任何 IA-Connect 连接器，必须安装 IA-Connect 软件。这可以免费测试 30 天，之后需要 IA-Connect 许可证。

IA-Connect 软件由两个主要组件组成：

IA-Connect Orchestrator，它是一个可在自己的 Azure 租户中托管的 Azure WebApp。这会处理 RPA 流到一个或多个本地或基于云的虚拟机的路由和安全性。
IA-Connect 代理和控制器，安装在要自动执行的软件可访问的虚拟机上。此外，IA-Connect 代理可以在 Citrix 或 Microsoft 远程桌面服务（RDS）会话中运行，其中 RPA 命令将虚拟通道传递到远程会话以供执行。 IA-Connect 代理可以从网络共享运行，不需要安装。

可用的 IA-Connect 连接器

可用的 IA-Connect 连接器包括：

IA-Connect 动态代码
IA-Connect Java
IA-Connect JML
IA-Connect 大型机
office IA-Connect Microsoft
IA-Connect SAP 图形用户界面
IA-Connect 会话
IA-Connect UI (用户界面)
IA-Connect Web 浏览器

如何获取凭据

若要接收许可证并开始 30 天的免费试用，请在我们的网站上提交请求（https://www.ultima.com/IA-Connect/Power-Automate）。

收到试用请求后，我们将通过提供的电子邮件地址与你联系，以帮助设置 IA-Connect 软件并提供试用许可证。这是一个功能齐全的试用版，可让你在试用期内在所有 9 个 IA-Connect 连接器中测试所有 800 个作中的任意一个。

连接器入门

提交 IA-Connect 的试用请求后，你将能够下载包含 IA-Connect 软件和涵盖安装和设置的文档的 ZIP 文件。我们还将与你联系，根据需要通过安装过程提供支持和指导。

Support

在试用期内，可以联系 Ultima Labs （IAConnect@ultima.com）获取支持和帮助。

购买 IA-Connect 许可证后，将收到支持令牌，这些令牌可以兑换为来自 Ultima 的英国技术服务中心（TSC）的定制培训或支持。

已知问题、常见错误和常见问题解答

我们的知识库包含许多文章，这些文章涵盖了任何已知问题、使用 IA-Connect 连接器和常见问题时可能发生的常见错误。可在 IA-Connect https://support.ultima.com/ultimalabs 试用期间以及购买 IA-Connect 许可证时访问这些资源的帐户访问。

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
API 密钥	securestring	此 API 的 API 密钥	True
IA-Connect Orchestrator 地址	字符串	指定不带 HTTP（S）组件的 IA-Connect 业务流程协调程序地址	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

IA-Connect 会话是否存在名称	返回指定的 IA-Connect 控制器会话是否存在。这是将命令发送到 IA-Connect 代理的会话。该名称将从前面的“附加”作中已知。
TCP 端口是否响应	报告网络 TCP 端口是否响应 IA-Connect 代理的连接尝试。这可能是运行 IA-Connect 代理的计算机（输入远程主机的“localhost”）或任何远程计算机上的 TCP 端口。如果 IA-Connect 代理成功连接到 TCP 端口，它将立即关闭 TCP 连接。
上半鼠标按钮	在 IA-Connect 代理用户会话中释放中间鼠标按钮。
下载 HTTP 文件	使用 HTTP（S）将文件下载到运行 IA-Connect 代理的计算机。
中断文件夹安全继承	中断运行 IA-Connect 代理的计算机上的文件夹中的安全继承。
中间单击鼠标	单击 IA-Connect 代理用户会话中的中间鼠标按钮。
中间按住鼠标	保留指定秒数的 IA-Connect 代理用户会话中的中间鼠标按钮。
中间按住鼠标坐标	将鼠标中间按钮保存在 IA-Connect 代理用户会话中指定秒数的指定坐标处。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
从 Orchestrator 分配辅助角色	从 IA-Connect Orchestrator 分配辅助角色。可以按标记或辅助角色名称（或两者或两者）请求辅助角色，以便更准确地选择所需的辅助角色。分配辅助角色后，会将其分配给流，并报告为正在执行的工作。请注意，业务流程协调程序在执行分配时仍会考虑“支持的流环境 ID”、“支持的流名称”和“不支持的流名称”。当多个辅助角色与搜索匹配时，将应用正常的负载均衡规则。
从 Orchestrator 流统计信息获取上次失败的作	检索通过 IA-Connect Orchestrator 传递给辅助角色的最后一个作的详细信息（如果该作失败）。此作最常在错误处理期间使用。
从 Orchestrator 获取工作流使用情况热度图	从 IA-Connect Orchestrator 返回工作流使用情况每日热度图。用于报告目的。可以选择使用一个或多个筛选器来限制返回的结果。
从 Orchestrator 获取流统计信息	从 IA-Connect Orchestrator 返回流统计信息的列表。用于报告目的。可以选择使用一个或多个筛选器来限制返回的结果。
从 Orchestrator 获取登录历史记录	返回用于报告目的的 IA-Connect Orchestrator 登录历史记录。可以选择使用一个或多个筛选器来限制返回的结果。
从 Orchestrator 获取辅助角色可用性统计信息	从 IA-Connect Orchestrator 返回辅助角色可用性统计信息。用于报告目的。可以选择使用一个或多个筛选器来限制返回的结果。
从 Orchestrator 获取通用凭据	检索已存储在 IA-Connect Orchestrator 中的通用凭据。凭据可以保存用户名、密码、主机名、URL 和其他通用数据。
从文件夹安全性中删除标识	从运行 IA-Connect 代理的计算机上的文件夹中的安全权限中删除标识（例如用户、组或计算机）。
从文件安全性中删除标识	从运行 IA-Connect 代理的计算机上的文件的安全权限中删除标识（例如用户、组或计算机）。
从文件读取所有文本	读取运行 IA-Connect 代理的计算机上的文件的文本内容。
从流结果 JSON 获取失败的作错误消息	反序列化一个或多个流结果（）表达式的 JSON 输出，并从失败的作中检索第一个找到的错误消息。错误消息可以采用各种格式存储在 JSON 中。此作处理已知格式并返回第一个找到的错误消息。
从用户凭据读取	从 IA-Connect 代理会话中用户配置文件中的凭据读取用户名和密码。可以从 Windows 控制面板查看凭据。用户名和密码都可以从通用凭据检索，而只能从 Windows 凭据检索用户名。
以 Base64 的形式获取文件内容	检索 Base64 格式的指定文件的内容，该格式适合通过 API 传输，并轻松转换为原始文本或二进制格式。
会话已锁定	报告 IA-Connect 代理正在运行的会话是否已锁定。
使会话保持活动状态	通过将鼠标移动到指定时间间隔来使 IA-Connect 代理用户会话保持活动状态，以防止会话处于空闲状态。
停止使会话保持活动状态	停止 IA-Connect 代理用户会话保持活动状态。
关闭 IA-Connect 代理	关闭 IA-Connect 代理。这不会影响运行 IA-Connect 代理的用户会话。
写入 CSV 文件	在运行 IA-Connect 代理的计算机上创建 CSV 文件。 CSV 文件是从集合（表）或 JSON 格式的表中创建的。
写入文本文件	在运行 IA-Connect 代理的计算机上创建文本文件，并将文本写入文件中。
写入用户凭据	将用户名和密码写入 IA-Connect 代理会话中用户配置文件中的凭据，创建该凭据（如果不存在）。可以从 Windows 控制面板查看凭据。
分配 Orchestrator 自动化任务	将选定的 Orchestrator 自动化任务分配给指定的用户或组。此分配将传递到与此自动化任务（例如 ServiceNow）链接的源系统，最常用于将票证传递给其他人员或人员组，以便进行其他处理。如果 Orchestrator 自动化任务未链接到源，将引发异常。
创建 Orchestrator 一次性机密	一次性机密提供一种用于存储一次可通过不可模糊的唯一 URL 检索的机密的设施。这通常用于与第三方共享机密。可以使用 Orchestrator UI、REST API 或流创建一次性机密。
创建目录	在运行 IA-Connect 代理的计算机上创建目录（文件夹）。
创建远程桌面会话（RDS）启动文件	创建远程桌面会话（RDS）启动文件，该文件可用于使用指定的参数自动启动远程桌面会话，而无需自动化远程桌面客户端 UI。 RDS 启动文件具有扩展名“.rdp”，通常称为 RDP 文件。
删除 Orchestrator 自动化任务	删除已延迟的 Orchestrator 自动化任务。
删除 Orchestrator 自动化任务作	通过提供唯一的任务作 ID 来删除特定的 Orchestrator 自动化任务。
删除代理内存中的密码	删除存储在代理内存中的密码，或删除所有代理存储的密码。
删除代理线程	删除代理线程或所有代理线程（终止、中止）线程（如果线程仍在运行）。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。监视代理线程的进程或流将收到“代理线程 ID 不存在”错误。
删除文件	删除运行 IA-Connect 代理的计算机上的文件。
删除文件	删除与运行 IA-Connect 代理的计算机上的模式匹配的指定文件夹中的文件。
删除用户凭据	删除 IA-Connect 代理会话中用户配置文件中的凭据。可以从 Windows 控制面板查看凭据。
删除目录	删除运行 IA-Connect 代理的计算机上的目录（文件夹）。
单击鼠标左键	单击 IA-Connect 代理用户会话中的鼠标左键。
双击鼠标	双击 IA-Connect 代理用户会话中的鼠标左键。
发送密码密钥	将全局按键发送到 IA-Connect 代理用户会话，特别是用于输入密码。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。
发送密码密钥事件	使用低级键盘驱动程序将全局按键事件发送到 IA-Connect 代理用户会话，特别是用于输入密码。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。
发送密钥	将全局按键发送到 IA-Connect 代理用户会话。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。
发送密钥事件	使用低级别键盘驱动程序将全局按键事件发送到 IA-Connect 代理用户会话。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。
右键单击坐标处的鼠标	单击指定坐标处 IA-Connect 代理用户会话中的鼠标右键。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
右键单击鼠标	单击 IA-Connect 代理用户会话中的鼠标右键。
向 Orchestrator 自动化任务添加备注	将注释添加到选定的 Orchestrator 自动化任务。此说明将传递到与此自动化任务（例如 ServiceNow）链接的源系统，最常用于将详细信息添加到票证中。如果 Orchestrator 自动化任务未链接到源，将引发异常。
向左按住鼠标	将鼠标左键保留在 IA-Connect 代理用户会话中的指定秒数。
向文件夹添加权限	向运行 IA-Connect 代理的计算机上的文件夹添加权限。
向文件添加权限	向运行 IA-Connect 代理的计算机上的文件添加权限。
启动远程桌面会话（RDS）	使用 RDP 启动文件启动远程桌面会话（RDS）。
启用下一跃点 IA-Connect	启用下一跃点，它将接收的所有将来命令转发到下一跃点会话中运行的 IA-Connect 代理。
启用文件夹安全继承	在运行 IA-Connect 代理的计算机上的文件夹中启用安全继承。
在坐标之间拖动鼠标右键	在 IA-Connect 代理用户会话中的两个指定坐标之间执行鼠标右键拖动。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。
在坐标之间拖动鼠标左键	在 IA-Connect 代理用户会话中的两个指定坐标之间执行鼠标左键拖动。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。
在坐标之间移动鼠标	在 IA-Connect 代理用户会话中的两个指定坐标之间移动鼠标。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。
在坐标处单击鼠标中间键	单击指定坐标处 IA-Connect 代理用户会话中的中间鼠标按钮。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
在坐标处单击鼠标左键	单击指定坐标处 IA-Connect 代理用户会话中的鼠标左键。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
在坐标处双击鼠标	双击指定坐标处 IA-Connect 代理用户会话中的鼠标左键。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
在坐标处按住鼠标	将鼠标右键保存在 IA-Connect 代理用户会话中指定秒数的指定坐标处。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
在屏幕上绘制矩形	在屏幕上绘制一个矩形，以帮助识别屏幕坐标或报告屏幕坐标的作的输出。矩形在 5 秒后自动删除。
在文件上设置所有者	在运行 IA-Connect 代理的计算机上设置所有者。
坐标之间的中间鼠标拖动	在 IA-Connect 代理用户会话中的两个指定坐标之间执行中间鼠标按钮拖动。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。
复制文件	在运行 IA-Connect 代理的计算机上复制文件。
将 Flow 标记为已完成	将流标记为已完成，这会通知 IA-Connect Orchestrator 分配的工作器计算机现在可用于处理其他流。
将 IA-Connect 代理 GUI 置于前面	将 IA-Connect 代理 GUI 置于前面，使其在屏幕上可见。
将密码存储在代理内存中	将密码存储在代理内存（加密）中，可从支持存储密码的任何作中使用密码。密码仅存储在内存中，在关闭代理时会丢失。
将文件从客户端复制到服务器	将文件从本地计算机（运行 IA-Connect 控制器）复制到远程计算机（运行 IA-Connect 代理）。
将文件复制到剪贴板	将指定的本地文件复制到 IA-Connect 代理用户会话中的剪贴板。
将文件夹添加到 ZIP	文件夹中的 ZIP 文件将 ZIP 文件（将文件存储到压缩存档中）。
将文件添加到 ZIP	文件（将文件存储到压缩存档中）。
将消息发送到 Web API	将消息发送到 Web API 并接收响应。这可与任何 Web API 一起使用，但常见用法是 REST API。 IA-Connect 支持从虚拟机（即访问本地资源）或通过 Citrix 或Microsoft远程桌面会话（例如，仅从隔离环境访问 API）将消息发送到 Web API。
将鼠标悬停在坐标处	将鼠标左键保留在 IA-Connect 代理用户会话中指定秒数的指定坐标处。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
将鼠标移动到坐标	将 IA-Connect 代理用户会话中的鼠标移动到指定的像素坐标。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
展开密码字符串	接受包含对 IA-Connect 存储密码的引用的输入字符串，并使用存储的密码所替换的引用返回该字符串。
展开环境变量	在 IA-Connect 代理用户会话中展开包含环境变量（例如 %USERPROFILE% 或 %TEMP%）的字符串。
延迟现有的 Orchestrator 自动化任务	延迟队列中已有的现有 Orchestrator 任务。该任务将延迟到将来的指定时间。这通常用于重新延迟现有任务（即任务以前已延迟，现在需要再次延迟）。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。
延迟现有的 Orchestrator 自动化任务作	延迟队列中已有的现有 Orchestrator 任务。该任务将延迟到将来的指定时间。这通常用于重新延迟现有任务（即任务以前已延迟，现在需要再次延迟）。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。
引发异常	如果输入异常不为空，则引发具有指定消息的异常。这对于在流（HTTP 400）中触发异常消息非常有用，如果早期作出错，该消息将由错误处理阶段捕获。此异常不会记录在 IA-Connect Orchestrator 流运行统计信息中。
拍摄屏幕截图	获取 IA-Connect 代理用户会话的屏幕截图，并将其作为 Base64 编码字符串返回。
按名称终止 IA-Connect 会话	终止指定的 IA-Connect 控制器会话（如果存在）。这是将命令发送到 IA-Connect 代理的会话。该名称将从前面的“附加”作中已知。
按名称获取进程计数	返回具有指定进程名称的 IA-Connect 代理用户会话中正在运行的进程计数。
按名称附加到 IA-Connect 会话	按名称附加到指定的 IA-Connect 控制器会话。这是将命令发送到 IA-Connect 代理的会话。
按索引附加到 IA-Connect 会话	按索引附加到指定的 IA-Connect 控制器会话（例如附加到第一个 Citrix ICA 会话）。这是将命令发送到 IA-Connect 代理的会话。
按进程 ID 获取进程	返回具有指定进程 ID 的进程是否在 IA-Connect 代理用户会话中运行。进程 ID 是唯一的，因此只有一个进程可以匹配 ID。进程 ID 是动态的，对于应用程序的每次启动都是不同的。
摇摆鼠标	按指定的坐标数来回移动鼠标。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。
文件是否存在	报告 true 或 false，以确定 IA-Connect 代理正在运行的计算机上是否存在文件。
断开远程会话的连接	如果 IA-Connect 代理在远程会话中运行，此作会断开远程会话的连接。这与注销不同，将远程会话保持处于断开连接状态。此作可用于以后要连接到远程会话的位置，然后从同一状态继续，而不是启动新会话。如果 IA-Connect 代理在本地运行，此作将锁定会话。
是否已启用屏幕阅读器	返回是否已在 IA-Connect 代理用户会话中启用屏幕阅读器。
更改 Orchestrator 自动化任务状态	更改所选 Orchestrator 自动化任务状态或其他任务属性。
更新 Orchestrator Flow 统计信息结果	更新 IA-Connect Orchestrator 中当前辅助角色流的结果统计信息。这用于修改 IA-Connect Orchestrator 中流统计信息的最终结果，该结果通常用于报告目的。这仅适用于当前流（业务流程协调程序检测流运行 ID）。不能修改任何其他流的统计信息。
替换 INI 文件中的变量数据	更新 INI 文件中的单个变量。
校准mouse_event	通过按指定数量的像素移动鼠标，然后读取新鼠标位置来校准mouse_event方法。
检索代理线程的状态	检索代理线程的状态，并选择性地检索线程输出数据。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。
注销远程会话	注销运行 IA-Connect 代理的远程会话。
添加新的 Orchestrator 延迟任务	将新的 Orchestrator 延迟任务添加到可从流监视的队列中。该任务将延迟到将来的指定时间。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。
添加新的 Orchestrator 延迟任务作	添加新的 Orchestrator 延迟任务，并接收作 ID。该任务将延迟到将来的指定时间。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。如果任务由外部轮询程序或 Orchestrator 触发器处理，则需要特定的任务名称。此作不同于“添加新业务流程协调程序延迟任务”（TasksAddNewDeferral），因为它使用不可模糊的作 ID 而不是可猜测的任务 ID 进行响应。
添加新的 Orchestrator 自动化任务	将新的 Orchestrator 自动化任务添加到可从流监视的队列中。任务可以立即运行，也可以延迟到以后运行。
添加新的 Orchestrator 自动化任务作	添加新的 Orchestrator 自动化任务，并接收作 ID。如果任务由外部轮询程序或 Orchestrator 触发器处理，则需要特定的任务名称。此作不同于“添加新的 Orchestrator 自动化任务”（TasksAddNewTaskOperation），因为它使用不可模糊的作 ID 而不是可猜测的任务 ID 进行响应。
清除剪贴板	清除 IA-Connect 代理用户会话中剪贴板的内容。
清除目录	清除运行 IA-Connect 代理的计算机上的目录（文件夹），删除目录中存储的所有文件。
生成密码	生成一个密码，其中包含以模板格式定义的字典词、数字、符号、字符。
目录可访问	返回目录（文件夹）是否可访问，以及权限是否限制在 IA-Connect 代理的计算机上对其进行访问。
目录是否存在	报告 true 或 false，以确定 IA-Connect 代理正在运行的计算机上是否存在目录（文件夹）。
禁用下一跃点 IA-Connect	禁用下一跃点，以便接收下一跃点的代理处理所有将来的命令（而不是转发到下一跃点代理）。
移动文件	在运行 IA-Connect 代理的计算机上移动文件。
移动鼠标相对	将鼠标移到 IA-Connect 代理用户会话中相对于其当前位置的指定像素数。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。
等待 IA-Connect 下一跃点会话进行连接	等待下一跃点会话进行连接，并等待 IA-Connect 代理在下一跃点会话中运行。
等待 IA-Connect 会话按名称关闭	等待指定的 IA-Connect 控制器会话关闭。这是将命令发送到 IA-Connect 代理的会话。该名称将从前面的“附加”作中已知。
等待代理线程成功完成	等待代理线程完成并选择性地检索线程输出数据。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。如果代理线程完成，但在失败中，将引发异常。
终止代理线程	终止代理线程（终止、中止）。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。代理线程不会被删除（使用作“删除代理线程”删除线程删除线程）允许监视代理线程的任何进程或流接收“IA-Connect 代理线程已中止”错误。
终止所有其他 IA-Connect 代理	终止当前在用户会话中运行的 IA-Connect 代理的任何其他实例。这将确保仅运行 IA-Connect 代理的一个实例。
终止进程	终止具有指定进程名称的 IA-Connect 代理用户会话中的任何正在运行的进程。
终止进程 ID	在具有指定进程 ID 的 IA-Connect 代理用户会话中终止正在运行的进程。进程 ID 是唯一的，因此只有一个进程可以匹配 ID。进程 ID 是动态的，并且每次启动应用程序时都有所不同。
翻转鼠标滚轮	在 IA-Connect 代理用户会话中打开鼠标滚轮（正或负向）。
获取 CSV 文本作为集合	返回 IA-Connect 代理作为集合（表）运行的计算机上的 CSV 文件。只需要对 CSV 文件具有只读访问权限。
获取 IA-Connect 代理会话信息	返回有关 IA-Connect 代理用户会话的信息。
获取 IA-Connect 代理信息	返回 IA-Connect 代理的属性，包括版本号和代理可执行文件的路径。
获取 IA-Connect 代理全局坐标配置	检索 IA-Connect 代理全局坐标系配置的配置，该配置用于显示元素位置（例如：在鼠标检查期间）和计算鼠标位置（例如：执行全局鼠标作时）。
获取 IA-Connect 代理当前许可证状态	返回 IA-Connect 代理当前是否获得许可，如果已获得许可，则返回许可证的属性。
获取 IA-Connect 代理日志	以文件或读取内容并在输出变量中返回当前 IA-Connect 代理日志。
获取 IA-Connect 代理日志级别	返回当前 IA-Connect 代理日志记录级别。日志记录级别从 1 设置为 4,1 为最低级别，4 为最高级别。
获取 IA-Connect 代理进程计数	返回当前在用户会话中运行的 IA-Connect 代理的实例数。这对于检测是否存在正在运行的 IA-Connect 代理的多个实例非常有用。
获取 IA-Connect 控制器信息	返回 IA-Connect 控制器的属性，包括版本号和控制器可执行文件的路径。
获取 IA-Connect 控制器日志级别	返回当前 IA-Connect 控制器日志记录级别。日志记录级别从 0 设置为 4。 0 已禁用。 1 是最低日志级别（默认值）。 4 是最高的日志级别。
获取 IA-Connect 控制器运行时间	以秒为单位返回此 IA-Connect 控制器的运行时间（即控制器运行的时间）。
获取 Orchestrator 状态	检索基本业务流程协调程序状态。这可用于确认 Orchestrator 是否可用并做出响应。
获取 Orchestrator 自动化任务	检索特定的 Orchestrator 自动化任务。
获取 Orchestrator 自动化任务作	通过提供唯一的任务作 ID 来检索特定的 Orchestrator 自动化任务。
获取 Orchestrator 辅助角色	检索向 IA-Connect Orchestrator 注册的单个辅助角色的详细信息和实时状态。
获取 Orchestrator 辅助角色可用性状态	检索基本业务流程协调程序状态。这可用于确认 Orchestrator 是否可用并做出响应。
获取 Orchestrator 辅助角色的列表	检索注册到 IA-Connect Orchestrator 及其实时状态的辅助角色的列表。
获取下一个 Orchestrator 自动化任务	检索匹配给定搜索条件的下一个 Orchestrator 自动化任务。只能检索“新建”和“延迟”任务（已达到延迟日期）。不会检索保留任务。
获取下一跃点状态 IA-Connect	报告接收此命令的代理的下一跃点控制器状态。如果启用了下一跃点，代理将命令转发到下一跃点（通过下一跃点控制器）。如果禁用下一跃点，则代理正在处理命令本身（默认值）。
获取代理线程	返回代理线程的列表。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。通常，一旦代理线程完成及其检索数据，代理线程就会被删除，并且不会显示在线程列表中。
获取剪贴板	获取 IA-Connect 代理用户会话中剪贴板的当前内容。
获取可用的 IA-Connect 会话	检索 IA-Connect 控制器会话的列表（与运行 IA-Connect 代理的会话（例如本地、Microsoft RDP 或 Citrix ICA）的会话建立连接）。
获取坐标处的像素颜色	返回给定坐标处像素的 RGB 颜色。
获取存储的密码	检索以前生成的或存储的密码。
获取客户端主机名	返回运行 IA-Connect 控制器的客户端的主机名。
获取屏幕分辨率	返回 IA-Connect 代理用户会话的屏幕分辨率。对于在物理台式机或笔记本电脑上运行的 IA-Connect 本地代理，这将提供有关所有显示设备及其缩放的信息。在虚拟机上，通常只报告一个显示器，除非虚拟机已配置为显示多个显示器（不常见）。在远程会话中，通常只报告一个显示，即使该显示器跨越多个本地显示器，因为远程会话通常创建单个虚拟显示器。
获取当前鼠标坐标	使用 setcursorpos API 获取 IA-Connect 代理用户会话中的当前鼠标光标位置。
获取所有 IA-Connect 命令统计信息	返回当前会话中执行 IA-Connect 代理所执行命令的所有当前存储统计信息。
获取所有 Orchestrator 自动化任务	检索与筛选器匹配的所有 Orchestrator 自动化任务。
获取打印机列表	返回 IA-Connect 代理会话中所有可用打印机的列表。
获取控制器客户端类型和会话信息	返回由第 1 层控制器处理的本地或远程会话的详细信息。
获取文件	返回运行 IA-Connect 代理的计算机上的文件夹中的文件列表（匹配 CSV 模式列表）。
获取文件大小	返回运行 IA-Connect 代理的计算机上的文件的大小（以字节为单位）。
获取文件夹	返回运行 IA-Connect 代理的计算机上的指定文件夹中的所有子文件夹。
获取文件夹安全权限	返回当前在运行 IA-Connect 代理的计算机上的文件夹中设置的权限列表。
获取文件安全权限	返回当前在运行 IA-Connect 代理的计算机上的文件上设置的权限列表。
获取最后一个输入信息	获取自 IA-Connect 代理用户会话中收到上次用户输入以来的时间。
获取父进程 ID	返回具有指定进程 ID 的 IA-Connect 代理用户会话中任何正在运行的进程的进程的进程 ID。
获取环境信息	返回有关运行 IA-Connect 代理用户会话的环境的信息。
获取磁盘空间	返回运行 IA-Connect 代理的计算机上的指定磁盘的可用空间量。
获取计算机名称	返回运行 IA-Connect 代理用户会话的计算机的名称。
获取计算机域	返回运行 IA-Connect 代理用户会话的计算机的域。
获取进程	返回 IA-Connect 代理用户会话中正在运行的进程的列表。这可以通过提供进程名称来进行筛选。
获取进程 ID 命令行属性	返回 IA-Connect 代理用户会话中具有指定进程 ID 的任何正在运行进程的命令行属性。
获取驱动器列表	返回运行 IA-Connect 代理的计算机上的驱动器列表。
获取默认打印机	获取 IA-Connect 代理会话中用户的默认打印机的名称。
获取鼠标乘数	检索 IA-Connect 代理用户会话中的全局鼠标乘数。这默认为（1， 1），但可能已由“设置鼠标乘数”作更改。
获取鼠标移动方法	获取当前鼠标移动方法。
解压缩文件	解压缩已使用 ZIP 压缩压缩的文件。
解锁会话	解锁运行 IA-Connect 代理的会话。这要求在托管会话的计算机上安装 IA-Connect 解锁程序凭据提供程序，因为只有凭据提供程序才能解锁计算机。
设置 IA-Connect 代理 GUI 不透明度	将 IA-Connect 代理的不透明度从 1（可见）设置为 0（透明）。
设置 IA-Connect 代理 GUI 位置	将 IA-Connect 代理 GUI 的屏幕上位置设置为指定位置。
设置 IA-Connect 代理 GUI 最顶层	将 IA-Connect 代理设置为最顶层。这意味着 IA-Connect 代理将始终在屏幕上可见，并且不能隐藏在其他应用程序窗口后面。
设置 IA-Connect 代理全局坐标配置	配置 IA-Connect 代理全局坐标系，该系统用于显示元素位置（例如：在鼠标检查期间），并计算鼠标位置（例如：执行全局鼠标作时）。默认值提供最新功能，但你可以使用此作还原到早期版本的代理中的行为，或指定 API 使用的是其他坐标系。
设置 IA-Connect 代理命令超时	设置 IA-Connect 代理将用于执行的每个命令的命令超时。
设置 IA-Connect 代理日志级别	将 IA-Connect 代理日志记录级别设置为指定值（1 为最低级别，4 为最高）。
设置 IA-Connect 控制器日志级别	将 IA-Connect 控制器日志记录级别设置为指定值。日志记录级别从 0 设置为 4。 0 已禁用。 1 是最低日志级别（默认值）。 4 是最高的日志级别。
设置 IA-Connect 许可证代码	将旧式代理（7.0 和 7.1）代理域许可证上传到 IA-Connect 代理。
设置 IA-Connect 许可证密钥	使用许可证密钥许可 IA-Connect 代理。这可以是许可证字符串，也可以是 IA-Connect Orchestrator 中持有的许可证的友好名称。
设置 Orchestrator 自动化任务输出数据	设置 Orchestrator 自动化任务的输出数据。通常在完成任务时使用，并希望提供输出数据，由创建该任务的过程收集。
设置 Orchestrator 辅助角色维护模式	将 IA-Connect Orchestrator 中定义的 IA-Connect 辅助角色放入维护模式（因此流未分配给辅助角色），或使辅助角色退出维护模式。
设置剪贴板	设置 IA-Connect 代理用户会话中剪贴板的内容。
设置屏幕阅读器	启用或禁用 IA-Connect 代理用户会话中的屏幕阅读器。
设置文件夹的所有者	设置运行 IA-Connect 代理的计算机上的文件夹的所有者。
设置默认打印机	在 IA-Connect 代理会话中设置用户的默认打印机。
设置鼠标乘数	在 IA-Connect 代理用户会话中设置全局鼠标乘数。如果在远程桌面缩放时遇到问题，这在开发过程中非常有用。
设置鼠标光标位置	将 IA-Connect 代理用户会话中的鼠标光标设置为指定位置。 setcursorpos API 用于移动鼠标，而不考虑选择的活动鼠标移动 API。
设置鼠标移动方法	将当前鼠标移动方法设置为mouse_event或 setcursorpos。
转换矩形坐标	将矩形像素坐标从虚拟转换为物理或物理坐标转换为虚拟。如果要转换点，只需设置 Right=Left 和 Bottom=Top 即可。物理坐标直接映射到监视器上的像素。虚拟坐标是 DPI 缩放的。如果所有显示设备的基础显示缩放为 100%，则物理坐标和虚拟坐标相同。
运行 PowerShell 进程	启动 PowerShell 进程，在磁盘上运行现有脚本，或提供要执行的脚本的内容。请考虑改用“运行 PowerShell 脚本”作，这更强大，并提供 PowerShell 脚本输出的数据表。如果 PowerShell 脚本输出到标准输出或标准错误（例如，使用 Write-Host 而不是返回表），则需要 PowerShell 7，或者以替代用户身份运行 Active Directory作，而通过 WinRM 的 CredSSP 不可用。
运行从控制器发送的备用 IA-Connect 代理	通过从 IA-Connect 控制器上传备用代理，然后加载备用代理可执行文件来运行备用 IA-Connect 代理（例如更高版本）。
运行备用 IA-Connect 代理	通过从文件位置加载代理可执行文件来运行备用 IA-Connect 代理（例如更高版本）。
运行泛型 IA-Connect 代理命令	运行泛型 IA-Connect 代理命令，将参数作为 JSON 传递，并将输出数据作为 JSON 返回。用于在控制器和检查器版本低于代理时运行代理命令，因此不了解该命令。
运行进程	启动进程、命令或应用程序。
配置下一跃点 IA-Connect 控制器	在双跃点方案中配置下一跃点控制器。仅当默认 IA-Connect 下一跃点控制器设置不适用时，才需要这样做。
重置 IA-Connect 命令统计信息	重置当前存储的任何统计信息，IA-Connect 代理在当前会话中执行的命令。
重置下一跃点 IA-Connect 控制器设置	重置已设置的任何自定义 IA-Connect 控制器设置，还原默认设置。
锁定会话	锁定运行 IA-Connect 代理的会话。
附加到最新的 IA-Connect 会话	附加到最近连接的 IA-Connect 控制器会话（可选为指定类型）。这是将命令发送到 IA-Connect 代理的会话。
附加到第 1 层 IA-Connect 会话	附加到接收 SOAP 和/或 REST 消息的控制器 IA-Connect 控制器会话。这是将命令发送到 IA-Connect 代理的会话。
鼠标中间按钮向下键	在 IA-Connect 代理用户会话中按（且未释放）鼠标中间按钮。若要释放鼠标，请使用鼠标中间按钮向上作。
鼠标右键向上键	在 IA-Connect 代理用户会话中释放鼠标右键。
鼠标右键向下键	在 IA-Connect 代理用户会话中按右鼠标按钮（且未释放）。若要释放鼠标，请使用鼠标右键向上作。
鼠标向右按住	将鼠标右键保存在指定秒数的 IA-Connect 代理用户会话中。
鼠标左键向上	在 IA-Connect 代理用户会话中释放鼠标左键。
鼠标左键向下键	在 IA-Connect 代理用户会话中按（且未释放）鼠标左键。若要释放鼠标，请使用鼠标左键向上作。

IA-Connect 会话是否存在名称

操作 ID:: DoesIAConnectSessionExistByName

返回指定的 IA-Connect 控制器会话是否存在。这是将命令发送到 IA-Connect 代理的会话。该名称将从前面的“附加”作中已知。

参数

名称	密钥	必需	类型	说明
IA-Connect 会话名称	IAConnectSessionName	True	string	要检查的 IA-Connect 会话的名称。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
IA-Connect 会话存在	IAConnectSessionExists	boolean	如果存在具有指定名称的会话，则返回 true;否则返回 false。

TCP 端口是否响应

操作 ID:: IsTCPPortResponding

报告网络 TCP 端口是否响应 IA-Connect 代理的连接尝试。这可能是运行 IA-Connect 代理的计算机（输入远程主机的“localhost”）或任何远程计算机上的 TCP 端口。如果 IA-Connect 代理成功连接到 TCP 端口，它将立即关闭 TCP 连接。

参数

名称	密钥	必需	类型	说明
远程主机	RemoteHost	True	string	要连接到的计算机的 IPv4 地址、DNS 地址或主机名。输入“localhost”，检查运行 IA-Connect 代理的计算机上的 TCP 端口。示例：192.168.1.10 或 www.test.com 或 vm-server19。
TCP 端口	TCPPort	True	integer	要连接到指定远程（或本地）主机上的 TCP 端口号。 TCP 端口必须为 1 或更高，并且必须为 65535 或更低。常见已知端口的示例包括 80（HTTP）、443（HTTPS）、445（SMB/文件共享）。
超时（秒）	TimeoutInSeconds		integer	等待 TCP 连接的最大秒数。这默认为 10 秒，但大多数工作连接应在几秒钟（通过 Internet）或小于 1 秒（本地网络）内进行连接。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已连接的 TCP 端口	TCPPortConnected	boolean	如果 TCP 端口已连接，则设置为 true;如果 TCP 端口无法连接，则设置为 false。
连接错误消息	ConnectionErrorMessage	string	如果 TCP 端口无法连接，则显示错误消息。这通常是 DNS/名称查找错误或超时。

上半鼠标按钮

操作 ID:: MiddleMouseButtonUp

在 IA-Connect 代理用户会话中释放中间鼠标按钮。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

下载 HTTP 文件

操作 ID:: DownloadHTTPFile

使用 HTTP（S）将文件下载到运行 IA-Connect 代理的计算机。

参数

名称	密钥	必需	类型	说明
下载 URL	DownloadURL	True	string	HTTP 或 HTTPS 下载 URL。
保存文件路径	SaveFilename		string	保存文件名的完整路径。如果此字段为空，并且已将“返回内容作为字符串”指定为 True，则不会将文件保存到计算机。
覆盖现有文件	OverwriteExistingFile		boolean	如果文件已存在且“保存文件路径”输入中指定的名称，应覆盖该文件？
直通身份验证	PassthroughAuthentication		boolean	用户凭据是否应传递到 Web 服务器？这通常仅用于内部 Intranet 站点。
用户代理	UserAgent		string	这样，就可以将报告的用户代理设置为网页。通常不需要此作，并且仅当网页需要特定的代理字符串时，才应更改。
接受	Accept		string	此参数指定支持哪些内容类型。仅当下载的内容需要其他内容类型时，才应更改此项。
支持 TLS10	SupportTLS10		boolean	设置为 True 以支持 TLS 1.0 加密协议。
支持 TLS11	SupportTLS11		boolean	设置为 True 以支持 TLS 1.1 加密协议。
支持 TLS12	SupportTLS12		boolean	设置为 True 以支持 TLS 1.2 加密协议。
自动解压缩 deflate	AutoDecompressDeflate		boolean	某些 Web 内容使用“deflate”压缩返回压缩。将此值设置为 True 会通知 Web 服务器支持“deflate”，如果使用此压缩发送内容，它将自动解压缩。
自动解压缩 GZip	AutoDecompressGZIP		boolean	使用“GZIP”压缩返回某些 Web 内容。将此值设置为 True 会通知 Web 服务器支持“GZIP”，如果使用此压缩发送内容，它将自动解压缩。
以字符串的形式返回内容	ReturnContentsAsString		boolean	文件内容是否应作为字符串返回？
返回内容编码	ReturnContentEncoding		string	下载的内容的编码。仅当“以字符串形式返回内容”为 True 并且它定义下载内容的编码以便正确解释时，才使用此方法。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
下载文件内容	DownloadFileContents	string	下载的文件的内容。

中断文件夹安全继承

操作 ID:: BreakFolderSecurityInheritance

中断运行 IA-Connect 代理的计算机上的文件夹中的安全继承。

参数

名称	密钥	必需	类型	说明
文件夹路径	FolderPath	True	string	文件夹的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
将继承转换为显式	ConvertInheritedToExplicit		boolean	当前是否应将任何当前继承的权限转换为显式权限？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

中间单击鼠标

操作 ID:: MiddleClickMouse

单击 IA-Connect 代理用户会话中的中间鼠标按钮。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

中间按住鼠标

操作 ID:: MiddleHoldMouse

保留指定秒数的 IA-Connect 代理用户会话中的中间鼠标按钮。

参数

名称	密钥	必需	类型	说明
要保留的秒数	SecondsToHold	True	double	按住鼠标中间按钮的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

中间按住鼠标坐标

操作 ID:: MiddleHoldMouseAtCoordinate

将鼠标中间按钮保存在 IA-Connect 代理用户会话中指定秒数的指定坐标处。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
要保留的秒数	SecondsToHold	True	double	按住鼠标中间按钮的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

从 Orchestrator 分配辅助角色

操作 ID:: AllocateWorkerFromOrchestrator

从 IA-Connect Orchestrator 分配辅助角色。可以按标记或辅助角色名称（或两者或两者）请求辅助角色，以便更准确地选择所需的辅助角色。分配辅助角色后，会将其分配给流，并报告为正在执行的工作。请注意，业务流程协调程序在执行分配时仍会考虑“支持的流环境 ID”、“支持的流名称”和“不支持的流名称”。当多个辅助角色与搜索匹配时，将应用正常的负载均衡规则。

参数

名称	密钥	必需	类型	说明
辅助角色标记	WorkerTag		string	要分配的辅助角色的可选标记。标记允许将辅助角色分类为组。标记名称不区分大小写。可以通过在单独的行中输入多个标记来指定多个标记，然后分配机制将考虑具有其中任一标记的任何辅助角色（只需匹配一个标记）。可以使用格式通配符：Tag* 执行通配符搜索（例如通配符：JML*），并使用格式 RegEx：TagExpression（例如 RegEx： ^JML）执行正则表达式搜索。
工作人员姓名	WorkerName		string	要分配的辅助角色的可选名称。辅助角色名称不区分大小写。可以通过在单独的行中输入多个辅助角色来指定这些辅助角色，然后分配机制将考虑具有匹配名称的任何辅助角色。可以使用格式通配符：Name* 执行通配符搜索（例如通配符：vmrpa*），并使用正则表达式：表达式格式（例如正则表达式： ^vmrpa）执行正则表达式搜索。
如果辅助角色不可用，请引发异常	RaiseExceptionIfWorkerNotImmediatelyAvailable		boolean	如果设置为 true 且无法分配合适的辅助角色，则会引发异常。如果设置为 false（默认值）且无法分配合适的辅助角色，Orchestrator 将返回 HTTP 状态代码 500，导致 PA 流等待，根据“重试策略”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
分配的辅助角色名称	WorkerNameAllocated	string	分配的工作器的名称。如果未分配任何辅助角色，则为空。

从 Orchestrator 流统计信息获取上次失败的作

操作 ID:: GetLastFailedActionFromOrchestratorFlowStats

检索通过 IA-Connect Orchestrator 传递给辅助角色的最后一个作的详细信息（如果该作失败）。此作最常在错误处理期间使用。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
分配给流运行的辅助角色	WorkerAllocatedToFlowRun	boolean	如果为此流运行分配了辅助角色，则返回 true，因此可以提供有关上一个作错误的信息。如果没有分配给此流运行的辅助角色（从未分配过工作器或辅助角色现已提供给另一个流运行），则返回 false，因此无法提供有关上次错误的信息。
上次作失败	LastActionFailed	boolean	如果此流运行中的最后一个作（该作在分配给此流运行的辅助角色上运行）失败，则返回 true：此作的其他输出将保留详细信息。如果此流运行中的最后一个作未失败，则返回 false：其他输出将为空。
上次失败的作请求路径	LastFailedActionRequestPath	string	如果此流运行中的最后一个作（该作在分配给此流运行的辅助角色上运行）失败，则此输出将包含作请求路径。这可用于确定哪个作失败。如果此流运行中的最后一个作未失败，则此值将为空。
上次失败的作错误消息	LastFailedActionErrorMessage	string	如果此流运行中的最后一个作（该作在分配给此流运行的辅助角色上运行）失败，则此输出将包含错误消息。如果此流运行中的最后一个作未失败，则此值将为空。

从 Orchestrator 获取工作流使用情况热度图

操作 ID:: GetOrchestratorWorkerFlowUsageHeatmap

从 IA-Connect Orchestrator 返回工作流使用情况每日热度图。用于报告目的。可以选择使用一个或多个筛选器来限制返回的结果。

参数

名称	密钥	必需	类型	说明
流开始时间开始时间窗口	SearchStartDateStartWindow	True	date-time	筛选结果以仅检索指定开始日期后的工作流使用情况热度图（忽略时间组件）。设置为空白以不筛选。例如：“2022-01-24T00：00：00”将返回在 2022 年 1 月 24 日或之后启动的流的工作热度地图。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。
流开始时间结束窗口	SearchStartDateEndWindow	True	date-time	筛选结果以仅检索指定开始日期之前的工作流使用情况热度图（忽略时间组件）。设置为空白以不筛选。例如：“2022-01-25T00：00：00”将返回从 2022 年 1 月 25 日或 2022 年 1 月 25 日开始的 Flow 的工作热度地图。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。
与 UTC 的时区分钟偏移量	TimeZoneMinutesOffsetFromUTC		integer	时区从 UTC 偏移量（以分钟为单位）以对齐每日热度地图。例如：如果指定 60 分钟，每日热度地图从 01：00 UTC 运行到 01：00 UTC。
IA-Connect 辅助角色名称	WorkerNames		string	要返回 JSON 或 CSV 格式的热度地图的 IA-Connect 辅助角色的名称列表。如果留空，将为业务流程协调程序当前已知的所有辅助角色生成热度地图。例如：[{“WorkerName”： “Worker1”}， {“WorkerName”： “Worker2”}] （JSON 表格式），[“Worker1”， “Worker2”] （JSON 数组格式），或 Worker1，Worker2 （CSV 格式）。

名称	路径	类型	说明
工作流使用情况热度地图 JSON	WorkerFlowUsageHeatmapJSON	string	工作流使用情况热度地图，采用 JSON 格式。
工作流使用情况热度地图项数	NumberOfWorkerFlowUsageHeatmapItems	integer	返回的工作流使用情况热度地图项数。每天每个辅助角色一个项目。

从 Orchestrator 获取流统计信息

操作 ID:: GetOrchestratorFlowStats

从 IA-Connect Orchestrator 返回流统计信息的列表。用于报告目的。可以选择使用一个或多个筛选器来限制返回的结果。

参数

名称	密钥	类型	说明
在最近几天内	WithinLastNumberOfDays	integer	筛选结果以仅检索在过去指定天数内启动的结果。设置为 0 以不进行筛选。
流名称	SearchFlowName	string	筛选结果以仅检索具有指定流名称的那些结果。设置为空白，不按流名称进行筛选。
流最后一个作结果	SearchFlowLastActionResult	boolean	筛选结果以仅检索具有指定最后一个作结果的结果。设置为 true 以仅检索成功的流。设置为 false 以仅检索失败的流。不要将值/设置为空白，不能按 Flow 上一个作结果进行筛选。
流开始时间开始时间窗口	SearchFlowStartTimeStartWindow	date-time	筛选结果以仅检索在指定开始时间后启动的结果。设置为空白以不筛选。例如：“2022-01-24T07：00：00”将返回在 2022 年 1 月 24 日或 07.00 小时后启动的流的所有业务流程协调程序流统计信息。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。
流开始时间结束窗口	SearchFlowStartTimeEndWindow	date-time	筛选结果以仅检索在指定开始时间之前启动的结果。设置为空白以不筛选。例如：“2022-01-25T07：00：00”将返回在 2022 年 1 月 25 日或 07.00 小时之前启动的流的所有业务流程协调程序流统计信息。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。

名称	路径	类型	说明
业务流程协调程序流统计信息 JSON	OrchestratorFlowStatsJSON	string	JSON 格式的所有 Orchestrator 流统计信息的列表。
流统计信息数	NumberOfOrchestratorFlowStats	integer	返回的流统计信息数。

从 Orchestrator 获取登录历史记录

操作 ID:: GetOrchestratorLoginHistory

返回用于报告目的的 IA-Connect Orchestrator 登录历史记录。可以选择使用一个或多个筛选器来限制返回的结果。

参数

名称	密钥	类型	说明
在最近几天内	WithinLastNumberOfDays	integer	筛选结果以仅检索指定天数内的 Orchestrator 登录名。设置为 0 以不进行筛选。
电子邮件地址	SearchByEmail	string	筛选结果以仅检索具有指定电子邮件地址的 Orchestrator 登录名。设置为空白，不能按电子邮件地址进行筛选。
登录历史记录时间开始窗口	SearchLoginHistoryTimeStartWindow	date-time	筛选结果以仅检索指定开始时间之后的 Orchestrator 登录名。设置为空白以不筛选。例如：“2022-01-24T07：00：00”将在 2022 年 1 月 24 日或 07.00 小时后返回所有 Orchestrator 登录名。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。
登录历史记录时间结束窗口	SearchLoginHistoryTimeEndWindow	date-time	筛选结果以仅检索指定开始时间之前的 Orchestrator 登录名。设置为空白以不筛选。例如：“2022-01-25T07：00：00”将在 2022 年 1 月 25 日或 07.00 小时之前返回所有 Orchestrator 登录名。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。

名称	路径	类型	说明
Orchestrator 登录历史记录 JSON	OrchestratorLoginHistoryJSON	string	所有 Orchestrator 登录名的列表，以 JSON 格式满足指定的筛选器。
Orchestrator 登录名数	NumberOfOrchestratorLogins	integer	返回的 Orchestrator 登录名数。

从 Orchestrator 获取辅助角色可用性统计信息

操作 ID:: GetOrchestratorWorkerAvailabilityStats

从 IA-Connect Orchestrator 返回辅助角色可用性统计信息。用于报告目的。可以选择使用一个或多个筛选器来限制返回的结果。

参数

名称	密钥	类型	说明
在最近几天内	WithinLastNumberOfDays	integer	筛选结果以仅检索在过去指定天数内启动的结果。设置为 0 以不进行筛选。
流名称	SearchFlowName	string	筛选结果以仅检索具有指定流名称的那些结果。设置为空白，不按流名称进行筛选。
流开始时间开始时间窗口	SearchFlowStartTimeStartWindow	date-time	筛选结果以仅检索在指定开始时间后启动的结果。设置为空白以不筛选。例如：“2022-01-24T07：00：00”将返回在 2022 年 1 月 24 日或 07.00 小时后启动的流的所有业务流程协调程序流统计信息。所有日期/时间均采用 UTC（GMT+0），因此你可能希望使用“转换日期/时间”作将本地时间转换为 UTC。

名称	路径	类型	说明
辅助角色可用性统计信息 JSON	WorkerAvailabilityStatsJSON	string	JSON 格式的辅助角色可用性统计信息列表。
辅助角色可用性统计信息数	NumberOfWorkerAvailabilityStats	integer	返回的工作器可用性统计信息数。

从 Orchestrator 获取通用凭据

操作 ID:: GetGenericCredentialFromOrchestrator

检索已存储在 IA-Connect Orchestrator 中的通用凭据。凭据可以保存用户名、密码、主机名、URL 和其他通用数据。

参数

名称	密钥	必需	类型	说明
友好的名称	FriendlyName		string	Orchestrator 中存储的凭据的友好名称。
检索纯文本密码	RetrievePlainTextPassword		boolean	如果选中，指定的 Orchestrator 泛型凭据的密码将作为纯文本返回，如果已禁用 Orchestrator 泛型凭据设置“不公开密码”（允许检索密码）。建议不要将密码检索为纯文本，而是使用支持存储密码的 IA-Connect作（例如：“输入密码到 UIA作”），业务流程协调程序将在运行时将密码直接插入作。

名称	路径	类型	说明
用户名	Username	string	在通用凭据中保留的用户名。
纯文本密码	PlainTextPassword	string	密码保存在通用凭据中，作为纯文本字符串。业务流程协调程序密码是加密的，但会以纯文本形式返回，以便将密码传递给需要密码的作。
主机名	Hostname	string	通用凭据中保留的主机名或域名（如果使用）。
URL	Url	string	通用凭据中保留的 URL（如果使用）。
泛型属性 1	GenericProperty1	string	泛型凭据中保留的泛型属性（如果使用）。这可用于存储可能与凭据关联的数据。
泛型属性 2	GenericProperty2	string	泛型凭据中保留的泛型属性（如果使用）。这可用于存储可能与凭据关联的数据。
泛型属性 3	GenericProperty3	string	泛型凭据中保留的泛型属性（如果使用）。这可用于存储可能与凭据关联的数据。

从文件夹安全性中删除标识

操作 ID:: RemoveIdentityFromFolderSecurity

从运行 IA-Connect 代理的计算机上的文件夹中的安全权限中删除标识（例如用户、组或计算机）。

参数

名称	密钥	必需	类型	说明
文件夹路径	FolderPath	True	string	文件夹的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
要删除的标识	IdentityToRemove	True	string	要删除的用户或组的标识。这可以采用“username”、“DOMAIN\username”或“username@domainfqdn”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
权限已删除	PermissionWasRemoved	boolean	如果权限已成功删除，则返回 true。

从文件安全性中删除标识

操作 ID:: RemoveIdentityFromFileSecurity

从运行 IA-Connect 代理的计算机上的文件的安全权限中删除标识（例如用户、组或计算机）。

参数

名称	密钥	必需	类型	说明
文件路径	FilePath	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
要删除的标识	IdentityToRemove	True	string	要删除的用户或组的标识。这可以采用“username”、“DOMAIN\username”或“username@domainfqdn”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
权限已删除	PermissionWasRemoved	boolean	如果权限已成功删除，则返回 true。

从文件读取所有文本

操作 ID:: ReadAllTextFromFile

读取运行 IA-Connect 代理的计算机上的文件的文本内容。

参数

名称	密钥	必需	类型	说明
文件路径	Filename	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
文件文本内容	FileTextContents	string	文件的文本内容。

从流结果 JSON 获取失败的作错误消息

操作 ID:: GetFailedActionErrorMessageFromPowerAutomateResultJSON

反序列化一个或多个流结果（）表达式的 JSON 输出，并从失败的作中检索第一个找到的错误消息。错误消息可以采用各种格式存储在 JSON 中。此作处理已知格式并返回第一个找到的错误消息。

参数

名称	密钥	必需	类型	说明
流结果 JSON	PowerAutomateResultJSON	True	array of string	JSON 数组，该数组应包含来自一个或多个流结果（）表达式的输出。如果只处理单个流结果（）表达式的输出，只需在第一个数组项中输入该输出即可。
搜索状态	SearchStatus		string	包含错误消息的作的状态。仅当搜索与默认值“Failed”不同的状态时，才应更改此状态。

名称	路径	类型	说明
作错误消息	ActionErrorMessage	string	返回从结果 JSON 中提取的作错误消息。如果找不到错误消息，将返回空白值。
操作名称	ActionName	string	返回与错误消息关联的作的名称。
作代码	ActionCode	string	返回与错误消息关联的作的结果代码。

从用户凭据读取

操作 ID:: CredentialRead

从 IA-Connect 代理会话中用户配置文件中的凭据读取用户名和密码。可以从 Windows 控制面板查看凭据。用户名和密码都可以从通用凭据检索，而只能从 Windows 凭据检索用户名。

参数

名称	密钥	必需	类型	说明
凭据地址	CredentialAddress	True	string	凭据的名称/地址。
凭据类型	CredentialType	True	string	凭据类型：Windows 或 Generic。
对称加密密钥	SymmetricKey		string	用于解密凭据密码的可选对称加密密钥（如果使用密钥加密凭据）。仅可用于通用凭据，因为无法检索 Windows 凭据的密码。
将密码存储为标识符	StorePasswordAsIdentifier		string	如果提供了标识符，则检索到的凭据密码将存储在代理中，供任何可以使用存储凭据的命令稍后检索/使用。这些密码仅存储在内存中，在关闭代理时会丢失。仅可用于通用凭据，因为无法检索 Windows 凭据的密码。例如：MyExchangePassword。
不返回密码	DontReturnPassword		boolean	如果设置为 true，则不会返回凭据密码。如果在代理中存储密码供进一步命令使用（即“将密码存储为标识符”为 true），但实际上不需要知道工作流中的密码，这非常有用。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
用户名	UserName	string	凭据用户名。
密码	Password	string	凭据密码。

以 Base64 的形式获取文件内容

操作 ID:: GetFileContentsAsBase64

检索 Base64 格式的指定文件的内容，该格式适合通过 API 传输，并轻松转换为原始文本或二进制格式。

参数

名称	密钥	必需	类型	说明
文件路径	FilePath	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
压缩	Compress		boolean	设置为 true 以 GZip 压缩文件内容，然后再转换为 Base64。文件保持不变，所有作都在内存中执行。仅当检索 Base64（解码回原始文件内容文本或二进制数据时）后，才能使用此功能。如果将 Base64 直接传递给接受 Base64 作为输入且没有 GUnzip 功能的作，则设置为 false。
最大文件大小	MaxFileSize		integer	文件的最大大小，高于将引发异常，而不是检索文件内容。这样，就可避免要求代理检索大型文件的情况，这最终会导致作超时。设置为 -1 以禁用文件大小检查。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
将文件内容作为 Base64	FileContentsAsBase64	string	Base64 格式的文件内容。

会话已锁定

操作 ID:: IsSessionLocked

报告 IA-Connect 代理正在运行的会话是否已锁定。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
会话已锁定	SessionIsLocked	boolean	如果锁定了运行 IA-Connect 代理的会话，则设置为 true。

使会话保持活动状态

操作 ID:: KeepSessionAlive

通过将鼠标移动到指定时间间隔来使 IA-Connect 代理用户会话保持活动状态，以防止会话处于空闲状态。

参数

名称	密钥	必需	类型	说明
X 摇摆	XWiggle		integer	水平移动鼠标的像素数。
Y 摆动	YWiggle		integer	垂直移动鼠标的像素数。
摇摆延迟（以秒为单位）	WiggleDelayInSeconds		double	摇摆时鼠标移动之间的秒数。
空闲阈值（以秒为单位）	IdleThresholdInSeconds		integer	自移动鼠标前最后一个输入以来应经过的秒数。
空闲检查周期（以秒为单位）	IdleCheckPeriodInSeconds		integer	检查上次输入时间之间的秒数（检查空闲阈值是否已通过）。
总 keepalive 运行时（以秒为单位）	TotalKeepaliveRuntimeInSeconds		integer	使会话保持活动状态的总秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	KeepSessionAliveResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

停止使会话保持活动状态

操作 ID:: StopKeepSessionAlive

停止 IA-Connect 代理用户会话保持活动状态。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	StopKeepSessionAliveResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

关闭 IA-Connect 代理

操作 ID:: CloseRSAServer

关闭 IA-Connect 代理。这不会影响运行 IA-Connect 代理的用户会话。

参数

名称	密钥	必需	类型	说明
等待的秒数	SecondsToWait		integer	发出关闭命令之前等待的时间，以便 IA-Connect 代理可以报告命令的完成情况。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

写入 CSV 文件

操作 ID:: WriteCollectionToCSVFile

在运行 IA-Connect 代理的计算机上创建 CSV 文件。 CSV 文件是从集合（表）或 JSON 格式的表中创建的。

参数

名称	密钥	必需	类型	说明
属性	Properties		object
输入表 JSON	InputTableJSON		string	要写入 CSV 文件的数据表，格式为 JSON 格式。
输出 CSV 文件路径	CSVFilePath	True	string	CSV 文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
输出编码	OutputEncoding		string	写入 CSV 文件时要使用的文本编码格式。支持的编码为 UTF8、UTF7、Unicode 和 ASCII。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	WriteCollectionToCSVFileResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

写入文本文件

操作 ID:: WriteTextFile

在运行 IA-Connect 代理的计算机上创建文本文件，并将文本写入文件中。

参数

名称	密钥	必需	类型	说明
文件路径	Filename	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
要写入的文本	TextToWrite		string	要写入文件中的文本内容。
追加现有文件	AppendExistingFile		boolean	如果文件已存在，是否应将要写入的新文本追加到现有文件的末尾？
编码	Encoding		string	提供文件编码（Unicode、UTF8、UTF7 或 ASCII），或为默认值留空（UTF8）。
根据需要创建文件夹	CreateFolderIfRequired		boolean	如果存储在“文件路径”参数中提供的文件的文件夹不存在，是否应创建此文件夹？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

写入用户凭据

操作 ID:: CredentialWrite

将用户名和密码写入 IA-Connect 代理会话中用户配置文件中的凭据，创建该凭据（如果不存在）。可以从 Windows 控制面板查看凭据。

参数

名称	密钥	必需	类型	说明
凭据地址	CredentialAddress	True	string	凭据的名称/地址。
用户名	UserName	True	string	凭据用户名。
密码	Password	True	string	凭据密码。
凭据类型	CredentialType	True	string	凭据类型：Windows 或 Generic。
凭据持久性	CredentialPersistence		string	凭据持久性：会话（仅适用于此登录会话）、LocalMachine（仅在此计算机上为此用户保留会话和仅重启）或 Enterprise（可以在计算机之间漫游）。
对称加密密钥	SymmetricKey		string	用于加密凭据的可选对称加密密钥。如果知道密钥，则只能检索此凭据。仅可用于通用凭据。
将密码存储为标识符	StorePasswordAsIdentifier		string	如果提供了标识符，此密码也将存储在代理中，供任何可以使用存储凭据的命令稍后检索/使用。这些密码仅存储在内存中，在关闭代理时会丢失。例如：MyExchangePassword。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	CredentialWriteResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

分配 Orchestrator 自动化任务

操作 ID:: TasksAssignTask

将选定的 Orchestrator 自动化任务分配给指定的用户或组。此分配将传递到与此自动化任务（例如 ServiceNow）链接的源系统，最常用于将票证传递给其他人员或人员组，以便进行其他处理。如果 Orchestrator 自动化任务未链接到源，将引发异常。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要分配的 Orchestrator 任务的 ID。
分配给用户 ID	AssignToUserId		string	要向其分配任务的用户的 ID。如果将任务分配给用户，并且你知道用户 ID，请使用此输入。请使用用户 ID 或用户名输入，而不是同时分配给组，请将此输入留空。
分配给用户名	AssignToUserName		string	要向其分配任务的用户的名称。如果将任务分配给用户，并且知道用户名，请使用此输入。使用用户 ID 或用户名输入，而不是同时用于分配组，请将此输入留空。
分配到组 ID	AssignToGroupId		string	要向其分配任务的组的 ID。如果将任务分配给组，并且你知道组 ID，请使用此输入。请使用组 ID 或组名称输入，而不是同时分配给用户，请将此输入留空。
分配到组名称	AssignToGroupName		string	要向其分配任务的组的名称。如果将任务分配给组，并且知道组名称，请使用此输入。使用组 ID 或组名称输入，而不是同时为用户分配，请将此输入留空。
如果为空，则删除用户分配	RemoveUserAssignmentIfBlank		boolean	如果用户分配字段为空且此字段设置为 true，则任何当前分配的用户都将被删除，否则用户分配将保持不变。
如果为空，则删除组分配	RemoveGroupAssignmentIfBlank		boolean	如果组分配字段为空且此字段设置为 true，则删除任何当前分配的组，否则组分配将保持不变。

名称	路径	类型	说明
命令结果	TasksAssignTaskResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

创建 Orchestrator 一次性机密

操作 ID:: CreateOrchestratorOneTimeSecret

一次性机密提供一种用于存储一次可通过不可模糊的唯一 URL 检索的机密的设施。这通常用于与第三方共享机密。可以使用 Orchestrator UI、REST API 或流创建一次性机密。

参数

名称	密钥	必需	类型	说明
友好的名称	FriendlyName	True	string	这是一个描述性名称，仅用于标识此一次性机密。此名称的唯一用途是在 Orchestrator UI 中的机密列表中查看。
密码值	SecretValue		password	希望通过一次性 URL 共享和提供一次性机密值。
检索短语 1	RetrievalPhrase1		password	这是通过唯一 URL 检索一次性机密所需的短语。如果留空，则不需要检索短语。检索阶段区分大小写。
检索短语 2	RetrievalPhrase2		password	这是通过唯一 URL 检索一次性机密所需的第二个短语。如果留空，则不需要检索短语。检索阶段区分大小写。
删除前的最大检索数	MaximumRetrievalsBeforeDeletion		integer	在从 Orchestrator 中删除此机密之前，可以检索此一次性机密的次数？默认情况下，此值设置为 1（一次性）。仅当多个用户需要访问此机密时，才设置为更高的值。
机密有开始日期	SecretHasAStartDate		boolean	在特定的日期和时间之前，如果机密不能用于检索，请启用该机密。
机密开始日期和时间	SecretStartDateTime		date-time	此机密可供检索的日期和时间。日期和时间以 dd/MM/yyyy HH：mm 格式输入，并在 UTC/GMT+0 中存储和处理。例如：“2022-01-24T07：00：00”将阻止在 2022 年 1 月 24 日 07.00 小时 UTC（GMT+0）之前检索一次性机密（你将收到 404）。或者，使用“直到机密开始时间”输入的“小时”。使用此输入时，必须将“机密有开始日期”设置为 true，否则将忽略输入。
机密开始时间之前的小时数	HoursUntilSecretStartTime		integer	此机密可供检索的小时数。或者，使用“机密开始日期和时间”输入。使用此输入时，必须将“机密有开始日期”设置为 true。
机密的到期日期	SecretHasAnExpiryDate		boolean	启用是否应在一段时间后自动删除机密，而不考虑是否已检索机密。
机密到期日期和时间	SecretExpiryDateTime		date-time	自动删除此机密的日期和时间，而不考虑是否已检索它。日期和时间以 yyyy-MM-ddTHH：mm：ss 格式输入，并在 UTC/GMT+0 中存储和处理。例如：“2022-01-24T07：00：00”将在 2022 年 1 月 24 日 07.00 小时 UTC（GMT+0）删除一次性机密。或者，使用“机密过期前的小时数”输入。使用此输入时，必须将“机密的到期日期”设置为 true，否则将忽略输入。
机密到期前的小时数	HoursUntilSecretExpiry		integer	此机密自动删除之前的小时数，无论是否已检索它。或者，使用“机密到期日期和时间”输入。使用此输入时，必须将“机密的到期日期”设置为 true。

名称	路径	类型	说明
检索 URL	RetrievalURL	string	用于检索一次性机密的一次性 URL。
检索 ID	RetrievalId	string	唯一检索 ID。此一次性 URL 基于此唯一 ID 生成。如果需要在自定义方案中构造自己的 URL，此 ID 可能很有用。

创建目录

操作 ID:: CreateDirectory

在运行 IA-Connect 代理的计算机上创建目录（文件夹）。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
错误（如果已存在）	ErrorIfAlreadyExists		boolean	如果目录（文件夹）已存在，IA-Connect 是否应引发错误？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

创建远程桌面会话（RDS）启动文件

操作 ID:: GenerateRDPFile

创建远程桌面会话（RDS）启动文件，该文件可用于使用指定的参数自动启动远程桌面会话，而无需自动化远程桌面客户端 UI。 RDS 启动文件具有扩展名“.rdp”，通常称为 RDP 文件。

参数

名称	密钥	必需	类型	说明
远程地址	RemoteAddress	True	string	要连接到的远程系统的地址。这可能是 IP 地址、主机名或完全限定的域名（FQDN）。
输出文件夹路径	OutputFolderPath	True	string	要在其中保存 RDP 文件的文件夹。
RDP 文件名	RDPFileName	True	string	将在输出文件夹路径中创建的 RDP 文件的名称。
覆盖 RDP 文件（如果已存在）	OverwriteRDPFileIfAlreadyExists		boolean	设置为 true 以自动覆盖具有相同文件夹/文件名的任何 RDP 文件。如果不存在具有相同文件夹/文件名的现有 RDP 文件，则不应创建新的 RDP 文件，则设置为 false。
信任远程计算机	TrustRemoteComputer		boolean	设置为 true 以将远程地址标记为受信任（在 Windows 注册表中），主要用于设备重定向目的，从而消除启动 RDP 文件时可能收到的弹出窗口。
存储凭据	StoreCredentials		boolean	设置为 true 以创建用户凭据以保存远程桌面身份验证详细信息。这可以让你连接到远程桌面系统，而无需提示进行身份验证。
UserName	UserName		string	如果存储用于保存远程桌面身份验证详细信息的凭据，则可以指定要存储在凭据中的用户名。
密码	Password		string	如果存储用于保存远程桌面身份验证详细信息的凭据，则可以指定要存储在凭据中的密码。
凭据类型	CredentialType		string	如果存储用于保存远程桌面身份验证详细信息的凭据，则允许你指定凭据类型：Windows 或泛型。若要保存 RDP 凭据，通常会创建 Windows 凭据。
凭据持久性	CredentialPersistence		string	如果存储用于保存远程桌面身份验证详细信息的凭据，则可以指定凭据暂留：会话（仅适用于此登录会话）、LocalMachine（仅在会话之间保留此用户，并且仅在此计算机上重新启动）或企业版（可以在计算机之间漫游）。创建 RDP 文件时，默认值为“会话”。
重定向打印机	RedirectPrinters		boolean	本地会话中的打印机是否应映射到远程桌面会话？此设置可能在远程端强制执行，因此不会生效。
重定向所有驱动器	RedirectAllDrives		boolean	本地会话中的所有驱动器号（例如 C：）是否应映射到远程桌面会话？此设置可能在远程端强制执行，因此不会生效。
重定向剪贴板	RedirectClipboard		boolean	是否应在本地和远程系统之间共享剪贴板，从而允许在两个系统之间复制和粘贴？此设置可能在远程端强制执行，因此不会生效。
全屏	Fullscreen		boolean	远程桌面会话是否为全屏。
桌面宽度	DesktopWidth		integer	如果远程桌面会话未全屏，则远程桌面会话的宽度（以像素为单位）。
桌面高度	DesktopHeight		integer	如果远程桌面会话未全屏，则远程桌面会话的高度（以像素为单位）。
使用多监视器	UseMultiMonitor		boolean	如果全屏远程桌面会话应仅使用单个监视器，则设置为 false。如果全屏远程桌面会话应使用所有监视器，则设置为 true。对单监视器系统（因此大多数虚拟机）没有影响。
会话颜色深度	SessionBPP		integer	远程桌面会话的颜色深度（以每像素（BPP）为单位。数字越高，颜色就越多。支持的值为 15、16、24、32。
智能大小调整	SmartSizing		boolean	对于本地计算机，设置为 true 以自动缩放远程会话的内容以适应窗口大小。设置为 false 以不自动缩放。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
RDP 文件路径	RDPFilePath	string	生成的 RDP 文件的完整路径。

删除 Orchestrator 自动化任务

操作 ID:: TasksDeleteTask

删除已延迟的 Orchestrator 自动化任务。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要删除的 Orchestrator 自动化任务的 ID。
更新源系统	UpdateSourceSystem		boolean	如果设置为 true（默认值），并且 Orchestrator 任务已链接到源系统（例如 ServiceNow），Orchestrator 将执行 Orchestrator 中源系统配置中指定的任何作（例如关闭票证）。如果设置为 false，或者任务未链接到源系统，则任务将仅从 Orchestrator 中删除。

名称	路径	类型	说明
命令结果	TasksDeleteTaskResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

删除 Orchestrator 自动化任务作

操作 ID:: TasksDeleteTaskOperation

通过提供唯一的任务作 ID 来删除特定的 Orchestrator 自动化任务。

参数

名称	密钥	必需	类型	说明
操作 ID	OperationId	True	string	要删除的 Orchestrator 任务的作 ID。
更新源系统	UpdateSourceSystem		boolean	如果设置为 true（默认值），并且 Orchestrator 任务已链接到源系统（例如 ServiceNow），Orchestrator 将执行 Orchestrator 中源系统配置中指定的任何作（例如关闭票证）。如果设置为 false，或者任务未链接到源系统，则任务将仅从 Orchestrator 中删除。

名称	路径	类型	说明
命令结果	TasksDeleteTaskOperationResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

删除代理内存中的密码

操作 ID:: DeletePasswordInAgentMemory

删除存储在代理内存中的密码，或删除所有代理存储的密码。

参数

名称	密钥	必需	类型	说明
删除所有密码	DeleteAllPasswords		boolean	设置为 true 以删除代理内存中存储的所有密码。设置为 false（默认值），删除与提供的标识符匹配的单个密码。
标识符	Identifier		string	要删除的密码的唯一标识符。例如：SAPGUILogon。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	DeletePasswordInAgentMemoryResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

删除代理线程

操作 ID:: DeleteAgentThread

删除代理线程或所有代理线程（终止、中止）线程（如果线程仍在运行）。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。监视代理线程的进程或流将收到“代理线程 ID 不存在”错误。

参数

名称	密钥	必需	类型	说明
线程 ID	ThreadId		integer	如果以前以线程身份运行代理作，请提供线程 ID 以终止和删除该线程。此线程 ID 将作为之前作为线程运行的作的输出提供。如果指定的代理线程 ID 不存在，将引发异常。
删除所有代理线程	DeleteAllAgentThreads		boolean	设置为 true 以删除所有代理线程。设置为 false（默认值），以删除由“线程 ID”输入指定的单个代理线程。
如果代理线程无法删除，则引发异常	RaiseExceptionIfAgentThreadFailsToDelete		boolean	如果代理线程无法删除，则设置为 true 以引发异常。请注意，如果代理线程在发出此作时完成（因为它在删除时不再存在），则可能会导致引发异常。设置为 false（默认值），以在删除代理线程时忽略错误。输出“已删除代理线程数”将报告已删除的代理线程数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已删除的代理线程数	NumberOfAgentThreadsDeleted	integer	如果“删除所有代理线程”为 true，则此输出将保留已删除的代理线程数（0 或更高）。如果“删除所有代理线程”为 false，并且提供了代理线程 ID，则此输出将设置为 0 或 1。

删除文件

操作 ID:: DeleteFile

删除运行 IA-Connect 代理的计算机上的文件。

参数

名称	密钥	必需	类型	说明
文件路径	Filename	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

删除文件

操作 ID:: DeleteFiles

删除与运行 IA-Connect 代理的计算机上的模式匹配的指定文件夹中的文件。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
图案	Pattern		string	与要删除的文件匹配的模式。对于具有 .txt 扩展名的文件，或 *.txt。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已删除的文件数	NumberOfFilesDeleted	integer	已成功删除的文件数。
未能删除的文件数	NumberOfFilesFailedToDelete	integer	无法删除的文件数。

删除用户凭据

操作 ID:: CredentialDelete

删除 IA-Connect 代理会话中用户配置文件中的凭据。可以从 Windows 控制面板查看凭据。

参数

名称	密钥	必需	类型	说明
凭据地址	CredentialAddress	True	string	凭据的名称/地址。
凭据类型	CredentialType	True	string	凭据类型：Windows 或 Generic。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	CredentialDeleteResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

删除目录

操作 ID:: DeleteDirectory

删除运行 IA-Connect 代理的计算机上的目录（文件夹）。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
递归的	Recursive		boolean	是否还应删除目录中的子目录（子文件夹）和文件？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

单击鼠标左键

操作 ID:: LeftClickMouse

单击 IA-Connect 代理用户会话中的鼠标左键。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

双击鼠标

操作 ID:: DoubleLeftClickMouse

双击 IA-Connect 代理用户会话中的鼠标左键。

参数

名称	密钥	必需	类型	说明
延迟（以毫秒为单位）	DelayInMilliseconds		integer	每次单击之间的延迟（以毫秒为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

发送密码密钥

操作 ID:: SendPasswordKeys

将全局按键发送到 IA-Connect 代理用户会话，特别是用于输入密码。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。

参数

名称	密钥	必需	类型	说明
密码	Password	True	password	要输入的密码，在 IA-Connect 代理用户会话中使用模拟按键。密钥代码记录在“UI 用户指南”中的“发送密钥语法”中。如果这是“Stored”密码，请输入 {IAConnectPassword：StoredPasswordIdentifier} 格式，并将“存储密码”输入设置为 true。如果这是 Orchestrator 泛型凭据，请输入 {OrchestratorCredential：FriendlyName} 格式，并将“存储的密码”输入设置为 true。
间隔（以毫秒为单位）	Interval		integer	每个按键之间的毫秒数。
不解释符号	DontInterpretSymbols		boolean	密码中的符号是否不应解释为特殊键（例如，对于 Shift、^ for Ctrl）？如果尝试输入实际符号，则应将其设置为 true。
密码包含存储的密码	PasswordContainsStoredPassword		boolean	如果密码是 IA-Connect 存储的密码标识符（例如：由“生成密码”作生成）或 IA-Connect Orchestrator 泛型凭据（例如：将 IA-Connect 与 PA 流配合使用），则设置为 true。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

发送密码密钥事件

操作 ID:: SendPasswordKeyEvents

使用低级键盘驱动程序将全局按键事件发送到 IA-Connect 代理用户会话，特别是用于输入密码。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。

参数

名称	密钥	必需	类型	说明
密码	Password	True	password	使用低级别键盘驱动程序进入 IA-Connect 代理用户会话的密码。密钥代码记录在“UI 用户指南”中的“发送密钥事件语法” 中。如果这是“Stored”密码，请输入 {IAConnectPassword：StoredPasswordIdentifier} 格式，并将“存储密码”输入设置为 true。如果这是 Orchestrator 泛型凭据，请输入 {OrchestratorCredential：FriendlyName} 格式，并将“存储的密码”输入设置为 true。
间隔（以毫秒为单位）	Interval		integer	每个按键事件之间的毫秒数。
不解释符号	DontInterpretSymbols		boolean	密码中的符号是否不应解释为特殊键（例如，Shift 的 {SHIFT}，Ctrl} for Ctrl）？如果尝试输入实际符号，则应将其设置为 true。
密码包含存储的密码	PasswordContainsStoredPassword		boolean	如果密码是 IA-Connect 存储的密码标识符（例如：由“生成密码”作生成）或 IA-Connect Orchestrator 泛型凭据（例如：将 IA-Connect 与 PA 流配合使用），则设置为 true。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

发送密钥

操作 ID:: SendKeys

将全局按键发送到 IA-Connect 代理用户会话。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。

参数

名称	密钥	必需	类型	说明
文本	Text	True	string	在 IA-Connect 代理用户会话中模拟的按键。密钥代码记录在“UI 用户指南”中的“发送密钥语法”中。若要输入字母数字，只需提供文本 as-is。按 Ctrl+C 的示例： ^c。按 Alt+F 的示例：%f。
间隔（以毫秒为单位）	Interval		integer	每个按键之间的毫秒数。
是密码	IsPassword		boolean	输入是否为密码值？如果是，则应使用备用的“发送密码密钥”作。
不解释符号	DontInterpretSymbols		boolean	文本中的符号是否不应解释为特殊键（例如，对于 Shift、^ for Ctrl）？如果尝试输入实际符号，则应将其设置为 true。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

发送密钥事件

操作 ID:: SendKeyEvents

使用低级别键盘驱动程序将全局按键事件发送到 IA-Connect 代理用户会话。这会模拟用户在键盘上按这些键。确保目标 Window 元素处于焦点，或者键压可能由错误的应用程序接收，或被忽略。

参数

名称	密钥	必需	类型	说明
文本	Text	True	string	使用低级别键盘驱动程序将按下键输入到 IA-Connect 代理用户会话中。密钥代码记录在“UI 用户指南”中的“发送密钥事件语法” 中。按下和释放转义的示例： {Escape}。按 Win+D 显示桌面的示例（按左 Windows 键、按下和释放 d、释放左 Windows 键）： <{LWin}d>{LWin}。按 Ctrl+C 的示例（按下左键、按下和释放 c、释放左控件）： <{Ctrl}c>{Ctrl}。请记住释放沮丧的键，或者它们将保持沮丧（例如，如果你用于 < 抑制修饰键，用于 > 释放它）。
间隔（以毫秒为单位）	Interval		integer	每个按键事件之间的毫秒数。
是密码	IsPassword		boolean	输入是否为密码值？如果是这样，则应使用备用的“发送密码密钥事件”作。
不解释符号	DontInterpretSymbols		boolean	文本中的符号是否不应解释为特殊键（例如，Shift 的 {SHIFT}，Ctrl} for Ctrl）？如果尝试输入实际符号，则应将其设置为 true。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

右键单击坐标处的鼠标

操作 ID:: RightClickMouseAtCoordinate

单击指定坐标处 IA-Connect 代理用户会话中的鼠标右键。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

右键单击鼠标

操作 ID:: RightClickMouse

单击 IA-Connect 代理用户会话中的鼠标右键。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

向 Orchestrator 自动化任务添加备注

操作 ID:: TasksAddNote

将注释添加到选定的 Orchestrator 自动化任务。此说明将传递到与此自动化任务（例如 ServiceNow）链接的源系统，最常用于将详细信息添加到票证中。如果 Orchestrator 自动化任务未链接到源，将引发异常。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要向其添加注释的 Orchestrator 任务的 ID。
注释文本	NoteText	True	string	备注文本消息。
备注类型	NoteType		string	如果源系统支持不同的笔记类型（例如工作笔记、关闭笔记或批注），请输入此处的备注类型。这将以不同的方式解释，具体取决于源系统。当前支持的类型为“WorkNote”（默认值）、“CloseNote”、“Comment”。如果只有一种类型的笔记，请输入“WorkNote”。如果有自定义工作说明，请输入“其他”。
其他备注类型	NoteTypeOther		string	如果你有自定义笔记类型，请选择“其他”的“备注类型”，并在此字段中输入自定义类型。

名称	路径	类型	说明
命令结果	TasksAddNoteResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

向左按住鼠标

操作 ID:: LeftHoldMouse

将鼠标左键保留在 IA-Connect 代理用户会话中的指定秒数。

参数

名称	密钥	必需	类型	说明
要保留的秒数	SecondsToHold	True	double	按住鼠标左键的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

向文件夹添加权限

操作 ID:: AddPermissionToFolder

向运行 IA-Connect 代理的计算机上的文件夹添加权限。

参数

名称	密钥	必需	类型	说明
文件夹路径	FolderPath	True	string	文件夹的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
身份	Identity	True	string	要分配权限的用户、组或计算机等标识。这可以采用“username”、“DOMAIN\username”或“username@domainfqdn”。
许可	Permission	True	string	提供要分配的权限（Read、ReadAndExecute、Modify 或 FullControl），或为默认值留空（读取）。
应用于文件夹	ApplyToFolder		boolean	权限是否适用于文件夹本身？
应用于子文件夹	ApplyToSubFolders		boolean	权限是否应传播到子文件夹？
应用于文件	ApplyToFiles		boolean	权限是否适用于文件夹中的文件？
Deny	Deny		boolean	是否拒绝权限？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

向文件添加权限

操作 ID:: AddPermissionToFile

向运行 IA-Connect 代理的计算机上的文件添加权限。

参数

名称	密钥	必需	类型	说明
文件路径	FilePath	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
身份	Identity	True	string	要分配权限的用户或组的标识。这可以采用“username”、“DOMAIN\username”或“username@domainfqdn”。
许可	Permission	True	string	提供要分配的权限（Read、ReadAndExecute、Modify 或 FullControl），或为默认值留空（读取）。
Deny	Deny		boolean	是否拒绝权限？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

启动远程桌面会话（RDS）

操作 ID:: LaunchRemoteDesktopSession

使用 RDP 启动文件启动远程桌面会话（RDS）。

参数

名称	密钥	必需	类型	说明
RDP 文件路径	RDPFilePath	True	string	RDP 文件的完整路径（可以预先存在或使用作创建：“创建远程桌面会话（RDS）启动文件”）。
信任远程计算机	TrustRemoteComputer		boolean	设置为 true 以将远程地址（在 RDP 文件中设置）标记为受信任（在 Windows 注册表中），主要用于设备重定向目的，消除了启动 RDP 文件时可能会收到的弹出窗口。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	LaunchRemoteDesktopSessionResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

启用下一跃点 IA-Connect

操作 ID:: EnableNextHop

启用下一跃点，它将接收的所有将来命令转发到下一跃点会话中运行的 IA-Connect 代理。

参数

名称	密钥	必需	类型	说明
下一跃点控制器地址	NextHopDirectorAddress		string	如果“下一跃点地址为 localhost”、“下一跃点控制器地址为主机名”、“下一跃点控制器地址为 FQDN”或“下一跃点控制器地址已命名管道”参数均设置为 true，则下一跃点 IA-Connect 控制器地址的可选地址转发命令。
下一跃点控制器 TCP 端口	NextHopDirectorTCPPort		integer	下一跃点控制器正在侦听的 TCP 端口（代理正在运行的计算机上的控制器）。
下一跃点控制器使用 HTTPS	NextHopDirectorUsesHTTPS		boolean	如果下一跃点控制器使用 HTTPS，则设置为 True;否则设置为 false。
下一跃点控制器地址为 localhost	NextHopDirectorAddressIsLocalhostname		boolean	下一跃点控制器地址（相对于代理）是“localhost”。
下一跃点控制器地址为主机名	NextHopDirectorAddressIsHostname		boolean	下一跃点控制器地址是运行代理的计算机的主机名（即运行代理的计算机和控制器）。
下一跃点控制器地址为 FQDN	NextHopDirectorAddressIsFQDN		boolean	下一跃点控制器地址是运行代理的计算机（即运行代理和控制器）的完全限定域名（FQDN）。
按会话 ID 递增下一跃点控制器 TCP 端口	IncrementNextHopDirectorTCPPortBySessionId		boolean	若要确保下一跃点控制器 TCP 端口是唯一的（如果有多个并行会话使用同一主机中的下一跃点），可将会话 ID 添加到下一跃点控制器 TCP 端口。
启用前禁用	DisableBeforeEnable		boolean	在再次启用之前，是否应禁用双跃点（如果当前处于活动状态？如果设置为 true（默认值），则任何新的双跃点启用指令都将替换前面的指令。如果设置为 false，则会启用三跃点，因为双跃点 IA-Connect 代理将收到指令。
检查下一跃点控制器正在运行	CheckNextHopDirectorIsRunning		boolean	下一跃点需要在代理所在的同一台计算机上运行 IA-Connect 控制器。如果此设置为 true，代理将按所述检查下一跃点控制器正在运行，如果下一跃点控制器未运行，将无法启用下一跃点。如果此设置为 false，则代理不会执行任何检查，只需启用下一跃点。
检查下一跃点代理正在运行	CheckNextHopAgentIsRunning		boolean	下一跃点需要在代理和运行 IA-Connect 代理所在的同一台计算机上运行 IA-Connect 控制器在下一跃点会话中运行。如果此设置为 true，代理将按所述检查下一跃点代理正在运行，如果下一跃点代理未运行，将无法启用下一跃点。如果此设置为 false，则代理不会执行任何检查，只需启用下一跃点。
下一跃点控制器地址命名为管道	NextHopDirectorAddressIsNamedPipe		boolean	下一跃点控制器地址（相对于代理）使用命名管道而不是 TCP/IP Web 服务。这是避免在第一跃点上使用 TCP/IP 端口的默认值。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
活动下一跃点控制器地址	ActiveNextHopDirectorAddress	string	正在使用的下一跃点控制器的地址。
活动下一跃点控制器 TCP 端口	ActiveNextHopDirectorTCPPort	integer	活动下一跃点控制器的 TCP 端口（如果使用）。
活动下一跃点控制器使用 HTTPS	ActiveNextHopDirectorUsesHTTPS	boolean	如果活动的下一跃点控制器正在使用 HTTPS，则返回 true。
活动下一跃点控制器 URL	ActiveNextHopDirectorURL	string	活动下一跃点控制器的 URL。

启用文件夹安全继承

操作 ID:: EnableFolderSecurityInheritance

在运行 IA-Connect 代理的计算机上的文件夹中启用安全继承。

参数

名称	密钥	必需	类型	说明
文件夹路径	FolderPath	True	string	文件夹的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标之间拖动鼠标右键

操作 ID:: RightMouseDragBetweenCoordinates

在 IA-Connect 代理用户会话中的两个指定坐标之间执行鼠标右键拖动。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。

参数

名称	密钥	必需	类型	说明
开始 X 像素	StartXCoord	True	integer	起始 X 坐标值（以像素为单位）。
开始 Y 像素	StartYCoord	True	integer	起始 Y 坐标值（以像素为单位）。
结束 X 像素	EndXCoord	True	integer	结束 X 坐标值（以像素为单位）。
结束 Y 像素	EndYCoord	True	integer	结束 Y 坐标值（以像素为单位）。
步骤数	NumberOfSteps		integer	拖动作应分解到的步骤数。
总时间（以秒为单位）	TotalTimeInSeconds		double	拖动作应从头到尾执行的总时间。
最大移动像素抖动	MaximumMovementPixelJitter		integer	执行拖动作时的最大像素抖动。如果值为 1 或更高，则移动抖动。抖动在每一步之间平滑，以避免移动高峰。此输入的值控制抖动可以位于任何特定点的最大值，从而限制鼠标偏离路径的距离。值越高，拖动作显示的“平滑”就越少。每个点的抖动只能偏离以前的抖动值，方法是 -2 和 2（默认情况下），因此最大可能的抖动是 2 x NumberOfSteps，而不管你将最大值设置为什么。
最大结束像素抖动	MaximumEndPixelJitter		integer	拖动作末尾的最大像素抖动。值越高，到达结束坐标时拖动越精确。
最大移动像素抖动增量	MaximumMovementPixelJitterDelta		integer	如果使用鼠标移动抖动（最大移动像素抖动为 1 或更高），则每个点的抖动最大可能会偏离上一点。这用于确保抖动是平滑的。较大的值会导致平滑度降低。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标之间拖动鼠标左键

操作 ID:: LeftMouseDragBetweenCoordinates

在 IA-Connect 代理用户会话中的两个指定坐标之间执行鼠标左键拖动。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。

参数

名称	密钥	必需	类型	说明
开始 X 像素	StartXCoord	True	integer	起始 X 坐标值（以像素为单位）。
开始 Y 像素	StartYCoord	True	integer	起始 Y 坐标值（以像素为单位）。
结束 X 像素	EndXCoord	True	integer	结束 X 坐标值（以像素为单位）。
结束 Y 像素	EndYCoord	True	integer	结束 Y 坐标值（以像素为单位）。
步骤数	NumberOfSteps		integer	拖动作应分解到的步骤数。
总时间（以秒为单位）	TotalTimeInSeconds		double	拖动作应从头到尾执行的总时间。
最大移动像素抖动	MaximumMovementPixelJitter		integer	执行拖动作时的最大像素抖动。如果值为 1 或更高，则移动抖动。抖动在每一步之间平滑，以避免移动高峰。此输入的值控制抖动可以位于任何特定点的最大值，从而限制鼠标偏离路径的距离。值越高，拖动作显示的“平滑”就越少。每个点的抖动只能偏离以前的抖动值，方法是 -2 和 2（默认情况下），因此最大可能的抖动是 2 x NumberOfSteps，而不管你将最大值设置为什么。
最大结束像素抖动	MaximumEndPixelJitter		integer	拖动作末尾的最大像素抖动。值越高，到达结束坐标时拖动越精确。
最大移动像素抖动增量	MaximumMovementPixelJitterDelta		integer	如果使用鼠标移动抖动（最大移动像素抖动为 1 或更高），则每个点的抖动最大可能会偏离上一点。这用于确保抖动是平滑的。较大的值会导致平滑度降低。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标之间移动鼠标

操作 ID:: MoveMouseBetweenCoordinates

在 IA-Connect 代理用户会话中的两个指定坐标之间移动鼠标。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。

参数

名称	密钥	必需	类型	说明
开始 X 像素	StartXCoord	True	integer	起始 X 坐标值（以像素为单位）。
开始 Y 像素	StartYCoord	True	integer	起始 Y 坐标值（以像素为单位）。
结束 X 像素	EndXCoord	True	integer	结束 X 坐标值（以像素为单位）。
结束 Y 像素	EndYCoord	True	integer	结束 Y 坐标值（以像素为单位）。
步骤数	NumberOfSteps		integer	移动作应划分到的步骤数。
总时间（以秒为单位）	TotalTimeInSeconds		double	移动作应从头到尾的总时间。
最大移动像素抖动	MaximumMovementPixelJitter		integer	执行拖动作时的最大像素抖动。如果值为 1 或更高，则移动抖动。抖动在每一步之间平滑，以避免移动高峰。此输入的值控制抖动可以位于任何特定点的最大值，从而限制鼠标偏离路径的距离。值越高，拖动作显示的“平滑”就越少。每个点的抖动只能偏离以前的抖动值，方法是 -2 和 2（默认情况下），因此最大可能的抖动是 2 x NumberOfSteps，而不管你将最大值设置为什么。
最大结束像素抖动	MaximumEndPixelJitter		integer	拖动作末尾的最大像素抖动。值越高，到达结束坐标时拖动越精确。
最大移动像素抖动增量	MaximumMovementPixelJitterDelta		integer	如果使用鼠标移动抖动（最大移动像素抖动为 1 或更高），则每个点的抖动最大可能会偏离上一点。这用于确保抖动是平滑的。较大的值会导致平滑度降低。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标处单击鼠标中间键

操作 ID:: MiddleClickMouseAtCoordinate

单击指定坐标处 IA-Connect 代理用户会话中的中间鼠标按钮。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标处单击鼠标左键

操作 ID:: LeftClickMouseAtCoordinate

单击指定坐标处 IA-Connect 代理用户会话中的鼠标左键。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标处双击鼠标

操作 ID:: DoubleLeftClickMouseAtCoordinate

双击指定坐标处 IA-Connect 代理用户会话中的鼠标左键。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
延迟（以毫秒为单位）	DelayInMilliseconds		integer	每次单击之间的延迟（以毫秒为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在坐标处按住鼠标

操作 ID:: RightHoldMouseAtCoordinate

将鼠标右键保存在 IA-Connect 代理用户会话中指定秒数的指定坐标处。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
要保留的秒数	SecondsToHold	True	double	按住鼠标右键的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

在屏幕上绘制矩形

操作 ID:: DrawRectangleOnScreen

在屏幕上绘制一个矩形，以帮助识别屏幕坐标或报告屏幕坐标的作的输出。矩形在 5 秒后自动删除。

参数

名称	密钥	必需	类型	说明
矩形左边缘屏幕像素 X 坐标	RectangleLeftPixelXCoord	True	integer	要显示的矩形的左像素边缘。可以采用虚拟像素或物理像素，具体取决于输入“坐标是物理的”。
矩形右边缘屏幕像素 X 坐标	RectangleRightPixelXCoord	True	integer	要显示的矩形的右像素边缘。可以采用虚拟像素或物理像素，具体取决于输入“坐标是物理的”。
矩形上边缘屏幕像素 Y 坐标	RectangleTopPixelYCoord	True	integer	要显示的矩形的上像素边缘。可以采用虚拟像素或物理像素，具体取决于输入“坐标是物理的”。
矩形下边缘屏幕像素 Y 坐标	RectangleBottomPixelYCoord	True	integer	要显示的矩形的下像素边缘。可以采用虚拟像素或物理像素，具体取决于输入“坐标是物理的”。
笔颜色	PenColour		string	要绘制的矩形的颜色（例如红色、绿色、蓝色、黄色、紫色或橙色）或字符串十六进制代码（例如 #FF0000）。
笔粗像素	PenThicknessPixels		integer	突出显示矩形边框的粗细（以像素为单位）。
显示秒数	SecondsToDisplay		integer	显示矩形的秒数。
坐标是物理坐标	CoordinatesArePhysical		boolean	如果提供的坐标是物理屏幕坐标，则设置为 true。如果提供的坐标是虚拟的，则设置为 false。如果基础显示缩放为 100%，则物理坐标和虚拟坐标相同。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	DrawRectangleOnScreenResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

在文件上设置所有者

操作 ID:: SetOwnerOnFile

在运行 IA-Connect 代理的计算机上设置所有者。

参数

名称	密钥	必需	类型	说明
文件路径	FilePath	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
用户标识	UserIdentity	True	string	要分配所有权的用户的标识。这可以采用“username”、“DOMAIN\username”或“username@domainfqdn”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

坐标之间的中间鼠标拖动

操作 ID:: MiddleMouseDragBetweenCoordinates

在 IA-Connect 代理用户会话中的两个指定坐标之间执行中间鼠标按钮拖动。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。鼠标移动支持可选的抖动，使其更像是人手移动。

参数

名称	密钥	必需	类型	说明
开始 X 像素	StartXCoord	True	integer	起始 X 坐标值（以像素为单位）。
开始 Y 像素	StartYCoord	True	integer	起始 Y 坐标值（以像素为单位）。
结束 X 像素	EndXCoord	True	integer	结束 X 坐标值（以像素为单位）。
结束 Y 像素	EndYCoord	True	integer	结束 Y 坐标值（以像素为单位）。
步骤数	NumberOfSteps		integer	拖动作应分解到的步骤数。
总时间（以秒为单位）	TotalTimeInSeconds		double	拖动作应从头到尾执行的总时间。
最大移动像素抖动	MaximumMovementPixelJitter		integer	执行拖动作时的最大像素抖动。如果值为 1 或更高，则移动抖动。抖动在每一步之间平滑，以避免移动高峰。此输入的值控制抖动可以位于任何特定点的最大值，从而限制鼠标偏离路径的距离。值越高，拖动作显示的“平滑”就越少。每个点的抖动只能偏离以前的抖动值，方法是 -2 和 2（默认情况下），因此最大可能的抖动是 2 x NumberOfSteps，而不管你将最大值设置为什么。
最大结束像素抖动	MaximumEndPixelJitter		integer	拖动作末尾的最大像素抖动。值越高，到达结束坐标时拖动越精确。
最大移动像素抖动增量	MaximumMovementPixelJitterDelta		integer	如果使用鼠标移动抖动（最大移动像素抖动为 1 或更高），则每个点的抖动最大可能会偏离上一点。这用于确保抖动是平滑的。较大的值会导致平滑度降低。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

复制文件

操作 ID:: CopyFile

在运行 IA-Connect 代理的计算机上复制文件。

参数

名称	密钥	必需	类型	说明
源文件路径	SourceFilePath	True	string	源文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
目标文件路径	DestFilePath	True	string	文件应复制到的目标的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

将 Flow 标记为已完成

操作 ID:: WorkflowCompleted

将流标记为已完成，这会通知 IA-Connect Orchestrator 分配的工作器计算机现在可用于处理其他流。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

将 IA-Connect 代理 GUI 置于前面

操作 ID:: BringRSAGUIToFront

将 IA-Connect 代理 GUI 置于前面，使其在屏幕上可见。

参数

名称	密钥	必需	类型	说明
焦点	Focus		boolean	是否应将 IA-Connect 代理 GUI 重点？
全局鼠标左键单击	GlobalLeftMouseClick		boolean	是否应使用全局左鼠标单击将代理置于前面？这可以保证在作系统限制焦点方法阻止应用程序将自己置于前端的情况下引入前端事件。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

将密码存储在代理内存中

操作 ID:: StorePasswordInAgentMemory

将密码存储在代理内存（加密）中，可从支持存储密码的任何作中使用密码。密码仅存储在内存中，在关闭代理时会丢失。

参数

名称	密钥	必需	类型	说明
标识符	Identifier	True	string	密码的唯一标识符。如果标识符已在使用中，则会覆盖该标识符。例如：SAPGUILogon。使用短语 {IAConnectPassword：Identifier} 检索密码。
密码	Password	True	password	要存储的密码。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	StorePasswordInAgentMemoryResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

将文件从客户端复制到服务器

操作 ID:: CopyFileFromClientToServer

将文件从本地计算机（运行 IA-Connect 控制器）复制到远程计算机（运行 IA-Connect 代理）。

参数

名称	密钥	必需	类型	说明
客户端文件路径	ClientFilePath	True	string	从中复制文件的文件路径（在本地运行 IA-Connect 控制器的计算机上）。
服务器文件路径	ServerFilePath	True	string	要将文件复制到的文件路径（在运行 IA-Connect 代理的计算机上）。
压缩	Compress		boolean	复制时是否应压缩文件？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

将文件复制到剪贴板

操作 ID:: CopyFileToClipboard

将指定的本地文件复制到 IA-Connect 代理用户会话中的剪贴板。

参数

名称	密钥	必需	类型	说明
文件名	Filepath	True	string	要复制到剪贴板的本地文件的文件路径。
剪切	Cut		boolean	如果设置为 true，则将剪切文件而不是复制。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	CopyFileToClipboardResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

将文件夹添加到 ZIP

操作 ID:: AddFolderToZIP

文件夹中的 ZIP 文件将 ZIP 文件（将文件存储到压缩存档中）。

参数

名称	密钥	必需	类型	说明
要添加到 ZIP 的源文件夹	SourceFolderToAddToZIP	True	string	要添加到 zip 的文件夹的路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
输出 ZIP 文件路径	OutputZIPFilename	True	string	ZIP 应输出到的文件路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
在 ZIP 中将文件添加到文件夹中	AddFilesToFolderInZIP		string	如果要将源文件添加到 ZIP 文件中的文件夹，请在此处输入文件夹名称。
压缩	Compress		boolean	压缩时是否应压缩文件夹？
添加到现有 ZIP 文件	AddToExistingZIPFile		boolean	设置为 True 以添加到现有 ZIP 文件。
包括子文件夹	IncludeSubfolders		boolean	源文件夹中的子文件夹是否还应添加到 ZIP？
包含文件正则表达式	IncludeFilesRegEx		string	一个可选的正则表达式，用于指定应提取哪些文件。仅匹配文件名。
排除文件正则表达式	ExcludeFilesRegEx		string	一个可选的正则表达式，用于指定应从提取中排除哪些文件。仅匹配文件名。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
成功添加的文件数	FilesAddedSuccessfully	integer	已成功添加到 ZIP 的文件数。
排除的文件数	FilesExcluded	integer	排除的文件数（如果使用“排除文件正则表达式”输入）。

将文件添加到 ZIP

操作 ID:: AddFileToZIP

文件（将文件存储到压缩存档中）。

参数

名称	密钥	必需	类型	说明
要添加到 ZIP 的源文件路径	SourceFilenameToAddToZIP	True	string	要添加到 zip 的文件的文件路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
输出 ZIP 文件路径	OutputZIPFilename	True	string	ZIP 应输出到的文件路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
在 ZIP 中将文件名添加到文件夹	AddFilenameToFolderInZIP		string	如果要将源文件添加到 ZIP 文件中的文件夹，请在此处输入文件夹名称。
要添加到 ZIP 注释的源文件名	SourceFilenameToAddToZIPComment		string	添加到 ZIP 的此文件的可选注释。
压缩	Compress		boolean	压缩时是否应压缩文件？
添加到现有 ZIP 文件	AddToExistingZIPFile		boolean	设置为 True 以添加到现有 ZIP 文件。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

将消息发送到 Web API

操作 ID:: SendMessageToWebAPI

将消息发送到 Web API 并接收响应。这可与任何 Web API 一起使用，但常见用法是 REST API。 IA-Connect 支持从虚拟机（即访问本地资源）或通过 Citrix 或Microsoft远程桌面会话（例如，仅从隔离环境访问 API）将消息发送到 Web API。

参数

名称	密钥	必需	类型	说明
URL	URL		string	要向其发送消息的 API 的完整 URL。例如： https://myapi.remotesystem.com/path/action。
方法	Method		string	要使用的 HTTP 方法。这需要与远程 API 的预期匹配。
超时（秒）	TimeoutInSeconds		integer	等待响应的秒数。如果在收到 HTTP 响应之前达到超时，将引发异常。
内容类型	ContentType		string	消息正文中传输数据的内容类型（如果存在）。这必须与远程 API 的预期匹配。如果调用需要正文中 JSON 有效负载的 REST API，内容类型可能是应用程序/json;charset=utf-8。
接受	Accept		string	响应数据的可接受格式。这必须与远程 API 的预期匹配。如果调用返回 JSON 有效负载的 REST API，则接受值可能是应用程序/json。若要接受任何响应，请输入 /。
邮件正文	MessageBody		string	如果调用需要消息正文中的数据的 Web API（与 PUT、POST、PATCH 通用），请将正文的内容输入到此输入中。如果调用 REST API，则可能包含 JSON 数据。如果调用需要 JSON 数据的 REST API，但未发送任何数据，则可能需要输入 {} 此输入。默认情况下，使用 UTF-8 编码，但可以使用“编码”输入更改此编码。
传输编码	TransmitEncoding		string	传输的消息正文的编码（如果存在）。 UTF 编码用于传输 Unicode 数据。 BE 是 big-endian。
响应编码	ResponseEncoding		string	响应正文中响应数据的编码（如果存在）。响应编码很可能与传输编码匹配。 UTF 编码用于传输 Unicode 数据。 BE 是 big-endian。
缓冲区大小	BufferSize		integer	从输出流中读取的每个单独读取的大小。极不可能修改这一点。这不会限制响应的大小;它是块大小。
资产	Property		string
价值	Value		string
协商 TLS 1.0	NegotiateTLS10		boolean	如果使用 HTTPS 和 TLS 1.0 安全性，应与远程系统协商，则设置为 true。可以协商多个 TLS 安全级别，将使用客户端和远程系统之间的最高常见协商级别。警告：TLS 1.0 已弃用，因此不应启用，除非远程系统不支持更高级别（可能旧且可能未修补），并且你理解并接受安全风险。
协商 TLS 1.1	NegotiateTLS11		boolean	如果使用 HTTPS 和 TLS 1.1 安全性，则应与远程系统协商，则设置为 true。可以协商多个 TLS 安全级别，将使用客户端和远程系统之间的最高常见协商级别。警告：TLS 1.1 已弃用，因此不应启用，除非远程系统不支持更高级别（可能旧且可能未修补），并且你理解并接受安全风险。
协商 TLS 1.2	NegotiateTLS12		boolean	如果使用 HTTPS 和 TLS 1.2 安全性，则应与远程系统协商，则设置为 true。可以协商多个 TLS 安全级别，将使用客户端和远程系统之间的最高常见协商级别。 TLS 1.2 是建议的最低安全级别。
协商 TLS 1.3	NegotiateTLS13		boolean	如果使用 HTTPS 和 TLS 1.3 安全性，应与远程系统协商，则设置为 true。可以协商多个 TLS 安全级别，将使用客户端和远程系统之间的最高常见协商级别。 TLS 1.3 仅受 Windows 11 及更高版本以及 Server 2022 及更高版本支持。
保持活动状态	KeepAlive		boolean	如果应启用 keep-alive，则设置为 true。如果在短时间跨度内向同一终结点发出多个 API 请求（不到一分钟），这会重新使用 TCP 连接，从而提高性能。如果只想进行单个 API 调用，或者 API 调用之间的时间超过一分钟，则设置为 false。如果配置错误，则影响最小，因为它只会影响性能。
预期 100 继续	Expect100Continue		boolean	如果使用 POST 请求、发送大量数据并想要在发送数据之前确定服务器是否接受请求，则设置为 true。 False 在大多数情况下效果最佳，因为它减少了发送到服务器的数据包数，从而缩短了响应时间。
返回响应标头	ReturnResponseHeaders		boolean	如果希望 IA-Connect 代理在响应中返回从远程系统接收的 HTTP 标头，则设置为 true。响应采用 JSON 格式。仅当打算处理信息（例如返回的 Cookie）的响应标头时，才使用此功能，因为它会增加响应的大小。
以线程身份运行	RunAsThread		boolean	如果设置为 false，IA-Connect 代理将立即运行该作，并在作完成时返回结果，但如果作花费的时间超过辅助角色/RPA 命令超时，将失败。如果设置为 true，则 IA-Connect 代理将作为代理线程运行此作，并对其进行监视，直到它完成。这使作的运行时间超过辅助角色/RPA 命令超时时间。
等待线程	WaitForThread		boolean	仅当“作为线程运行”设置为 true 时使用。将此输入设置为 true 以等待代理线程完成;代理将等待“超时以秒为单位”指定的时间。设置为 false 以绕过等待;代理将继续在后台执行作，但也可用于下一个作。然后，可以使用作“等待代理线程成功完成”，等待代理线程完成，然后重新运行此作，并将输入“检索线程 ID 的输出数据”设置为代理线程 ID。
检索线程 ID 的输出数据	RetrieveOutputDataFromThreadId		integer	如果之前将“等待线程”设置为 false（这会导致代理在后台线程中执行等待），请提供代理线程 ID 以检索结果。此代理线程 ID 将由之前对此作的调用提供。否则，设置为 0（默认值）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
响应状态代码	ResponseStatusCode	integer	HTTP 响应代码。常见的成功响应为 200 （正常）、201 （已创建）、202 （已接受）。 3xx 响应代码是重定向消息。 4xx 响应代码是客户端错误消息（例如，如果请求出现问题）。 5xx 响应代码是服务器错误消息。 4xx 和 5xx 响应代码通常不会出现在此输出中，因为将改为引发异常。
响应消息	ResponseMessage	string	来自 HTTP 响应正文的响应消息的内容。
响应内容类型	ResponseContentType	string	响应正文的内容类型（如果有响应正文）以及是否提供了该类型。
响应标头 JSON	ResponseHeadersJSON	string	如果输入“返回响应标头”设置为 true，则此输出将包含 JSON 格式的 HTTP 响应标头。仅当打算处理信息（例如返回的 Cookie）的响应标头时，才使用此功能，因为它会增加响应的大小。
线程 ID	ThreadId	integer	如果已将“等待线程”设置为 false（这会导致代理在后台线程中执行等待），则此输出将保留代理线程 ID，该 ID 可用于监视作的进程，并在线程完成后检索结果。

将鼠标悬停在坐标处

操作 ID:: LeftHoldMouseAtCoordinate

将鼠标左键保留在 IA-Connect 代理用户会话中指定秒数的指定坐标处。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	Y 坐标值（以像素为单位）。
要保留的秒数	SecondsToHold	True	double	按住鼠标左键的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

将鼠标移动到坐标

操作 ID:: MoveMouseToCoordinate

将 IA-Connect 代理用户会话中的鼠标移动到指定的像素坐标。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	要将鼠标移动到的 X 坐标值（以像素为单位）。
Y 像素	YCoord	True	integer	将鼠标移动到的 Y 坐标值（以像素为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

展开密码字符串

操作 ID:: ExpandPasswordString

接受包含对 IA-Connect 存储密码的引用的输入字符串，并使用存储的密码所替换的引用返回该字符串。

参数

名称	密钥	必需	类型	说明
输入字符串	InputString		string	包含 IA-Connect 存储的密码标识符的输入字符串。例如：“欢迎使用新初学者，新帐户密码为 {IAConnectPassword：GeneratedPassword}”，其中“GeneratedPassword”是存储 IA-Connect 密码的名称。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
输出字符串	OutputString	string	包含输入字符串的输出字符串，其中包含由实际密码替换的密码标识符。例如：“欢迎使用新初学者，新帐户密码为 Fantastic12Monkeys！”。

展开环境变量

操作 ID:: ExpandEnvironmentVariable

在 IA-Connect 代理用户会话中展开包含环境变量（例如 %USERPROFILE% 或 %TEMP%）的字符串。

参数

名称	密钥	必需	类型	说明
输入字符串	InputString	True	string	包含环境变量的输入字符串。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
输出字符串	OutputString	string	扩展了任何环境变量的字符串。

延迟现有的 Orchestrator 自动化任务

操作 ID:: TasksDeferExistingTask

延迟队列中已有的现有 Orchestrator 任务。该任务将延迟到将来的指定时间。这通常用于重新延迟现有任务（即任务以前已延迟，现在需要再次延迟）。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要延迟的现有 Orchestrator 自动化任务的 ID（或再次延迟）。
延迟时间（以分钟为单位）	DeferralTimeInMinutes		integer	自动化任务应延迟多少分钟。
延迟存储的数据	DeferralStoredData		string	使用此任务存储的可选数据。当进程/流从延迟继续时，该进程/流将变为可用。这通常用于存储在进程/流期间计算的数据，需要在延迟后再次可用。你可以以任何格式存储数据，但 JSON 是常用的格式。
进程阶段	ProcessStage		string	延迟后自动化过程/流应继续的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。这将由延迟进程/流中的条件用于决定下一步执行的步骤。例如：如果希望进程/流在延迟后继续处于“Exchange”阶段，请输入值“Exchange”。
Priority	Priority		integer	设置此任务的优先级（1 为最高级别）。
将任务置于保留状态	TaskOnHold		boolean	如果将此值设置为 true，则任务将保持，因此不会在典型的任务工作流中进行处理，即使达到延迟日期也是如此。可以使用作“更改 Orchestrator 自动化任务状态”，稍后更改“保留”状态。

名称	路径	类型	说明
命令结果	TasksDeferExistingTaskResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

延迟现有的 Orchestrator 自动化任务作

操作 ID:: TasksDeferExistingTaskOperation

参数

名称	密钥	必需	类型	说明
操作 ID	OperationId	True	string	业务流程协调程序任务的作 ID（或再次延迟）。
延迟时间（以分钟为单位）	DeferralTimeInMinutes		integer	自动化任务应延迟多少分钟。
延迟存储的数据	DeferralStoredData		string	使用此任务存储的可选数据。当进程/流从延迟继续时，该进程/流将变为可用。这通常用于存储在进程/流期间计算的数据，需要在延迟后再次可用。你可以以任何格式存储数据，但 JSON 是常用的格式。
进程阶段	ProcessStage		string	延迟后自动化过程/流应继续的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。这将由延迟进程/流中的条件用于决定下一步执行的步骤。例如：如果希望进程/流在延迟后继续处于“Exchange”阶段，请输入值“Exchange”。
Priority	Priority		integer	设置此任务的优先级（1 为最高级别）。

名称	路径	类型	说明
命令结果	TasksDeferExistingTaskOperationResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

引发异常

操作 ID:: RaiseException

如果输入异常不为空，则引发具有指定消息的异常。这对于在流（HTTP 400）中触发异常消息非常有用，如果早期作出错，该消息将由错误处理阶段捕获。此异常不会记录在 IA-Connect Orchestrator 流运行统计信息中。

参数

名称	密钥	必需	类型	说明
输入异常	InputException		string	如果此输入异常不是空字符串，则会随提供的“异常消息”引发异常。如果此输入异常为空，此作将不执行任何作。
异常消息	ExceptionMessage		string	要引发的异常消息。

名称	路径	类型	说明
命令结果	RaiseExceptionResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

拍摄屏幕截图

操作 ID:: TakeScreenshot

获取 IA-Connect 代理用户会话的屏幕截图，并将其作为 Base64 编码字符串返回。

参数

名称	密钥	必需	类型	说明
全屏	Fullscreen		boolean	屏幕截图是否应包括整个屏幕？
左 X 像素	LeftXPixels		integer	如果未拍摄整个屏幕的屏幕截图，则屏幕截图应从中开始的 X 值（以像素为单位）。在单个显示器上，最左侧的 X 像素为 0。在多监视器显示器上，最左侧的 X 像素可能是负像素（具体取决于哪个显示器被标记为主显示器，以及相对于其他显示器的位置）。
前 Y 像素	TopYPixels		integer	如果未拍摄整个屏幕的屏幕截图，则从屏幕截图开始位置的 Y 值（以像素为单位）。在单个显示器上，最上面的 Y 像素为 0。在多监视器显示器上，最顶部的 Y 像素可能是负像素（具体取决于哪个显示器被标记为主要显示器，以及相对于其他显示器的位置）。
宽度像素	WidthPixels		integer	如果未获取整个屏幕的屏幕截图，则屏幕截图的宽度从起始位置开始。
高度像素	HeightPixels		integer	如果未获取整个屏幕的屏幕截图，则屏幕截图的高度从起始位置开始。
图像格式	ImageFormat		string	提供图像格式（PNG、JPG、BMP 或 GIF）。
使用显示设备	UseDisplayDevice		boolean	IA-Connect 代理是否应考虑显示设备信息？这将更好地使用 DPI 缩放，并为多个显示器提供支持。
引发错误异常	RaiseExceptionOnError		boolean	如果设置 true：如果屏幕截图失败（例如会话已锁定），IA-Connect 代理将引发异常。如果设置 false：如果屏幕截图失败，IA-Connect 将返回空白位图，并填充“屏幕截图成功”和“屏幕截图错误消息”输出。
隐藏代理	HideAgent		boolean	设置为 true 可自动隐藏代理（如果可见），以确保它不会掩盖屏幕截图。
使用物理坐标	UsePhysicalCoordinates		boolean	设置为 true 以指定提供的坐标是物理坐标（而不是 DPI 缩放，因此与显示器上的物理像素匹配）。设置为 false（默认值），以指定提供的坐标是虚拟的（DPI 缩放）。 UIA、Java 和 Web作通常使用虚拟坐标。
显示设备 ID	DisplayDeviceId		integer	仅当输入“使用显示设备”设置为 true 时，此输入才有效。设置为 0（默认值）以包括所有监视器。设置为 1 以仅包含主监视器。设置为 2 或更高版本，仅包含相关的辅助监视器。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
屏幕图像为 Base64	ScreenBitmapBase64	string	屏幕图像作为 Base64 编码字符串。可以使用提供的实用工具“Base64 到位图”进行查看。
屏幕截图成功	ScreenshotSuccessful	boolean	如果屏幕截图成功，则设置为 true。如果屏幕截图失败并且“出错时引发异常”设置为 false，则设置为 false。如果屏幕截图失败，并且“出错时引发异常”设置为 true，则会引发异常。
屏幕截图错误消息	ScreenshotErrorMessage	string	如果屏幕截图失败，并且“出错时引发异常”设置为 false，则此输出字段将保存错误消息。这是将“出错时引发异常”设置为 true 的替代方法，如果在执行屏幕截图时出错，将导致异常。

按名称终止 IA-Connect 会话

操作 ID:: KillIAConnectSessionByName

终止指定的 IA-Connect 控制器会话（如果存在）。这是将命令发送到 IA-Connect 代理的会话。该名称将从前面的“附加”作中已知。

参数

名称	密钥	必需	类型	说明
IA-Connect 会话名称	IAConnectSessionName	True	string	要终止的 IA-Connect 会话的名称。
成功时附加到第 1 层 IA-Connect 会话	AttachToTier1IAConnectSessionOnSuccess		boolean	如果会话已成功关闭，IA-Connect 连接到第 1 层 IA-Connect 会话（正在接收 SOAP 和/或 REST 消息的控制器 IA-Connect 控制器会话？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
IA-Connect 会话已终止	IAConnectSessionKilled	boolean	如果终止了具有指定名称的会话，则返回 true;否则返回 false。
附加的第 1 层 IA-Connect 会话名称	AttachedTier1IAConnectSessionName	string	连接到的第 1 层 IA-Connect 会话的名称。

按名称获取进程计数

操作 ID:: GetProcessCountByName

返回具有指定进程名称的 IA-Connect 代理用户会话中正在运行的进程计数。

参数

名称	密钥	必需	类型	说明
进程名	ProcessName	True	string	进程名称。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
进程数	NumberOfProcesses	integer	与所提供的进程名称匹配的进程数。

按名称附加到 IA-Connect 会话

操作 ID:: AttachToIAConnectSessionByName

按名称附加到指定的 IA-Connect 控制器会话。这是将命令发送到 IA-Connect 代理的会话。

参数

名称	密钥	必需	类型	说明
IA-Connect 会话名称	IAConnectSessionName	True	string	要连接到的 IA-Connect 会话的名称。
必须连接虚拟通道	VirtualChannelMustBeConnected		boolean	IA-Connect 控制器是否应在附加到会话时验证虚拟通道是否已连接？这可确保 IA-Connect 代理在指定的会话中运行。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

按索引附加到 IA-Connect 会话

操作 ID:: AttachToIAConnectSessionByIndex

按索引附加到指定的 IA-Connect 控制器会话（例如附加到第一个 Citrix ICA 会话）。这是将命令发送到 IA-Connect 代理的会话。

参数

名称	密钥	必需	类型	说明
搜索 IA-Connect 会话类型	SearchIAConnectSessionType		string	要搜索的会话类型，例如，任何类型的远程会话的“本地代理”、“Microsoft RDP”、“Citrix ICA”或“Remote”。留空以搜索任何会话类型。
搜索 IA-Connect 会话索引	SearchIAConnectSessionIndex		integer	要连接的会话的索引，例如第一个匹配会话类型的 1，第二个匹配会话类型的索引为 2。
等待时间（以秒为单位）	TimeToWaitInSeconds		integer	如果具有指定索引的会话不存在，应 IA-Connect 等待多长时间？
如果超时，引发异常	RaiseExceptionIfTimedout		boolean	如果新会话在超时期限过前未连接，IA-Connect 是否应引发异常？
必须连接虚拟通道	VirtualChannelMustBeConnected		boolean	IA-Connect 控制器是否应在附加到会话时验证虚拟通道是否已连接？这可确保 IA-Connect 代理在指定的会话中运行。
仅计算之前未看到的会话数	OnlyCountSessionsNotSeenBefore		boolean	如果设置为 true，则之前运行的“获取可用 IA-Connect 会话”作（或 IA-Connect 检查器查看会话）将不会在索引中计数。这仅允许对“new”会话进行计数（例如附加到第一个新的 Citrix 会话）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
附加 IA-Connect 会话名称	AttachedIAConnectSessionName	string	附加到 IA-Connect 会话的名称。
附加到会话	AttachedToSession	boolean	如果 IA-Connect 已附加到会话，则返回 true;否则返回 false。

按进程 ID 获取进程

操作 ID:: GetProcessByPID

返回具有指定进程 ID 的进程是否在 IA-Connect 代理用户会话中运行。进程 ID 是唯一的，因此只有一个进程可以匹配 ID。进程 ID 是动态的，对于应用程序的每次启动都是不同的。

参数

名称	密钥	必需	类型	说明
进程 ID	ProcessId	True	integer	要获取的进程的进程 ID。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
正在运行的进程	ProcessRunning	boolean	如果找到了具有提供的进程 ID 的进程，则返回 true。

摇摆鼠标

操作 ID:: WiggleMouse

按指定的坐标数来回移动鼠标。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。

参数

名称	密钥	必需	类型	说明
X 摇摆	XWiggle		integer	水平移动鼠标的像素数。
Y 摆动	YWiggle		integer	垂直移动鼠标的像素数。
摇摆延迟（以秒为单位）	WiggleDelayInSeconds		double	鼠标移动之间的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

文件是否存在

操作 ID:: FileExists

报告 true 或 false，以确定 IA-Connect 代理正在运行的计算机上是否存在文件。

参数

名称	密钥	必需	类型	说明
文件路径	Filename	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
文件存在	FileExists	boolean	如果文件存在，则返回 true;否则返回 false。

断开远程会话的连接

操作 ID:: DisconnectSession

如果 IA-Connect 代理在远程会话中运行，此作会断开远程会话的连接。这与注销不同，将远程会话保持处于断开连接状态。此作可用于以后要连接到远程会话的位置，然后从同一状态继续，而不是启动新会话。如果 IA-Connect 代理在本地运行，此作将锁定会话。

参数

名称	密钥	必需	类型	说明
等待的秒数	SecondsToWait		integer	在向作系统发出断开连接命令之前等待的时间，以便 IA-Connect 代理可以在失去联系人之前报告命令的完成情况（这仅在远程会话中发生）。
如果本地代理不断开连接	DoNotDisconnectIfLocalAgent		boolean	如果设置为 true 并且 IA-Connect 代理在本地会话（即直接在辅助角色上运行），则此作将被静默忽略。这很有用，因为断开本地代理的连接会锁定会话，因此在解锁会话之前限制 RPA 函数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

是否已启用屏幕阅读器

操作 ID:: IsScreenReaderEnabled

返回是否已在 IA-Connect 代理用户会话中启用屏幕阅读器。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已启用屏幕阅读器	ScreenReaderEnabled	boolean	如果已启用屏幕阅读器，则返回 true。

更改 Orchestrator 自动化任务状态

操作 ID:: TasksChangeTaskStatus

更改所选 Orchestrator 自动化任务状态或其他任务属性。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要修改的 Orchestrator 任务的 ID。
自动化任务新状态	AutomationTaskStatus		string	指定自动化任务的新任务状态，如果不想更改现有任务的状态，请留空。如果要延迟现有任务，请改用作“延迟现有 Orchestrator 自动化任务”。
将任务置于保留状态	TaskOnHold		boolean	指定任务的“保留”状态。只有新的或延迟的任务可以保持，因此，如果尝试保留任何其他任务状态，将引发异常。
擦除任务输入数据	EraseTaskInputData		boolean	如果将此值设置为 true，则会清除任何任务输入数据。这通常用于节省已完成或失败任务的存储空间，因为不再需要原始数据。
擦除延迟存储的数据	EraseDeferralStoredData		boolean	如果将此值设置为 true，则会擦除任何延迟存储的数据。这通常用于节省已完成或失败任务的存储空间，因为不再需要原始数据。
更新源系统	UpdateSourceSystem		boolean	如果将此值设置为 true 并且 Orchestrator 任务已链接到源系统（例如 ServiceNow），Orchestrator 将执行 Orchestrator 中源系统配置中指定的任何作（例如关闭票证）。
任务关闭原因	TaskClosureReason		string	为“已完成”或“失败”任务提供任务关闭原因，该任务将存储在任务中。此外，如果 Orchestrator 任务链接到源系统（例如 ServiceNow），则更改状态，并将“更新源系统”设置为 true，则原因也将传递给源系统（例如，作为 ServiceNow 工作说明）。只有已完成或失败的任务才能产生关闭原因，因此，如果尝试设置任何其他任务状态的关闭原因，将引发异常。

名称	路径	类型	说明
命令结果	TasksChangeTaskStatusResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

更新 Orchestrator Flow 统计信息结果

操作 ID:: UpdateOrchestratorFlowStatsResult

更新 IA-Connect Orchestrator 中当前辅助角色流的结果统计信息。这用于修改 IA-Connect Orchestrator 中流统计信息的最终结果，该结果通常用于报告目的。这仅适用于当前流（业务流程协调程序检测流运行 ID）。不能修改任何其他流的统计信息。

参数

名称	密钥	必需	类型	说明
流上次作成功	FlowLastActionSuccess		boolean	设置为 true 以指定 Orchestrator Flow 统计信息中的最后一个作是否成功。设置为 false 以指定 Orchestrator Flow 统计信息中的最后一个作是失败的。如果不想更新流上一个作状态（例如：如果只想更新最后一个作代码，请将此字段留空。
流上一作错误消息	FlowLastActionErrorMessage		string	如果指定 Flow 上一个作失败，请在此处提供错误消息。
流上一作代码	FlowLastActionCode		integer	要分配给流统计信息的可选代码。这通常用作错误代码（例如，区分系统和业务异常），但可用作成功代码。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	UpdateOrchestratorFlowStatsResultResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

替换 INI 文件中的变量数据

操作 ID:: ReplaceVariableDataInINIFile

更新 INI 文件中的单个变量。

参数

名称	密钥	必需	类型	说明
INI 文件路径	InputFilename	True	string	INI 文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
输出 INI 文件路径	OutputFilename		string	如果要将更新的 INI 文件写入备用文件，请在此处输入输出文件的完整路径。输入 INI 文件将未经修改 - 输出 INI 文件将保留更改。
INI 搜索部分	SearchSection		string	保留要更改的变量的节的可选名称。
INI 搜索变量名称	SearchVariable		string	要更新的变量的名称。
替换数据	ReplaceData		string	要更新变量的替换数据。
INI 文件编码	InputFilenameEncoding		string	提供 INI 文件编码（Unicode、UTF8、UTF7 或 ASCII），或指定编码值（例如西欧的 1252）。
如果输入文件不存在，请创建新文件	CreateNewFileIfNotExists		boolean	如果输入文件不存在，应创建一个新文件？
在等于之前写入空间	WriteSpaceBeforeEquals		boolean	是否应在等号（=）符号之前写入空格？
等于后的写入空间	WriteSpaceAfterEquals		boolean	是否应在等号（=）符号后写入空格？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

校准mouse_event

操作 ID:: CalibrateMouseEvent

通过按指定数量的像素移动鼠标，然后读取新鼠标位置来校准mouse_event方法。

参数

名称	密钥	必需	类型	说明
校准大小（以像素为单位）	CalibrationSizeInPixels		integer	鼠标将移动的像素数，以便校准。值越低，校准的准确性就越低。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
鼠标 X 乘数	MouseXMultiplier	double	鼠标 X 乘数值。值为 1.0 表示无乘数。
鼠标 Y 乘数	MouseYMultiplier	double	鼠标 Y 乘数值。值为 1.0 表示无乘数。

检索代理线程的状态

操作 ID:: GetAgentThreadStatus

检索代理线程的状态，并选择性地检索线程输出数据。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。

参数

名称	密钥	必需	类型	说明
线程 ID	ThreadId	True	integer	如果以前以线程身份运行代理作，请提供线程 ID 以检索线程的状态。此线程 ID 将作为之前作为线程运行的作的输出提供。
检索线程输出数据	RetrieveThreadOutputData		boolean	设置为 true 以检索 JSON 格式的线程输出数据。建议通过调用用于创建线程的相同作来检索线程输出数据，将输入“检索线程 ID 的输出数据”设置为线程 ID，但此选项允许直接检索线程输出数据，并且可以选择不删除数据。
在检索输出数据后删除线程	ClearOutputDataFromMemoryOnceRead		boolean	如果线程成功完成并且已检索输出数据（请参阅输入“检索线程输出数据”），请将此输入设置为 true，以在返回结果后删除该线程。这会删除线程输出数据和线程本身，因此无法再次查询线程。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
线程已启动	ThreadStarted	boolean	如此如果线程已启动。如果线程尚未启动，则为 False，这表明自线程立即启动以来出现了错误。
线程正在运行	ThreadRunning	boolean	如此如果线程当前正在运行。如果线程从未启动（极不可能），或者线程现已完成，则为 False。
线程已完成	ThreadCompleted	boolean	如此如果线程已完成。如果线程从未启动（极不可能），或者线程仍在运行，则为 False。
线程成功	ThreadSuccess	boolean	如此如果线程已成功完成。如果线程从未启动（极不可能），线程仍在运行，或者线程失败，则为 False。
线程运行时（以秒为单位）	ThreadRuntimeInSeconds	integer	线程正在运行的总秒数。
IA-Connect作名称	IAConnectActionName	string	作为线程运行的 IA-Connect 代理作的内部名称。
线程状态消息	ThreadStatusMessage	string	描述线程状态的文本字符串。此消息从 ThreadStarted、ThreadRunning、ThreadCompleted、ThreadSuccess 属性计算。此文本字符串与语言无关（不会更改以匹配区域设置）。
线程错误消息	ThreadErrorMessage	string	如果线程失败，则此输出包含错误消息。
线程输出数据 JSON	ThreadOutputJSON	string	如果“检索线程输出数据”设置为 true，则此输出将保留 JSON 格式的原始线程输出数据。

注销远程会话

操作 ID:: LogoffSession

注销运行 IA-Connect 代理的远程会话。

参数

名称	密钥	必需	类型	说明
等待的秒数	SecondsToWait		integer	向作系统发出注销命令后等待的时间，以便 IA-Connect 代理可以报告命令的完成情况。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

添加新的 Orchestrator 延迟任务

操作 ID:: TasksAddNewDeferral

将新的 Orchestrator 延迟任务添加到可从流监视的队列中。该任务将延迟到将来的指定时间。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。

参数

名称	密钥	必需	类型	说明
设置自动化名称	SetAutomationName		string	如果要将流名称用作任务名称，或选择“手动”，并在“自动化名称”字段中输入名称以使用该名称，请选择“自动”。
自动化名称	AutomationName		string	只有在“设置自动化名称”字段中选择了“手动”时，才会使用此方法。一个友好名称，用于帮助稍后标识任务或将其与特定流相关联。多个任务可以使用相同的自动化名称。
延迟时间（以分钟为单位）	DeferralTimeInMinutes		integer	自动化任务应延迟多少分钟。
任务输入数据	TaskInputData		string	用于在任务启动时可用的可选数据。你可以以任何格式存储数据，但 JSON 是常用的格式。
延迟存储的数据	DeferralStoredData		string	使用此任务存储的可选数据。当进程/流从延迟继续时，该进程/流将变为可用。这通常用于存储在进程/流期间计算的数据，需要在延迟后再次可用。你可以以任何格式存储数据，但 JSON 是常用的格式。
进程阶段	ProcessStage		string	延迟后自动化过程/流应继续的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。这将由延迟进程/流中的条件用于决定下一步执行的步骤。例如：如果希望进程/流在延迟后继续处于“Exchange”阶段，请输入值“Exchange”。
Priority	Priority		integer	设置此任务的优先级（1 为最高级别）。
将任务置于保留状态	TaskOnHold		boolean	指定任务的“保留”状态。 “获取下一个 Orchestrator 自动化任务”作不会检索设置为“保留”的任务，因此不会在典型的任务工作流中进行处理。
组织	Organisation		string	（可选）指定此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department		string	（可选）指定此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description		string	（可选）指定此任务的说明。通常用于搜索和筛选任务。
标记	Tags		string	要分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
任务 ID	TaskId	integer	创建的延迟任务的 ID。

添加新的 Orchestrator 延迟任务作

操作 ID:: TasksAddNewDeferralOperation

添加新的 Orchestrator 延迟任务，并接收作 ID。该任务将延迟到将来的指定时间。使用此作可暂时挂起任务的时间（例如，如果正在等待某些内容）。如果任务由外部轮询程序或 Orchestrator 触发器处理，则需要特定的任务名称。此作不同于“添加新业务流程协调程序延迟任务”（TasksAddNewDeferral），因为它使用不可模糊的作 ID 而不是可猜测的任务 ID 进行响应。

参数

名称	密钥	类型	说明
自动化名称	AutomationName	string	一个友好名称，用于帮助稍后标识任务或将其与特定流相关联。多个任务可以使用相同的自动化名称。
延迟时间（以分钟为单位）	DeferralTimeInMinutes	integer	自动化任务应延迟多少分钟。
任务输入数据	TaskInputData	string	用于在任务启动时可用的可选数据。你可以以任何格式存储数据，但 JSON 是常用的格式。
延迟存储的数据	DeferralStoredData	string	使用此任务存储的可选数据。当进程/流从延迟继续时，该进程/流将变为可用。这通常用于存储在进程/流期间计算的数据，需要在延迟后再次可用。你可以以任何格式存储数据，但 JSON 是常用的格式。
进程阶段	ProcessStage	string	自动化过程/流应启动的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。此过程/流中的条件将使用此条件来确定下一步要执行的步骤。例如：如果希望进程/流从“Exchange”阶段开始，请输入值“Exchange”。
Priority	Priority	integer	设置此自动化任务的优先级（1 为最高级别）。
组织	Organisation	string	（可选）指定此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department	string	（可选）指定此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description	string	（可选）指定此任务的说明。通常用于搜索和筛选任务。
标记	Tags	string	要分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。

名称	路径	类型	说明
操作 ID	OperationId	string	已创建的 Orchestrator 延迟任务的作 ID。此作 ID 可用于在以后检索任务。作 ID 是一个唯一的不可模糊字符串，限制了第三方猜测它们未创建的作的 ID 的能力。

添加新的 Orchestrator 自动化任务

操作 ID:: TasksAddNewTask

将新的 Orchestrator 自动化任务添加到可从流监视的队列中。任务可以立即运行，也可以延迟到以后运行。

参数

名称	密钥	必需	类型	说明
设置自动化名称	SetAutomationName		string	如果要将流名称用作任务名称，或选择“手动”，并在“自动化名称”字段中输入名称以使用该名称，请选择“自动”。
自动化名称	AutomationName		string	只有在“设置自动化名称”字段中选择了“手动”时，才会使用此方法。一个友好名称，用于帮助稍后标识任务或将其与特定流相关联。多个任务可以使用相同的自动化名称。如果任务由外部轮询程序或 Orchestrator 触发器处理，则需要特定的任务名称。
任务输入数据	TaskInputData		string	用于在任务启动时可用的可选数据。你可以以任何格式存储数据，但 JSON 是常用的格式。
进程阶段	ProcessStage		string	自动化过程/流应启动的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。此过程/流中的条件将使用此条件来确定下一步要执行的步骤。例如：如果希望进程/流从“Exchange”阶段开始，请输入值“Exchange”。
Priority	Priority		integer	设置此自动化任务的优先级（1 为最高级别）。
SLA（以分钟为单位）	SLA		integer	设置 SLA 所需的分钟数。如果没有 SLA，请设置为 0。默认情况下，接近 SLA 末尾的自动化任务将优先于其他任务。
将任务置于保留状态	TaskOnHold		boolean	指定任务的“保留”状态。 “获取下一个 Orchestrator 自动化任务”作不会检索设置为“保留”的任务，因此不会在典型的任务工作流中进行处理。
组织	Organisation		string	（可选）指定此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department		string	（可选）指定此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description		string	（可选）指定此任务的说明。通常用于搜索和筛选任务。
标记	Tags		string	要分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
任务 ID	TaskId	integer	创建的 Orchestrator 自动化任务的 ID。此任务 ID 可用于在以后检索任务。

添加新的 Orchestrator 自动化任务作

操作 ID:: TasksAddNewTaskOperation

添加新的 Orchestrator 自动化任务，并接收作 ID。如果任务由外部轮询程序或 Orchestrator 触发器处理，则需要特定的任务名称。此作不同于“添加新的 Orchestrator 自动化任务”（TasksAddNewTaskOperation），因为它使用不可模糊的作 ID 而不是可猜测的任务 ID 进行响应。

参数

名称	密钥	类型	说明
自动化名称	AutomationName	string	一个友好名称，用于帮助稍后标识任务或将其与特定流相关联。多个任务可以使用相同的自动化名称。
任务输入数据	TaskInputData	string	用于在任务启动时可用的可选数据。你可以以任何格式存储数据，但 JSON 是常用的格式。
进程阶段	ProcessStage	string	自动化过程/流应启动的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。此过程/流中的条件将使用此条件来确定下一步要执行的步骤。例如：如果希望进程/流从“Exchange”阶段开始，请输入值“Exchange”。
Priority	Priority	integer	设置此自动化任务的优先级（1 为最高级别）。
SLA（以分钟为单位）	SLA	integer	设置 SLA 所需的分钟数。如果没有 SLA，请设置为 0。默认情况下，接近 SLA 末尾的自动化任务将优先于其他任务。
组织	Organisation	string	（可选）指定此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department	string	（可选）指定此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description	string	（可选）指定此任务的说明。通常用于搜索和筛选任务。
标记	Tags	string	要分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。

名称	路径	类型	说明
操作 ID	OperationId	string	创建的 Orchestrator 自动化任务的作 ID。此作 ID 可用于在以后检索任务。作 ID 是一个唯一的不可模糊字符串，限制了第三方猜测它们未创建的作的 ID 的能力。

清除剪贴板

操作 ID:: ClearClipboard

清除 IA-Connect 代理用户会话中剪贴板的内容。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

清除目录

操作 ID:: PurgeDirectory

清除运行 IA-Connect 代理的计算机上的目录（文件夹），删除目录中存储的所有文件。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
递归的	Recursive		boolean	是否还应清除所有子文件夹？
删除顶级	DeleteTopLevel		boolean	是否还应删除顶级文件夹？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

生成密码

操作 ID:: GeneratePassword

生成一个密码，其中包含以模板格式定义的字典词、数字、符号、字符。

参数

名称	密钥	必需	类型	说明
密码格式	PasswordFormat	True	string	使用符号描述的生成的密码的格式。符号“w”表示字典单词，“u”表示大写字典单词，“n”表示数字，“s”表示符号，“l”表示小写字母，“L”表示大写字母，“z”表示无任何（在组合中使用）。例如，wnnwsl 可能会生成 Pluto35Marmite！b。大括号中后跟两个或多个符号的数字将创建该符号数的随机组合。例如，8（Lln）可能产品 6hP2AxP0 和 4（Lsz）可能会生成 S！-A （LssL 符号）或生成 J$ （Lszz 符号）。使用单引号中的字符 as-is。例如，w'--'w'_'nn 可能会生成 Jersey--Mountain_64。
最小长度	MinimumLength		integer	生成的密码的最小长度。如果生成的密码太短，则会添加额外的字典词，直到满足长度。如果没有最小长度要求，则设置为 0。
以纯文本形式返回	ReturnAsPlainText		boolean	设置为 true 以以纯文本形式返回密码。
将密码存储为标识符	StorePasswordAsIdentifier		string	如果提供了标识符，此密码将加密存储在 Orchestrator 或 Agent（请参阅“Generate at”）中，供任何可以使用存储凭据的命令稍后检索/使用。如果由代理生成，则这些密码仅存储在内存中，并在关闭代理时丢失。例如，可以使用 {IAConnectPassword：MyExchangePassword} 检索 MyExchangePassword。
支持的符号	SupportedSymbols		string	允许在符号“s”以生成的密码格式使用符号时随机使用符号列表。如果未指定，则使用内置列表。例如：！$（）*。
尝试唯一密码	AttemptUniquePasswords		boolean	设置为 true（默认值）的 Orchestrator 或 Agent（请参阅“Generate at”），以避免复制随机数序列，因此确保在特定会话中尽可能唯一生成的密码。如果由代理生成，这不能保证独立代理之间的唯一密码，或者代理是关闭或重启的，因此应始终使用复杂密码确保密码高度随机（例如：wnnws 比 wnw 更随机）。
生成位置	GenerateAt		string	指定哪个 IA-Connect 组件将生成密码。
最小小写	MinimumLowercase		integer	密码中必须存在的最小小写字符数。如果这是不可能的（例如，如果密码格式没有足够的 l、w 或 u 符号），将引发异常。设置为 0（无最小值）。
最小大写	MinimumUppercase		integer	密码中必须存在的最小大写字符数。如果这是不可能的（例如，如果密码格式没有足够的 L、w 或 u 符号），将引发异常。设置为 0（无最小值）。
最小数字	MinimumNumbers		integer	密码中必须存在的最小数字数。如果这是不可能的（例如，如果密码格式没有足够的 n 个符号），将引发异常。设置为 0（无最小值）。
最小符号	MinimumSymbols		integer	密码中必须存在的最小符号数。如果这是不可能的（例如，如果密码格式没有足够的符号），将引发异常。设置为 0（无最小值）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
纯文本密码	PlainTextPassword	string	如果请求，则为纯文本密码。密码可能以纯文本形式请求，因为密码是一次性密码，旨在通过短信或电子邮件传输（例如），因此需要看到 as-is。

目录可访问

操作 ID:: DirectoryIsAccessible

返回目录（文件夹）是否可访问，以及权限是否限制在 IA-Connect 代理的计算机上对其进行访问。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
可访问目录	DirectoryAccessible	boolean	如果目录可访问，则返回 true;否则返回 false。
未授权的目录访问	DirectoryAccessUnauthorised	boolean	如果目录不可访问，则返回 true，因为权限正在限制对它的访问，否则返回 false。

目录是否存在

操作 ID:: DirectoryExists

报告 true 或 false，以确定 IA-Connect 代理正在运行的计算机上是否存在目录（文件夹）。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
目录存在	DirectoryExists	boolean	如果目录（文件夹）存在，则返回 true;否则返回 false。

禁用下一跃点 IA-Connect

操作 ID:: DisableNextHop

禁用下一跃点，以便接收下一跃点的代理处理所有将来的命令（而不是转发到下一跃点代理）。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

移动文件

操作 ID:: MoveFile

在运行 IA-Connect 代理的计算机上移动文件。

参数

名称	密钥	必需	类型	说明
源文件路径	SourceFilePath	True	string	源文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
目标文件路径	DestFilePath	True	string	文件应移动到的目标的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

移动鼠标相对

操作 ID:: MoveMouseRelative

将鼠标移到 IA-Connect 代理用户会话中相对于其当前位置的指定像素数。当前处于活动状态的鼠标移动 API（mouse_event或 setcursorpos）用于移动鼠标。计算坐标时，将考虑 DPI 缩放和多个显示器。

参数

名称	密钥	必需	类型	说明
X 像素	XCoord	True	integer	从鼠标当前位置开始移动鼠标的 X 像素数。
Y 像素	YCoord	True	integer	要移动鼠标的 Y 像素数，从当前位置开始。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

等待 IA-Connect 下一跃点会话进行连接

操作 ID:: WaitForNextHopSessionToConnect

等待下一跃点会话进行连接，并等待 IA-Connect 代理在下一跃点会话中运行。

参数

名称	密钥	必需	类型	说明
下一跃点控制器地址	NextHopDirectorAddress		string	如果“下一跃点地址为 localhost”、“下一跃点控制器地址为主机名”、“下一跃点控制器地址为 FQDN”或“下一跃点控制器地址已命名管道”参数均设置为 true，则下一跃点 IA-Connect 控制器地址的可选地址转发命令。
下一跃点控制器 TCP 端口	NextHopDirectorTCPPort		integer	下一跃点控制器正在侦听的 TCP 端口（代理正在运行的计算机上的控制器）。
下一跃点控制器使用 HTTPS	NextHopDirectorUsesHTTPS		boolean	如果下一跃点控制器使用 HTTPS，则设置为 True;否则设置为 false。
下一跃点控制器地址为 localhost	NextHopDirectorAddressIsLocalhostname		boolean	下一跃点控制器地址（相对于代理）是“localhost”。
下一跃点控制器地址为主机名	NextHopDirectorAddressIsHostname		boolean	下一跃点控制器地址是运行代理的计算机的主机名（即运行代理的计算机和控制器）。
下一跃点控制器地址为 FQDN	NextHopDirectorAddressIsFQDN		boolean	下一跃点控制器地址是运行代理的计算机（即运行代理和控制器）的完全限定域名（FQDN）。
按会话 ID 递增下一跃点控制器 TCP 端口	IncrementNextHopDirectorTCPPortBySessionId		boolean	若要确保下一跃点控制器 TCP 端口是唯一的（如果有多个并行会话使用同一主机中的下一跃点），可将会话 ID 添加到下一跃点控制器 TCP 端口。
等待的时间（以秒为单位）	SecondsToWait		double	等待下一跃点会话连接的最大秒数。
下一跃点控制器地址命名为管道	NextHopDirectorAddressIsNamedPipe		boolean	下一跃点控制器地址（相对于代理）使用命名管道而不是 TCP/IP Web 服务。这是避免在第一跃点上使用 TCP/IP 端口的默认值。
禁用现有下一跃点	DisableExistingNextHop		boolean	在再次启用之前，是否应禁用双跃点（如果当前处于活动状态？如果设置为 true（默认值），则任何新的双跃点启用指令都将替换前面的指令。如果设置为 false，则会启用三跃点，因为双跃点 IA-Connect 代理将收到指令。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已连接的下一跃点会话	NextHopSessionConnected	boolean	如果超过等待的最长时间之前连接的下一跃点会话，则返回 true。

等待 IA-Connect 会话按名称关闭

操作 ID:: WaitForIAConnectSessionToCloseByName

等待指定的 IA-Connect 控制器会话关闭。这是将命令发送到 IA-Connect 代理的会话。该名称将从前面的“附加”作中已知。

参数

名称	密钥	必需	类型	说明
IA-Connect 会话名称	IAConnectSessionName	True	string	要检查的 IA-Connect 会话的名称。
等待时间（以秒为单位）	TimeToWaitInSeconds		integer	如果没有指定类型的会话（如果指定了特定类型），应 IA-Connect 等待多长时间？
如果超时，引发异常	RaiseExceptionIfTimedout		boolean	如果新会话在超时期限过前未连接，IA-Connect 是否应引发异常？
成功时附加到第 1 层 IA-Connect 会话	AttachToTier1IAConnectSessionOnSuccess		boolean	如果会话已成功关闭，IA-Connect 连接到第 1 层 IA-Connect 会话（正在接收 SOAP 和/或 REST 消息的控制器 IA-Connect 控制器会话？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
IA-Connect 会话已关闭	IAConnectSessionClosed	boolean	如果具有指定名称的会话已关闭，则返回 true;否则返回 false。
附加的第 1 层 IA-Connect 会话名称	AttachedTier1IAConnectSessionName	string	连接到的第 1 层 IA-Connect 会话的名称。

等待代理线程成功完成

操作 ID:: WaitForAgentThreadToCompleteSuccessfully

等待代理线程完成并选择性地检索线程输出数据。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。如果代理线程完成，但在失败中，将引发异常。

参数

名称	密钥	必需	类型	说明
线程 ID	ThreadId	True	integer	如果以前以线程身份运行代理作，请提供线程 ID 以检索线程的状态。此线程 ID 将作为之前作为线程运行的作的输出提供。
等待线程的秒数	SecondsToWaitForThread	True	integer	等待线程完成的秒数。如果线程在此期间尚未完成，将引发异常（除非“如果线程未完成引发异常”设置为 false）。
检索线程输出数据	RetrieveThreadOutputData		boolean	设置为 true 以检索 JSON 格式的线程输出数据。建议通过调用用于创建线程的相同作来检索线程输出数据，将输入“检索线程 ID 的输出数据”设置为线程 ID，但此选项允许直接检索线程输出数据，并且可以选择不删除数据。
在检索输出数据后删除线程	ClearOutputDataFromMemoryOnceRead		boolean	如果线程成功完成并且已检索输出数据（请参阅输入“检索线程输出数据”），请将此输入设置为 true，以在返回结果后删除该线程。这会删除线程输出数据和线程本身，因此无法再次查询线程。
如果线程未完成，引发异常	RaiseExceptionIfThreadNotCompleted		boolean	如果设置为 true 且线程未在指定时间内完成，则会引发异常。如果设置为 false，此作将等待请求的时间（使线程完成），并报告线程状态（请参阅输出“线程正在运行”等）。如果线程完成，但失败，将始终引发异常。
如果线程错误，引发异常	RaiseExceptionIfThreadError		boolean	如果设置为 true（默认行为），并且线程有错误条件（线程已完成但未成功），则会引发异常，并将删除该线程。如果设置为 false，则错误将存储在输出“线程错误消息”中，并且不会删除线程（在适当时应使用作“删除代理线程”删除线程）。
等待每个调用的秒数	SecondsToWaitPerCall		integer	“等待线程的秒数”将细分为较小的时间切片，以避免超时。此可选输入允许指定较小的时间切片的大小。不要设置为大于 80% RPA 超时的值，否则可能会收到超时错误。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
线程已启动	ThreadStarted	boolean	如此如果线程已启动。如果线程尚未启动，则为 False，这表明自线程立即启动以来出现了错误。仅当“如果线程未完成时引发异常”设置为 false，否则如果线程未在指定的等待时间中完成，将引发异常。
线程正在运行	ThreadRunning	boolean	如此如果线程当前正在运行。如果线程从未启动（极不可能），或者线程现已完成，则为 False。仅当“如果线程未完成时引发异常”设置为 false，否则如果线程未在指定的等待时间中完成，将引发异常。
线程已完成	ThreadCompleted	boolean	如此如果线程已完成。如果线程从未启动（极不可能），或者线程仍在运行，则为 False。仅当“如果线程未完成时引发异常”设置为 false，否则如果线程未在指定的等待时间中完成，将引发异常。
线程成功	ThreadSuccess	boolean	如此如果线程已成功完成。如果线程从未启动（极不可能），线程仍在运行，或者线程失败，则为 False。仅当“如果线程未完成时引发异常”设置为 false，否则如果线程未在指定的等待时间中完成，将引发异常。
线程运行时（以秒为单位）	ThreadRuntimeInSeconds	integer	线程正在运行的总秒数。
IA-Connect作名称	IAConnectActionName	string	作为线程运行的 IA-Connect 代理作的内部名称。
线程状态消息	ThreadStatusMessage	string	描述线程状态的文本字符串。此消息从 ThreadStarted、ThreadRunning、ThreadCompleted、ThreadSuccess 属性计算。此文本字符串与语言无关（不会更改以匹配区域设置）。
线程错误消息	ThreadErrorMessage	string	如果线程失败，则此输出包含错误消息。仅当“如果线程错误时引发异常”设置为 false，否则如果线程出错，将引发异常。
线程输出数据 JSON	ThreadOutputJSON	string	如果“检索线程输出数据”设置为 true，则此输出将保留 JSON 格式的原始线程输出数据。

终止代理线程

操作 ID:: KillAgentThread

终止代理线程（终止、中止）。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。代理线程不会被删除（使用作“删除代理线程”删除线程删除线程）允许监视代理线程的任何进程或流接收“IA-Connect 代理线程已中止”错误。

参数

名称	密钥	必需	类型	说明
线程 ID	ThreadId	True	integer	如果以前以线程身份运行代理作，请提供线程 ID 以终止线程（永久停止线程运行）。此线程 ID 将作为之前作为线程运行的作的输出提供。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	KillAgentThreadResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

终止所有其他 IA-Connect 代理

操作 ID:: KillAllOtherAgents

终止当前在用户会话中运行的 IA-Connect 代理的任何其他实例。这将确保仅运行 IA-Connect 代理的一个实例。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已终止的代理数	NumberOfAgentsKilled	integer	已终止的 IA-Connect 代理进程数。
代理数未能终止	NumberOfAgentsFailedToKill	integer	未能终止的 IA-Connect 代理进程数。

终止进程

操作 ID:: KillProcess

终止具有指定进程名称的 IA-Connect 代理用户会话中的任何正在运行的进程。

参数

名称	密钥	必需	类型	说明
进程名	ProcessName	True	string	要终止的过程。例如记事本。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
终止的进程数	NumberOfProcessesKilled	integer	已终止的进程数。

终止进程 ID

操作 ID:: KillProcessID

在具有指定进程 ID 的 IA-Connect 代理用户会话中终止正在运行的进程。进程 ID 是唯一的，因此只有一个进程可以匹配 ID。进程 ID 是动态的，并且每次启动应用程序时都有所不同。

参数

名称	密钥	必需	类型	说明
进程ID	ProcessID	True	integer	要终止的进程的进程 ID。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
终止的进程数	NumberOfProcessesKilled	integer	已终止的进程数。

翻转鼠标滚轮

操作 ID:: TurnMouseWheel

在 IA-Connect 代理用户会话中打开鼠标滚轮（正或负向）。

参数

名称	密钥	必需	类型	说明
轮轮旋转	WheelTurns	True	integer	要执行的轮次数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

获取 CSV 文本作为集合

操作 ID:: GetCSVTextAsCollection

返回 IA-Connect 代理作为集合（表）运行的计算机上的 CSV 文件。只需要对 CSV 文件具有只读访问权限。

参数

名称	密钥	必需	类型	说明
CSV 文件路径	CSVFilePath	True	string	CSV 文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
第一行是标头	FirstLineIsHeader		boolean	CSV 文件中的第一行是标题行吗？
剪裁标头	TrimHeaders		boolean	是否应剪裁标头以删除任何前导或尾随空格？
允许空白行	AllowBlankRows		boolean	如果设置为 true（默认值），则允许 CSV 数据中的完全空白行，并将作为空行返回。如果设置为 false，则返回的数据中将删除完全空白的行（文件将保持不变）。
根据需要扩展列	ExtendColumnsIfRequired		boolean	如果设置为 true，并且如果数据中有单元格没有匹配的列标题（即包含多于标题行的行），则会自动创建名称为Column_N的列标题（其中 N 是列索引）。如果设置为 false（默认值），则如果行包含没有匹配列的数据，则会出现异常。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
CSV 数据 JSON	CSVDataJSON	string	CSV 文件的内容，采用 JSON 格式。

获取 IA-Connect 代理会话信息

操作 ID:: GetRemoteSessionInfo

返回有关 IA-Connect 代理用户会话的信息。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
会话 ID	SessionId	integer	当前远程用户会话 ID。
会话类型	SessionType	integer	远程会话的类型（1（Citrix）、2（RDP）或 0（控制台）。
会话类型名称	SessionTypeName	string	远程会话的类型，即 ICA （Citrix）、RDP 或控制台。

获取 IA-Connect 代理信息

操作 ID:: GetIAConnectAgentInfo

返回 IA-Connect 代理的属性，包括版本号和代理可执行文件的路径。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
IA-Connect 代理版本	IAConnectAgentVersion	string	IA-Connect 代理的完整版本号。
DotNet CLR 版本	DotNetCLRVersion	string	DotNet 公共语言运行时（CLR）版本。
IA-Connect 代理以用户名身份运行	IAConnectAgentRunAsUsername	string	运行 IA-Connect 代理的用户会话的用户名。
IA-Connect 代理以 userdomain 身份运行	IAConnectAgentRunAsUserdomain	string	运行 IA-Connect 代理的用户会话的用户域。
IA-Connect 代理路径	IAConnectAgentPath	string	IA-Connect 代理可执行文件的完整路径。
IA-Connect 代理是 64 位进程	IAConnectAgentIs64bitProcess	boolean	如果 IA-Connect 代理是 64 位进程，则返回 true;否则返回 false。
IA-Connect 代理版本	IAConnectAgentReleaseVersion	string	IA-Connect 代理版本，例如 8.0。
IA-Connect 代理 RPA 命令超时	IAConnectAgentRPACommandTimeout	integer	IA-Connect 代理 RPA 命令超时。这默认为 30 秒，可以使用“设置 IA-Connect 代理命令超时”作进行设置。
IA-Connect 代理日志文件名	IAConnectAgentLogFilename	string	IA-Connect 代理日志文件名。此值对于 IA-Connect 代理的每个启动都是唯一的，因为它具有文件名中的启动日期和时间。

获取 IA-Connect 代理全局坐标配置

操作 ID:: GetAgentGlobalCoordinateConfiguration

检索 IA-Connect 代理全局坐标系配置的配置，该配置用于显示元素位置（例如：在鼠标检查期间）和计算鼠标位置（例如：执行全局鼠标作时）。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
多监视器功能	MultiMonitorFunctionality	string	如果 IA-Connect 代理当前配置为仅支持突出显示元素并在主显示设备上执行全局鼠标作，则返回“PrimaryMonitor”。如果 IA-Connect 代理将突出显示所有监视器上的元素（默认值自 IA-Connect 9.4 起），则返回“MultiMonitor”。
自动设置鼠标检查乘数	AutoSetMouseInspectionMultiplier	boolean	如果 IA-Connect 代理在代理启动时自动计算主显示设备上的鼠标检查乘数，并且每次执行鼠标检查（自 IA-Connect 9.4 以来的默认值）。则返回 true。如果 IA-Connect 代理要求手动设置鼠标检查乘数（IA-Connect 9.3 及更早版本中的唯一可用选项），则返回 false。此选项仅在禁用多监视器模式时产生任何影响。
自动设置全局鼠标乘数	AutoSetGlobalMouseMultiplier	boolean	如果 IA-Connect 代理在代理启动时自动计算主显示设备上的全局鼠标移动乘数，并且每次执行鼠标检查时（自 IA-Connect 9.4 以来的默认值），则返回 true。如果 IA-Connect 代理要求手动设置全局鼠标移动乘数（IA-Connect 9.3 及更早版本中的唯一可用选项），则返回 false。此选项仅在禁用多监视器模式时产生任何影响。
鼠标检查 X 乘数	MouseInspectionXMultiplier	double	当前水平（X）鼠标检查乘数（当代理突出显示鼠标下的内容时）。例如：如果 IA-Connect 在实际鼠标 X 位置的一半处显示检查矩形，则此值将为 0.5。乘数仅在禁用“多重监视器功能”时产生任何影响，因为当将 IA-Connect 代理配置为多监视器感知时动态计算乘数。
鼠标检查 Y 乘数	MouseInspectionYMultiplier	double	当前垂直（Y）鼠标检查乘数（当代理突出显示鼠标下的内容时）。例如：如果 IA-Connect 在实际鼠标 Y 位置的一半显示检查矩形，则此值将为 0.5。乘数仅在禁用“多重监视器功能”时产生任何影响，因为当将 IA-Connect 代理配置为多监视器感知时动态计算乘数。
全局鼠标 X 乘数	GlobalMouseXMultiplier	double	当前水平（X）全局鼠标移动乘数（当代理移动鼠标时）。乘数仅在禁用“多重监视器功能”时产生任何影响，因为当将 IA-Connect 代理配置为多监视器感知时动态计算乘数。
全局鼠标 Y 乘数	GlobalMouseYMultiplier	double	当前垂直（Y）全局鼠标移动乘数（当代理移动鼠标时）。乘数仅在禁用“多重监视器功能”时产生任何影响，因为当将 IA-Connect 代理配置为多监视器感知时动态计算乘数。
全局鼠标移动方法	GlobalMouseMoveMethod	string	返回当前全局鼠标移动方法（mouse_event或 setcursorpos）。
Java 坐标系	JavaCoordinateSystem	string	返回当前 Java 坐标系，可以是“虚拟”（默认值）或“物理”（IA-Connect 9.4 中的新增）。虚拟坐标是 DPI 缩放的，而物理坐标直接映射到像素。此值应设置为 Java 访问桥呈现的任何坐标系。
SAP GUI 坐标系	SAPGUICoordinateSystem	string	返回当前的 SAP GUI 脚本 API 坐标系，可以是“虚拟”（默认值）或“物理”（IA-Connect 9.4 中的新增功能）。虚拟坐标是 DPI 缩放的，而物理坐标直接映射到像素。此值应设置为 SAP GUI 脚本 API 呈现的任何坐标系。

获取 IA-Connect 代理当前许可证状态

操作 ID:: GetLicenseState

返回 IA-Connect 代理当前是否获得许可，如果已获得许可，则返回许可证的属性。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已获得许可	IsLicensed	boolean	如果 IA-Connect 代理当前已获得许可，则返回 true;否则返回 false。
许可证类型	LicenseType	string	正在使用的 IA-Connect 许可证的类型。
代理域名	CustomerNETBIOSDomainName	string	运行 IA-Connect 代理的计算机的 NetBIOS 域名（如果通过域名（IA-Connect 7.0 或 7.1）授权）。
控制器主机名	DirectorHostnameCSV	string	IA-Connect 控制器可以安装的计算机的主机名（如果主机名许可（IA-Connect 7.2 后）。
客户显示名称	CustomerDisplayName	string	要显示在 IA-Connect 代理的标题栏中的客户名称。
供应商名称	VendorName	string	IA-Connect 供应商名称。
许可证到期日期	LicenseExpiryDate	string	IA-Connect 许可证的到期日期。
许可证过期前的天数	DaysUntilLicenseExpires	integer	IA-Connect 许可证过期之前的剩余天数。
许可证功能	LicenseFeatures	string	其他许可证功能，通常提供对其他功能的访问权限。
是 JML 许可证	IsJMLLicense	boolean	此许可证是否提供对 JML 功能的访问权限。

获取 IA-Connect 代理日志

操作 ID:: GetIAConnectAgentLog

以文件或读取内容并在输出变量中返回当前 IA-Connect 代理日志。

参数

名称	密钥	必需	类型	说明
压缩	Compress		boolean	IA-Connect 代理可执行文件是否应在上传过程中进行压缩？
仅返回最后一个命令日志	ReturnLastCommandOnly		boolean	IA-Connect 代理日志是否应限制为最后一个命令的结果，而不是整个日志？
将日志保存到文件	SaveLogToFile		boolean	是否应将 IA-Connect 代理日志另存为文件？
在数据项中放置日志内容	PlaceLogContentInDataItem		boolean	日志的内容是否应在输出变量中返回？
本地保存文件夹	LocalSaveFolder		string	要保存 IA-Connect 代理登录的文件夹的文件路径。
使用代理日志文件名	UseAgentLogFilename		boolean	是否应为日志文件指定与代理上日志文件的名称相同的名称？如果设置为 false，则可以将“本地保存文件名”设置为指定文件名。
本地保存文件名	LocalSaveFilename		string	IA-Connect 代理日志的本地保存文件的文件名。仅当“使用代理日志文件名”设置为 false 时，才会使用此名称。
要读取的最大字节数	MaxBytesToRead		integer	从代理日志读取的最大字节数（从结尾向后）。这可以设置为 0 或 -1 以检索整个日志。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
代理日志内容	IAConnectAgentLogContentsBase64	string	IA-Connect 代理日志的内容。
本地保存的日志文件名	IAConnectAgentLogFilenameOnly	string	保存的日志文件名的路径。

获取 IA-Connect 代理日志级别

操作 ID:: GetRemoteLoggingLevel

返回当前 IA-Connect 代理日志记录级别。日志记录级别从 1 设置为 4,1 为最低级别，4 为最高级别。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
日志级别	LoggingLevel	integer	IA-Connect 代理的当前日志记录级别。
IA-Connect 代理日志文件名	IAConnectAgentLogFilename	string	IA-Connect 代理日志文件名。此值对于 IA-Connect 代理的每个启动都是唯一的，因为它具有文件名中的启动日期和时间。

获取 IA-Connect 代理进程计数

操作 ID:: GetAgentProcessCount

返回当前在用户会话中运行的 IA-Connect 代理的实例数。这对于检测是否存在正在运行的 IA-Connect 代理的多个实例非常有用。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
进程数	NumberOfProcesses	integer	当前在用户会话中运行的 IA-Connect 代理进程数。

获取 IA-Connect 控制器信息

操作 ID:: GetIAConnectDirectorInfo

返回 IA-Connect 控制器的属性，包括版本号和控制器可执行文件的路径。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
IA-Connect 控制器版本	IAConnectDirectorVersion	string	IA-Connect 控制器的完整版本号。
DotNet CLR 版本	DotNetCLRVersion	string	DotNet 公共语言运行时（CLR）版本。
IA-Connect 控制器以用户名身份运行	IAConnectDirectorRunAsUsername	string	运行 IA-Connect 控制器的用户会话的用户名。
IA-Connect 控制器以 userdomain 身份运行	IAConnectDirectorRunAsUserdomain	string	运行 IA-Connect 控制器的用户会话的用户域。
IA-Connect 控制器路径	IAConnectDirectorPath	string	IA-Connect Director 可执行文件的完整路径。
IA-Connect 控制器是 64 位进程	IAConnectDirectorIs64bitProcess	boolean	如果 IA-Connect 控制器是 64 位进程，则返回 true;否则返回 false。
IA-Connect 控制器版本	IAConnectDirectorReleaseVersion	string	IA-Connect Director 版本，例如 8.0。
IA-Connect 控制器日志文件名	IAConnectDirectorLogFilename	string	IA-Connect 控制器日志文件名。此值对于 IA-Connect 控制器的每个启动都是唯一的，因为它具有文件名中的启动日期和时间。

获取 IA-Connect 控制器日志级别

操作 ID:: GetLocalLoggingLevel

返回当前 IA-Connect 控制器日志记录级别。日志记录级别从 0 设置为 4。 0 已禁用。 1 是最低日志级别（默认值）。 4 是最高的日志级别。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
日志级别	LoggingLevel	integer	IA-Connect 控制器的当前日志记录级别。
IA-Connect 控制器日志文件名	IAConnectDirectorLogFilename	string	IA-Connect 控制器日志文件名。此值对于每个启动都是唯一的，因为它的文件名中具有启动日期和时间。

获取 IA-Connect 控制器运行时间

操作 ID:: GetDirectorUpTime

以秒为单位返回此 IA-Connect 控制器的运行时间（即控制器运行的时间）。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
控制器运行时间（以秒为单位）	UpTimeInSeconds	integer	IA-Connect Director 正在运行的秒数。

获取 Orchestrator 状态

操作 ID:: OrchestratorGetStatus

检索基本业务流程协调程序状态。这可用于确认 Orchestrator 是否可用并做出响应。

名称	路径	类型	说明
Orchestrator 版本	OrchestratorVersion	string	Orchestrator 软件版本。
Orchestrator 启动错误	NumberOfStartupErrors	integer	Orchestrator 启动错误数。
业务流程协调程序运行时间（以秒为单位）	UptimeInSeconds	integer	Orchestrator 正在运行的秒数。

获取 Orchestrator 自动化任务

操作 ID:: TasksGetTask

检索特定的 Orchestrator 自动化任务。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要检索的 Orchestrator 任务的 ID。
将状态更改为	StatusChange		string	如果设置为“已检索”：检索任务时，任务状态将更改为“已检索”，以防止其他作尝试运行同一任务。如果设置为“不执行任何作”，则不会更改任务状态。

名称	路径	类型	说明
自动化名称	AutomationName	string	检索到的 Orchestrator 任务的名称。
操作 ID	OperationId	string	检索到的 Orchestrator 任务的作 ID。此作 ID（或任务 ID）可用于在以后检索任务。作 ID 是一个唯一的不可模糊字符串，限制了第三方猜测它们未创建的作的 ID 的能力。
延迟日期和时间	DeferralDateTime	string	已检索的业务流程协调程序任务的日期和时间计划准备就绪。这将以 UTC 格式返回为字符串。
延迟存储的数据	DeferralStoredData	string	任务延迟时存储的可选数据。这通常是需要继续处理/流的数据。
延迟计数	DeferralCount	integer	此任务延迟的频率。对于从未延迟或 1 个或多个延迟任务的新任务，这通常为 0。每次再次延迟任务时，Orchestrator 都会自动增加此数字。
任务输入数据	TaskInputData	string	创建任务时存储的可选数据。这通常是用于启动进程/流的数据，但你可以将此字段用于任何目的。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。
任务输出数据	TaskOutputData	string	由自动化在处理任务时存储的可选数据。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。
Priority	Priority	integer	此 Orchestrator 任务的优先级（1 为最高级别）。
自动化任务状态	AutomationTaskStatus	string	检索到的 Orchestrator 任务的状态。
进程阶段	ProcessStage	string	延迟后自动化过程/流应继续的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。这将由延迟进程/流中的条件用于决定下一步执行的步骤。例如：如果希望进程/流在延迟后继续处于“Exchange”阶段，请输入值“Exchange”。
收到的日期和时间	ReceivedDateTime	string	任务最初由 Orchestrator 接收的日期和时间。这将以 UTC 格式返回为字符串。
延迟日期之前的分钟数	MinutesUntilDeferralDate	integer	此任务的延迟日期前的分钟数（即此任务准备好运行的时间）。如果此任务已准备好运行，则分钟数将为 0。
暂停	OnHold	boolean	如果任务处于保留状态，则设置为 true。保留任务永远不会由“获取下一个 Orchestrator 自动化任务”作检索，因此不会在典型的任务工作流中进行处理。
源类型名称	SourceTypeName	string	任务源的名称。 “Web UI”表示通过 UI 手动输入的任务。 “REST API”表示通过 Orchestrator 的 REST API 创建的任务。 “ServiceNow”表示从 Orchestrator 的内部“源”ServiceNow 集成创建的任务。
源友好名称	SourceFriendlyName	string	如果任务是从 Orchestrator 内部“源”集成（例如 ServiceNow）创建的，则此任务保留该源的友好名称。
源票证 ID	SourceTicketId	string	如果任务是从业务流程协调程序内部“源”集成（例如 ServiceNow）创建的，则此任务包含源票证的 ID。对于 ServiceNow，这将保留目录任务sys_id。
源票证子 ID	SourceTicketSubId	string	如果任务是从业务流程协调程序内部“源”集成（例如 ServiceNow）创建的，则此任务包含源票证的 ID。对于 ServiceNow，这将保留请求项sys_id。
组织	Organisation	string	此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department	string	此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description	string	此任务的说明。通常用于搜索和筛选任务。
标记	Tags	string	分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。

获取 Orchestrator 自动化任务作

操作 ID:: TasksGetTaskOperation

通过提供唯一的任务作 ID 来检索特定的 Orchestrator 自动化任务。

参数

名称	密钥	必需	类型	说明
操作 ID	OperationId	True	string	要检索的 Orchestrator 任务的作 ID。

名称	路径	类型	说明
自动化名称	AutomationName	string	检索到的 Orchestrator 任务的名称。
延迟日期和时间	DeferralDateTime	string	已检索的业务流程协调程序任务的日期和时间计划准备就绪。这将以 UTC 格式返回为字符串。
延迟存储的数据	DeferralStoredData	string	任务延迟时存储的可选数据。这通常是需要继续处理/流的数据。
延迟计数	DeferralCount	integer	此任务延迟的频率。对于从未延迟或 1 个或多个延迟任务的新任务，这通常为 0。每次再次延迟任务时，Orchestrator 都会自动增加此数字。
任务输入数据	TaskInputData	string	创建任务时存储的可选数据。这通常是用于启动进程/流的数据，但你可以将此字段用于任何目的。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。
任务输出数据	TaskOutputData	string	由自动化在处理任务时存储的可选数据。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。
Priority	Priority	integer	此 Orchestrator 任务的优先级（1 为最高级别）。
自动化任务状态	AutomationTaskStatus	string	检索到的 Orchestrator 任务的状态。
进程阶段	ProcessStage	string	延迟后自动化过程/流应继续的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。这将由延迟进程/流中的条件用于决定下一步执行的步骤。例如：如果希望进程/流在延迟后继续处于“Exchange”阶段，请输入值“Exchange”。
收到的日期和时间	ReceivedDateTime	string	任务最初由 Orchestrator 接收的日期和时间。这将以 UTC 格式返回为字符串。
延迟日期之前的分钟数	MinutesUntilDeferralDate	integer	此任务的延迟日期前的分钟数（即此任务准备好运行的时间）。如果此任务已准备好运行，则分钟数将为 0。
暂停	OnHold	boolean	如果任务处于保留状态，则设置为 true。保留任务永远不会由“获取下一个 Orchestrator 自动化任务”作检索，因此不会在典型的任务工作流中进行处理。
组织	Organisation	string	此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department	string	此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description	string	此任务的说明。通常用于搜索和筛选任务。
标记	Tags	string	分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。

获取 Orchestrator 辅助角色

操作 ID:: GetOrchestratorWorker

检索向 IA-Connect Orchestrator 注册的单个辅助角色的详细信息和实时状态。

参数

名称	密钥	必需	类型	说明
搜索辅助角色 ID	SearchWorkerId		integer	要检索的辅助角色的 ID。设置为值 1 或更高版本，以检索具有该特定 ID 的辅助角色的详细信息。如果不想按 ID 检索辅助角色，则设置为 0。
搜索辅助角色名称	SearchWorkerName		string	要检索的工作器的名称。如果不想按名称检索辅助角色，则设置为空或 null。

名称	路径	类型	说明
辅助角色 ID	WorkerId	integer	此工作器的内部业务流程协调程序 ID。
辅助角色名称	WorkerName	string	此辅助角色的内部业务流程协调程序名称。
辅助角色说明	WorkerDescription	string	此辅助角色的内部 Orchestrator 说明。
当前流显示名称	CurrentFlowDisplayName	string	此工作正在处理的流的显示名称;如果辅助角色处于空闲状态，则为空。
辅助角色实时状态	LiveStatus	boolean	如此，如果辅助角色当前已连接到 Orchestrator 并响应投票。如果辅助角色未连接，则为 False。
上次联系人计时周期	LiveStatusLastContactTicks	integer	业务流程协调程序上次与工作人员联系的时间（以时钟周期为单位）。这是自 10001 年 1 月 1 日午夜 12：00：00 起经过的 100 纳秒间隔数。这是常见的通用时间格式。
自上次联系人以来的秒数	SecondsSinceLastContact	integer	自业务流程协调程序上次与工作人员联系以来经过的时间（以秒为单位）。这表示与“上次接触刻度”相同的时间点，但以相对秒表示。
维护模式下的辅助角色	MaintenanceMode	boolean	如此，如果辅助角色当前处于维护模式。如果辅助角色不在维护模式下，则为 False。
辅助角色优先级	Priority	integer	整数值 1 或更高，表示分配给辅助角色的优先级。优先级 1 是最高优先级。流将发送到优先级最高的可用辅助角色。多个辅助角色可以具有相同的优先级，Orchestrator 将使用“辅助角色负载均衡方法”（请参阅“站点设置”）来选择可用的辅助角色。
辅助角色超时（以秒为单位）	TimeoutInSeconds	integer	业务流程协调程序在超时之前应等待来自 IA-Connect 控制器的 REST API 响应的时间（以秒为单位）。
辅助角色获得许可	AgentIsLicensed	boolean	如此，如果辅助角色当前已获得许可。如果辅助角色未获得许可，则为 False。 Null，如果 Orchestrator 不知道辅助角色是否获得许可（可能未响应，可能是一个非常旧的代理，该代理在投票中不提供实时许可更新）。
代理许可证功能	AgentLicenseFeatures	string	特定代理许可证功能。例如：联接器、Mover、Leaver 许可证的 JML。
辅助角色可用于工作	IsAvailableForWork	boolean	如此，如果辅助角色可用于工作，这意味着该辅助角色可以接受传入的工作。如果辅助角色不是，则为 False。可用于工作由 a 确定为工作状态，b）辅助角色是否处于维护模式，c）辅助角色是否获得许可，d）工作线程当前正在处理流。
辅助角色连接类型 ID	WorkerConnectionTypeId	integer	配置的辅助角色连接类型的 ID，用于将辅助角色连接到 Orchestrator。对于“Azure WCF 中继”，2 个用于“Azure 混合连接”，3 个用于“Azure 虚拟网络（VNet）”，4 个用于“Direct”。
辅助角色连接类型名称	WorkerConnectionTypeName	string	配置的辅助角色连接类型的名称，用于将辅助角色连接到 Orchestrator。这可以是 AzureWCFRelay、AzureHybridConnection、AzureVNet、Direct。
控制器 REST API URL	DirectorRestApiUrl	string	如果配置的连接类型是混合连接、VNet 或直接连接，则此属性包含辅助角色 REST API URL，这通常是 HTTP，因为 HTTP 流量在 HTTPS 隧道中加密（例如混合连接或本地数据网关）。如果配置的连接类型为 Azure WCF 中继，则此属性包含 WCF 中继 URL。
Azure 服务总线命名空间	AzureServiceBusNamespace	string	如果配置的连接类型为 Azure WCF 中继，则包含 Azure 服务总线命名空间。
Azure WCF 中继名称	AzureWCFRelayName	string	如果配置的连接类型为 Azure WCF 中继，则此属性包含 Azure WCF 中继名称。
代理连接类型名称	IAConnectAgentConnectionTypeName	string	代理连接类型的名称。这可以是“本地代理”、“Citrix ICA”或“Microsoft RDP”。
附加到下一跃点控制器	AttachedToNextHopDirector	boolean	如果连接到 Orchestrator 的控制器（通常是由本地代理托管的控制器）正在将作转发到下一跃点控制器（通常是 Citrix ICA 或 Microsoft RDP 控制器），此属性将设置为 True。如果控制器将作直接发送到它连接到的代理（通常是本地代理），此属性将设置为 False。
下一跃点控制器会话类型	NextHopDirectorSessionType	string	如果连接到 Orchestrator 的控制器（通常是由本地代理托管的控制器）正在将作转发到下一跃点控制器（通常是 Citrix ICA 或 Microsoft RDP 控制器），则此属性将保留连接类型的名称，即“Citrix ICA”或“Microsoft RDP”。
控制器版本	DirectorVersion	string	IA-Connect 控制器的内部版本，该控制器处理 REST API 接口，并为在 IA-Connect 辅助角色上运行的 IA-Connect 代理提供 IA-Connect 检查器。
代理版本	AgentVersion	string	IA-Connect 代理的内部版本，该代理在 IA-Connect 辅助角色上运行。
控制器版本	DirectorReleaseVersion	double	IA-Connect 控制器的 IA-Connect 发布版本，该控制器处理 REST API 接口，并为在 IA-Connect 辅助角色上运行的 IA-Connect 代理提供 IA-Connect 检查器。
代理发布版本	AgentReleaseVersion	double	在 IA-Connect 辅助角色上运行的 IA-Connect 代理的 IA-Connect 发布版本。
控制器主机名	DirectorHostname	string	承载 IA-Connect 控制器的作系统的主机名。这是辅助角色的主机名，通常与辅助角色名称相同。
控制器 NETBIOS 域名	DirectorNetBIOSDomainName	string	承载 IA-Connect 控制器的作系统的 NETBIOS 域名，它是在 IA-Connect 辅助角色上运行的 IA-Connect 代理的组件。对于工作组，这通常是辅助角色主机名。对于 Active Directory 域，这是域 NetBIOS 名称。例如：MYDOMAIN。
控制器 DNS 域名	DirectorDNSDomainName	string	承载 IA-Connect 控制器的作系统的 DNS 域名，该控制器是 IA-Connect 代理的一个组件，在 IA-Connect 辅助角色上运行。对于工作组，这通常是空白的。对于 Active Directory 域，这是域 DNS 名称。例如：mydomain.local。
支持的流环境 ID 数	SupportedFlowEnvironmentIdsCount	integer	如果辅助角色配置为仅处理来自指定流环境 ID 的流，则此属性将保留列表中支持的流环境 ID 数。如果辅助角色可以处理来自任何环境的流，则此属性保留 0。
支持的流名称数	SupportedFlowNamesCount	integer	如果辅助角色配置为仅处理具有特定名称的流，则此属性将保留列表中支持的流名称数。如果辅助角色可以处理具有任何名称的流，则此属性保留 0。
不支持的流名称数	UnsupportedFlowNamesCount	integer	如果辅助角色配置为拒绝处理具有特定名称的流，则此属性将保留列表中不受支持的流名称数。如果未将辅助角色配置为拒绝特定流，则此属性保留 0。
辅助角色标记数	WorkerTagsCount	integer	如果辅助角色配置了某些标记，则此属性将保留列表中的标记数。如果辅助角色没有标记，则此属性保留 0。
辅助角色强制标记数	WorkerMandatoryTagsCount	integer	如果辅助角色配置了一些必需标记，则此属性保存列表中的必需标记数。如果辅助角色没有必需的标记，则此属性保留 0。

获取 Orchestrator 辅助角色可用性状态

操作 ID:: OrchestratorGetWorkerAvailabilityStatusOverview

检索基本业务流程协调程序状态。这可用于确认 Orchestrator 是否可用并做出响应。

名称	路径	类型	说明
辅助角色总数	TotalWorkersCount	integer	业务流程协调程序中定义的 IA-Connect 辅助角色数，无论它们是否正常工作。
可用辅助角色数	AvailableWorkersCount	integer	业务流程协调程序中定义的 IA-Connect 辅助角色数，可用于工作。可用意味着它们正在响应、许可、不在维护模式下，而不是当前正在运行的流（自动化）。这是可用于接受新传入工作的工人数。
不可用的辅助角色数	UnavailableWorkersCount	integer	业务流程协调程序中定义的 IA-Connect 辅助角色数，这些工作不可用。这等于辅助角色总数减去可用辅助角色的数量。
运行流的辅助角色数	WorkersRunningFlowsCount	integer	Orchestrator 中定义的 IA-Connect 辅助角色数，这些工作器正在运行流（自动化）。这些工人不能上班，因为他们很忙。
维护模式下的辅助角色数	WorkersInMaintenanceModeCount	integer	业务流程协调程序中定义的 IA-Connect 辅助角色数，这些工作器处于维护模式。这些辅助角色不适用于工作，因为它们已手动配置为不接受新工作。
实时工作者数	LiveWorkersCount	integer	Orchestrator 中定义的 IA-Connect 辅助角色数，这些工作器正在响应。这些辅助角色可能或可能不适用于工作，因为它们可能是未经许可的、在主体模式下或运行流（自动化）。
已授权的辅助角色数	LicensedWorkersCount	integer	业务流程协调程序中定义的 IA-Connect 辅助角色数，这些工作器响应和许可。已授权的辅助角色将始终响应，因为 Orchestrator 仅在辅助角色正在响应时知道其许可状态（因此通知业务流程协调程序其状态）。如果辅助角色停止响应，Orchestrator 将不再将其视为已获得许可。这些辅助角色可能或可能不适用于工作，因为它们可能处于主体模式或运行流（自动化）。

获取 Orchestrator 辅助角色的列表

操作 ID:: GetListOfOrchestratorWorkers

检索注册到 IA-Connect Orchestrator 及其实时状态的辅助角色的列表。

参数

名称	密钥	必需	类型	说明
仅返回实时工作者	OnlyReturnLiveWorkers		boolean	设置为 true，仅返回实时工作者（积极连接到 Orchestrator 的工人）。

名称	路径	类型	说明
业务流程协调程序辅助角色	OrchestratorWorkers	array of object	已注册到 IA-Connect Orchestrator 及其实时状态的辅助角色列表。
Id	OrchestratorWorkers.Id	integer
Name	OrchestratorWorkers.Name	string
CurrentFlowDisplayName	OrchestratorWorkers.CurrentFlowDisplayName	string
LiveStatus	OrchestratorWorkers.LiveStatus	boolean
LiveStatusLastContactTicks	OrchestratorWorkers.LiveStatusLastContactTicks	integer
SecondsSinceLastContact	OrchestratorWorkers.SecondsSinceLastContact	integer
MaintenanceMode	OrchestratorWorkers.MaintenanceMode	boolean
Priority	OrchestratorWorkers.Priority	integer
AgentIsLicensed	OrchestratorWorkers.AgentIsLicensed	boolean
IsAvailableForWork	OrchestratorWorkers.IsAvailableForWork	boolean
辅助角色数	NumberOfOrchestratorWorkers	integer	响应中的 Orchestrator 辅助角色数。

获取下一个 Orchestrator 自动化任务

操作 ID:: TasksGetNextTask

检索匹配给定搜索条件的下一个 Orchestrator 自动化任务。只能检索“新建”和“延迟”任务（已达到延迟日期）。不会检索保留任务。

参数

名称	密钥	类型	说明
自动化名称	AutomationName	string	留空可返回具有任何名称的 Orchestrator 自动化任务。输入一个值以仅检索具有此自动化名称的任务。
自动化名称	AutomationNames	array of string	如果需要返回匹配两个或多个自动化名称中的任何一个的 Orchestrator 任务，请在此列表中输入名称，而不是输入“自动化名称”输入。
最低优先级级别	MinimumPriorityLevel	integer	仅返回具有指定优先级或更高级别的 Orchestrator 自动化任务。例如：设置 2 将返回优先级为 1 和 2 的任务。
将状态更改为	StatusChange	string	如果设置为“已检索”：检索任务时，任务状态将更改为“已检索”，以防止其他作尝试运行同一任务。如果设置为“不执行任何作”，则不会更改任务状态。
延迟日期之前的分钟数	MinutesUntilDeferralDate	integer	仅返回准备好在指定分钟数内运行的 Orchestrator 自动化任务。如果只想让准备好立即运行的自动化任务，则设置为 0。
忽略 SLA	IgnoreSLA	boolean	将此设置为 true 以忽略在任务上设置的任何 SLA。默认情况下，具有 SLA 的任务将很快泄露优先于其他所有内容。
排除任务 ID	ExcludeTaskIds	array of integer	要从处理中排除的任务 ID 的列表。

名称	路径	类型	说明
检索到的任务	TaskRetrieved	boolean	如果检索了任务，则设置为 true。如果没有与搜索条件匹配的任务，则设置为 false。
任务 ID	TaskId	integer	检索到的 Orchestrator 自动化任务的 ID。
操作 ID	OperationId	string	检索到的 Orchestrator 任务的作 ID。此作 ID（或任务 ID）可用于在以后检索任务。作 ID 是一个唯一的不可模糊字符串，限制了第三方猜测它们未创建的作的 ID 的能力。
自动化名称	AutomationNameOutput	string	检索到的自动化任务的名称。
延迟日期和时间	DeferralDateTime	string	已检索的业务流程协调程序任务的日期和时间计划准备就绪。这将以 UTC 格式返回为字符串。
延迟存储的数据	DeferralStoredData	string	任务延迟时存储的可选数据。这通常是需要继续处理/流的数据，但你可以将此字段用于任何目的。
延迟计数	DeferralCount	integer	此任务延迟的频率。对于从未延迟或 1 个或多个延迟任务的新任务，这通常为 0。每次再次延迟任务时，Orchestrator 都会自动增加此数字。
任务输入数据	TaskInputData	string	创建任务时存储的可选数据。这通常是用于启动进程/流的数据，但你可以将此字段用于任何目的。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。
任务输出数据	TaskOutputData	string	由自动化在处理任务时存储的可选数据。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。
Priority	Priority	integer	此 Orchestrator 任务的优先级（1 为最高级别）。
自动化任务状态	AutomationTaskStatus	string	检索到的 Orchestrator 任务的状态。
进程阶段	ProcessStage	string	延迟进程/流应在延迟后继续的点。这是一个可选字符串值，该值对于特定进程/流是唯一的。这将由延迟进程/流中的条件用于决定下一步执行的步骤。
收到的日期和时间	ReceivedDateTime	string	任务最初由 Orchestrator 接收的日期和时间。这将以 UTC 格式返回为字符串。
延迟日期之前的分钟数	MinutesUntilDeferralDateOutput	integer	此任务的延迟日期前的分钟数（即此任务准备好运行的时间）。如果此任务已准备好运行，则分钟数将为 0。
源类型名称	SourceTypeName	string	任务源的名称。 “Web UI”表示通过 UI 手动输入的任务。 “REST API”表示通过 Orchestrator 的 REST API 创建的任务。 “ServiceNow”表示从 Orchestrator 的内部“源”ServiceNow 集成创建的任务。
源友好名称	SourceFriendlyName	string	如果任务是从 Orchestrator 内部“源”集成（例如 ServiceNow）创建的，则此任务保留该源的友好名称。
源票证 ID	SourceTicketId	string	如果任务是从业务流程协调程序内部“源”集成（例如 ServiceNow）创建的，则此任务包含源票证的 ID。对于 ServiceNow，这将保留目录任务sys_id。
源票证子 ID	SourceTicketSubId	string	如果任务是从业务流程协调程序内部“源”集成（例如 ServiceNow）创建的，则此任务包含源票证的 ID。对于 ServiceNow，这将保留请求项sys_id。
组织	Organisation	string	此任务与之关联的组织。通常用于搜索和筛选任务。
Department	Department	string	此任务与之关联的部门。通常用于搜索和筛选任务。
Description	Description	string	此任务的说明。通常用于搜索和筛选任务。
标记	Tags	string	分配给此任务的一个或多个标记的可选列表。通常用于对任务进行分类以搜索和筛选。不区分大小写。每行一行。

获取下一跃点状态 IA-Connect

操作 ID:: GetNextHopStatus

报告接收此命令的代理的下一跃点控制器状态。如果启用了下一跃点，代理将命令转发到下一跃点（通过下一跃点控制器）。如果禁用下一跃点，则代理正在处理命令本身（默认值）。

参数

名称	密钥	必需	类型	说明
检查下一跃点控制器正在运行	CheckNextHopDirectorIsRunning		boolean	下一跃点需要在代理所在的同一台计算机上运行 IA-Connect 控制器。如果此设置为 true，代理将检查下一跃点控制器正在运行，如前所述。如果此设置为 false，则代理不会执行任何检查，并且只会检查下一跃点状态。
检查下一跃点代理正在运行	CheckNextHopAgentIsRunning		boolean	下一跃点需要在代理和运行 IA-Connect 代理所在的同一台计算机上运行 IA-Connect 控制器在下一跃点会话中运行。如果此设置为 true，代理将检查下一跃点代理是否正在运行，如前所述。如果此设置为 false，则代理不会执行任何检查，并且只会检查下一跃点状态。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已启用下一跃点	NextHopEnabled	boolean	如果当前启用了下一跃点，则返回 true。
活动下一跃点控制器地址	ActiveNextHopDirectorAddress	string	正在使用的下一跃点控制器的地址。
活动下一跃点控制器 TCP 端口	ActiveNextHopDirectorTCPPort	integer	活动下一跃点控制器的 TCP 端口（如果使用）。
活动下一跃点控制器使用 HTTPS	ActiveNextHopDirectorUsesHTTPS	boolean	如果活动的下一跃点控制器正在使用 HTTPS，则返回 true。
活动下一跃点控制器正在运行	ActiveNextHopDirectorIsRunning	boolean	如果活动下一跃点控制器正在运行，则返回 true;否则返回 false。
活动下一跃点控制器 URL	ActiveNextHopDirectorURL	string	活动下一跃点控制器的 URL。
正在运行活动的下一跃点代理	ActiveNextHopAgentIsRunning	boolean	如果活动下一跃点代理正在运行，则返回 true;否则返回 false。

获取代理线程

操作 ID:: GetAgentThreads

返回代理线程的列表。代理线程可用于在线程中运行某些作，允许作长时间运行（比 RPA 超时时间长）或与其他作并行运行。通常，一旦代理线程完成及其检索数据，代理线程就会被删除，并且不会显示在线程列表中。

参数

名称	密钥	必需	类型	说明
排序方式	SortOrder		string	代理线程的输出列表的排序顺序。支持的排序顺序为“None”、“ThreadStartTime”、“ThreadStartTime_Desc”、“ThreadEndTime”、“ThreadEndTime_Desc”、“ThreadId”、“ThreadId_Desc”、“ThreadActionName”、“ThreadActionName_Desc”、“ThreadRuntime”、“ThreadRuntime_Desc”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
代理线程数	NumberOfAgentThreads	integer	仍在运行或可供检索的代理线程数。通常，一旦代理线程完成及其检索数据，代理线程就会被删除，并且不会显示在线程列表中。
代理线程	AgentThreads	array of object	代理线程列表和所有可用的线程信息（内部线程数据除外）。
ThreadId	AgentThreads.ThreadId	integer
IAConnectActionName	AgentThreads.IAConnectActionName	string
ThreadStartDateTimeUTC	AgentThreads.ThreadStartDateTimeUTC	date-time
ThreadCompletedDateTimeUTC	AgentThreads.ThreadCompletedDateTimeUTC	date-time
ThreadRuntimeInSeconds	AgentThreads.ThreadRuntimeInSeconds	integer
ThreadStarted	AgentThreads.ThreadStarted	boolean
ThreadRunning	AgentThreads.ThreadRunning	boolean
ThreadCompleted	AgentThreads.ThreadCompleted	boolean
ThreadSuccess	AgentThreads.ThreadSuccess	boolean
ThreadStatusMessage	AgentThreads.ThreadStatusMessage	string
ThreadErrorMessage	AgentThreads.ThreadErrorMessage	string

获取剪贴板

操作 ID:: GetClipboardData

获取 IA-Connect 代理用户会话中剪贴板的当前内容。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
剪贴板数据	ClipboardData	string	剪贴板中包含的数据。

获取可用的 IA-Connect 会话

操作 ID:: GetAvailableIAConnectSessions

检索 IA-Connect 控制器会话的列表（与运行 IA-Connect 代理的会话（例如本地、Microsoft RDP 或 Citrix ICA）的会话建立连接）。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
IA-Connect 会话 JSON	IAConnectSessionsJSON	string	所有 IA-Connect 会话的列表，格式为 JSON。
IA-Connect 会话数	NumberOfIAConnectSessions	integer	打开的 IA-Connect 会话总数。
本地 IA-Connect 会话数	NumberOfLocalIAConnectSessions	integer	打开的本地 IA-Connect 会话数。
Citrix ICA IA-Connect 会话数	NumberOfCitrixICAIAConnectSessions	integer	已打开的 Citrix ICA IA-Connect 会话数。
Microsoft RDP IA-Connect 会话数	NumberOfMicrosoftRDPIAConnectSessions	integer	打开的Microsoft RDP IA-Connect 会话数。

获取坐标处的像素颜色

操作 ID:: GetPixelColourAtCoordinate

返回给定坐标处像素的 RGB 颜色。

参数

名称	密钥	必需	类型	说明
左 X 像素	LeftXPixels	True	integer	要读取的像素的 X 位置。在单个显示器上，最左侧的 X 像素为 0。在多监视器显示器上，最左侧的 X 像素可能是负像素（具体取决于哪个显示器被标记为主显示器，以及相对于其他显示器的位置）。
前 Y 像素	TopYPixels	True	integer	要读取的像素的 Y 位置。在单个显示器上，最上面的 Y 像素为 0。在多监视器显示器上，最顶部的 Y 像素可能是负像素（具体取决于哪个显示器被标记为主要显示器，以及相对于其他显示器的位置）。
隐藏代理	HideAgent		boolean	设置为 true 可自动隐藏代理（如果可见），以确保它不会遮盖正在读取的像素。
使用物理坐标	UsePhysicalCoordinates		boolean	设置为 true 以指定提供的坐标是物理坐标（而不是 DPI 缩放，因此与显示器上的物理像素匹配）。设置为 false（默认值），以指定提供的坐标是虚拟的（DPI 缩放）。 UIA、Java 和 Web作通常使用虚拟坐标。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
红色值	RedValue	integer	返回像素的红色值，从 0（无红色）到 255（全红色）。
绿色值	GreenValue	integer	返回像素的绿色值，从 0（无绿色）到 255（全绿色）。
蓝色值	BlueValue	integer	返回像素的蓝色值，从 0（无蓝色）到 255（全蓝色）。
Alpha 值	AlphaValue	integer	返回像素的 alpha 值，从 0（完全透明）到 255（完全不透明）。
RRGGBB 十六进制值	RRGGBBHexValue	string	返回像素的 RRGGBB 十六进制值。例如：FF0000 全红色，00FF00 全绿色，0000FF 为蓝色，000000 为黑色，FFFFFF 全白色。
AARRGGBB 十六进制值	AARRGGBBHexValue	string	返回像素的 AARRGGBB 十六进制值，该值与 RRGGBB 相同，但开头包含十六进制 alpha 值。对于完全不透明像素（最常见的），这将保留值 FFRRGGBB。例如：FFFF0000完全不透明，全红色。

获取存储的密码

操作 ID:: GetStoredPassword

检索以前生成的或存储的密码。

参数

名称	密钥	必需	类型	说明
密码标识符	PasswordIdentifier		string	存储密码的标识符。这些密码仅存储在内存中，在关闭代理时会丢失。例如：MyExchangePassword。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
纯文本密码	PlainTextPassword	string	纯文本形式的密码。如果密码是一次性密码，则可能需要纯文本密码，以便通过短信或电子邮件传输（例如），因此需要 as-is。

获取客户端主机名

操作 ID:: GetRemoteSessionClientHostname

返回运行 IA-Connect 控制器的客户端的主机名。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
客户端主机名	ClientHostname	string	运行 IA-Connect 控制器的客户端的主机名。

获取屏幕分辨率

操作 ID:: GetScreenResolution

返回 IA-Connect 代理用户会话的屏幕分辨率。对于在物理台式机或笔记本电脑上运行的 IA-Connect 本地代理，这将提供有关所有显示设备及其缩放的信息。在虚拟机上，通常只报告一个显示器，除非虚拟机已配置为显示多个显示器（不常见）。在远程会话中，通常只报告一个显示，即使该显示器跨越多个本地显示器，因为远程会话通常创建单个虚拟显示器。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
水平分辨率	HorizontalResolution	integer	主屏幕的水平物理分辨率。物理坐标直接映射到监视器上的像素。
垂直分辨率	VerticalResolution	integer	主屏幕的垂直物理分辨率。物理坐标直接映射到监视器上的像素。
屏幕数	NumberOfScreens	integer	此会话中的屏幕数。
第二个显示水平分辨率	SecondDisplayHorizontalResolution	integer	检测到第二个屏幕的水平物理分辨率。物理坐标直接映射到监视器上的像素。
第二个显示垂直分辨率	SecondDisplayVerticalResolution	integer	检测到第二个屏幕的垂直物理分辨率。物理坐标直接映射到监视器上的像素。
第三个显示水平分辨率	ThirdDisplayHorizontalResolution	integer	检测到第三个屏幕的水平物理分辨率。物理坐标直接映射到监视器上的像素。
第三个显示垂直分辨率	ThirdDisplayVerticalResolution	integer	检测到第三个屏幕的垂直物理分辨率。物理坐标直接映射到监视器上的像素。
第四个显示水平分辨率	FourthDisplayHorizontalResolution	integer	检测到第四个屏幕的水平物理分辨率。物理坐标直接映射到监视器上的像素。
第四个显示垂直分辨率	FourthDisplayVerticalResolution	integer	检测到第四个屏幕的垂直物理分辨率。物理坐标直接映射到监视器上的像素。
虚拟屏幕左边缘像素	VirtualScreenLeftEdgePixels	integer	整个虚拟显示器的左边缘（所有检测到的显示器）。虚拟坐标是 DPI 缩放的。
虚拟屏幕上边缘像素	VirtualScreenTopEdgePixels	integer	整个虚拟显示器的上边缘（所有检测到的显示器）。虚拟坐标是 DPI 缩放的。
虚拟屏幕宽度像素	VirtualScreenWidthPixels	integer	整个虚拟显示器的宽度（所有检测到的显示器）。虚拟坐标是 DPI 缩放的。
虚拟屏幕高度像素	VirtualScreenHeightPixels	integer	整个虚拟显示器的高度（所有检测到的显示器）。虚拟坐标是 DPI 缩放的。
主要显示缩放	PrimaryDisplayScaling	double	主显示器的 DPI 缩放乘数作为小数。例如：100% 将返回为 1.0,125% 将返回为 1.25。
第二个显示缩放	SecondDisplayScaling	double	第二个显示器的 DPI 缩放乘数显示为小数。例如：100% 将返回为 1.0,125% 将返回为 1.25。
第三个显示缩放	ThirdDisplayScaling	double	第三个显示器的 DPI 缩放乘数作为小数。例如：100% 将返回为 1.0,125% 将返回为 1.25。
第四个显示缩放	FourthDisplayScaling	double	第四个显示器的 DPI 缩放乘数作为小数。例如：100% 将返回为 1.0,125% 将返回为 1.25。
物理屏幕左边缘像素	PhysicalScreenLeftEdgePixels	integer	整个物理显示器的左边缘（所有检测到的显示器）。物理坐标直接映射到监视器上的像素。
物理屏幕上边缘像素	PhysicalScreenTopEdgePixels	integer	整个物理显示器的上边缘（所有检测到的显示器）。物理坐标直接映射到监视器上的像素。
物理屏幕宽度像素	PhysicalScreenWidthPixels	integer	整个物理显示器的宽度（所有检测到的显示器）。物理坐标直接映射到监视器上的像素。
物理屏幕高度像素	PhysicalScreenHeightPixels	integer	整个物理显示器的高度（所有检测到的显示器）。物理坐标直接映射到监视器上的像素。
主显示左边缘像素	PrimaryDisplayLeftEdgePixels	integer	主显示器的左物理边缘。物理坐标直接映射到监视器上的像素。
主显示上边缘像素	PrimaryDisplayTopEdgePixels	integer	主显示器的上物理边缘。物理坐标直接映射到监视器上的像素。
第二个显示左边缘像素	SecondDisplayLeftEdgePixels	integer	第二个显示器的左物理边缘（如果检测到）。物理坐标直接映射到监视器上的像素。
第二个显示上边缘像素	SecondDisplayTopEdgePixels	integer	第二个显示器的上边缘（如果检测到）。物理坐标直接映射到监视器上的像素。
第三个显示左边缘像素	ThirdDisplayLeftEdgePixels	integer	第三个显示器的左物理边缘（如果检测到）。物理坐标直接映射到监视器上的像素。
第三个显示上边缘像素	ThirdDisplayTopEdgePixels	integer	第三个显示器的顶部物理边缘（如果检测到一个）。物理坐标直接映射到监视器上的像素。
第四个显示左边缘像素	FourthDisplayLeftEdgePixels	integer	第四个显示器的左物理边缘（如果检测到一个）。物理坐标直接映射到监视器上的像素。
第四个显示上边缘像素	FourthDisplayTopEdgePixels	integer	第四个显示器的上边缘（如果检测到）。物理坐标直接映射到监视器上的像素。

获取当前鼠标坐标

操作 ID:: GetCursorPos

使用 setcursorpos API 获取 IA-Connect 代理用户会话中的当前鼠标光标位置。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
X 像素	X	integer	X 坐标值（以像素为单位）。
Y 像素	Y	integer	Y 坐标值（以像素为单位）。

获取所有 IA-Connect 命令统计信息

操作 ID:: GetAllCommandStats

返回当前会话中执行 IA-Connect 代理所执行命令的所有当前存储统计信息。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令统计信息 JSON	CommandStatsJSON	string	IA-Connect 代理以 JSON 格式执行的命令列表。此列表将包含每个作的名称及其执行次数。

获取所有 Orchestrator 自动化任务

操作 ID:: TasksGetAllTasks

检索与筛选器匹配的所有 Orchestrator 自动化任务。

参数

名称	密钥	类型	说明
自动化名称筛选器	AutomationName	string	输入一个值以仅检索具有此自动化名称的任务。留空以返回具有任何名称的 Orchestrator 自动化任务（即禁用此筛选器）。
自动化任务状态筛选器	AutomationTaskStatus	string	按指定的自动化任务状态筛选自动化任务。将字段留空以返回所有自动化任务状态（即禁用此筛选器）。
按属性查询进行筛选	FilterByPropertyQuery	string	使用查询字符串筛选自动化任务。这与 Orchestrator 任务 UI 中的“按属性筛选”输入相同。将字段留空以不按属性进行筛选（即禁用此筛选器）。搜索筛选器的格式必须为“属性条件值”。仅支持单个搜索筛选器（不能使用和或）。支持的属性包括：name、org、dept、tags、stage、ticketid。支持的条件是相等的、包含的、不相等的、不包含的。例如：名称等于新初学者，名称包含初学者，Org 不等于 Acme，Dept 包含销售。
延迟日期之前的分钟数	MinutesUntilDeferralDate	integer	仅返回准备好在指定分钟数内运行的 Orchestrator 自动化任务。如果只想让准备好立即运行的自动化任务，则设置为 0。如果要检索任务而不考虑延迟，请留空。
最低优先级级别	MinimumPriorityLevel	integer	仅返回具有指定优先级或更高级别的 Orchestrator 自动化任务。例如：设置 2 将返回优先级为 1 和 2 的任务。
按延迟日期排序	SortByDeferralDate	boolean	设置为 true 以返回按延迟日期和时间排序的数据。如果设置为 false，则存储数据的顺序为 false。
检索保留任务	RetrieveOnHoldTasks	boolean	如果设置为 true（默认值为向后兼容性），即使任务处于保留状态，也会检索这些任务。如果设置为 false，则不会检索保留任务。
跳过	Skip	integer	如果检索数百个结果，可以使用 Skip 和 MaxResults 检索结果块。 Skip 指定要跳过的结果数，然后再返回块中的第一项。将 Skip 设置为 0 会从一开始就返回结果。
最大结果	MaxResults	integer	如果检索数百个结果，可以使用 Skip 和 MaxResults 检索结果块。 MaxResults 指定要返回的最大结果数，或者在处理 Skip 输入后返回所有结果的 0。
排除任务数据	ExcludeTaskData	boolean	如果设置为 true，则响应中不返回任务数据属性（TaskData、DeferralStoredData、TaskOutputData）。如果任务具有大量存储的数据，这可以显著减少响应的大小。

名称	路径	类型	说明
自动化任务	AutomationTasks	array of object	包含满足给定搜索条件的所有 Orchestrator 自动化任务的数据表。数据表是一种常见的 .NET 数据格式，但将 null 存储为 DbNull。 IA-Connect PowerShell 模块通过将大多数 DbNull 字符串转换为“”来解决此问题。 Orchestrator 的日期/时间响应将采用字符串格式。
items	AutomationTasks	object
自动化任务数	NumberOfAutomationTasks	integer	返回的自动化任务数。

获取打印机列表

操作 ID:: GetListOfPrinters

返回 IA-Connect 代理会话中所有可用打印机的列表。

参数

名称	密钥	必需	类型	说明
列出本地打印机	ListLocalPrinters		boolean	是否应返回本地打印机？
列出网络打印机	ListNetworkPrinters		boolean	是否应返回网络打印机？
返回详细信息	ReturnDetailedInformation		boolean	是否应返回每个打印机的位置、端口名称、驱动程序名称和状态等详细信息？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
打印机 JSON	PrintersJSON	string	找到的所有打印机的列表（采用 JSON 格式）。
打印机数	NumberOfPrinters	integer	找到的打印机数。

获取控制器客户端类型和会话信息

操作 ID:: GetRemoteClientType

返回由第 1 层控制器处理的本地或远程会话的详细信息。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
远程客户端类型	RemoteClientType	string	远程客户端类型（“Local”、“Citrix ICA”或“Microsoft RDP”）。
已连接的虚拟通道	VirtualChannelConnected	boolean	如此，如果虚拟通道已连接，则控制器和代理之间。
控制器版本	DirectorVersion	string	IA-Connect 控制器 DLL 的版本。例如：1.67.21.0。
控制器版本	DirectorReleaseVersion	string	IA-Connect Director 的 IA-Connect 版本。例如：9.4。
代理版本	AgentVersion	string	此控制器连接到的 IA-Connect Agent EXE 的版本。例如：1.74.21.0。
代理发布版本	AgentReleaseVersion	string	此控制器连接到的 IA-Connect 代理的 IA-Connect 版本。例如：9.4。
代理已获得许可	AgentIsLicensed	boolean	如此，如果此控制器连接到 IA-Connect 代理，则获得许可。如果 IA-Connect 代理未获得许可，则为 False。如果代理许可证状态未知，则为 Null。
代理许可证功能	AgentLicenseFeatures	string	分配给此 Director 连接到的 IA-Connect 代理的 IA-Connect 许可证功能的逗号分隔列表。例如：JML、DEV。
控制器主机名	DirectorHostname	string	运行控制器的计算机的主机名。例如：vmrpa1。
Director NetBIOS 域名	DirectorNetBIOSDomainName	string	运行控制器的计算机的 NetBIOS 域名。例如：domain1。如果计算机不是域的成员，这通常返回主机名。
控制器 DNS 域名	DirectorDNSDomainName	string	运行控制器的计算机的 DNS 域名。例如：domain1.myorg.local。如果计算机不是域的成员，这通常返回主机名。
附加到下一跃点控制器	AttachedToNextHopDirector	boolean	如果 IA-Connect 会话当前附加到此控制器连接到的代理，则设置为 false。如果控制器将所有作（即附加）转发到另一个控制器（连接到其他代理），则设置为 true。例如，如果此控制器是与本地代理通信的本地控制器，但 IA-Connect 会话当前附加到 Citrix，则此值为 true。
下一跃点控制器会话类型	NextHopDirectorSessionType	string	如果此控制器附加到下一跃点控制器，则此值将保留下一跃点会话类型。例如，如果此控制器是与本地代理通信的本地控制器，但 IA-Connect 会话当前附加到 Citrix，则此值将为“Citrix ICA”，而“远程客户端类型”值将是“本地”（表示本地控制器将作转发到 Citrix）。

获取文件

操作 ID:: GetFiles

返回运行 IA-Connect 代理的计算机上的文件夹中的文件列表（匹配 CSV 模式列表）。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
模式 CSV	PatternsCSV	True	string	要匹配的文件模式的逗号分隔列表，例如，对于所有文件或“.txt”，对于扩展名为 .txt 或 .docx 的文件，.docx”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
文件 JSON	FilesJSON	string	文件夹中包含的文件列表，格式为 JSON。
成功读取的文件数	NumberOfFilesReadSuccessfully	integer	已成功读取的文件数。
未能读取的文件数	NumberOfFilesFailedToRead	integer	无法读取的文件数。

获取文件大小

操作 ID:: GetFileSize

返回运行 IA-Connect 代理的计算机上的文件的大小（以字节为单位）。

参数

名称	密钥	必需	类型	说明
文件路径	Filename	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
文件大小	FileSize	integer	文件的大小（以字节为单位）。

获取文件夹

操作 ID:: GetFolders

返回运行 IA-Connect 代理的计算机上的指定文件夹中的所有子文件夹。

参数

名称	密钥	必需	类型	说明
目录路径	DirectoryPath	True	string	目录的完整路径（文件夹）。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
文件夹 JSON	FoldersJSON	string	文件夹中包含的子文件夹的列表，格式为 JSON 格式。
成功读取的文件夹数	NumberOfFoldersReadSuccessfully	integer	已成功读取的子文件夹数。
无法读取的文件夹数	NumberOfFoldersFailedToRead	integer	无法读取的子文件夹数。

获取文件夹安全权限

操作 ID:: GetFolderSecurityPermissions

返回当前在运行 IA-Connect 代理的计算机上的文件夹中设置的权限列表。

参数

名称	密钥	必需	类型	说明
文件夹路径	FolderPath	True	string	文件夹的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
安全权限 JSON	SecurityPermissionsJSON	string	当前在指定文件夹上设置的权限，采用 JSON 格式。

获取文件安全权限

操作 ID:: GetFileSecurityPermissions

返回当前在运行 IA-Connect 代理的计算机上的文件上设置的权限列表。

参数

名称	密钥	必需	类型	说明
文件路径	FilePath	True	string	文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
安全权限 JSON	SecurityPermissionsJSON	string	当前针对指定文件设置的权限，采用 JSON 格式。

获取最后一个输入信息

操作 ID:: GetLastInputInfo

获取自 IA-Connect 代理用户会话中收到上次用户输入以来的时间。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
上次输入总秒数	LastInputTotalSeconds	integer	自上次输入以来经过的秒数。
上次输入总分钟数	LastInputTotalMinutes	integer	自上次输入以来已用过的分钟数。
上次输入总小时数	LastInputTotalHours	integer	自上次输入以来经过的小时数。

获取父进程 ID

操作 ID:: GetParentProcessId

返回具有指定进程 ID 的 IA-Connect 代理用户会话中任何正在运行的进程的进程的进程 ID。

参数

名称	密钥	必需	类型	说明
进程 ID	ProcessId	True	integer	子进程的进程 ID。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
父进程 ID	ParentProcessId	integer	父进程的进程 ID。
父进程仍在运行	ParentProcessStillRunning	boolean	如果父进程仍在运行且尚未退出，则返回 true。
父进程名称	ParentProcessName	string	父进程的进程名称。

获取环境信息

操作 ID:: GetEnvironmentInfo

返回有关运行 IA-Connect 代理用户会话的环境的信息。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
OS 主版本	OSVersionMajor	integer	作系统主版本。
OS 次要版本	OSVersionMinor	integer	作系统次要版本。
OS 内部版本	OSVersionBuild	integer	作系统生成版本。
OS 为 64 位	OSIs64Bit	boolean	如果作系统为 64 位，则返回 true。
处理器计数	ProcessorCount	integer	处理器计数。
总物理 RAM（以 MB 为单位）	TotalPhysicalRAMInMB	integer	物理 RAM 量（以 MB 为单位）。
虚拟 RAM 总数（以 MB 为单位）	TotalVirtualRAMInMB	integer	虚拟 RAM 量（以 MB 为单位）。
可用物理 RAM（以 MB 为单位）	AvailablePhysicalRAMInMB	integer	当前可用的物理 RAM 量（以 MB 为单位）。
可用虚拟 RAM（以 MB 为单位）	AvailableVirtualRAMInMB	integer	当前可用的虚拟 RAM 量（以 MB 为单位）。
OS 全名	OSFullName	string	作系统全名，例如Microsoft Windows Server 2019 Standard。
已安装的 UI 区域性名称	InstalledUICultureName	string	随作系统一起安装的用户界面语言，例如 en-US。
当前 UI 区域性名称	CurrentUICultureName	string	默认用户界面语言，例如 en-US。
当前区域性名称	CurrentCultureName	string	默认用户区域设置，例如 en-GB。

获取磁盘空间

操作 ID:: GetDiskFreeSpace

返回运行 IA-Connect 代理的计算机上的指定磁盘的可用空间量。

参数

名称	密钥	必需	类型	说明
驱动器号	DriveLetter	True	string	要检查的磁盘的驱动器号。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
磁盘空间可用字节数	FreeSpaceBytes	integer	可用磁盘空间量（以字节为单位）。
磁盘空间可用空间 KB	FreeSpaceKB	integer	可用磁盘空间量（以 KB 为单位）。
磁盘空间可用空间 MB	FreeSpaceMB	integer	可用磁盘空间量（以兆字节为单位）。
磁盘空间可用空间 GB	FreeSpaceGB	integer	可用磁盘空间量（以 GB 为单位）。

获取计算机名称

操作 ID:: GetMachineName

返回运行 IA-Connect 代理用户会话的计算机的名称。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
计算机名称	MachineName	string	运行 IA-Connect 代理用户会话的计算机的名称。

获取计算机域

操作 ID:: GetMachineDomain

返回运行 IA-Connect 代理用户会话的计算机的域。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
域名	DomainName	string	运行 IA-Connect 代理用户会话的计算机的 NetBIOS 域名。
DNS 域名	DNSDomainName	string	运行 IA-Connect 代理用户会话的计算机的 DNS 域名。

获取进程

操作 ID:: GetProcesses

返回 IA-Connect 代理用户会话中正在运行的进程的列表。这可以通过提供进程名称来进行筛选。

参数

名称	密钥	必需	类型	说明
进程名	ProcessName		string	进程名称的可选筛选器。
获取进程命令行	GetProcessCommandLine		boolean	如果设置为 true，将返回进程命令行详细信息。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
进程数	NumberOfProcesses	integer	在用户会话中运行的进程数。
处理 JSON	ProcessesJSON	string	以 JSON 格式的用户会话运行的进程列表。

获取进程 ID 命令行属性

操作 ID:: GetProcessIdCommandLine

返回 IA-Connect 代理用户会话中具有指定进程 ID 的任何正在运行进程的命令行属性。

参数

名称	密钥	必需	类型	说明
进程 ID	ProcessId	True	integer	要从中检索命令行属性的进程的进程 ID。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
进程命令行	ProcessCommandLine	string	进程的命令行属性。
进程参数	ProcessArguments	string	启动进程时使用的参数。
处理当前工作目录	ProcessCurrentWorkingDirectory	string	进程当前工作目录。
处理映像路径名称	ProcessImagePathName	string	启动进程的可执行文件的路径。

获取驱动器列表

操作 ID:: GetListOfDrives

返回运行 IA-Connect 代理的计算机上的驱动器列表。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
驱动器 JSON	DrivesJSON	string	运行 IA-Connect 代理的计算机上的驱动器列表，格式为 JSON。

获取默认打印机

操作 ID:: GetDefaultPrinter

获取 IA-Connect 代理会话中用户的默认打印机的名称。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
默认打印机名称	DefaultPrinterName	string	用户的默认打印机的名称。

获取鼠标乘数

操作 ID:: GetMouseMultiplier

检索 IA-Connect 代理用户会话中的全局鼠标乘数。这默认为（1， 1），但可能已由“设置鼠标乘数”作更改。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
X 乘数	MouseXMultiplier	double	当前水平（X）全局鼠标乘数（当代理移动鼠标时）。当禁用“多重监视器功能”时，乘数才有任何影响。
Y 乘数	MouseYMultiplier	double	当前垂直（Y）全局鼠标乘数（当代理移动鼠标时）。当禁用“多重监视器功能”时，乘数才有任何影响。
鼠标移动方法	MouseMoveMethod	string	返回当前全局鼠标移动方法（mouse_event或 setcursorpos）。

获取鼠标移动方法

操作 ID:: GetMouseMoveMethod

获取当前鼠标移动方法。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
鼠标移动方法	MouseMoveMethod	string	返回当前鼠标移动方法（mouse_event或 setcursorpos）。

解压缩文件

操作 ID:: UnZIPFile

解压缩已使用 ZIP 压缩压缩的文件。

参数

名称	密钥	必需	类型	说明
ZIP 文件路径	ZIPFilename	True	string	要解压缩的 ZIP 文件的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
提取文件夹	ExtractFolder		string	要将其解压缩到的文件夹的文件夹路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
将所有文件提取到单个文件夹	ExtractAllFilesToSingleFolder		boolean	如果设置为 True，则 ZIP 中的文件夹结构将被忽略，所有文件都将提取到指定的文件夹中。
包含文件正则表达式	IncludeFilesRegEx		string	一个可选的正则表达式，用于指定应提取哪些文件。仅匹配文件名。
排除文件正则表达式	ExcludeFilesRegEx		string	一个可选的正则表达式，用于指定应从提取中排除哪些文件。仅匹配文件名。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
成功提取的文件数	FilesExtractedSuccessfully	integer	已成功从 ZIP 中提取的文件数。
无法提取的文件数	FilesFailedToExtract	integer	未能从 ZIP 中提取的文件数。
排除的文件数	FilesExcluded	integer	排除的文件数（如果使用“排除文件正则表达式”输入）。

解锁会话

操作 ID:: UnlockSession

解锁运行 IA-Connect 代理的会话。这要求在托管会话的计算机上安装 IA-Connect 解锁程序凭据提供程序，因为只有凭据提供程序才能解锁计算机。

参数

名称	密钥	必需	类型	说明
解锁密码	UnlockPassword	True	string	用于解锁当前会话的密码。这是登录到当前锁定的会话的帐户的 Windows 用户密码。如果这是“Stored”密码，请输入 {IAConnectPassword：StoredPasswordIdentifier} 格式，并将“存储密码”输入设置为 true。如果这是 Orchestrator 泛型凭据，请输入 {OrchestratorCredential：FriendlyName} 格式，并将“存储的密码”输入设置为 true。
密码包含存储的密码	PasswordContainsStoredPassword		boolean	如果密码是 IA-Connect 存储的密码标识符（例如：由“生成密码”作生成）或 IA-Connect Orchestrator 泛型凭据（例如：将 IA-Connect 与 PA 流配合使用），则设置为 true。
检测是否已锁定	DetectIfLocked	True	boolean	如果 IA-Connect 代理尝试检测会话是否已锁定。如果设置为 true 且未检测到会话处于锁定状态，则此作将只执行任何作（因为没有任何作）。仅当 IA-Connect 错误地检测会话是否已锁定并且你想要强制解锁尝试（如果会话未锁定，这将失败）时设置为 false。
检测凭据提供程序	DetectCredentialProvider	True	boolean	如果 IA-Connect 代理在发送解锁请求之前尝试检测 IA-Connect 解锁程序凭据提供程序是否存在。仅当 IA-Connect 凭据提供程序存在且正在运行，但出于某种原因，IA-Connect 代理未检测到它时，才应禁用此功能。
等待解锁的秒数	SecondsToWaitForUnlock		integer	IA-Connect 代理应等待成功解锁（通过检测桌面解锁状态）的证据（以秒为单位）。默认情况下，最长为 5 秒。设置为 0 可禁用此功能并继续，无需检查桌面是否已解锁。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
执行的会话解锁	SessionUnlockPerformed	boolean	如果会话已锁定并执行解锁作，则设置为 true。如果会话未锁定，并且“检测是否锁定”设置为 true，则设置为 false，导致不执行任何作。

设置 IA-Connect 代理 GUI 不透明度

操作 ID:: SetRSAGUIOpacity

将 IA-Connect 代理的不透明度从 1（可见）设置为 0（透明）。

参数

名称	密钥	必需	类型	说明
不透明度	Opacity	True	double	要设置的不透明度值，介于 1（可见）和 0 之间（透明）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 代理 GUI 位置

操作 ID:: SetRSAGUIPosition

将 IA-Connect 代理 GUI 的屏幕上位置设置为指定位置。

参数

名称	密钥	必需	类型	说明
X	X	True	integer	要将代理设置为的 X 坐标（以像素为单位）。
Y	Y	True	integer	要将代理设置为的 Y 坐标（以像素为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 代理 GUI 最顶层

操作 ID:: SetRSAGUITopmost

将 IA-Connect 代理设置为最顶层。这意味着 IA-Connect 代理将始终在屏幕上可见，并且不能隐藏在其他应用程序窗口后面。

参数

名称	密钥	必需	类型	说明
上面	TopMost		boolean	IA-Connect 代理应设置为最顶层（true）还是最顶层是否应禁用（false）？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 代理全局坐标配置

操作 ID:: SetAgentGlobalCoordinateConfiguration

配置 IA-Connect 代理全局坐标系，该系统用于显示元素位置（例如：在鼠标检查期间），并计算鼠标位置（例如：执行全局鼠标作时）。默认值提供最新功能，但你可以使用此作还原到早期版本的代理中的行为，或指定 API 使用的是其他坐标系。

参数

名称	密钥	必需	类型	说明
多监视器功能	MultiMonitorFunctionality		string	设置为“仅主显示”（PrimaryMonitor）可恢复为较旧的行为，它仅支持突出显示元素并在主显示设备上执行全局鼠标作（IA-Connect 9.3 及更早版本中的唯一可用模式）。设置为“所有显示”（MultiMonitor）以启用突出显示元素并在所有监视器上执行全局鼠标作，并自动检测每个监视器上的 DPI 缩放（自 IA-Connect 9.4 以来的默认值）。设置为“未设置”（NotSet），不进行更改。
自动设置鼠标检查乘数	AutoSetMouseInspectionMultiplier		string	设置为“自动”（1）（自 IA-Connect 9.4 以来的默认值），以在代理启动时自动计算主显示设备上的鼠标检查乘数，每次执行鼠标检查。设置为“手动”（0），要求手动设置检查乘数（IA-Connect 9.3 及更早版本中的唯一可用选项）。设置为空白或“NotSet”，使此选项保持不变。此选项仅在禁用“多重监视器功能”时产生任何影响。
自动设置全局鼠标乘数	AutoSetGlobalMouseMultiplier		string	设置为“自动”（1）（自 IA-Connect 9.4 以来的默认值），以在代理启动时自动计算主显示设备上的全局鼠标移动乘数，每次执行鼠标检查。设置为“Manual”（0），要求手动设置全局鼠标移动乘数（IA-Connect 9.3 及更早版本中的唯一可用选项）。设置为空白或“NotSet”，使此选项保持不变。此选项仅在禁用“多重监视器功能”时产生任何影响。
鼠标检查 X 乘数	MouseInspectionXMultiplier		double	要设置的水平（X）鼠标检查乘数（当代理突出显示鼠标下的内容时）。例如：如果 IA-Connect 在实际鼠标 X 位置的一半处显示检查矩形，则设置值 0.5。设置为 0 以保持当前值不变。此选项仅在禁用“多重监视器功能”且禁用“自动设置鼠标检查乘数”时产生任何影响。
鼠标检查 Y 乘数	MouseInspectionYMultiplier		double	要设置的垂直（Y）鼠标检查乘数（当代理突出显示鼠标下的内容时）。例如：如果 IA-Connect 在实际鼠标 Y 位置的一半处显示检查矩形，则设置值 0.5。设置为 0 以保持当前值不变。此选项仅在禁用“多重监视器功能”且禁用“自动设置鼠标检查乘数”时产生任何影响。
全局鼠标 X 乘数	GlobalMouseXMultiplier		double	要设置的水平（X）全局鼠标移动乘数（对于代理移动鼠标时）。设置为 0 以保持当前值不变。此选项仅在禁用“多重监视器功能”时产生任何影响。
全局鼠标 Y 乘数	GlobalMouseYMultiplier		double	要设置的垂直（Y）全局鼠标移动乘数（对于代理移动鼠标时）。设置为 0 以保持当前值不变。此选项仅在禁用“多重监视器功能”时产生任何影响。
应用于mouse_event	GlobalMouseMultiplierApplyToMouseEvent		boolean	这指定是否将全局鼠标乘数值应用于 mouse_event 方法。此选项仅在禁用“多重监视器功能”时产生任何影响。
应用于 SetCursorPos	GlobalMouseMultiplierApplyToSetCursorPos		boolean	此参数指定是否将全局鼠标乘数值应用于 SetCursorPos 方法。此选项仅在禁用“多重监视器功能”时产生任何影响。
应用于当前鼠标移动方法	GlobalMouseMultiplierApplyToCurrentMouseMoveMethod		boolean	此参数指定是否将全局鼠标乘数值应用于当前鼠标移动方法（例如：如果 SetCursorPos 是当前鼠标移动方法，则乘数将应用于 SetCursorPos）。如果设置为 true，则忽略输入“应用于 mouse_event”和“应用于 SetCursorPos”。此选项仅在禁用“多重监视器功能”时产生任何影响。
Java 坐标系	JavaCoordinateSystem		string	设置为“虚拟”（IA-Connect 9.3 及更早版本中的唯一可用选项），以通知代理 Java 访问桥提供虚拟（DPI 缩放）坐标。设置为“物理”，以通知代理 Java 访问桥提供物理坐标（直接映射到像素）。设置为“未设置”（NotSet），不进行更改。
SAP GUI 坐标系	SAPGUICoordinateSystem		string	设置为“虚拟”（IA-Connect 9.3 及更早版本中的唯一可用选项），以通知代理 SAP GUI 脚本 API 提供虚拟（DPI 缩放）坐标。设置为“物理”，以通知代理 SAP GUI 脚本 API 提供物理坐标（直接映射到像素）。设置为“未设置”（NotSet），不进行更改。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	SetAgentGlobalCoordinateConfigurationResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

设置 IA-Connect 代理命令超时

操作 ID:: SetRPACommandTimeout

设置 IA-Connect 代理将用于执行的每个命令的命令超时。

参数

名称	密钥	必需	类型	说明
命令超时（以秒为单位）	CommandTimeoutInSeconds	True	integer	IA-Connect 代理将使用的命令超时。如果读取或写入大量数据，可能需要增加超时期限。
终止超时 RPA 命令线程	TerminateTimedoutRPACommandThreads		boolean	如果命令线程已超时，应终止该线程吗？
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 代理日志级别

操作 ID:: SetRemoteLoggingLevel

将 IA-Connect 代理日志记录级别设置为指定值（1 为最低级别，4 为最高）。

参数

名称	密钥	必需	类型	说明
日志级别	LoggingLevel	True	integer	应将 IA-Connect 代理设置为的日志记录级别。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 控制器日志级别

操作 ID:: SetLocalLoggingLevel

将 IA-Connect 控制器日志记录级别设置为指定值。日志记录级别从 0 设置为 4。 0 已禁用。 1 是最低日志级别（默认值）。 4 是最高的日志级别。

参数

名称	密钥	必需	类型	说明
日志级别	LoggingLevel	True	integer	应将 IA-Connect 控制器设置为的日志记录级别。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 许可证代码

操作 ID:: SetLicenseCode

将旧式代理（7.0 和 7.1）代理域许可证上传到 IA-Connect 代理。

参数

名称	密钥	必需	类型	说明
客户 NetBIOS 域名	CustomerNETBIOSDomainName	True	string	运行 IA-Connect 代理的计算机的 NetBIOS 域名。
客户显示名称	CustomerDisplayName	True	string	要显示在 IA-Connect 代理的标题栏中的客户名称。
供应商名称	VendorName	True	string	IA-Connect 供应商名称。
许可证到期日期	LicenseExpiryDate	True	string	IA-Connect 许可证的到期日期。
激活代码	ActivationCode	True	string	IA-Connect 许可证的激活代码。
存储在注册表中	StoreInRegistry		boolean	IA-Connect 许可证是否应暂时存储在注册表中？这可确保 IA-Connect 代理在用户会话期间获得许可，即使代理已关闭并重新启动。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置 IA-Connect 许可证密钥

操作 ID:: SetLicenseString

使用许可证密钥许可 IA-Connect 代理。这可以是许可证字符串，也可以是 IA-Connect Orchestrator 中持有的许可证的友好名称。

参数

名称	密钥	必需	类型	说明
许可证密钥	LicenseString	True	string	IA-Connect 许可证密钥字符串或 IA-Connect Orchestrator 中持有的许可证的友好名称（如果通过 IA-Connect Orchestrator 控制 IA-Connect）。
存储在注册表中	StoreInRegistry		boolean	IA-Connect 许可证是否应暂时存储在注册表中？这可确保 IA-Connect 代理在用户会话期间获得许可，即使代理已关闭并重新启动。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
许可证过期前的天数	DaysUntilLicenseExpires	integer	IA-Connect 许可证过期之前的剩余天数。

设置 Orchestrator 自动化任务输出数据

操作 ID:: TasksSetOutputData

设置 Orchestrator 自动化任务的输出数据。通常在完成任务时使用，并希望提供输出数据，由创建该任务的过程收集。

参数

名称	密钥	必需	类型	说明
任务 ID	TaskId	True	integer	要向其添加注释的 Orchestrator 任务的 ID。
任务输出数据	TaskOutputData		string	输出数据字符串。这可以格式化为所选的任何文本格式，例如 JSON 或 XML 或原始文本。可以在 Orchestrator UI 中查看输出数据字符串，也可以通过 TasksGetTask REST API 进行访问。

名称	路径	类型	说明
命令结果	TasksSetOutputDataResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

设置 Orchestrator 辅助角色维护模式

操作 ID:: SetOrchestratorWorkerMaintenanceMode

将 IA-Connect Orchestrator 中定义的 IA-Connect 辅助角色放入维护模式（因此流未分配给辅助角色），或使辅助角色退出维护模式。

参数

名称	密钥	类型	说明
辅助角色 ID	WorkerId	integer	辅助角色的 ID。这是业务流程协调程序内部的整数值（1 或更高）。可以通过在 Orchestrator UI 中查看辅助角色详细信息并在浏览器 URL 中查找 ID 来确定辅助角色的 ID。如果要按名称搜索辅助角色，请将此值设置为 0，并在“辅助角色名称”字段中输入名称。
工作人员姓名	WorkerName	string	辅助角色的名称。这将导致 Orchestrator 搜索其具有指定名称的辅助角色列表。按名称搜索时，将“辅助角色 ID”设置为 0（若要禁用使用辅助角色 ID）。
维护模式	MaintenanceMode	boolean	设置为 true（默认值），以启用维护模式，因此不会将流分配给辅助角色。设置为 false 以离开维护模式，允许将流分配给辅助角色（假设其他规则不会拒绝该辅助角色）。

名称	路径	类型	说明
命令结果	SetOrchestratorWorkerMaintenanceModeResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

设置剪贴板

操作 ID:: SetClipboardData

设置 IA-Connect 代理用户会话中剪贴板的内容。

参数

名称	密钥	必需	类型	说明
新建剪贴板数据	NewClipboardData		string	要设置在剪贴板中的数据。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置屏幕阅读器

操作 ID:: SetScreenReader

启用或禁用 IA-Connect 代理用户会话中的屏幕阅读器。

参数

名称	密钥	必需	类型	说明
启用屏幕阅读器	EnableScreenReader		boolean	如果设置为 true，则将启用屏幕阅读器。如果设置为 false，屏幕阅读器将被禁用。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置文件夹的所有者

操作 ID:: SetOwnerOnFolder

设置运行 IA-Connect 代理的计算机上的文件夹的所有者。

参数

名称	密钥	必需	类型	说明
文件夹路径	FolderPath	True	string	文件夹的完整路径。必须可从运行 IA-Connect 代理的会话中访问此功能。
用户标识	UserIdentity	True	string	要分配所有权的用户的标识。这可以采用“username”、“DOMAIN\username”或“username@domainfqdn”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置默认打印机

操作 ID:: SetDefaultPrinter

在 IA-Connect 代理会话中设置用户的默认打印机。

参数

名称	密钥	必需	类型	说明
默认打印机名称	DefaultPrinterName	True	string	用户的默认打印机的名称。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置鼠标乘数

操作 ID:: SetMouseMultiplier

在 IA-Connect 代理用户会话中设置全局鼠标乘数。如果在远程桌面缩放时遇到问题，这在开发过程中非常有用。

参数

名称	密钥	必需	类型	说明
X 乘数	MouseXMultiplier		double	要设置的水平（X）全局鼠标乘数（对于代理移动鼠标时）。当禁用“多重监视器功能”时，乘数才有任何影响。
Y 乘数	MouseYMultiplier		double	要设置的垂直（Y）全局鼠标乘数（对于代理移动鼠标时）。当禁用“多重监视器功能”时，乘数才有任何影响。
应用于mouse_event	ApplyToMouseEvent		boolean	此参数指定是否将全局鼠标乘数值应用于 mouse_event 方法。
应用于 SetCursorPos	ApplyToSetCursorPos		boolean	此参数指定是否将全局鼠标乘数值应用于 SetCursorPos 方法。
应用于当前鼠标移动方法	ApplyToCurrentMouseMoveMethod		boolean	此参数指定是否将全局鼠标乘数值应用于当前鼠标移动方法（例如：如果 SetCursorPos 是当前鼠标移动方法，则乘数将应用于 SetCursorPos）。如果设置为 true，则忽略输入“应用于 mouse_event”和“应用于 SetCursorPos”。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置鼠标光标位置

操作 ID:: SetCursorPos

将 IA-Connect 代理用户会话中的鼠标光标设置为指定位置。 setcursorpos API 用于移动鼠标，而不考虑选择的活动鼠标移动 API。

参数

名称	密钥	必需	类型	说明
X 像素	X	True	integer	X 坐标值（以像素为单位）。
Y 像素	Y	True	integer	Y 坐标值（以像素为单位）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

设置鼠标移动方法

操作 ID:: SetMouseMoveMethod

将当前鼠标移动方法设置为mouse_event或 setcursorpos。

参数

名称	密钥	必需	类型	说明
设置鼠标移动方法	MouseMoveMethod	True	string	提供鼠标移动方法（mouse_event或 setcursorpos）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

转换矩形坐标

操作 ID:: ConvertRectangleCoordinates

将矩形像素坐标从虚拟转换为物理或物理坐标转换为虚拟。如果要转换点，只需设置 Right=Left 和 Bottom=Top 即可。物理坐标直接映射到监视器上的像素。虚拟坐标是 DPI 缩放的。如果所有显示设备的基础显示缩放为 100%，则物理坐标和虚拟坐标相同。

参数

名称	密钥	必需	类型	说明
矩形左边缘屏幕像素 X 坐标	RectangleLeftPixelXCoord	True	integer	要转换的矩形的左像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
矩形上边缘屏幕像素 Y 坐标	RectangleTopPixelYCoord	True	integer	要转换的矩形的上像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
矩形右边缘屏幕像素 X 坐标	RectangleRightPixelXCoord	True	integer	要转换的矩形的右像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
矩形下边缘屏幕像素 Y 坐标	RectangleBottomPixelYCoord	True	integer	要转换的矩形的下像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
转换类型	ConversionType	True	string	转换类型：从物理到虚拟（PhysicalToVirtual 或 P2V）或虚拟到物理（VirtualToPhysical 或 V2P）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
已转换矩形左边缘屏幕像素 X 坐标	ConvertedRectangleLeftPixelXCoord	integer	已转换矩形的左像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
转换后的矩形上边缘屏幕像素 Y 坐标	ConvertedRectangleTopPixelYCoord	integer	已转换矩形的上像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
转换后的矩形右边缘屏幕像素 X 坐标	ConvertedRectangleRightPixelXCoord	integer	转换后的矩形的右像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
转换后的矩形下边缘屏幕像素 Y 坐标	ConvertedRectangleBottomPixelYCoord	integer	已转换矩形的底部像素边缘。可以位于虚拟或物理像素中，具体取决于转换类型。
转换后的矩形宽度	ConvertedRectangleWidth	integer	转换后的矩形的宽度（以像素为单位）。可以位于虚拟或物理像素中，具体取决于转换类型。
转换后的矩形高度	ConvertedRectangleHeight	integer	转换后的矩形的高度（以像素为单位）。可以位于虚拟或物理像素中，具体取决于转换类型。

运行 PowerShell 进程

操作 ID:: RunPowerShellProcess

启动 PowerShell 进程，在磁盘上运行现有脚本，或提供要执行的脚本的内容。请考虑改用“运行 PowerShell 脚本”作，这更强大，并提供 PowerShell 脚本输出的数据表。如果 PowerShell 脚本输出到标准输出或标准错误（例如，使用 Write-Host 而不是返回表），则需要 PowerShell 7，或者以替代用户身份运行 Active Directory作，而通过 WinRM 的 CredSSP 不可用。

参数

名称	密钥	必需	类型	说明
PowerShell 可执行文件	PowerShellExecutable		string	PowerShell 可执行文件的路径。保留为默认的“PowerShell.exe”，以运行 Windows 路径中定义的默认 PowerShell 可执行文件。对 PowerShell 5.x 使用“%SYSTEMROOT%\system32\WindowsPowerShell\v1.0\PowerShell.exe”。对 PowerShell 7 使用“C:\Program Files\PowerShell\7\pwsh.exe”。 IA-Connect 代理将展开路径中的任何环境变量。
PowerShell 脚本文件路径	PowerShellScriptFilePath		string	要执行的现有 PowerShell 脚本的路径。 IA-Connect 代理（例如，如果代理在远程会话中运行），该脚本应位于远程系统上，或者可从远程系统访问）。或者，将此输入留空，并在输入“PowerShell 脚本内容”中提供 PowerShell 脚本的内容。 IA-Connect 代理将展开路径中的任何环境变量。
PowerShell 脚本内容	PowerShellScriptContents		string	要执行的 PowerShell 脚本的内容，而不是提供现有 PowerShell 脚本的路径。
工作文件夹	WorkingDirectory		string	PowerShell 脚本的工作文件夹/目录。 IA-Connect 代理将展开路径中的任何环境变量。
不创建窗口	CreateNoWindow		boolean	如果设置为 true（默认值），PowerShell 脚本将不可见地运行。如果设置为 false，将显示 PowerShell 脚本窗口。如果 PowerShell 脚本提示输入，并且你计划使用 UIA 和全局鼠标和键盘作与之交互，这可能很有用。
窗口样式	WindowStyle		string	如果 PowerShell 脚本配置为明显运行，请提供窗口样式（正常、最大化、最小化或隐藏）。
等待进程	WaitForProcess		boolean	IA-Connect 代理是否应等待 PowerShell 脚本完成？默认情况下，这设置为 true，以允许 IA-Connect 代理从脚本获取输出。对于火灾和忘记，设置为 false。
重定向标准输出	RedirectStandardOutput		boolean	如果设置为 true（默认值），则会重定向脚本的标准输出，从而允许代理在 StandardOutput 变量中返回它。如果要将脚本的输出返回到代理（例如来自 Write-Host的输出），这非常有用。
重定向标准错误	RedirectStandardError		boolean	如果设置为 true，则会重定向脚本的标准错误，从而允许代理在 StandardError 变量中返回它。
将标准错误重定向到输出	RedirectStandardErrorToOutput		boolean	如果设置为 true，脚本的标准错误将重定向到标准输出，将它们合并到单个输出中。
标准输出编码	StandardOutputEncoding		string	提供标准输出编码（UTF8、UTF7、UTF16、ASCII 或 UTF16BE）。
标准错误编码	StandardErrorEncoding		string	提供标准错误编码（UTF8、UTF7、UTF16、ASCII 或 UTF16BE）。
RunAs 域名	RunAsDomain		string	作为用户运行的域。如果未指定域，则用户名应采用username@domainFQDN格式。
RunAs 用户名	RunAsUsername		string	作为用户运行的用户名。
RunAs 密码	RunAsPassword		password	以用户身份运行的密码。
RunAs 加载用户配置文件	RunAsLoadUserProfile		boolean	是否应在加载用户时加载运行的 Windows 用户配置文件？
RunAs 提升	RunAsElevate		boolean	PowerShell 脚本是否应提升运行？接受提升请求可能非常困难。
超时（秒）	TimeoutInSeconds		integer	等待 PowerShell 脚本完成的最大秒数。
PowerShell 脚本临时文件夹	PowerShellScriptTempFolder		string	默认情况下，如果在输入“PowerShell 脚本内容”中提供 PowerShell 脚本，IA-Connect 代理会通过 -File 输入将脚本保存到文件“%TEMP%\IA-Connect\TempPowerShell-{Date}-{Time}.ps1', passes it to PowerShell.exe，并在脚本完成后删除该文件。如果使用 RunAs 用户名，则此默认路径可能不可接受，因为 RunAs 用户可能无法访问运行 IA-Connect 代理的帐户的配置文件。使用此输入提供备用文件夹。例如：“%SYSTEMDRIVE% emp”。 IA-Connect 代理将展开路径中的任何环境变量。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
进程已启动	ProcessStarted	boolean	如果启动 PowerShell 脚本进程（PowerShell.exe），则返回 true。
退出代码	ExitCode	integer	返回 PowerShell 脚本进程（PowerShell.exe）退出代码。
进程超时	ProcessTimedOut	boolean	如果 PowerShell 脚本进程（PowerShell.exe）超时，则返回 true。
进程 ID	ProcessId	integer	已启动的 PowerShell 脚本进程（PowerShell.exe）的进程 ID。
标准输出	StandardOutput	string	标准输出内容。
标准错误	StandardError	string	标准错误内容。

运行从控制器发送的备用 IA-Connect 代理

操作 ID:: RunAlternativeIAConnectSentFromDirector

通过从 IA-Connect 控制器上传备用代理，然后加载备用代理可执行文件来运行备用 IA-Connect 代理（例如更高版本）。

参数

名称	密钥	必需	类型	说明
本地文件名	LocalFilename	True	string	可从 IA-Connect 控制器访问的备用 IA-Connect Agent.exe 的完整路径。
远程文件名	RemoteFilename		string	要复制备用 IA-Connect Agent.exe（在远程系统上）的位置的完整路径。如果未指定，则将选择临时文件名。如果将备用 IA-Connect 代理加载到内存中，则除非将“保存到磁盘”设置为 true，否则不会创建此文件（因为它不需要）。如果想要使用需要“引用执行程序集”的 IA-Connect 动态代码作（例如访问 IA-Connect 内部方法），则只会将此设置为 true。
压缩	Compress		boolean	IA-Connect 代理可执行文件是否应在上传过程中进行压缩？
Arguments	Arguments		string	运行 IA-Connect Agent.exe 时传递给 IA-Connect Agent.exe 的任何可选参数。
允许降级	PermitDowngrade		boolean	是否应允许早期版本的 IA-Connect 代理？
跳过版本检查	SkipVersionCheck		boolean	是否应该检查 IA-Connect 代理（现有和新）的版本，从而导致所有方案（甚至同一版本）中使用新版本？
加载到内存中	LoadIntoMemory		boolean	是否应在内存中运行备用 IA-Connect 代理？如果设置为 true，则新代理将加载到内存中并在现有代理的程序集中执行。如果设置为 false，则新代理将作为正常进程执行，现有 Agent EXE 将退出。
即使从内存中运行，也保存到磁盘	SaveToDiskEvenIfRunningFromMemory		boolean	是否应将备用 IA-Connect 代理保存到磁盘，即使它正在内存中运行？如果想要使用需要“引用执行程序集”的 IA-Connect 动态代码作（例如访问 IA-Connect 内部方法），则只会将此设置为 true。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
复制的替代文件	AlternativeFileCopied	boolean	报告是否使用了备用 IA-Connect 代理。

运行备用 IA-Connect 代理

操作 ID:: RunAlternativeIAConnect

通过从文件位置加载代理可执行文件来运行备用 IA-Connect 代理（例如更高版本）。

参数

名称	密钥	必需	类型	说明
Filename	Filename	True	string	要运行的替代 IA-Connect Agent.exe 的完整路径。必须可从当前正在运行 IA-Connect 代理的会话访问此路径。
Arguments	Arguments		string	运行 IA-Connect Agent.exe 时传递给 IA-Connect Agent.exe 的任何可选参数。
加载到内存中	LoadIntoMemory		boolean	是否应在内存中运行备用 IA-Connect 代理？如果设置为 true，则新代理将加载到内存中并在现有代理的程序集中执行。如果设置为 false，则新代理将作为正常进程执行，现有 Agent EXE 将退出。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

运行泛型 IA-Connect 代理命令

操作 ID:: RunCommand

运行泛型 IA-Connect 代理命令，将参数作为 JSON 传递，并将输出数据作为 JSON 返回。用于在控制器和检查器版本低于代理时运行代理命令，因此不了解该命令。

参数

名称	密钥	必需	类型	说明
IA-Connect 代理命令名称	CommandName	True	string	IA-Connect Agent 命令的内部名称。命令名称列表可由作“GetAgentActionsInClass”提供。
输入 JSON	InputJSON		string	IA-Connect Agent 命令的输入，采用 JSON 格式。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
输出 JSON	OutputJSON	string	IA-Connect Agent 命令的输出，采用 JSON 格式。

运行进程

操作 ID:: RunProcess

启动进程、命令或应用程序。

参数

名称	密钥	必需	类型	说明
进程名	ProcessName	True	string	要运行的进程。例如 notepad.exe 或 C:\windows\system32\notepad.exe。 IA-Connect 代理将展开路径中的任何环境变量。
Arguments	Arguments		string	启动应用程序时要使用的任何命令行参数。
工作文件夹	WorkingDirectory		string	进程的工作文件夹/目录。 IA-Connect 代理将展开路径中的任何环境变量。
使用 Shell 执行	UseShellExecute		boolean	是否应使用作系统 shell 启动该过程？
不创建窗口	CreateNoWindow		boolean	进程是否应在没有窗口的情况下启动？
窗口样式	WindowStyle		string	提供窗口样式（正常、最大化、最小化或隐藏）。
等待进程	WaitForProcess		boolean	我们应该等待该过程完成吗？只有在运行需要完成的程序或脚本才能继续之前，才可能使用此脚本。
重定向标准输出	RedirectStandardOutput		boolean	是否应重定向标准输出？
重定向标准错误	RedirectStandardError		boolean	是否应重定向标准错误？
将标准错误重定向到输出	RedirectStandardErrorToOutput		boolean	是否应将标准错误重定向到输出？
标准输出编码	StandardOutputEncoding		string	提供标准输出编码（UTF8、UTF7、UTF16、ASCII 或 UTF16BE）。
标准错误编码	StandardErrorEncoding		string	提供标准错误编码（UTF8、UTF7、UTF16、ASCII 或 UTF16BE）。
RunAs 域名	RunAsDomain		string	作为用户运行的域。如果未指定域，则用户名应采用username@domainFQDN格式。
RunAs 用户名	RunAsUsername		string	作为用户运行的用户名。
RunAs 密码	RunAsPassword		password	以用户身份运行的密码。
RunAs 加载用户配置文件	RunAsLoadUserProfile		boolean	是否应在加载用户时加载运行的 Windows 用户配置文件？
RunAs 提升	RunAsElevate		boolean	进程是否应提升运行？
超时（秒）	TimeoutInSeconds		integer	等待进程完成的最大秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
进程已启动	ProcessStarted	boolean	如果进程已启动，则返回 true。
退出代码	ExitCode	integer	返回进程退出代码。
进程超时	ProcessTimedOut	boolean	如果进程超时，则返回 true。
进程 ID	ProcessId	integer	已启动的进程的进程 ID。
标准输出	StandardOutput	string	标准输出内容。
标准错误	StandardError	string	标准错误内容。

配置下一跃点 IA-Connect 控制器

操作 ID:: ConfigureNextHopDirector

在双跃点方案中配置下一跃点控制器。仅当默认 IA-Connect 下一跃点控制器设置不适用时，才需要这样做。

参数

名称	密钥	必需	类型	说明
已启用 SOAP	SOAPEnabled		boolean	是否应在下一跃点控制器上启用 SOAP 接口？
已启用 REST	RESTEnabled		boolean	是否应在下一跃点控制器上启用 REST 接口？
已启用 Web 服务器	WebServerEnabled		boolean	Web 服务器（用于托管 IA-Connect 检查器）是否应在下一跃点控制器上启用？
控制器仅限 localhost	DirectorIsLocalhostOnly		boolean	控制器 SOAP 和 REST 接口是否应仅侦听“localhost”？这应设置为 true，因为其他任何计算机都不需要与这些接口通信。
SOAP TCP 端口	SOAPTCPPort		integer	如果启用了 SOAP 接口，则应在哪个 TCP 端口上运行（默认值为 8002）？
REST TCP 端口	RESTTCPPort		integer	如果启用了 REST 接口，则应在哪个 TCP 端口上运行（默认值为 8002）？
SOAP 使用 HTTPS	SOAPUsesHTTPS		boolean	SOAP 接口是否使用 HTTPS（而不是 HTTP）？如果设置为 True，则需要在第一跃点计算机上提供证书来方便 HTTPS。这可与用于 REST 的证书共享。
REST 使用 HTTPS	RESTUsesHTTPS		boolean	REST 接口是否使用 HTTPS（而不是 HTTP）？如果设置为 True，则需要在第一跃点计算机上提供证书来方便 HTTPS。这可与用于 SOAP 的证书共享。
按 SessionId 递增控制器 TCP 端口	IncrementDirectorTCPPortBySessionId		boolean	为了确保控制器 TCP 端口是唯一的（如果同一个第一跃点主机使用双跃点的多个并行会话），可以将第一跃点会话 ID 添加到控制器 TCP 端口。只有在第一跃点控制器上启用了 SOAP 或 REST，并且通常不会启用它们，因为默认使用命名管道。
SOAP 使用用户身份验证	SOAPUsesUserAuthentication		boolean	如果希望 HTTP SOAP TCP 端口使用用户身份验证，则设置为 True。有关如何设置此内容的信息，请参阅 IA-Connect 安装指南。
REST 使用用户身份验证	RESTUsesUserAuthentication		boolean	如果希望 HTTP REST TCP 端口使用用户身份验证，则设置为 True。有关如何设置此内容的信息，请参阅 IA-Connect 安装指南。
已启用命令命名管道	CommandNamedPipeEnabled		boolean	第一跃点代理是否应使用命名管道与第一跃点控制器通信？这是默认通信方法。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

重置 IA-Connect 命令统计信息

操作 ID:: ResetCommandStats

重置当前存储的任何统计信息，IA-Connect 代理在当前会话中执行的命令。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

重置下一跃点 IA-Connect 控制器设置

操作 ID:: ResetNextHopDirectorSettings

重置已设置的任何自定义 IA-Connect 控制器设置，还原默认设置。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

锁定会话

操作 ID:: LockSession

锁定运行 IA-Connect 代理的会话。

参数

名称	密钥	必需	类型	说明
在作处于非活动状态几分钟后锁定	LockAfterMinutesOfActionInactivity		integer	如果设置为大于 0 的值，则代理不会立即锁定，而是在指定的作非活动分钟数后锁定（代理未接收任何作）。这样，当有许多流回回运行时，代理会不断锁定和解锁。设置为 0 以立即锁定。默认值为 5 分钟。
锁定后等待的秒数	SecondsToWaitAfterLock		integer	锁定后，等待指定的秒数。这为会话提供完全锁定的时间。如果预期锁定后立即启动解锁事件（即另一个会话启动）的可能性，这通常使用，如果上一个会话仍在锁定，则可能会失败。仅当“作处于非活动分钟后锁定”设置为 0（导致立即锁定）时使用。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
命令结果	LockSessionResult	boolean	命令的结果（成功或失败）。
错误消息	ErrorMessage	string	如果命令未成功，将包含返回的错误消息。

附加到最新的 IA-Connect 会话

操作 ID:: AttachToMostRecentIAConnectSession

附加到最近连接的 IA-Connect 控制器会话（可选为指定类型）。这是将命令发送到 IA-Connect 代理的会话。

参数

名称	密钥	必需	类型	说明
搜索 IA-Connect 会话类型	SearchIAConnectSessionType		string	要搜索的会话类型，例如，任何类型的远程会话的“本地代理”、“Microsoft RDP”、“Citrix ICA”或“Remote”。留空以搜索任何会话类型。
等待时间（以秒为单位）	TimeToWaitInSeconds		integer	如果没有指定类型的会话（如果指定了特定类型），应 IA-Connect 等待多长时间？
如果超时，引发异常	RaiseExceptionIfTimedout		boolean	如果新会话在超时期限过前未连接，IA-Connect 是否应引发异常？
必须连接虚拟通道	VirtualChannelMustBeConnected		boolean	IA-Connect 控制器是否应在附加到会话时验证虚拟通道是否已连接？这可确保 IA-Connect 代理在指定的会话中运行。
仅计算之前未看到的会话数	OnlyCountSessionsNotSeenBefore		boolean	如果设置为 true，则之前运行的“获取可用 IA-Connect 会话”作（或 IA-Connect 检查器查看会话）将不会在索引中计数。这仅允许对“new”会话进行计数（例如附加到第一个新的 Citrix 会话）。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
附加 IA-Connect 会话名称	AttachedIAConnectSessionName	string	附加到 IA-Connect 会话的名称。
附加到会话	AttachedToSession	boolean	如果 IA-Connect 已附加到会话，则返回 true;否则返回 false。

附加到第 1 层 IA-Connect 会话

操作 ID:: AttachToTier1IAConnectSession

附加到接收 SOAP 和/或 REST 消息的控制器 IA-Connect 控制器会话。这是将命令发送到 IA-Connect 代理的会话。

参数

名称	密钥	必需	类型	说明
必须连接虚拟通道	VirtualChannelMustBeConnected		boolean	IA-Connect 控制器是否应在附加到会话时验证虚拟通道是否已连接？这可确保 IA-Connect 代理在指定的会话中运行。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

名称	路径	类型	说明
附加的第 1 层 IA-Connect 会话名称	AttachedTier1IAConnectSessionName	string	连接到的第 1 层 IA-Connect 会话的名称。

鼠标中间按钮向下键

操作 ID:: MiddleMouseButtonDown

在 IA-Connect 代理用户会话中按（且未释放）鼠标中间按钮。若要释放鼠标，请使用鼠标中间按钮向上作。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

鼠标右键向上键

操作 ID:: RightMouseButtonUp

在 IA-Connect 代理用户会话中释放鼠标右键。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

鼠标右键向下键

操作 ID:: RightMouseButtonDown

在 IA-Connect 代理用户会话中按右鼠标按钮（且未释放）。若要释放鼠标，请使用鼠标右键向上作。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

鼠标向右按住

操作 ID:: RightHoldMouse

将鼠标右键保存在指定秒数的 IA-Connect 代理用户会话中。

参数

名称	密钥	必需	类型	说明
要保留的秒数	SecondsToHold	True	double	按住鼠标右键的秒数。
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

鼠标左键向上

操作 ID:: LeftMouseButtonUp

在 IA-Connect 代理用户会话中释放鼠标左键。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）

鼠标左键向下键

操作 ID:: LeftMouseButtonDown

在 IA-Connect 代理用户会话中按（且未释放）鼠标左键。若要释放鼠标，请使用鼠标左键向上作。

参数

名称	密钥	必需	类型	说明
Workflow	Workflow	True	string	在此处添加以下表达式：workflow（）