Subscribe

UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

Installation

🚧

Important

Please note that this is a change from our HW/SW specs from Insights 2021.10. Insights 2021.10 requires a single Windows machine, while Insights 2022.10 requires a Windows machine and a Linux machine with RHEL 8.2-8.6, or 9.0.

Click to expand this section

In 2021.10, the Insights Windows machine ran Docker which hosted the Looker Linux container. Starting with Windows 2022, the driver used to nest the Linux containers in Windows OS (called lcow) is not supported anymore by Microsoft for enterprise applications. As a result, we had to change our deployment architecture to require two machines - one Windows machine to run the UiPath Insights components, and a Linux machine to run the Looker container. With this change, enterprise support is available from OS vendors for the components needed to run UiPath products. The supported versions of Linux OS are the same that Automation Suite supports.

Overview

📘

Before you begin

Check Insights Hardware and Software Requirements.

To install Insights Standalone v2022.10 you need to follow these procedures in the order captured below:

  1. Prepare the Insights Windows and Linux Machines
  2. Initialize Looker on the Insights Linux Machine
  3. Install Insights

Prepare the Insights Windows Machine and the Insights Linux Machine

  1. Prepare the Certificate(s) to enable SSL for both machines. For more information, please click here.

📘

Note

Please make sure to import the Looker and Insights certificates to the machine that you want to access Insights on.

The certificate for the Insights Linux machine should be installed on the Insights Windows machine because the LookerPreinstallationtool.exe will export the certificate from the Insights Windows machine to the Insights Linux machine

  1. Configure two machines that meet the hardware and software requirements.
For details on preparing a Linux machine
Preparing an AWS EC2 Linux Machine

Step 1 Launch a Linux instance in AWS EC2

  1. Initiate instance launch.
  2. Select the Red Hat Enterprise Linux 8 Image (We support versions 8.2 - 8.6, or 9.0)
  3. Choose an Instance Type and configure Instance Details.
  4. Add storage to your instance and change the Size to 32.
  5. Review and Launch the Instance
    For more information, see Initiate instance launch in AWS.

Step 2 Open inbound ports

Open the inbound ports listed in the table below by following the instructions here:

TypePort rangeSourceDescription
Custom TCP9999Anywhere-IPv4This is the Looker port.
Custom TCP19999Anywhere-IPv4This is the Looker API port.
Custom TCP29999Anywhere-IPv4This is the LookML update port.
  1. Click Save rules.
Preparing a Microsoft Azure Linux environment

Step 1 Create a machine running Linux

  1. Navigate to Services > Virtual machines > Create.
  2. Go to See all images and select Red Hat Enterprise Linux 8.2 - 8.6, or 9.0 from the Plan. For the offline RHEL bundle, click here.
14641464
  1. Under Administrator account choose between SSH public key or Password. If you use an SSH public key, you can generate it and then choose Use existing key stored in Azure.

Step 2 Open Inbound ports to the created machine

To open the Inbound ports listed in the table below, follow the instructions here

Destination port rangesNamePrioritySource
9999Looker_Port310Any
19999LookerAPI_Port320Any
29999LookMLUpdate_Port330Any

To configure additional settings, see Create an inbound security rule.

Step 3 Increase storage allocation for Azure Linux machines

The default storage allocation in an Azure Linux machine is 8GB and it could cause out of space errors when pulling images, creating backups, or using multiple dashboards.

For air-gapped environments, make sure that /home , and /var volumes have enough available space (e.g., at least 4Gb for the /home, and 10GB for /var volumes, respectively) (see Insights Linux Machine Hardware Requirements). Before running the deployment script, follow the steps below to increase storage allocation and avoid out-of space errors:

  1. Open a SSH client in the Linux machine by running the command below:
ssh [email protected]<your-hostname>

Where <your-hostname> needs to be adjusted to reflect your machine hostname.

  1. Change to root user by running the command below:
sudo -i
  1. Check the disk size by running the command below:
lsblk -f

You’ll find the /var Mountpoint is under the name sda2 > rootvg-varlv.

10841084
  1. Check the size of /dev/sda2 by running the command below:
lsblk /dev/sda2

