UiPath Marketplace

优质内容标准

确定用例

即用型自动化的理想用例是有人值守的自动化流程，该流程使组织或部门的每个员工都可以从该自动化中受益。

在聚焦特定用例之前，开发者应该询问以下问题：

是否能让员工将每天处理的任务委派给机器人，例如安排会议、执行研究和运行报告，或者分析、管理和维护数据。
是否能让员工轻松使用自动化。

与工作效率相关的用例就是此类流程的典型示例，在该用例中，员工可以使用 Assistant 触发有人值守的机器人，该机器人将快速向他提示有关会议参加者、说明和时间限制的表单。机器人会获取此信息，并自动比较受邀者和会议室日历中的选项。然后，系统会显示会议日期、时间和房间选项，供用户进行最终验证，确认后，机器人会发出会议邀请。

针对高业务价值的建议

强烈建议使用可在 MS Office、Adobe Acrobat Reader、Google Chrome 等通用软件上运行的用例，因为如果该用例适用于很少使用的软件，则可能只有有限的最终用户能够从其优势中获益。
如果自动化需要非常高的培训才能配置或使用，那么对于平民开发者来说，即使运行一次该自动化也是令人反感的。很有可能另一个类别（例如“自定义活动”、“解决方案”或“工具”）可能更适合开发此类用例。
用例应具有通用性和可扩展性。例如，考虑一个即用型自动化，该自动化对日常使用的应用程序执行自动登录。如果作用域仅限于一个或两个应用程序，则优势将有限。因此，它应该为更多应用程序提供自动登录功能，或者应该有空间添加更多应用程序。

开发自动化

通常，有人值守的自动化流程适合使用 Assistant 运行。这些流程应设计得更小、更分散，并且可以在人工监督下运行。

即用型自动化的命名

在通过 UiPath Studio 开发现成的自动化流程时，项目的“名称”和“说明”至关重要。每个即用型自动化：
1. 应包含以操作词或动词开头的“名称”。它应该是描述性的，以便用户可以轻松地立即理解其值。
2. 应具有相关且简明的功能“说明”。
3. 在开发自动化时，可以通过 UiPath Studio 中的“项目设置”向导输入“名称”和“说明”，如下所示。
  
  重要提示：
  对于要在 UiPath 市场上发布的列表，您必须在列表的描述中包含有关自动化中使用的或与自动化兼容的 UiPath 产品的所有详细信息，以及它们所扮演的角色。
  
  未经第三方的明确授权，合作伙伴不得在 UiPath Marketplace 上的列表或产品说明文本中包含第三方或第三方应用程序或其他第三方产品的名称。

配置和启动

首次运行时，即用型自动化应显示“启动信息”屏幕，该屏幕会向用户建议此自动化的期望，提及运行自动化之前的所有先决条件，并提供使用说明。

一些有人值守的自动化流程以相同的方式对所有人运行，即当用户在 Assistant 中单击“开始”时，预定义的步骤将在没有任何变化的情况下执行。但在其他情况下，流程的运行方式取决于用户或上下文的唯一参数，例如电子邮件地址、文件夹的位置或消息字符串。在这种情况下，开发者应在 UiPath Studio 中使用参数或可自定义的输入字段构建流程。
在运行即用型自动化的计算机上，对于用户而言通常不会更改的配置详细信息，例如电子邮件服务器、端口、文件路径等应可在“显示流程详细信息”屏幕中作为 Assistant 的参数使用。
UiPath Assistant 只能在“显示流程详细信息”屏幕中显示以下参数类型，因此，如果需要将任何其他类型作为参数传递，则可以使用表单来实现此目的：
- Int32 - 输入一个数字。
- 字符串 - 输入文本。
- 布尔值 - 选中或清除复选框。
- 日期时间 - 选择日期或时间。
工作流不应公开或记录密码或敏感信息。

提供执行状态

应通过标注、自动关闭消息框或屏幕一角的面板在屏幕上传达现成的自动化的临时执行状态。在自动化过程中，此窗口应始终显示在屏幕顶部。它应向与 Assistant 交互的用户提供简短的更新消息或进度条。

实施异常处理，以便用户在发生错误时收到有意义的消息。
如果执行的结果是输出文本，则应将其作为可复制的字符串显示在最终用户的消息框或表单中。
- 例如，下面的列表“缩短我的 URL”链接 - RPA 组件 | UiPath Marketplace会生成输出，您可以复制该输出以供进一步使用。
考虑另一个列表获取我的文件的完整路径 - RPA 组件UiPath 市场。所有输出文件路径均可读取且可复制。

发布流程

由于 UiPath Assistant 只能使用 NuGet 包，因此应在 UiPath Studio 中将所有适用于 Assistant 的现成自动化作为 NuGet 包发布。

最佳实践

NuGet 包应包含以下元数据：

标签：这些是指示自动化类别/功能的相关标签。
许可证 URL：根据您为自动化选择的许可证类型指定许可证 URL。
需要选中许可证接受复选标记。
NuGet 包的名称应使用以下约定：公司名称.<PackageName> 。如果您不隶属于任何公司，则应使用以下约定：<PackageName>。
NuGet 版本从 0.0 开始。发布前所做的每项更改都会增加其“十进制”索引。例如，当我们发布 NuGet 的第一个版本或新版本时，我们将其视为主要更新，因此将其变为 1.0。
ID/dll 中不应包含 UiPath 标签名称。
如果内容已本地化，则即使该字段标记为“可选”，也应指定“语言”。
如果在将自动化发布到 NuGet 后需要编辑元数据，则可以使用NuGet 包资源管理器来完成。
应提供用户指南文档，其中包含运行自动化的必要信息。这是一个示例用户指南模板，可以下载并使用相关信息进行更新。
应提供演示如何使用 UiPath Studio 或 UiPath Assistant 执行自动化的视频演示。有关创建视频的准则，请参阅此页面。

使用 Assistant 测试 NuGet

要测试使用 UiPath Studio 开发的流程是否与 UiPath Assistant 兼容，第一步是在 UiPath Assistant 中安装该流程的 NuGet 包。

要从 Orchestrator 订阅源安装或更新 NuGet 包，必须将机器人连接到 Orchestrator。
成功安装 NuGet 包后，下一步是配置任何可自定义的输入字段。
如果在 UiPath Studio 中使用任何参数开发流程，则必须在 UiPath Assistant 的可自定义输入字段中提供参数。通过在相应流程的三点菜单中单击“显示流程详细信息”，可以在 Assistant 中访问这些字段。
可以保存提供给这些字段的值，以便下次运行自动化时使用这些值。