UiPath Documentation
insights
2022.10
false
Insights

Common Actions for Designers

Prerequisites

Prerequisite for Designers to Perform Actions in Insights <2021.10

  • A user needs to select the Insights button in the left menu of Orchestrator to get to Insights.

Prerequisite for Designers to Perform Actions in Insights 2022.10

  • Type in the Insights URL and log in.

Comparison

Action Insights <2021.10 Insights 2022.10 or later

Set alerts (Anomaly detection)

  • Click the dashboard that has the metric you want to set an alert for.

docs image

  • Click the Edit Dashboard button on the dashboard to launch the Insights Portal.

docs image

  • In the Insights portal, click the Options menu associated with the widget you want to add an alert for.

docs image

  • Then click Add to Pulse.

docs image

  • You can adjust the name and the alert condition. Click Automatic to add an alert using the anomaly detection algorithm.

docs image

  • You can also click Advanced and edit any of the other options. Here you can add a filter to the metric.
  • Click the People tab and enter the names, email addresses, or groups that you want to receive the pulse notification.

docs image

  • Lastly, click the last tab to add a message to the notification and choose how to notify the users.

docs image

  • Anomaly detection not available.

Set alerts (threshold)

  • Click the dashboard that has the metric you want to set an alert for.

docs image

  • Click the Edit Dashboard button (pencil icon) on the dashboard to launch the Insights portal.

docs image

  • In the Insights portal, click the Options menu associated with the KPI you want to add an alert for.

docs image

  • Then click Add to Pulse.

docs image

  • You can adjust the name and the alert condition. Click Threshold to choose to send an alert using a threshold and set the condition for the alert.

docs image

  • You can also click Advanced and edit any of the other options. Here you can add a filter to the metric.

docs image

  • Click the People tab and enter the names, email addresses, or groups that you want to receive the pulse notification.

docs image

  • Lastly, click the Wi-Fi symbol to add a message to the notification and choose how to notify the users.

docs image

  • To set an alert, navigate to the dashboard that you want to set an alert for.

docs image

  • Hover over the tile that you want to add an alert for.

docs image

  • Click the tile’s bell icon to set an alert.

docs image

  • Now you can choose the exact threshold and condition to trigger the alert.

docs image

  • Then add the emails to send the alert to and edit the frequency. The frequency sets how often Insights will check the data for changes (and to send an alert notification if the alert conditions are met). Then click Save.

docs image

For more information, please see the document Alerts and Schedules

Set alerts (Always alert)

  • Click the dashboard that has the metric you want to set an alert for.

docs image

  • Click the Edit Dashboard button (pencil icon) on the dashboard to launch the Insights portal.

docs image

  • In the Insights portal, click the Options menu associated with the KPI you want to add an alert for.

docs image

  • Then, click Add to Pulse.

docs image

  • You can adjust the name and the alert condition. Click Always to choose to send an alert after each build regardless of if the value has changed.

docs image

  • You can also click Advanced and edit any of the other options. Here you can add a filter to the metric.

docs image

  • Click the People tab and enter the names, email addresses, or groups that you want to receive the pulse notification.

docs image

  • Lastly, click on the Wi-Fi symbol to add a message to the notification and choose how to notify the users.

docs image

  • Always alerts not available.

Create Dashboard

  • Click Create dashboard to create a new dashboard.

docs image

  • If you are already in the Insights Portal, click the Options button.

docs image

docs image

docs image

  • Lastly, name the dashboard and click Create.
  • Click Create New Dashboard to create a new dashboard.

docs image

  • Then, choose a name for your dashboard and click Save.

docs image

For more information, please take a look at the document Dashboards

Edit Dashboard

*you can also edit a dashboard by clicking the pencil icon on the dashboard when it is opened in Orchestrator, which will launch the dashboard in edit mode in the Insights portal.

  • Click the More Actions button on the dashboard that you would like to edit.

docs image

  • Select Edit Dashboard, and then you can edit the dashboard in the Insights Portal.

docs image

docs image

  • To edit a dashboard, first click the dashboard you want to edit.

docs image

  • Click the 3-dot dashboard actions menu on the top right side of the dashboard.

docs image

  • Then, click Edit Dashboard.

docs image

Edit A Tile

  • Click the More Actions button next to the dashboard that you would like to edit.

docs image

  • Then select Edit Dashboard.

docs image

docs image

  • Then, click the Edit Widget button (pencil) on the widget you would like to edit.

docs image

  • Optionally, you can edit a widget by first selecting the dashboard, and then clicking the pencil on the widget you would like to edit.

docs image

