自定义变量

Insights always ingests data via the pre-defined fields available in the Insights data model, but Admins can also configure custom variables extracted from robot logs and queues to use for calculating specific KPIs or building more specialized dashboards.

提示：

1. 要包括流程的自定义变量 ，必须首先确保通过 Studio 中的UiPath.System.Activities.AddLogFields活动将其添加到自动化中的日志，然后必须选择它们进行提取。
   • 流程自定义变量将与默认的机器人日志（流程已开始/结束）以及使用日志消息活动写入的任何消息一起发送。 如果未填充任何变量，请确保执行写入日志消息活动。
2. 要包括队列的自定义变量，必须首先确保通过 Studio 中的活动将其添加到工作流中，然后选择要提取的变量。
   • 对特定数据使用 UiPath.System.Activities.AddQueueItem 活动；
   • 对输出数据和分析数据使用 UiPath.System.Activities.SetTransactionStatus 活动。
3. 选择自定义变量时，您可以创建可视化。
4. 禁用自定义变量可能会破坏引用变量的现有仪表板。 添加更多自定义变量到同一可视化不会破坏仪表板。
5. 如果您已经在“添加队列项目”活动中添加了自定义字段，则只需将事务项目指定为“成功”或“失败”，而无需填写“输出数据”或“分析数据”属性。 如果未在“添加队列项目”活动中指定字段，则在设置状态时必须将其添加到“设置事务项目”活动中。
6. 使用自定义变量时，建议使用机器人日志获取作业级别信息，使用队列项目获取队列级别信息。将机器人日志与队列一起使用可能会导致意外结果。

在组织范围内的仪表板中使用自定义变量

在组织范围内的仪表板中使用自定义变量时，请考虑以下事项：

• 只有在“租户”视图中从“配置自定义变量”窗口中提取的自定义变量才会显示在组织范围内的自定义变量配置部分中。并非从租户中提取的任何自定义变量都不会显示在组织范围的仪表板中。
• 更改租户范围内的自定义变量时，系统将在组织中禁用组织范围内的自定义变量。请务必在完成所有更改后重新启用它们，以便在仪表板中显示这些更改。
• ROI 和自定义变量部分为只读部分。

配置自定义变量

要配置自定义变量，管理员必须执行以下步骤：

1. 打开任意 Insights 页面右上角的三点菜单，然后选择“配置自定义变量”。系统随即会打开配置页面，其中列出可提取的所有自定义字段。

2. 单击配置页面顶部的相应选项卡，决定是否要为流程或队列配置自定义变量。

   

3. 在“提取”列中，选择构建仪表板时要使用的自定义变量。

4. 在“类型”列中，选择自定义变量的类型。您可以选择“字符串” 、 “数字”或“日期时间” 。

   重要提示：

   • 字段不得超过 40 个字符，并且此数字之后的任何字符都将被剪切。 要添加超过 40 个字符，请更改 Insights.Etl.Json.MaxStringLen 标志。 您可以在 Orchestrator 网页配置中添加此标志，并根据项目需求设置值。 例如：

   <add key="Insights.Etl.Json.MaxStringLen" value="60" />

   • 回填百分比显示从所有流程或队列中提取自定义变量的进度。您需要刷新页面以查看最新的回填百分比。所需时间视数据大小而定。自定义变量值将从最新数据回填到最旧数据。保存配置后，你很快即可使用该字段，而无需等到 100％ 回填。
   • 您最多可以从 500 个流程或队列中提取变量，最多可以从每个流程或队列中提取 200 个变量。
   • 如果您将自定义变量的“类型”配置为“数字”，请确保其不包含 , 或其他非数字字符，例如 $，因为这些字符不受支持。对于包含特殊字符的数字，请选择类型“字符串”。
   • 每次更改自定义变量配置都将导致该特定流程进行全新的回填。回填的时间取决于 Insights 数据库中为该特定流程存储的日志数量。

