UiPath Marketplace 用户指南

上次更新日期 2024年9月5日

内容

解决方案加速器的结构

您的“解决方案加速器”需要符合以下文件夹结构，以在所有“解决方案加速器”中保持一致的体验。此文件夹可包含四个文件夹：

部署（如果用户体验为有人值守，例如测试数据管理，则可能不包括在内）
文档
库（如果流程不包含任何库，则可能不包含此内容）
流程

尽管某些元素在每个解决方案加速器中保持一致（例如文件夹结构），但解决方案加速器可能会受到解决方案加速器中使用的特定用例和 UiPath 产品的影响。下表列出了每个解决方案加速器中的一致项目：

部署	文档	库	流程
资产详细信息队列详细信息解决方案管理包任何库 NUPKG 文件任何其他自定义活动	解决方案加速器 – 加速器概述解决方案加速器 – 部署指南解决方案加速器 – 技术文档高级解决方案设计（.pdf 和原始编辑文件，例如 .vsdx）详细的解决方案设计（.pdf 和原始编辑文件，例如 .vsdx）	每个库的单独子文件夹	每个流程的单独子文件夹

2. 部署文件夹

A.资产详细信息

资产表示可在解决方案加速器中的不同自动化项目中使用的共享变量或凭据。资产详细信息是与Orchestrator 管理器兼容的 Microsoft Excel 工作簿文件 (.xlsx)，后者是一种利用 Orchestrator 的 API 来操作实体的工具。此工作簿使用户可以轻松查看和添加在整个 Solution Accelerator 中使用的资产。

根据下面的示例，此工作簿预计有两个工作表：“创建”以创建“文本”、“布尔”和“整数”资产，以及“创建凭据”以创建凭据资产。下表定义了每个工作表所需的标头和标头顺序，以及每行中的信息。

文件夹名称¹	资产名称¹	说明¹	作用域¹	机器人名称或用户的用户名¹	类型¹	值¹	资产 ID ²	结果²
采购订单处理	`Dispatcher_PurchaseOrdersEmailsSourceAccount`	我们需要处理的采购订单文档电子邮件所在的邮箱。	全局		文本	替换为特定值

¹⁾列从操作接收输入，例如要创建的资产的名称、类型和值。

²⁾ Orchestrator 管理器用于写入从 Orchestrator 检索的数据（例如已创建资产的 ID）的列。执行下一次“创建” /“创建凭据” 操作时，系统会覆盖此处的值。

创建

文件夹名称¹	资产名称¹	说明¹	作用域¹	机器人名称¹或用户的用户名¹	类型¹	值¹	资产 ID ²	结果²
指定新式文件夹的子文件夹名称时，需要输入父文件夹的完整名称（包括其上级），并用正斜杠字符 (/) 分隔。示例：如果名为“WorkGroup1”的新式文件夹是名为“DepartmentA”的新式文件夹的子文件夹，则 WorkGroup1 的完整名称为“DepartmentA/WorkGroup1”。	资产的名称。名称最多只能包含 256 个字符。	资产说明。说明最多只能包含 250 个字符。	根据 Orchestrator 中可用的资产作用域，“作用域” 字段具有固定数量的可能值：全局机器人（仅在传统文件夹中可用）用户（仅在新式文件夹中可用）。	在为每个机器人创建资产时，使用“机器人名称” 或“用户的用户名” 字段指定应有权访问正在定义的资产值的机器人的名称。机器人必须与所创建的每个机器人的资产位于同一文件夹中。必须在单独的行中指定多个机器人的值，并使其具有相同的文件夹名称、资产名称、作用域和类型。	根据 Orchestrator 中可用的资产类型，“类型” 字段有固定数量的可能值：文本 Bool 整数	资产的值。如果资产值需要由用户定义，则应写为“用特定值替换”。此字段必须包含以下内容：文本类型最多 1,000,000 个字符对于整数类型，介于 2147483648 和 2147483648 之间的值对于 Bool 类型，值为 TRUE 或 FALSE。	创建资产的 ID（如果已成功创建资产）。	资产创建的结果 – 成功或失败。

¹⁾列从操作接收输入，例如要创建的资产的名称、类型和值。

创建凭据

文件夹名称¹	资产名称¹	说明¹	作用域¹	机器人名称或用户的用户名¹	用户名¹	密码¹	资产 ID ²	结果²
指定新式文件夹的子文件夹名称时，需要输入父文件夹的完整名称（包括其上级），并用正斜杠字符 (/) 分隔。示例：如果名为“WorkGroup1”的新式文件夹是名为“DepartmentA”的新式文件夹的子文件夹，则“WorkGroup1”的完整名称为“DepartmentA/WorkGroup1”。	资产的名称。名称最多只能包含 256 个字符。	资产说明。说明最多只能包含 250 个字符。	根据 Orchestrator 中可用的资产作用域，“作用域” 字段具有固定数量的可能值：全局机器人（仅在传统文件夹中可用）用户（仅在新式文件夹中可用）。	在为每个机器人创建资产时，使用“机器人名称” 或“用户的用户名” 字段指定应有权访问正在定义的资产值的机器人的名称。机器人必须与所创建的每个机器人的资产位于同一文件夹中。必须在单独的行中指定多个机器人的值，并使其具有相同的文件夹名称、资产名称、作用域和类型。	用户名字段。由于这是由最终用户提供的，因此此字段在每一行中应始终包含“用特定值替换”。	密码字段。由于这是由最终用户提供的，因此此字段在每一行中应始终包含“用特定值替换”。	创建资产的 ID（如果已成功创建资产）。	资产创建的结果 – 成功或失败。

¹⁾列从操作接收输入，例如要创建的资产的名称、类型和值。

b.队列详细信息

队列是一个容器，可用于存储不限数量的项目。队列项目可以存储多种类型的数据，例如发票信息或客户详细信息。队列使您能够创建大型自动化项目，例如带有下划线的复杂逻辑的“解决方案加速器”。

“队列详细信息”是与Orchestrator 管理器兼容的 Microsoft Excel 工作簿文件 (.xlsx)，后者是一种利用 Orchestrator 的 API 来操作实体的工具。此工作簿使用户可以轻松查看和添加在整个 Solution Accelerator 中使用的队列

根据下面的示例，此工作簿预计会有一个工作表：“创建”以创建所有队列。下表定义了工作表所需的标头和标头顺序，以及每行中的信息。橙色标头列接收来自操作的输入，例如要创建的队列的名称、说明和最大重试次数。 Orchestrator Manager 使用灰色标头列写入从 Orchestrator 检索到的数据，例如已创建队列的 ID。执行下一次“创建”操作时，系统会覆盖此处的值。

文件夹名称	队列名称	描述	Unique Reference	Auto Retry	Max # of Retries	资产 ID	结果
指定新式文件夹的子文件夹名称时，需要输入父文件夹的完整名称（包括其上级），并用正斜杠字符 (/) 分隔。示例：如果名为“WorkGroup1”的新式文件夹是名为“DepartmentA”的新式文件夹的子文件夹，则 WorkGroup1 的完整名称为“DepartmentA/WorkGroup1”。	队列的名称。名称不能包含任何空格。名称最多只能包含 50 个字符。	队列的说明。说明最多只能包含 250 个字符。	强制事务具有唯一的引用。必须为“是” 或“否”。	启用队列中因系统异常而失败的事务项目自动重试。必须为“是” 或“否”。	队列中事务项目的最大重试次数。如果“自动重试”为“是”，则必须至少为 1。可以是 1 到 50 之间的整数。	创建队列的 ID（如果队列创建成功）。	队列创建的结果 – 成功或失败。

C.解决方案管理包

“解决方案加速器”是在 UiPath Platform 上开发的多个组件（流程、资产、队列等）的捆绑包，这些组件协同工作以自动化业务用例。 UiPath 解决方案管理提供了一种开箱即用的方法，用于管理解决方案加速器组件构建后的生命周期。一旦解决方案加速器的开发完成，并且您希望轻松地将其组件升级到新环境，这组功能将发挥作用。

通过“解决方案管理”，您可以在开发解决方案加速器的 Orchestrator 环境中方便地将这些组件打包到单个文件中。有关如何创建解决方案管理包的指南，请参阅创建解决方案项目。

为解决方案加速器创建解决方案管理包时的一些要求和注意事项：

任何“凭据”资产都应包含“用户名”和“密码”字段，且该字段的值为“用特定值替换”，因为这些值是由最终用户提供的。
任何特定于最终用户的资产（例如目标电子邮件地址或环境 URL）也应具有“用特定值替换”值。
解决方案管理 Zip 的命名约定应为“解决方案加速器名称 1.0.0” 其中“解决方案加速器名称”是“解决方案加速器”的名称，其中“1.0.0”是“解决方案管理”zip 的解决方案项目版本。
所有存储桶和触发器都将包含在“解决方案管理”zip 中。存储桶和触发器不能包含在手动部署中，并且必须在部署指南文档中说明为手动创建。
“解决方案管理”zip 中不应包含流程。如果不修改解决方案加速器特定于环境和过程的增强功能，流程预计将无法立即运行。
如果无论如何都要修改自定义库，则不应将其包含在解决方案管理包中，因为如果不进行修改，它不会立即起作用。

D.库 NUPKG 文件

库是一个项目，其中包含一个或多个工作流，这些工作流可作为活动在其他项目中重用。这使您的解决方案加速器能够在每个单独的流程中使用通用代码。有关创建库的信息，请参阅库文档中的 “创建库”部分。有关为解决方案加速器创建库的开发标准的信息，请参阅“库开发”部分。库在发布时会另存为 NUPKG 文件，并且可以从包管理器作为依赖项进行安装。可以将库发布到本地文件夹，也可以从 NuGet 包订阅源发布和下载，以检索相关的 NUPKG 文件。