docs image

  • Lastly, if you are inside the Insights Portal, click the dashboard that contains the widget you want to edit.

docs image

  • Then, click the pencil on the widget you would like to edit.

docs image

  • To edit a tile, first select the dashboard you want to edit.

docs image

  • Click on the 3-dot dashboard actions menu on the top right side of the dashboard.

docs image

  • Click Edit Dashboard.

docs image

  • Now you can edit a tile. Click the 3-dot menu on any specific tile, and then click Edit.

docs image

docs image

  • Now you can edit the tile and, finally, click Save.

docs image

Copy templates

  • Click the More Actions button next to the default dashboard that you would like to edit to enter the Insights Portal.

docs image

  • Open the folder that contains the shared default dashboards.

docs image

  • Click the default dashboard that you want to copy.

docs image

  • Click the More Actions menu and then Duplicate.

docs image

docs image

  • Optionally, you can also hover over the default dashboard that you would like to copy and click the More Actions button.

docs image

docs image

  • Select Duplicate to create a copy of the dashboard

docs image

  • To copy a template, navigate to the UiPath Templates tab.

docs image

  • Click the Copy button to copy the template.

docs image

  • Give the new dashboard a title and click Save.

docs image

For more information, see the document Dashboards

Copy dashboard

  • Click the More Actions menu next to the dashboard that you would like to copy. Then click Edit to enter the Insights portal.

docs image

docs image

docs image

  • Click the dashboard you want to copy.
  • Click the Options menu on the dashboard and then Duplicate.

docs image

docs image

  • Optionally, you can also hover over the dashboard that you would like to copy and click the More Actions button.

docs image

docs image

  • Select Duplicate to create a copy of the dashboard.

docs image

  • To copy a dashboard, navigate to the desired dashboard tile.

docs image

  • Click the Share/Duplicate button.

docs image

  • Click Duplicate to make a copy.

docs image

For more information, see the document Dashboards

Export dashboard (as .dash file)

  • Click the More Options menu next to the dashboard that you would like to export. Then click Edit to enter the Insights portal.

docs image

docs image

docs image

  • You can export this dashboard by clicking the Options menu button in the upper right.

docs image

  • Click Export.

docs image

  • Optionally, you can also click the More Actions button on the dashboard that you would like to export as a .dash file.

docs image

  • Then click Export.

docs image

  • Cannot currently export a dashboard as a .dash file.

Import a dashboard (as .dash file)

  • Once inside the Insights portal, click the Options ( +) button.

docs image

  • Then select Import dashboards.

docs image

  • Locate the file path of where the dashboard was saved as a .dash file, and then click Open.

docs image

  • Then click OK to import the dashboard.

docs image

  • Cannot currently import a dashboard as a .dash file

Forecasting

  • Once inside the Insights Portal, click the dashboard that contains the widget you want to add forecasting to.

docs image

  • Click Edit on the widget that you want to add forecasting to.

docs image

  • To add forecasting to the visualization, duplicate the value that you would like to forecast. To do so, click the More Options button and select Duplicate.

docs image

docs image

  • If a break-by is set on the widget, make sure to delete it by clicking the Delete button.

docs image

  • Click the settings menu next to the copied value, and click Regression.

docs image

docs image

  • You can choose the regression that fits to the chart. Click save, and it will get applied.

docs image

  • To add forecasting to a dashboard, navigate to the desired dashboard tile.
  • Click Edit on the widget that you want to add forecasting to. You can only add forecasting to the following visualization types: Column, Bar, Scatterplot, Line, and Area. You can support rendering forecasted data to the following text and table charts: Table, Table Legacy, Single record, and Word Cloud.
  • To add forecasting to the visualization, make sure you have exactly one timeframe dimension with dimension fille enabled. Also, include at least one measure or custom measure (a forecast can include up to five measures).
  • Select the forecasting button to add Forecasting. Then click on the Select Field's drop-down to select the measure that you want to add forecasting to. Add the Length to include the length of time for which to forecast data values.
  • Lastly, press run to see the forecasted results.

Exploration paths

  • Once inside the Insights Portal, click the dashboard that you would like to add an exploration path to.

docs image

  • Then click the Options button on the dashboard and then Exploration Paths.

docs image

docs image

  • Then, exploration paths will be enabled for all users of this dashboard, and the dashboard will refresh.

docs image

docs image

  • Exploration paths are not available.

Delete dashboard

  • Once inside the Insights Portal, click the dashboard that you would like to delete.
  • Then click the Options button on the top right of the dashboard, and then choose Delete Dashboard.

docs image

docs image

  • Optionally, you can hover over the dashboard in the left dashboard pane, and click the More Actions button and then Delete.