5. 保存配置。针对特定流程提取的所有变量应显示在名为“*流程 - 流程名称”的探索中，而针对特定队列提取的所有变量应显示在名为“*队列 - 队列名称”的探索中。

   重要提示：

   您最多可以从 500 个流程或队列中提取变量，最多可以从每个流程或队列中提取 200 个变量。

   已配置的自定义变量数	硬件规模	流程数量	每个流程的机器人日志数量	提取的预估时间
   Resolution settings	大规模	1	1,000,000	5 分钟
   Resolution settings	大规模	1	40,000,000	120 分钟

编辑现有配置

要编辑现有配置，管理员必须采取以下步骤：

1. 打开任意 Insights 页面右上角的三点菜单，然后选择“配置自定义变量”。系统随即会打开配置页面，其中列出可提取的所有自定义字段。

2. 通过选择配置页面顶部的相应选项卡，决定是否要为流程或队列配置自定义变量。

3. 要删除以前选择的变量，请取消选中“提取”复选框。

   备注：

   禁用自定义变量可能会破坏引用变量的现有仪表板。 添加更多自定义变量到同一可视化不会破坏仪表板。

4. 要从变量中删除“通用”状态，请取消选中对应复选框。

5. 要更改变量的类型，请从下拉列表中选择所需的新类型。

6. 请务必保存配置。

7. 对曾使用已修改或已删除变量的现有仪表板执行以下检查：

   1. 如果删除了变量，请务必从已创建或修改的公式，从筛选器或可视化图表中删除对变量的任何引用；
   2. 如果更改了变量类型，请确保新类型仍可正确应用；
   3. If the variable no longer has Common status, you need to replace the reference to the common variable with the updated per-process value.

配置示例

本节提供了在仪表板中使用自定义变量的示例。

在下图中，ProcessCount 变量存在于多个流程中，而 Argument1_Email 变量仅出现在一个流程中。

请采取以下步骤配置自定义变量：

1. 选择要提取的 ProcessCount 变量，然后选择“字符串”类型。将变量标记为“通用”，以便在显示此变量的所有流程中获取其值。

2. 启用“Argument1_Email”变量，然后选择“字符串”类型。由于此变量不会在多个流程中出现，因此您不应选择“通用” 。选择保存。

   

3. 返回“仪表板”，创建一个新的仪表板，并添加一个新的图块。

4. 选择“Robot 日志”探索以查看已配置的自定义变量。

   由于您为 ProcessCount 选择了“通用”，因此可以看到没有流程名称前缀，因为前缀已添加到标准数据模型中。与 ProcessCount 不同，您没有为 Argument1_Email 选择“通用”，因此自定义字段被添加为“Log_Email.Argument1_Email”。

   

自定义变量为空值的情况

自定义变量在某些特定情况下可能具有空值，如以下部分中所述。

场景 1

如果您在可视化中使用标准数据模型中的字段，该字段与流程特定的自定义变量字段配对，并且流程在机器人日志中不包含自定义变量，则与该流程关联的所有字段的值为空。

有两种方法可以消除此场景中的空值：

选项 1 ：将自定义变量添加为筛选器，并将条件设置为“非空” ，以从可视化中删除空值。

选项 2 ：为确实包含自定义变量的流程名称设置筛选器。但是请注意，如果您采用这种方法，则可能会遇到第二种情况。

场景 2

如果流程生成的所有日志中都不包含自定义变量，则不包含该自定义变量值的日志将显示该变量的值为空。

以下示例说明了此特定情况。

1. 前往“配置自定义变量”。您可以看到，“Argument1_Email”自定义变量字段仅出现在“Log_Email”流程中。考虑到“Argument1_Email”是一个特定于流程的自定义变量字段，请取消选中“通用”。

   

2. 打开新的或现有的仪表板，并添加一个图块。

3. 前往“机器人日志”探索。选择“流程名称”字段和“自定义变量”字段。在本例中，自定义变量字段为 Log_Email.Argument1_Email。

4. 选择运行。 您看到的结果应与以下屏幕截图所示的结果相似。

   

要消除空值，请将自定义变量字段添加为筛选器。最后，将条件设置为非空，以便从可视化中删除空值。

备注：

当您查看自定义字段的原始数据时，这两种情况都会发生。当您对自定义变量应用函数（SUM、AVERAGE 等）时，您将排除空值。

故障排除和限制

有关故障排除和限制的信息，请参阅“故障排除”部分。