自定义变量

Insights 始终通过 Insights 数据模型中可用的预定义字段来提取数据，但管理员还可以配置从机器人日志和队列中提取的自定义变量，以用于计算特定 KPI 或构建更专业的仪表板。

提示：

• 要包括流程的自定义变量，必须首先确保通过 Studio 中的 UiPath.System.Activities.AddLogFields 活动将其添加到自动化中的日志，然后必须选择要提取的变量。
• 要包括队列的自定义变量，必须首先确保通过 Studio 中的活动将其添加到工作流中，然后选择要提取的变量。
  • 对特定数据使用 UiPath.System.Activities.AddQueueItem 活动；
  • 对输出数据和分析数据使用 UiPath.System.Activities.SetTransactionStatus 活动。

配置自定义变量

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

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

2. Decide whether you want to configure custom variables for processes or queues by selecting the corresponding tab at the top of the configuration page.

   
   

   

   
   
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. Decide whether you want to configure custom variables for processes or queues by selecting the corresponding tab at the top of the configuration page.
3. 要删除以前选择的变量，请取消选中“提取”复选框。
4. 要更改变量的类型，请从下拉列表中选择所需的新类型。
5. 请务必保存配置。
6. 对曾使用已修改或已删除变量的现有仪表板执行以下检查：
   1. 如果删除了变量，请务必从已创建或修改的公式，从筛选器或可视化图表中删除对变量的任何引用；
   2. 如果更改了变量类型，请确保新类型仍可正确应用；

配置示例

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

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

1. 选择要提取的“ProcessCount”变量，然后选择“字符串”类型。

2. Enable the Argument1_Email variable, and select the String type and then select Save.

   
   

   

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

4. 选择“*流程 - 自定义日志 2”探索，然后选择“自定义日志 2”视图，以在图块中使用此流程中已配置的自定义变量。

   
   

   

   
   

自定义变量为空值的情况

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

场景 1

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

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

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

  

  
  
• Option 2: Set a filter for the process name that does include the custom variable. Note, however, that if you adopt this approach, you may run into the second scenario.
  
  

  

  
  

场景 2

If a custom variable is not present in all logs generated by a process, the logs that do not contain a value for that custom variable will show the variable's value as null as captured in the following image .

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

1. 前往“配置自定义变量”。您可以看到“Birthday2”自定义变量字段出现在“自定义日志 2”流程中。

   
   

   

   
   
2. 打开新的或现有的仪表板，并添加一个图块。
3. 前往“自定义日志 2”探索。选择作业视图下的“流程名称”字段和“自定义变量”字段。在本例中，自定义变量字段为“CustomLogs2.Birthday2”。

4. Select Run. The results you see should be similar to the ones shown in the following screenshot.

   
   

   

   
   

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

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

故障排除和限制

有关故障排除和限制的信息，请查看故障排除部分。