重要提示：

如果可重用库被设计为开箱即用，无需任何修改，请将其包含在“部署”文件夹中。

如果需要修改库以在项目中正常工作，则预计不会将其包含在部署文件夹中，并且部署指南应明确指出，需要使用以下命令在任何项目中修改、发布库并更新依赖项该库。

如果在订阅源上单独发布可重用库，例如 UiPath解决方案加速器通用可重用库，则不需要包含 NUPKG 文件。

e.任何其他自定义活动

您可以创建自己的自定义活动，以便在 UiPath Studio 项目中使用。要使用创建的自定义活动，您必须在解决方案加速器项目中安装包含该活动的 NuGet 包，方法是从 UiPath Studio 访问包管理器并安装 NUPKG。应在完成自定义活动后创建该 NuGet 包。 NUPKG 可以包含在解决方案加速器的部署文件夹中。

3. 文档

文档结构必须遵循以下准则：

解决方案加速器 – 加速器概述
解决方案加速器 – 部署指南
解决方案加速器 – 技术文档
高级解决方案设计（.pdf 和原始编辑文件，例如 .vsdx）
详细的解决方案设计（.pdf 和原始编辑文件，例如 .vsdx）

4. 库

UiPath 库是一个项目，其中包含一个或多个工作流，这些工作流可作为活动在其他项目中重用。库在发布时会另存为 NUPKG 文件，并且可以从包管理器作为依赖项进行安装。只能使用“库”类型的项目来开发“库”。任何可重用的用户界面组件也应在库中使用对象存储库来实现。任何 Data Service 实体都应在库中导入，以便通过导入库在整个解决方案加速器中使用相同的引用/命名空间。通过在库中导入，命名空间在不同流程中不会发生冲突。

库具有以下要求：

项目类型	库项目
流程大小和工作流命名约定	小型且定义良好的 XAML 命名：使用“首字母大写”的命名方式（其间使用空格），而非帕斯卡拼写法。如果工作流首选帕斯卡拼写法，则仍可通过“活动布局”的“显示名称”字段（右键单击“项目资源管理器”中的“工作流”菜单选项））。
批注	在每个工作流文件上添加固定注释作为免责声明/说明使用适当的描述性解释来标注活动
变量命名约定	小驼峰式命名法（例如， firstName、lastName、myOrganizationSture ）
参数命名约定	应使用帕斯卡拼写法标准命名参数。参数名称不应包含in_/out_/io_ 前缀，因为在创建库时这些参数将显示为属性。每个参数都应存在注释，因为在使用“库” 活动时会显示注释
参数结果	根据工作流名称的描述，应为“库”工作流工作流应解析任何 API 或 GUI 结果并返回特定的数据结果
注释	添加注释以提高库项目的可读性
Data Service 实体	可以在库中导入 Data Service 实体。命名空间应为实体的名称。 Data Service 操作可以在库中进行，以提高实体在整个解决方案加速器中的可重用性。
异常处理	库中的错误应作为异常引发，而不是通过输出参数发出信号。最后，通过检查所需操作是否已发生来确认库组件的结果，如果未发生，则引发异常。

5. 流程

流程是使用流程设计选项开发的 UiPath 项目，可由 UiPath 机器人执行。任何新的“流程”项目都应为“跨平台项目”或“ Windows 项目” 。 Windows – 旧版使用 .NET Framework 的较旧版本，在不久的将来新项目将不再提供该选项。不应在流程中导入 Data Service 实体。在单个流程中导入可能会导致整个解决方案加速器中的命名空间发生冲突。

流程具有以下要求：

项目类型	Windows 项目跨平台项目
流程大小	小型且边界明确的流程
批注	在每个工作流文件上添加固定注释，作为免责声明/说明。典型格式描述了工作流的目的，同时解释了要发送、发送和输入/输出的每个参数使用适当的描述性解释来标注活动
变量命名约定	在整个自动化流程中保持一致的变量命名约定对于提高可读性和清晰度非常重要 UiPath 开发者遵循的典型标准是小驼峰式命名法（例如，名字、我的名字、姓氏、我的组织结构）
参数命名约定	带前缀的小驼峰式命名法，将参数类型指明为 in、out 或 in/out，例如in_defaultTimeout、in_fileName、out_textResult 和 io_retryNumber 。每个参数都应存在注释，因为在调用工作流时会显示注释
注释	在适当的位置添加注释活动，以突出显示配置区域/需要根据客户场景更改逻辑的区域
Data Service 实体	不应在流程中导入 Data Service 实体。应在常用库中导入 Data Service 实体，以避免命名空间冲突。 “数据服务”操作可以在从库导入的具有命名空间的流程中进行。
图层	应用程序层（可以对特定应用程序使用 API 或用户界面自动化，但这由开发者自行决定）业务逻辑层/实施层