UiPath Orchestrator

The UiPath Orchestrator Guide

Additional Configurations

Updating Insights v2019.10.3

For users that have installed Insights v2019.10.3, follow the instructions below to incorporate the fixes and enhancements of Insights v2019.10.4 in your installation.

Timezone Fix

Important!

Do not run the provided script when any schema altering build is in progress.

To correct an existing issue where the wrong timezone would be displayed in Insights:

  1. Download the Insights_19.10.4_hotfix.ziparchive from the UiPath Insights-Customer GitHub repository.
  2. Extract the contents of the archive to a local directory on your Insights machine.
  3. Open a Powershell window with administrative rights.
  4. Run Insights_19.10.4_hotfix.ps1.
  5. When prompted, enter your Orchestrator Host admin user and password.

Robot Logs Ingestion

To include robot logs stored in the Orchestrator SQL database as part of the historical data ingested by Insights:

  1. If you have not already done so, download the Insights_19.10.4_hotfix.zip archive from the UiPath Insights-Customer GitHub repository and extract the contents to a local directory on your Insights machine.
  2. Copy the UiPath.InsightsAdminTool.exe file to the C:\Program Files (x86)\UiPath\Orchestrator\Tools directory.
  3. For each Insights enabled tenant, perform the Tenant Setup again.

Updated Dashboards

To benefit from improvements to the out-of-the-box dashboards provided with Insights:

  1. If you have not already done so, download the Insights_19.10.4_hotfix.zip archive from the UiPath Insights-Customer GitHub repository and extract the contents to a local directory on your Insights machine.
  2. Copy all .dash files in the archive to the C:\Program Files\Sisense\OotbFiles directory of your Insights server.
  3. For each Insights enabled tenant, perform the Tenant Setup again:
    a. When prompted Delete existing cube? (y/n), enter n.
    b. When prompted Do you want to overwrite? (y/n) for each existing dashboard, select y.

Updating Credentials

If you need to change and/or update your credentials, the procedure below details the steps that must be performed on your Orchestrator and Insights machines.

Orchestrator Database Credentials

On Your Orchestrator Machine:

  1. Open the web.config file.
  2. In the connectionStrings section, modify the connectionString parameter of the key name="Default" as follows:
    a. For SQL Authentication: connectionString="Data Source={YOUR_ORCH_DB_HOST};Initial Catalog={YOUR_ORCH_DB_NAME};User ID={YOUR_ORCH_DB_SQL_USER};Password={YOUR_ORCH_DB_SQL_PASSWORD}" />
    b. For Windows Authentication: connectionString="Data Source={YOUR_ORCH_DB_HOST};Initial Catalog={YOUR_ORCH_DB_DATABASE_NAME};Integrated Security=true" />

Example for SQL Authentication:

<add name="Default" providerName="System.Data.SqlClient" connectionString="Data Source=sql.uipath.com;Initial Catalog=UiPathOrchestrator;User ID=docs-uipath;[email protected]" />

Example for Windows Authentication:

<add name="Default" providerName="System.Data.SqlClient" connectionString="Data Source=sql.uipath.com;Initial Catalog=UiPathOrchestrator;Integrated Security=true" />

On Your Insights Machine:

  1. Open an elevated command prompt and navigate to the C:\Program Files (x86)\UiPath\Orchestrator\Tools\ directory. For example, cd C:\Program Files (x86)\UiPath\Orchestrator\Tools\.
  2. Run the UiPath.InsightsAdminTool.exe utility with the necessary command parameters:
Command
Description

updateDB

Indicates a update of the database configuration.

-u

The username of the Orchestrator Host tenant administrator. This is admin by default.

-p

The password for the Orchestrator Host tenant admin user.

-c

The targeted database. The available options are:

  • Default
  • Insights

-s

The server for the targeted database.

-n

The database name.

-a

The authentication type for the database. The available options are:

  • 0 / false - SQL authentication is used.
  • 1 / true - Windows authentication is used.

-r

The username for the targeted database.
Only required for SQL Authentication.

-w

The password of your database user.
Only required for SQL Authentication.

Example for SQL Authentication:

.\UiPath.InsightsAdminTool.exe updateDB -u admin -p Orch_Host_Password -c Default -s sql.uipath.com -n UiPathOrchestrator -r docs-uipath -w my_SQL_Password

Example for Windows Authentication:

.\UiPath.InsightsAdminTool.exe updateDB -u admin -p Orch_Host_Password -c Default -s sql.uipath.com -n UiPathOrchestrator -a true

Insights Database Credentials

On Your Orchestrator Machine:

  1. Open the web.config file.
  2. In the connectionStrings section, modify the connectionString parameter of the key name="Insights" as follows:
    a. For SQL Authentication: connectionString="Data Source={YOUR_INSIGHTS_DB_HOST};Initial Catalog={YOUR_INSIGHTS_DB_NAME};User ID={YOUR_INSIGHTS_DB_SQL_USER};Password={YOUR_INSIGHTS_DB_SQL_PASSWORD}" />
    b. For Windows Authentication: connectionString="Data Source={YOUR_INSIGHTS_DB_HOST};Initial Catalog={YOUR_INSIGHTS_DB_NAME};Integrated Security=true" />

