注释可以直接添加到流程、机器人和 API 编辑器中,以标注流程中的特定元素或向 机器人 或 API 任务 自动化逻辑添加注释。
在流程中添加注释可明确业务意图,方便流程编写者说明步骤用途及转换规则,减少对外部文档的依赖。 同样,在使用 机器人 和 API 任务 构建自动化时,您可以添加注释,以便清晰记录每个操作的目的和业务逻辑,便于专业开发人员理解自动化逻辑。 这有助于在设计或审查流程或构建自动化时提高可维护性、可读性和协作性。
添加注释的好处
注释可提供随附于所描述元素的上下文文档,使流程和自动化具备自文档化能力。 以下是在流程、机器人和 API 编辑器中使用注释的主要好处:
- 保留业务意图: 注释会捕捉每个步骤背后的原因——例如为何选择了特定的审批路径,或为何存在某个条件分支——从而确保即使原始编写者离开,业务依据也不会丢失。
- 改善跨团队协作: 当注释同时说明流程中嵌入的业务规则和技术决策时,业务用户、开发人员和管理员便能基于共同的理解开展工作。
- 维护单一事实来源: 由于注释会在保存、导出、导入、复制和重复操作中持续存在,因此记录的上下文会随自动化一起传递,并且不会与外部文档脱节。
- 降低维护成本: 在排查或修改自动化时,行内注释可立即提供有关边缘情况、依赖关系或约束的上下文,从而减少诊断问题或评估变更影响所需的时间。
支持的自动化类型
注释可以添加到机器人和 API 编辑器中的 操作。 在 Process Editor 中,可以向以下元素添加注释:
- 任务(例如任务机器人、API、表单和审批)
- 条件节点(If/Else/Else if 和拆分-合并)
- 事件(开始和结束)
如何添加注释
-
Process Editor
- 从元素面板中拖动一个任务元素(任务机器人、API 任务、表单、流程、AI 坐席或文档提取)。
- 在所选元素的属性面板中,单击添加注释。注: 注释字段可选填。
- 在注释窗口中,在源字段中添加文本,以提供有关该元素的必要上下文、理由和业务规则。 例如,说明为什么选择特定路径,或者为什么存在一个决策节点。 使用预览选项卡查看文本,或使用双重选项卡在源字段中输入并同时查看预览。注: 注释支持纯文本,最大字符限制为 1000 个字符。
- 单击更新以返回编辑器。 注释指示器图标会添加到带注释的元素中。
- 要编辑注释,请单击注释(可选)字段旁边的编辑图标。 要删除注释,请清除“源”字段中的文本,然后单击“更新”。 注释指示器已从元素中移除。
-
机器人或 API 编辑器
- 拖动一个 操作 或拖动来自操作或触发器面板的触发器。
- 在所选 操作 或触发器的属性面板中,单击添加注释。注: 注释字段可选填。
- 在注释窗口中,在源字段中添加上下文信息。 使用预览选项卡查看文本,或使用双重选项卡在源字段中输入并同时查看预览。注: 注释支持纯文本,最大字符限制为 1000 个字符。
- 单击更新以返回编辑器。 注释指示器图标已添加到自动化流程中的 操作 步骤。 单击图标以在“属性”面板中查看注释的详细信息。
- 要编辑注释,请单击注释(可选)字段旁边的编辑图标。 要删除注释,请清除源字段中的文本,然后单击更新。 注释指示器已从 操作 步骤中移除。
使用说明
- 注释在以下操作中保持不变:
- 保存并重新打开流程、机器人或 API
- 复制、剪切、粘贴和复制操作
- 流程、机器人或 API 操作的导出和导入
- 在机器人和 API 编辑器中,所有三种视图都支持注释: 流程、列表和双重。
- 当带有注释的自动化导入到不支持注释功能的 Control Room 中时,注释不会显示。 如果自动化保存在该环境中,注释将被清除。