Where /dev/sda2 is retrieved from step 3. You will now see the size for /var , which is 8G.

829829
  1. Next, check the available space by running the command below:
vgdisplay rootvg
940940

You’ll see the Free PE / Size will be around 40 GiB.

  1. Increase the size of rootvg-varlv by running the command below:
    You can change it to +10G or a different value that is smaller than the available 40GB (the size of free memory that you see in Step 5).
lvresize -r -L +10G /dev/mapper/rootvg-varlv

Note: for air-gapped installations please run the same command on /home

13391339
lsblk /dev/sda2

Now you’ll have enough space for docker (located in /var/lib/docker).

746746

📘

Note

For airgapped environments please run the commands from steps 1–6 to increase the size of '/home' to ensure enough space for offline image and package bundle.

For details on preparing a Windows machine for hosting the Insights service
  1. Configure a Windows machine that meets the hardware and software requirements.

  2. Open the default inbound port 443. For instructions on how to open an inbound port in AWS, see Authorizing access to an instance. For instructions on how to open an inbound port in Azure, see NSG Quickstart Portal.

  3. Run the Install-Prerequisites.ps1 script to Enable IIS 10+, install .NET 6.0.5+, and then restart the IIS service. Alternatively, you can manually install the prerequisites highlighted in steps 3.1 - 3.4 below:

   3.1 Open an RDP session in the created machine to install the prerequisites.

   3.2 Enable IIS 10+.

Click for details on enabling IIS 10+

To enable IIS 10+, go to Control Panel > Programs > Turn Windows features on or off. This will open the Add Roles and Features Wizard. Follow the wizard to enable Web Server (IIS).

10111011

This will open the "Add Roles and Features Wizard". Follow the wizard to enable Web Server (IIS).

236236

Enable the following Web Server (IIS) modules:

  • Web Server
    • Common HTTP Features
      • Default Document
      • Directory Browsing
      • HTTP Errors
      • Static Content
    • Health and Diagnostics
      • HTPP Logging
    • Performance
      • Static Content
    • Security
      • Request Filtering
  • Management Tools
    • IIS Management Console

 

   3.3 Download and install .NET Hosting Bundle version 6.0.5+.

   3.4 In PowerShell, run the following commands:

net stop was /y ; net start w3svc
  1. Enable HTTPS on your machine using an SSL certificate. Prepare your certificate using a procedure similar to the one provided for Orchestrator. See Using a Certificate for the HTTPS Protocol.

  2. When specifying a hostname for Insights, make sure that the desired hostname is resolvable within your DNS.

  3. Make sure to use TLS 1.1 or 1.2.

🚧

Important

• Make sure that you select the db_owner role as this is required when you add the database owner role during the Insights SQL machine configuration.

• Both the Orchestrator and Insights versions need to match. For example, if you run Orchestrator version 2022.10.0, you need to run the same version of Insights to establish proper communication between the two UiPath products.

• The Insights database needs to point to the same database that was created when you enabled Insights during the installation of Orchestrator.

• If you have a large database, consider manually adding indexes using SQL scripts . The Orchestrator installation might fail during the Insights Database migration if it has to index a large set of data (see Database migration fails during installation).

SQL Server Configuration

Before installing Insights, you need to configure the Insights SQL Server instance that you want to use.

📘

Note:

The Insights SQL database must be case insensitive (“InsightsDB” = “insightsdb”). If it is created during the Insights installation process, it is automatically set as such. If you create your own Insights database, set the collation sequence to Latin1_General_CI_AS to configure it manually as case insensitive.

Make sure that you have the following information readily available as it is needed for running the Insights installer:

  • The name of the SQL Server machine.
  • The name of the instance, if it’s not the default instance.

