- 入门指南
- 使用编码Apps
- Studio Web 中的编码 Apps
- Coded Action Apps
- 关于编码操作Apps
- 构建和部署编码操作Apps
- 编码操作示例Apps
构建和部署编码操作Apps
在 UiPath 中构建和部署编码操作应用程序:开始之前需要准备、应用程序如何与 Action Center 交换数据、如何在本地测试,以及如何将其部署为任务界面。
编码操作应用程序具有与任何编码应用程序相同的生命周期:它在代码中定义,连接到 UiPath,部署到 Orchestrator,然后用作 Action Center 任务的界面。
该流程包括以下阶段:
- 在集成开发环境 (IDE) 中定义操作应用程序逻辑。
- 与 UiPath 建立安全连接。
- 将操作应用程序部署到 Orchestrator。
- 使用 Action 应用作为 Action Center 任务的用户界面。编码操作应用程序可以作为通过所有界面(包括智能体、RPA 流程和 Maestro 流程)创建的任务的界面。
在开始之前
确保满足以下条件:
- 包含 Node.js 20.x 或更高版本和 npm 的本地开发环境,用于构建应用程序和安装 UiPath 工具。从nodejs.org下载安装程序,其中包括 npm。要查看已安装的内容,请运行
node -v和npm -v。 - 安装了
codedapp工具的 UiPath CLI。有关安装说明,请参阅UiPath CLI指南。 - 在您作为目标的 Orchestrator 文件夹中发布包和部署应用程序的权限。
操作应用程序可能还需要外部应用程序 ID,具体取决于其功能:
| 如果您的操作应用程序 | 需要外部应用程序 ID |
|---|---|
| 仅读取并完成任务 | 否 |
| 同时调用其他 UiPath 服务,例如 Orchestrator 或 Data Fabric | 是 |
如果需要外部应用程序 ID,则其必须来自在您的组织中注册的外部应用程序。Action 应用在浏览器中运行,无法存储应用程序密码,因此需要将其注册为具有用户作用域的非机密应用程序。要注册一个,请参阅 《Automation Cloud 管理员指南》中的“添加外部应用程序” 。
构建操作应用程序
编码 Action 应用在 Action Center 呈现的沙盒框架中运行,因此它无法直接读取或写入任务数据。UiPath 编码操作应用程序 SDK弥补了这一差距,使应用程序可以执行四件事:
- 在加载应用程序时接收任务及其数据。
- 在用户编辑表单时通知Action Center,以便启用“保存”按钮。
- 使用用户选择的操作和最终数据完成任务。
- 在 Action Center 中向用户显示消息。
除此之外,UiPath 还会向普通网页项目添加两个一次性设置:
- 与您组织的连接。项目根目录中的小型配置文件可在需要时标识您的组织、租户和外部应用程序 ID。
- 本地开发设置。当应用程序在开发者计算机上运行时,项目构建工具的 UiPath 插件会提供相同的配置,因此可以在部署应用程序之前,在真实租户上进行测试。
有关完整的开发者设置,包括 SDK 方法、配置文件、构建工具插件以及应用程序在打包前所需的调整,请参阅编码操作应用程序 SDK文档。
在本地测试 Actions 应用程序
Action Center 为在本地主机上运行的 Coded Action Apps 提供任务模拟体验。只能在 UiPath 端完成两项配置才能正常运行。
将 Action Center 重定向 URI 添加到外部应用程序
将重定向 URI https://<host>/<orgId>/<tenantId>/actions_添加到您的 Action 应用使用的外部应用程序,其中<host>是您登录的环境,例如cloud.uipath.com 。
<orgId>和<tenantId>是 GUID,不是浏览器地址栏中显示的组织和租户名称。缺少条目或使用名称而不是 GUID 的条目将失败,并显示invalid_request或Invalid redirect_uri 。
要检索这两个 GUID,请使用uip login登录,然后运行:
uip login status --output json
uip login status --output json
响应将它们返回为OrganizationId和TenantId 。
通常会在首次部署使用外部应用程序的编码操作应用程序时添加此条目。要读取应用程序发送的确切值,请打开应用程序并在浏览器的“网络”选项卡中从/identity_/connect/authorize请求中复制redirect_uri 。
打开 Action Center 调试页面
- 转到
https://<host>/<orgName>/<tenantName>/actions_/debug/coded-action-app。与重定向 URI 不同,此页面按名称对组织和租户进行编址。 - 输入应用程序的详细信息,然后加载。
部署操作应用程序
部署分两个部分:开发者打包并发布操作应用程序,然后将该包部署到 Orchestrator 文件夹。
打包并发布操作应用程序
编码操作应用程序以.nupkg包的形式发布到 Orchestrator,这与自动化使用的包格式相同。它使用--type Action发布,并会注册它,以便可以将其选为 Action Center 任务的用户界面。
-
构建应用程序:
npm run buildnpm run build -
将构建输出打包:
uip codedapp pack dist -n <appName> --version 1.0.0uip codedapp pack dist -n <appName> --version 1.0.0 -
登录到您的 UiPath 组织:
uip loginuip login -
将包作为 Action 应用发布到租户订阅源或个人工作区订阅源:
uip codedapp publish --type Actionuip codedapp publish --type Action -
部署应用程序:
uip codedapp deployuip codedapp deploy
有关每个命令的完整参数列表,请参阅 UiPath CLI 指南中的uip codedapp 。
从 Orchestrator 部署操作应用程序
如果包已发布,或者您不希望使用命令行,请改为从 Orchestrator 部署 Actions 应用程序。
- 在 Orchestrator 中,转到“租户” > “包” 。
- 选择“上传” ,然后上传由
uip codedapp pack创建的.nupkg文件。有关详细过程,请参阅管理包。 - 转到要部署应用程序的文件夹,然后转到“自动化” > “Apps” 。
- 选择“部署应用程序” ,然后选择您的应用程序及其版本。有关详细过程,请参阅管理应用程序。
从 Studio Web 部署操作应用程序
如果操作应用程序在 Studio Web 解决方案中构建为编码应用程序项目,则其与该解决方案一起打包和部署,而不是单独部署。Action 应用程序的版本与其依赖的工作流、智能体和资源保持同步。
-
在本地构建应用程序,然后将其推送到 Studio Web 项目:
uip codedapp push --project-id <project-id>uip codedapp push --project-id <project-id> -
在 Studio Web 中,打开解决方案,然后选择“部署” 。
-
设置包版本,选择是打包到个人工作区还是共享工作区,为部署命名,选择文件夹,然后选择部署。
有关部署面板中的完整选项,请参阅《Studio Web 用户指南》中的发布和部署解决方案。
部署后,该操作应用程序将在 Action Center 中可用,并且可以分配为任务的界面。