Subscribe

UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

Insights Admin Tool

The Insights Admin Tool can be used to perform many administrative actions that may be required for your Insights instance. The graphic interface of the Insights Admin Tool detailed here can be used to perform all functions except upgrading.

See here for using the tool from the command line.

Launch Insights Admin Tool

  1. On the machine where Insights is installed, navigate to the \Orchestrator\Tools directory and double-click Insights Admin Tool. The login screen is displayed:

📘

Note:

You must log in using the Orchestrator Host Admin credentials to continue with other tool features.

  1. After you log in, the Feature Selection page is displayed:

The feature selection page allows the user to choose which action to take with the tool.

Enable / Disable Insights for Tenants

Field

Description

Insights Enabled

Indicate whether Insights should be enabled or disabled for the respective tenant.

Tenant Name

The name of Orchestrator tenant to be targeted.

Dashboard Language

Select the language for the OOTB dashboards to be uploaded, the default is English.

Replace Resources

Required if you are changing the dashboard language. Your custom dashboards are not affected.

For an already enabled tenant, this replaces Insights resources already created with the default instances.

For dashboards, this will replace your current OOTB dashboards with new OOTB dashboards. For Cubes this will delete the cube and replace it with a new cube with default schema. It is recommended to check this when changing dashboard language.

Dashboard Access

Select the user roles/groups which are given access to the Insights Default Dashboards from the following options:
All - the default dashboards are shared with all Insights users.
Consumers - the default dashboards are shared only with users who have View permissions to Insights.
Editors - the default dashboards are shared only with users who have Edit permissions to Insights.
Insights Admin - the default dashboards are not automatically shared with any Insights users, instead the Insights Admin user shares them manually from the Insights portal.

Backfill

Selecting Backfill and providing a number of days will import historical data for the newly enabled tenants from the Orchestrator DB into Insights DB.

Depending on the amount of data being transferred, this can greatly increase the runtime.

🚧

Important:

If you intend to backfill logs from Orchestrator, and you are using Robot or Studio in a language that is not English, please visit Log Ingestion for Non-English Deployments to ensure that your logs are ingested correctly.

Group Data Tables

Upload Groups Tab

This page enables you to upload a grouping configuration file to group Data from multiple Queues or Processes into one table to improve Insights performance.

See here for details.

Clean Up Tables Tab

This page enables you to delete any existing tables which have been made redundant by a table group.

Check Tenant Cube Build Status

The Check Tenant Cube Build Status page enables you to see if the Insights Cube builds are failing and offers the option to manually trigger a full Rebuild of the cube. In addition, you can monitor the number of custom tables created in your Insights deployment, and set an alert threshold (up to the supported maximum of 75 custom tables) to warn you when you are approaching this limit. The threshold is set to 50 by default.

If the threshold is nearly met or exceeded, Insights users will see a toast notification when they click the Insights tab in Orchestrator, warning them of the status of the threshold.

Cube build logs can also be saved locally by selecting Download Logs.

Manage Custom Tables

The Manage Custom Tables page allows you to select which processes and queue tables you would like to add to the Insights Cube. In previous releases, any process with custom fields in the logs, or any queue with data stored in Specific Data, Output, or Analytics, had a table created in the cube by default. As Insights cubes can support a maximum of 75 custom tables, this limit was reached quickly if many processes and queues contained custom data. Through this feature, you will be able to select a maximum of 75 combined processes and queues to add to the "whitelist".

These processes and queues are not required to have custom fields at the time of enablement. You may add the respective table to the whitelist, and they will be added in the cube as soon as custom data is detected.

The tool will not allow the selection of more than 75 total tables. After 75, the "Submit" button will become unavailable and the whitelisted table count will appear in red.

This page will also display the count of groups for the tenant. Whitelisting is intended to reduce the need for grouping, as it has mostly been used as a way to limit the number of custom tables. If a process or queue is part of a currently enabled group, there will be a checkmark in the grouped column.

If a table shows as both grouped and whitelisted, this means the table was not cleaned up after grouping. This will add the table twice to the table count, as well as impact performance, so it is recommended to clean up grouped tables in this scenario.

📘

Note:

New 20.10 installations will not add any tables to the Insights Cube by default. The tables will only be added after whitelisting in the Insights Admin Tool. Deployments upgraded from previous releases will retain all tables in the cube, and all such tables will be automatically added to the whitelist in the tool.

Updated 25 days ago


Insights Admin Tool


Suggested Edits are limited on API Reference Pages

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