docs image

  • Locate the dashboard in the My Dashboards or Tenant tab and click the Delete button.

docs image

  • Optionally, click the specific dashboard you want to delete.

docs image

  • Then, click the dashboard actions menu in the top-right corner of the dashboard, and click Move to Trash. Lastly confirm the deletion by clicking Move to trash.

docs image

docs image

For more information, see the document Dashboards

Dashboard schedules

  • Once inside the Insights Portal, click the dashboard that you would like to schedule to be sent (this is not applicable for the default dashboards). To schedule a default dashboard, first make a copy of it.
  • Click the Share button.

docs image

  • Enter the names, email addresses, or groups that you want to share the report with.

docs image

  • Choose whether you want to send the dashboard as an email report or a .pdf attachment. Then modify the time zone and the recurrence to send the dashboard.

docs image

  • Optionally you can click the More Actions button next to the dashboard in the dashboard pane and then Share.

docs image

  • Enter the names, email addresses, or groups that you want to share the report with.

docs image

  • Choose whether you want to send the dashboard as an email report or a .pdf attachment. Enter the frequency and time at which email reports are sent.
  • To schedule a dashboard, first open the dashboard you would like to schedule.

docs image

  • Click the dashboard actions menu in the top-right corner of the dashboard and then select Schedule Delivery.

docs image

docs image

  • Select the recurrence, time, email addresses, and format. You can send reports to any email address, even to users with no Insights or Orchestrator access.

docs image

  • You can also add more filters.

docs image

  • Lastly, you can add a custom message, edit the paper size, and the delivery time zone. Then click Save.

docs image

For more information, see the document Alerts and Schedules

Share a dashboard with another user inside the product

  • Once inside the Insights Portal, click the dashboard that you would like to share.
  • Click the Share button on the dashboard.

docs image

  • Enter the names that you would like to share the dashboard with. You can also give the user the right to view, edit, or own the dashboard.

docs image

docs image

  • Click Save and the dashboard will be shared.
  • Optionally, click the More Actions button next to the dashboard that you want to share.

docs image

  • Click Share.

docs image

  • Enter the names that you would like to share the dashboard with. You can also give the user the right to view, edit, or own the dashboard.

docs image

docs image

  • Click Save and the dashboard will be shared.
  • You cannot share a dashboard with one person directly inside of the product. You can achieve this with scheduling a delivery.

Share a dashboard with everyone who has Insights access on the tenant

  • Once inside the Insights Portal, click the dashboard that you would like to share.
  • Click the Share button on the dashboard.

docs image

  • Enter the group called Everyone to share the dashboard with everyone. To share with all users and groups that have Viewer permissions, enter [Tenant Name]-Consumer. To share with all users and groups that have Designer permissions, enter [Tenant Name]-Editor.

docs image

  • Click Save, and the dashboard will be shared
  • Optionally, click the More Actions button next to the dashboard that you want to share.

docs image

  • Click Share.

docs image

  • Enter the group called Everyone to share the dashboard with everyone. To share with all users and groups that have Viewer permissions, enter [Tenant Name]-Consumer. To share with all users and groups that have Designer permissions, enter [Tenant Name]-Editor.

docs image

  • Click Save, and the dashboard will be shared.
  • To share a dashboard with everyone who has access on the tenant, first locate the dashboard you want to share in the My Dashboards tab and click the Share/Duplicate button.

docs image

  • Click Share with Tenant to share the dashboard with the tenant.

docs image

For more information, see the document Dashboards

Create folders for dashboard sorting

  • Once inside the Insights Portal, click the Options button in the Dashboards pane.

docs image

  • Click New Folder.

docs image

  • Edit the name for the new folder and then click the green check to save the folder.

docs image

  • To add a dashboard to the folder, click the More Actions button next to the folder and then New Dashboard.

docs image

  • Creating folders for dashboard sorting is not currently available.

Add filter to custom dashboard

  • From the Insights portal, click the dashboard that you want to add a filter to.

docs image

  • On the right side of the dashboard, click the Options button in the filters pane.

docs image

  • Add the filter you want to the dashboard and click OK.

docs image

docs image

  • Navigate to the dashboard that you want to add a filter to.

docs image

  • Then, edit the dashboard.

docs image

  • Now you can add a filter to the dashboard. Click Filters and then Add Filter.

docs image

  • Add the field you want to filter the dashboard with.

docs image

  • Edit the title for the filter, the way the filter is presented, and the values.

docs image

  • Lastly, choose which tiles should be filtered by this new field and click Add.

docs image