Example for SQL Authentication:

<add name="Insights" providerName="System.Data.SqlClient" connectionString="Data Source=sql.uipath.com;Initial Catalog=UiPathInsights;User ID=docs-uipath;[email protected]" />

Example for Windows Authentication:

<add name="Insights" providerName="System.Data.SqlClient" connectionString="Data Source=sql.uipath.com;Initial Catalog=UiPathInsights;Integrated Security=true" />

On Your Insights Machine:

  1. Open an elevated command prompt and navigate to the C:\Program Files (x86)\UiPath\Orchestrator\Tools\ directory. For example, cd C:\Program Files (x86)\UiPath\Orchestrator\Tools\.
  2. Run the UiPath.InsightsAdminTool.exe utility with the necessary command parameters:
Command
Description

updateDB

Indicates a update of the database configuration.

-u

The username of the Orchestrator Host tenant administrator. This is admin by default.

-p

The password for the Orchestrator Host tenant admin user.

-c

The targeted database. The available options are:

  • Default
  • Insights

-s

The server for the targeted database.

-n

The database name.

-a

The authentication type for the database. The available options are:

  • 0 / false - SQL authentication is used.
  • 1 / true - Windows authentication is used.

-r

The username for the targeted database.
Only required for SQL Authentication.

-w

The password of your database user.
Only required for SQL Authentication.

Example for SQL Authentication:

.\UiPath.InsightsAdminTool.exe updateDB -u admin -p [email protected] -c Insights -s sql.uipath.com -n UiPathInsights -r docs-uipath -w myPassword

Example for Windows Authentication:

.\UiPath.InsightsAdminTool.exe updateDB -u admin -p [email protected] -c Insights -s sql.uipath.com -n UiPathInsights -a true 
  1. From the \Program Files(x86)\Sisense\DataConnectors\JVMContainer\Connectors\UiFrost directory, update uipath_insights.properties as follows: insights.db.conn=jdbc:sqlserver://{YOUR_INSIGHTS_DB_SQL_HOST};Database={YOUR_INSIGHTS_DB_DATABASE_NAME};user={YOUR_INSIGHTS_DB_SQL_USERNAME};​insights.db.password={YOUR_INSIGHTS_DB_SQL_PASSWORD}

For example:

insights.db.conn=jdbc:sqlserver://sql.uipath.com;Database=UiPathInsights;user=docs-uipath;insights.db.password=myPassword

Updating the Insights Certificate

Note:

Before updating the Insights certificate, ensure that this new certificate is trusted inline with relevant policies for your company.

From the Insights host:

  1. Open a supported web browser and navigate to http://localhost:3030.
  2. In the Web Server section, use the Upload Certificate radio buttons to select your desired method. The available options are:
    • .pfx - if selected, you must provide the certificate password.
    • .cert/.key
  3. Drag and drop the corresponding certificate file(s) and click Upload.
  4. Click Restart Services. The new certificate is now used by Insights.
    Note: If the new certificate does not have the same subject as the original or is not present under a wildcard in your trust store, you must also add it to both the Insights and Orchestrator trust stores.

Chrome 80+ Update

Beginning with Chrome 80, there is a change in the default cross-domain (SameSite) behavior of cookies. This change impacts functionality of Insights and must be addressed as follows:

  1. Download the UiPath provided script here.
  2. Unzip the script package.
  3. Open an elevated command prompt and navigate to the directory where you saved the script. For example cd C:\Chrome80Fix.
  4. Run run_patch.cmd.
  5. Insights is configured to use SameSite value none and should function as intended.

Using Firefox

It is not initially possible to access Insights via your Firefox browser when using a self-signed certificate. This is a known issue due to Firefox blocking HTTPS sites from using self-signed certificates unless explicitly allowed by the user.

To avoid this issue, prior to accessing Insights for the first time and without being logged into your Orchestrator account, follow these steps:

  1. Navigate your browser directly to the Insights Portal using the format https://<Your_Insights_Host>/app/account. For example, https://insights-test:8081/app/account.
  2. When prompted by Firefox, explicitly select to continue on to the site.
  3. You are then redirected to the Orchestrator login page. Login using your Orchestrator credentials and you can now access the Insights page and Portal.

Workflow Design for Insights

When designing your automation workflows intended for consumption and analysis in Insights, there are changes to consider in the best practice approach used to date.

Where previously RPA developers would use the RemoveLogFields activity at the end of any individual sequence to remove logs not needed in the rest of the workflow, removing all custom logs as such results in the process and data not being ingested into the Insights database.

For those workflows that you want to analyze in Insights, it is recommended to log all desired data at the end of each workflow.

Updated 26 days ago


See Also

Installation

Additional Configurations


Suggested Edits are limited on API Reference Pages

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