Installation

Prerequisites to Installation

1. Ensure that you meet the Hardware and Software Requirements for Insights.
2. Install Orchestrator or modify an existing installation enabling the Insights feature.
3. Ensure that you have followed the Orchestrator instructions. This certificate must have both public and private keys and must be installed in the Trusted Root of the Insights machine.
4. Ensure the Insights certificate is placed in the Trusted Root of the Orchestrator machine.
5. When specifying a hostname for Insights, make sure that the desired hostname is resolvable within your DNS.
6. Verify that the server where Insights will be installed can communicate with the server(s) where Orchestrator is installed and vice versa,
   Important: It is preferable to use a SAN SSL certificate submitted to a Certificate Authority rather than a self-signed one.

   Self-signed certificates (and those from your own certificate authority) must be installed in both the Trusted Root and Personal certificate store on the Insights machine. The certificate must also be marked as Exportable.

   Note that when using a self-signed certificate, you may experience issues if accessing Insights via Firefox, Internet Explorer, or Edge.

Modifying an Orchestrator Install for Insights

1. From the Windows Control Panel, select Add or remove programs.
2. Select your Orchestrator from the list and click Modify.
3. Follow the on-screen installer, selecting the Insights Integration feature:
   
   

   

   
   
   Note: After installation is complete, you must also update your Host license to ensure the Insights feature is activated.

Insights Installation

1. Run the UiPathInsightsInstaller.exe installer as an administrator. The UiPath Insights Installer wizard is displayed.
2. Select the Check here to accept the license agreement check box to agree to the terms in the agreement, then click Next. The Insights Server Configuration is displayed.
   
   

   

   
   
3. Change the Server Configuration as desired:
   • Website host name - used to identify the device on which Insights is installed. By default this is set to the machine host name but can be edited. This name must be resolvable from an external server.
   • Website port - the port to be used for Insights communication. By default this is set to 443 to enable the use of HTTPS.
   • Add firewall rules for this port - if selected, automatically adds firewall rules for this port to ensure your machine's security.
     Important: Insights uses the loopback IP address for communication between different services. These ports are not using HTTPS, so to prevent the ports from being reachable from other machines, make sure that only port 443 is open to receiving connections from external sources (i.e. IP addresses other than 127.0.0.1).
   • Insights Build Directory - If defined, sets the directory that Insights data will be stored after it has been imported and built into the system.
     Important: This field is not required, if left blank the installer uses the default directory. The folder cannot be root of drive - D:\ or have trailing slash.

     Double-check the selected installation path. Moving an installation from one location to another post-install is not supported.

   • SSL Certificate Subject - the subject name of the SSL certificate you want to use to secure connections with Insights. By default, this is filled in with the full computer name but may be edited.

Note: The SSL certificate subject must match the Website host name provided above. If using an existing certificate, it must be marked as exportable and be installed under the Local Machine Personal Certificate Store.

• Create Self Signed Cert - if selected, automatically creates a self-signed certificate with subject name specified above. For using Edge or Internet Explorer with self-signed certificates, see here.
  Important: We do not recommend enabling the Create Self-Signed Cert option because It is preferable to use a SAN SSL certificate submitted to a Certificate Authority.

  If also using a self-signed certificate on your Orchestrator machine, the Orchestrator and Insights certificates must be added to the trusted root on both machines.

• Email - the email of the local Insights admin user.

Note: This must not match the email address of any user defined in Orchestrator.