For more information, see the document Dashboards

Process baselines/ROI dashboard

  • Once inside the Insights Portal, click the Business ROI Dashboard under the OOTB folder.
  • Make a copy of this to own it locally.

docs image

  • Scroll to the Process Baselines widget and select Edit. From the Design menu, select the Tabular radio button. Enter the corresponding Manual Time(min) and Hourly Cost values for all processes. You can also add in more custom columns and lastly click Apply to confirm and save your changes.

docs image

docs image

we should also add that tenant admins can edit the ROI dataset and how to do so. probably a link to that section in the docs would be great

  • To access anything related to the ROI Dataset, you will also need ROI editor permissions. First, make a copy of the Business ROI template.

docs image

  • Then edit the dashboard itself.

docs image

  • Add a visualization tile or open up an existing tile. Click the Process Manual Values or Queue Manual Values explore.

docs image

docs image

For more information, see the document ROI Dataset

Suggested fields when building widget

  • Once inside the Insights Portal, edit a dashboard or create a new dashboard.
  • Click the Add Widget button.

docs image

  • Here you can see the suggested fields when building a widget.

docs image

  • Not available in Insights 2022.10.

Building a dashboard with custom fields from Robot Logs and Queues

  • Once inside the Insights Portal, create a new dashboard or edit an existing one.

docs image

  • Click Select Data and choose the available tenant data source.

docs image

  • Custom variables that have been added via the Add Log Fields activity are found in a new table created in Insights containing those custom fields with the title Process- <your process name>. These custom fields are extracted from the raw message and added to the table in the RawMessage_CustomfieldName format. Locate the process to see the custom variables.

docs image

  • If custom fields are detected by Insights in a queue, a custom table is created in the data model called Queue-<your queue name>. The fields will be identified via the input they were stored in:
  • Custom variables that have been added via the Add Queue Item in the ItemInformation property will be named SpecificData_<yourfieldname>.
  • Custom variables that have been added via the Set Transaction Status activity are found in AnalyticsData_<yourfieldname> if they were stored under the analytics property, or Output_<yourfieldname> if they were stored under the Output property.
  • Navigate to the dashboard that you want to add custom variables to or create a new dashboard.
  • Edit the dashboard.
  • Then add a new tile.
  • Choose the explore that contains the custom variable you want to use. All extracted variables for a specific Process should appear in an explore named *Process - ProcessName, and all extracted variables for a specific Queue should appear in an explore named *Queue- QueueName.

docs image

  • In the *ProcessName view, you can select the custom fields that were extracted.

docs image

For more information, see the document Custom Variables

Add value labels to visualizations

  • Once inside the Insights Portal, click the dashboard with the visualizations that you want to add value labels to.

docs image

  • Click the Edit button next to the desired widget.

docs image

  • Turn on the value label for the widget and click Apply.

docs image

  • You can add total values where the values appear at the top of each column:

docs image

or relative values where the values are broken down:

docs image

  • Navigate to the dashboard that you want to add value labels to the visualization.

docs image

  • Edit the dashboard.

docs image

  • Then edit the tile you want to add value labels to.

docs image

  • Click the Edit/Gear icon and navigate to the Values tab.

docs image

  • Turn on value labels by clicking the text that says Value Labels and then click Save.

docs image

Add title to widget

  • Once inside the Insights Portal, click the dashboard with the widget that you want to add a title to, or create a new widget in.
  • To add a title for a new widget, create a new widget and then add the title as shown in the following image:

docs image

  • To edit t title of an existing widget, click the pencil icon next to the widget.

docs image

  • Click the current name and replace it with the name you desire and click Apply.

docs image

  • To add a title to a tile, first navigate to a dashboard and edit the dashboard.

docs image

  • Add a new tile as a visualization.

docs image

  • Choose the explore you want to use for your visualization.
  • Replace the word Untitled with the new title you want to use.

docs image

  • To replace an existing tile’s title, navigate to the dashboard, edit the dashboard, and edit the tile. Click the tile’s title, replace the text, and click Save.

docs image

docs image

Add description to widget

  • Once inside the Insights Portal, click the dashboard that you want to add a widget’s description to.
  • To edit a description of an existing widget, click the pencil next to the widget.
  • Click the information button and start typing a description.

docs image

  • Click Apply to save the changes.
  • To add a description to a tile, fist navigate to the dashboard where the tile occurs. Then edit the dashboard.

docs image

  • Click the 3-dot button (Edit Tile button) on the tile and then click Add Note.

docs image

  • Enter the description you want in the note text field and adjust the display location. Click Add.

docs image

docs image

docs image

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated