Subscribe

UiPath Insights

The UiPath Insights Guide

Custom Variables

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.

👍

Before you begin

To include custom variables for processes, you must first make sure they are added to logs in your automation via the UiPath.Core.Activities.AddLogFields activity in Studio, and then you must select them for ingestion.


To include custom variables for queues, you must first make sure they are added in workflows via an activity in Studio, and then select them for ingestion.

  • Use the UiPath.Core.Activities.AddQueueItem activity for Specific Data;
  • Use the UiPath.Core.Activities.SetTransactionStatus activity for Output Data and Analytics Data.

 

Configuring Custom Variables

To configure custom variables, an Admin must take the following steps:

  1. Open the 3-dot menu in the top-right corner of any Insights page, and select Configure Custom Variables. The configuration page opens, listing all custom fields that are available for extraction.

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

  1. In the Extract column, choose the custom variables that you would like to use when building dashboards.

  2. In the Type column, select the custom variable's type. You can choose String or Number.

🚧

Important!

The number of custom variables per tenant is limited to a total of 400: 200 custom variables for processes and 200 custom variable for queues. Each of these two sets of variables allows using up to 100 string variables and 100 number variables.

  1. If a variable is present across multiple processes or queues, and you want to extract the value for all processes or queues in which it appears, select the Common checkbox. This disables the variable for selection in all the other processes or queues where it appears.

📘

Note:

If you select Common, the custom variable for processes appears in the data model as [FieldName], and the custom variable for queues shows up as [Output/Specific/Analytics.FieldName]. Note that you can use common variables across all processes/queues.


If you do not select Common, the custom variable for processes appears as [ProcessName.FieldName], and the custom variable for queues shows up as [QueueName.Output/Specific/Analytics.FieldName].


If a variable is present across multiple processes or queues, but you only want to extract its value for a particular process or queue, enable the variable, but do not select Common.

  1. Save the configuration. All extracted variables for Processes should appear in the Robot Logs explore, and all extracted variables for Queues should appear in the Queues explore.

 

Editing an Existing Configuration

To edit an existing configuration, an Admin must take the following steps:

  1. Open the 3-dot menu in the top-right corner of any Insights page, and select Configure Custom Variables. The configuration page opens, listing all custom fields that are available for extraction.

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

  3. To remove variables that were previously selected, uncheck the Extract checkbox.

  4. To remove Common status from a variable, uncheck the dedicated checkbox.

  5. To change a variable’s type, select the new desired type from the dropdown.

  6. Make sure to save the configuration.

  7. Perform the following checks on existing dashboards that used a modified or removed variable:
    a. If you deleted the variable, make sure to remove any references to the variable from formulas that were created or modified, from filters, or inside visualizations;
    b. If you changed the variable type, ensure that the new type still applies correctly;
    c. If the variable no longer has Common status, you need to replace the reference to the common variable with the updated per-process value.

 

Configuration Example

This section provides an example of using a custom variable in a dashboard.

In the following image, the ProcessCount variable is present in multiple processes while the Argument1_Email variable occurs only in one process.

Take the following steps to configure custom variables:

  1. Select the ProcessCount variable for extraction, and choose the String type. Mark the variable as Common so that you get its value across all processes in which it appears.

  2. Enable the Argument1_Email variable, and select the String type. Since this variable does not occur in multiple processes, you should not select Common. Click Save.

  1. Navigate back to Dashboards, create a new dashboard, and add a new tile.

  2. Choose the Robot Logs explore to see the already configured custom variables.
    Because you selected Common for ProcessCount, you can see that there is no process name prefix because it was added to the standard data model. Unlike ProcessCount, you did not select Common for Argument1_Email, so the custom field was added as Log_Email.Argument1_Email.

 

Custom Variables Null Cases

Custom variables can have a null value in some particular cases, as described in the following sections.

Scenario 1

If you use a field from the standard data model in a visualization paired with a process-specific custom variable field, and a process does not contain the custom variable in the robot logs, the value of all fields associated with the process that does not contain the custom variable in its robot logs is null.

 

There are two ways to eliminate the null values for this scenario:
Option 1: Add the custom variable as a filter, and set the condition to is not null to remove the null values from the visualization.

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 below.

 

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.

The following example illustrates this particular case.

  1. Go to Configure Custom Variables. You can see that the Argument1_Email custom variable field only occurs in the Log_Email process. Considering that Argument1_Email is a process-specific custom variable field, keep Common unselected.
  1. Open a new or existing dashboard and add a tile.
  2. Navigate to the Robot Logs explore. Select the Process Name field and the custom variable field. In this case, the custom variable field is Log_Email.Argument1_Email.
  3. Click Run. The results you see should be similar to the ones shown in the following screenshot.

 

To eliminate the null values, add the custom variable field as a filter. Lastly, set the condition to is not null, so that you can remove the null values from the visualization.

 

📘

Note:

Both of these cases occur when you are viewing the custom field’s raw data. When you apply a function (Sum, Average, etc.) to the custom variables, you exclude null values.

 

Troubleshooting and Limitations

See our Troubleshooting section for information about troubleshooting and limitations.

Updated 25 days ago

Custom Variables


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.