• Password - the password for the local Insights admin user. It must be 8-20 characters in length and contain at least 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character (!, @, #, $, %, ^, &, *).
  1. Click Next. The Insights Database Configuration is displayed.
     
     

     

     
     
  2. Fill in the database details, as follows:
• Host Servername - the name of the SQL Server machine where the Insights database is located. You can also specify a custom port number here using a colon, such as sql.uipath.com:1733.
• Database Name - the name of the Insights database specified when installing Orchestrator.
• Windows Authentication - if selected, the connection to Insights is made using a domain account. See the additional configuration steps, below.
• SQL Authentication - if selected, the connection to Insights is made using SQL authentication. If using this option, the Username and Password fields become editable and you must provide the SQL username and password used to connect to the database.
  1. Click Next. The Orchestrator Configuration is displayed.
     
     

     

     
     
  2. Provide the connection details for your Orchestrator instance, as follows:
• Orchestrator Endpoint - the URL of your Orchestrator.
• Username - the username of the Host tenant. By default, this is admin and cannot be edited.
• Password - the password for the Host admin account.
  1. Click Next. The Orchestrator Database Configuration is displayed.
     
     

     

     
     
  2. Fill in the Orchestrator database details, as follows:
• Host Servername - the name of the SQL Server machine where the Orchestrator database is located. You can also specify a custom port number here using a colon, such as sql.uipath.com:1733.
• Database Name - the name of the Orchestrator database specified when installing Orchestrator.
• Windows Authentication - if selected, the connection is made using a domain account.
• SQL Authentication - if selected, the connection is made using SQL authentication. If using this option, the Username and Password fields become editable and you must provide the SQL username and password used to connect to the database.
  1. Click Next. The Email Server Configuration is displayed.
     
     

     

     
     
     Note: If you do not configure an email server then no Insights email alerts and notifications are sent. You can, however, add an email server configuration after installation by using the Modify function of the Windows Add or Remove Programs feature.
  2. If desired, configure your email server for Insights notifications, as follows:
• SMTP Host - enter your SMTP host.
• SMTP Port - enter your SMTP port. By default this is set to 25 but can be edited.
• TLS Configuration - used to set the email server security settings. It has the following options:
  • Secure - if checked, the connection will use TLS.
  • Ignore TLS - if selected (and Secure is not), TLS will not be used. Select this option when connecting to a non-secure SMTP server.
  • Require TLS - if selected (and **Secure is not), it requires the connection to be upgraded to TLS regardless of email server support.
• SMTP Username - the email address to send mail messages from.
• SMTP Password - the password for the email address used above.
• From Address - the email address to send mail messages from. It must match that provided for SMTP Username, above.
• From Display Name - a display name for the email address.

• Advanced Email Server Configuration - it has the following options:

  • Debug - if selected, Insight logs all SMTP traffic. Should only be used for troubleshooting.
  • Logger - if selected, Insights logs all events (e.g. server connection).
  • Connection Timeout - time, in milliseconds, to wait for a connection to be established.
  • Greeting Timeout - time, in milliseconds, to wait for the greeting after a connection is established.

  • Socket Timeout - duration, in milliseconds, of inactivity to allow.

    1. Click Install. The installation process starts. Once completed, click Close to exit the installer.
       Important:

       After Insights installation has finished:

       • Ensure the .NET Trust Level of the Sisense app is set to Full.
       • Open the consts.js file located in the C:\Program Files\Sisense\app\query-proxy-service\src\common directory and set the HEALTH_CHECK_TIMEOUT parameter to 100000.

Windows Authentication Configuration

If you are using Windows Authentication to connect to the Insights database (Step 4, above), you must modify the logon properties of the Sisense.CLRConnectorsContainer and Sisense.JVMConnectorsContainer services as follows:

Note: If the account performing this process was not the one used when running the Insights installer, please make sure that it is part of the local Administrator group.

1. Open Windows Services Manager.
2. Right-click on Sisense.CLRConnectorsContainer and select Properties.
3. From the Log On tab select the This account radio button.
4. Enter the username and password of the account used to connect to the Insights SQL database and click OK.
5. Repeat this process for the Sisense.JVMConnectorsContainer service.
6. Restart both services.

Tenant Setup

After Insights has been installed, you must then enable it for your desired tenant(s) using the UiPath.InsightsAdminTool.exe utility.

Important:

Each tenant enabled triggers a "warm start' process that fetches data into the Insights database for your configured number of backfill days.

Depending on the volume of data and hardware capabilities, it may be several hours before all tenant data is processed and viewable in Insights.

1. On the machine where Insights is installed, navigate to the \Orchestrator\Tools directory. For example, cd C:\Program Files (x86)\UiPath\Orchestrator\Tools.
2. Run the UiPath.InsightsAdminTool.exe utility:
   
   

   

   
   
3. In the User field enter the admin user of the Orchestrator host tenant. This is admin by default and cannot be change.
4. Enter the Password for the Orchestrator host tenant and click Login. The Select a feature window is displayed.
   Important: Insights 20.10.0 has a minor known issue on the ROI Dashboard. Please visit the linked release notes for instructions on how to remedy this issue using Tenant Setup.
   
   

   

   
   
5. Select Enable Insights for Tenants. A list of all tenants is displayed.
   
   

   

   
   
6. For each tenant, select the following options:
   • Insights Enabled - Check this box to enable Insights for the selected tenant.
   • Dashboard Language - The desired language for your dashboard.
   • Replace Resources - Select Cube to delete and rebuild the Insights data cube, and Dashboards if you want to replace all OOTB included dashboards with new OOTB dashboards.
   • 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 - Check to enable a backfill of historical data, and enter the desired number of days into the input field.
  1. Click Next. A warning window appears, click OK to proceed.
  2. The tenant(s) are enable and your installation is complete.
     Important:

     By default, no custom tables will be created starting with this release. You must add processes and queues to an allowlist via the Manage Custom Tables option in the Admin Tool. The Manage Custom Tables page allows you to select which processes and queue tables you would like to add to the Insights Cube.

     For deployments where the desired number of process and queue tables exceeds the maximum number of 75 per tenant, enabling table grouping will allow the combination of multiple processes or queues into a single group table.

Log Ingestion for Non-English Deployments

For deployments using non-English data (including running Robot or Studio in a language other than English), a few changes must be made in order to ensure that all logs are ingested properly:

For historical logs to backfill during warmstart:

1. Open the UiPath.InsightsAdminTool.exe.config file located in the C:\Program Files (x86)\UiPath\Orchestrator\Tools directory.
2. Find the key called "Insights.RobotLogsWarmStartupQueryCondition", and replace "execution ended" in the value with the appropriate translation in the language used by your deployment.

For ongoing log ingestion:

1. Open the UiPath.Orchestrator.dll.config file located at C:\Program Files (x86)\UiPath\Orchestrator.
2. Find the when condition called level, and replace execution ended with the appropriate string translated in the language used by your deployment:

• de > Ausführung beendet
• fr > Exécution terminée
• es-ES > Ejecución finalizada
• es-MX > Ejecución terminada
• ja > の実行が終了しました。
• ko > 실행이 종료되었습니다.
• zh-CN > 执行结束
• pt-pt > Execução terminada
• pt-BR > A execução terminou
• tr > Yürütme işlemi bitti
• ru > Выполнение завершено

Examples

• English

  <logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="false" minlevel="Info" writeTo="insightsRobotLogs"><filters defaultAction="Ignore"><when condition="level >= LogLevel.Error or ends-with('${message}',' execution ended')" action="Log" /></filters></logger>

• Portuguese (BR)

  <logger name="Robot.*" ruleName="insightsRobotLogsRule" enabled="false" minlevel="Info" writeTo="insightsRobotLogs"><filters defaultAction="Ignore"><when condition="level >= LogLevel.Error or ends-with('${message}',' A execução terminou')" action="Log" /></filters></logger>

Please note that any other string changes to this when condition are not supported and may require a full product reinstall if implemented.

Addressing log4j Vulnerability

To address the log4j vulnerability, make sure you run the hotfix to update dependencies to the latest non-vulnerable version of Apache Log4j.

For more information, see the UiPath Insights Advisory (Prior to version 2021.10) section in UiPath Security Advisory CVE-2021-44228, CVE-2021-45046 & CVE-2021-45105j.