Also, ensure:

  • The SQL Server port is open in the firewall of the SQL Server machine. You can use SKIP_FIREWALL_RULE_CREATION=true` to skip firewall rule creation.
  • The TCP Protocol in SQL Server Configuration Manager is enabled.
  • The SQL Server service is set to listen on a fixed port, not on a dynamically allocated one.

Configure one of the following authentication methods through which Insights can connect to the SQL Server database:

Windows Integrated Authentication (click to expand)

For this option, a new login is required for the SQL Server as a service account. The service account should be a domain user whose password never expires. Looker, the underlying engine used by Insights, runs in a Linux container.

🚧

Important

To enable Windows Authentication, SQL Server needs to support authentication through the Kerberos protocol.

For more details on how to enable Kerberos authentication on SQL Server, see Manual SPN Registration.

Considerations when configuring Windows Integrated Authentication

  • Before configuring the Kerberos authentication, make sure that the Insights Server can access your Active Directory (AD) and SQL Server. You can review this with your IT administrator.
  • SQL Server needs to be added to your AD domain.
  • Insights machine needs to be on the same network as the AD Domain and SQL Server.
  • DNS should be configured so that Insights machine can resolve the domain names for both AD Domain and SQL Server.
  • AD user should exist with access to SQL Server and DB permissions as defined in the Permissions section. Domain, username, and password for this user must be provided during the Insights install process. Keep in mind that the username is case sensitive and that this also serves as the sAMAccountName of the user.
    Open cmd as admin and run set user to get the USERDNSDOMAIN and USERNAME.
  • SQL server needs to have SPN entries in AD. For more information, see Register a Service Principal Name for Kerberos Connections.

🚧

Important

It is critical that the Insights machine needs to resolve the domain names of both AD Domain and SQL Server. You can verify this by running nslookup <your_AD_domain_name> and nslookup <your_SQL_server_domain_name> on the host machine.

Create new login in SQL Server Management Studio

  1. In the Object Explorer panel, navigate to Security > Logins.
  2. Right-click the Logins folder and select New Login.
  3. Select the Windows Authentication option. The window is updated accordingly.
704704
  1. In the Login name field, type the user domain you want to use as a service account.
  2. From the Default Language list, select English.

🚧

Important!

Ensure that the Default Language is set to English. If it isn't, the website will not be able to start, and the Event Viewer on the machine on which Insights is installed will display the following error message: The conversion of a varchar data type to a datetime data type resulted in an out-of range value.

  1. Click OK to save the configuration.
    If the service account has already been created and added to the Security > Logins section of the SQL Server, check whether the Default Language of that SQL account is set to English. If it isn't, you need to make the necessary adjustments.
SQL Server Authentication (click to expand)

For this authentication method, you need an SQL Server user.
Consider using a non-SA (system administrator) account for security reasons.

Create SQL user in SQL Server Management Studio

  1. In the Object Explorer panel, navigate to Security > Logins.
  2. Right-click the Logins folder and select New Login. The Login - New window is displayed.
  3. Select the SQL Server authentication option. The window is updated accordingly.
700700
  1. Fill in the Login Name, Password, and Confirm Password fields appropriately.
  2. Ensure that the Enforce password expiration and User must change password at next login options are not selected.

🚧

Important!

Ensure that the Default Language is set to English. If it isn't, the website cannot start, and the Event Viewer on the machine on which Insights is installed displays the following error message: “The conversion of a varchar data type to a datetime data type resulted in an out of range value”.

If the SQL Server account has already been created and added to the Security > Logins section of the SQL Server, please check whether the Default Language is set to English. If it isn't, please make the necessary adjustments.

Permissions

Regardless of the type of user (domain or SQL) you want to connect to SQL Server, please note that you need to assign it the dbcreator Server Role BEFORE installing Insights, as the database is created during this installation process.

If security restrictions do not allow the use of the dbcreator Server Role in the service account, create the empty database in SQL Server.

The Windows installer connects to SQL Server to verify the existence of the database.

After creating the database, you need to provide the user which connects to the Orchestrator SQL database with the db_owner user mapping role, as captured in the screenshot below:

704704

If security restrictions do not allow you to use the db_owner user mapping role with the UiPath login, grant the following:

  • db_datareader
  • db_datawriter
  • db_ddladmin
  • EXECUTE permission on dbo schema
705705

The EXECUTE permission has to be granted by using the GRANT EXECUTE SQL command, as follows.

  • if Windows Integrated Authentication is used:
USE UiPath Insights
GO
GRANT EXECUTE ON SCHEMA::dbo TO [domain\user]
GO
  • if SQL Server Authentication is used:
USE UiPath Insights
GO
GRANT EXECUTE ON SCHEMA::dbo TO [sql_user]
GO

📘

Recommendations

To configure the default MAXDOP of your database, see Configure the max degree of parallelism Server Configuration Option.

 

Install Orchestrator and Enable the Insights Feature

This section is required to prepare the Insights Database. Before you can continue installing Insights, you need to enable the Insights feature in Orchestrator, based on your scenario.

For versions above 2021.10 Orchestrator and Insights fresh installation or Add Insights to existing Orchestrator installation: See Step 3 in Orchestrator Single-Node Installation).

For versions before 2021.10, when you Upgrade Insights: Disable the Insights feature in Orchestrator, then re-enable it.

Orchestrator installed as app service in Azure: If you run Orchestrator as an app service in Azure, you can run a script to publish Orchestrator and enable Insights through the -insightsFeatureEnabled parameter.

📘

Information

• Both the Orchestrator and Insights versions need to match. For example, if you run Orchestrator version 2022.10.0, you need to run the same version of Insights to establish proper communication between the two UiPath products.

• The Insights database needs to point to the same database that was created when you enabled Insights during the installation of Orchestrator.

• If you have a large database, consider manually adding indexes using SQL scripts . The Orchestrator installation might fail during the Insights Database migration if it has to index a large set of data.

Initialize Looker on the Insights Linux Machine

Follow the procedure to initialize Looker on the Insights Linux Machine.

Alternatively, you can use the deployment script (click to expand section)
  1. Run the LookerPreinstallationTool.exe tool to generate a ZIP file for Looker. This will generate Looker files on the Insights Windows Machine.
  2. Copy the Looker files to Insights Linux Machine to deploy Looker, or use the Deploy-Looker.ps1 script to copy extracted files to the Insights Linux Machine and then initialize Looker.

🚧

Important

The Deploy-Looker.ps1 script is compatible with LookerPreinstallationTool.exe version 2022.10.0.


For detailed information, see the Automated Deployment Script.

Generate Looker files on the Insights Windows Machine

The SMTP settings are configured automatically starting with the 2022.10 version

  1. Select the language.

🚧

When you select Chinese/Korean/Japanese

If the console cannot display Chinese/Korean/Japanese correctly, please change the font of your console. For Powershell, you can right-click the title bar and select Properties and select a TrueType font (e.g., MS Gothic, MS Mincho, or NSimSun).

  1. Validate and export the generated certificate. Make sure the hostname is fully qualified and is covered by the certificate.

📘

Note:

The certificate needs to be placed in both Personal and Trusted Root Certification Authorities folders.

823823
  1. (Optional) Configure Windows Auth, if you use it.

📘

Note

If upgrading from 21.10, due to the architectural change to 2 VMs in 22.10, the installer does not automatically transfer dashboards, alerts, and schedules from 21.10 to 22.10. To avoid losing dashboards. alerts, and schedules, please follow step 6 to migrate this content to the new Linux machine. This is not applicable for upgrades from 22.4. Please be advised that if this step is not completed during the upgrade, all dashboards, schedules, and alerts will be deleted and no longer available for export to the new Looker machine once the installation via InsightsInstaller.msi is completed successfully.

  1. (Optional) Export data to continue using your previous dashboards, alerts and schedules in the new version. The tool can detect if a looker_container is running on the machine. If you move your data, the current Looker password stored in $Env:ProgramData\UiPath Insights is going to be exported and used in the new Insights Linux machine.
  2. (Optional) Encrypt the ZIP file to protect the Looker Secret. If you have completed step 4, please consider using a password to protect the ZIP file.
823823
  1. Type the path where you want to create the ZIP file. Otherwise, it will be created in the default path that will be displayed in the console.

Copy Looker files to the Insights Linux Machine

Copy the ZIP file to the Insights Linux machine.

  1. Authenticate into your Insights Linux machine.
  2. Open an SCP session and enter a command including the ZIP file path and username and password used as your Insights Linux machine credentials by running the command below:
scp <path-to-Insights_Lookerfile>.zip <[email protected]>:~/

📘

Note

Consider using Powershell 7 or higher, or Putty, as previous versions (Powershell 5.1) might experience rendering issues or a blank screen.

Initialize Looker

  1. Open Powershell and run the command below to authenticate:

📘

Note

After you log into the Insights Linux machine, make sure the system local time is correct. Otherwise, Looker could enter an infinite refresh loop.

  1. Generate GPG key using the command below:
gpg --generate-key

When prompted, enter the username, email and set a password. A Public Key is generated. Make sure that you save the public key as you will use this later.

The Public Key is used to store the Looker password and certificate generated during the Looker initialization. You can pass this public key using the -k parameter when you run looker-initialization.sh.

15311531
  1. Unzip the Looker files by running the command below:
unzip <Insights_Lookerfiles_timestamp.zip>
  1. Run the Looker initialization script by running the command below:
bash insights/looker-initialization.sh -k <Public Key>

Where <Public Key> is generated through the gpg --generate-key command.
:information-source: You might be asked to enter your password to save the Looker password.

📘

Note

You might get the following error Module yaml error: Unexpected key in data: static_context [line 9 col 3] during the installation. For more information about this bug, see Turn off strict validation of modulemd documents (RhBug:2004853).

This has no impact on the Insights installation.

  1. Exit Powershell and download looker.json by running the following command
scp <[email protected]>:~/insights/looker.json <path-to-save-json>

Replace <[email protected]> with your username and Linux hostname.

You can use cat /home/user/insights/looker.json to copy the content and create a file in the Insights Windows machine named looker.json under $HOME/_insights, then paste the copied content.

After initialization, a file called 'looker.key' will be created in the $HOME/_insights folder. Please do not delete this file, it will be needed for future upgrades.

Insights Installation

📘

Note:

  • When upgrading from a version earlier than 2021.10, users with Insights permissions are not automatically migrated to your new installation. They can be optionally migrated via the User Migration tool. If you already used the tool when upgrading to 2021.10, you do not have to re-run the user migration tool again.

  • The Installer will use the Windows Display Language if it is one of the following languages: en-US, fr-FR, de-DE, es-ES, es-MX, ja-JP, ko-KR, pt-BR, pt-PT, ru-RU, tr-TR, zh-CN. If the Windows Display Language is not one of these languages, then the installer will use English.
  1. Run the InsightsInstaller.msi installer as administrator using the command prompt or PowerShell console.

  2. Navigate to the directory where your .msi installer is located.

  3. Run the Insights installer using the following command:

msiexec /i InsightsInstaller.msi

Alternatively, you can use the following command:

.\InsightsInstaller.msi
  1. The Insights installer should now check the prerequisites. If all prerequisites are met, the UiPath Insights Setup Wizard shows up and guides you through the Insights installation and configuration.
612612

📘

Note:

If the installation failed or you want to check the installation log, you can go to the %temp% or %temp%/<sessionID> folder and check the latest MSI{random chars}.LOG. The files in this directory are not permanent and may be lost between sessions. You can enter the command below to run the installation with the predefined log location.

msiexec -I "InsightsInstaller.msi" -L*V  c:\logs\interactive.log
  1. Accept the License Agreement and click Next.
494494
  1. The Looker initialization script on your Linux host outputs a JSON file with the configuration of the instance. Please input the full filepath of the location where you stored that file on this Windows host.
495495
  1. Enter the Insights Window machine settings as follows:
  • Insights Server URL - the hostname or the URL of the Insights Windows machine.
  • Port - the port you want to use to enable the communication with the Insights Windows machine. The default port number is set to 443.
  • Certificate - the Subject or Thumbprint of the SSL certificate you want to use to secure connections with Insights.
495495
  1. Configure the Orchestrator settings as follows:
  • Orchestrator URL - the URL of Orchestrator
  • Installation Token - enter the Installation Access Token you generated on Identity Server's Installation Access Token page by logging in as the host tenant. For more details, see Host administration portals.
  • Separate Identity Server - If you have a separate identity server, enable this option.

📘

Note:

You need a new Installation Access Token on every installation. The token is valid for 2 hours, after which it expires. Generate another if experiencing an installation failure.

495495
  1. Configure the Insights database settings as follows:
  • Server Name - the name of the SQL Server machine where the Insights database is located, including the default listening port for the SQL Server (1433). For example: SQLServer,1433.
  • Database Name - the name of the Insights database.
  • Authentication Type - choose one of the following authentication methods:
    You must use the fully qualified domain name for the database (e.g., mysever.my.domain instead of myserver). Preferably the SQL Server must join the AD domain directly.
    • Windows Authentication - if selected, Insights connects to the database, creates tables, and runs the IIS Application Pool using the specified credentials. The installer validates the connection using the Windows credentials you are currently logged in with. If you select this option, you must specify the domain, username, and password.
    • 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.
495495

🚧

Important

For security purposes, we do not support no authentication for SMTP. You need to provide the authentication details in step 10.

  1. Configure the email settings as follows:
  • Configure Email Service (SMTP) - check to configure the email service
    • Server - the SMTP hostname.
    • From - the email address to send mail messages from.
    • Username - the username of the SMTP server, if it requires authentication. For example, if you are using Gmail, fill in this field with the email address used to send messages.
      Consider using SMTP with authentication, as SMTP with no authentication may not be supported in the future.
    • Password - the email account password.
    • Port - the SMTP port.
    • TLS/SSL - check to enable TLS/SSL.
      * TLS/SSL Version - only visible TLS/SSL is checked. Choose between TLSv1_1 and TLSv1_2
495495

📘

Note:

Once this step is completed, an email is sent using the SMTP server details. This is to ensure the SMTP details are correct. If there's an error during this step, please check the log file and navigate to the troubleshooting page

  1. Click Next to start the installation. Once the installation process is completed, click Close to exit the installer.
495495

 

Post-Installation Steps

Migrate tables

To migrate jobs tables, use the steps below.

  1. Fill in JobOrganizationUnitId.
with CTE as (
select qie.[JobOrgUnitFullyQualifiedName] as qOrgName, qie.[JobOrganizationUnitId] as qOrgId, j.[OrganizationUnitId] as jOrgId, j.[OrgUnitFullyQualifiedName] as jOrgName
from [dbo].[QueueItemEvents] qie 
inner join [dbo].[QueueItems] qi on qie.[QueueItemId] = qi.[Id]
inner join [dbo].[Jobs] j on qi.[ExecutorJobId] = j.[Id]
where j.[OrganizationUnitId] != qie.[JobOrganizationUnitId] or (qie.[JobOrganizationUnitId] is null and j.[OrganizationUnitId] is not null))
update CTE
set qOrgName = jOrgName, qOrgId = jOrgId;
  1. Create a long-running workflow index if it does not exist.
    Note: If this script was used previously, there is no need to run it a second time.
IF NOT EXISTS(SELECT * FROM sys.indexes WHERE Name = 'IX_JobEvents_JobId_TenantId' and OBJECT_NAME(object_id) = 'JobEvents')
CREATE NONCLUSTERED INDEX [IX_JobEvents_JobId_TenantId] ON [dbo].[JobEvents]
(
    [JobId] ASC,
    [TenantId] ASC
)
  1. Truncate read tables to backfill new fields.
truncate table [read].[QueueItemEvents];
truncate table [read].[QueueItems];
truncate table [read].[Jobs];
truncate table [read].[JobEvents];
delete [dbo].[IngestionMarkers] where [IngestionEventType] in (9002, 9001);

Ensure proper licensing

You need to have at least one license code, which will include Orchestrator, Insights, and one Robot, all of them at the Host level, attached in Orchestrator (see Manage Host Licensing).

Enabling Tenants

After installing Insights, you must then enable Insights for your desired tenant(s) from the Orchestrator host portal. For more details, see Enabling or disabling features.

Verifying the Insights Services

  1. Open a supported web browser
  2. Navigate to the https://hostname:443/Insights to confirm that Insights was successfully installed.

Modifying Insights

Keep the original installation file in case you want to modify or uninstall it.

For more information, see Modifying Insights configurations.

Related Articles

Updated a day ago


Installation


Suggested Edits are limited on API Reference Pages

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