Subscribe

UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

Installation

Prerequisites to Installation

  1. Ensure that you meet the Hardware and Software Requirements for Insights.

  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 > IIS.

  1. Download and install .NET Hosting Bundle version 3.1.17+.
Click for details on installing .NET Hosting Bundle
  1. Download .NET Hosting Bundle.
  2. In Command Prompt, run net stop was /y and then net start w3svc.
  1. Install Orchestrator and enable the Insights feature. You need to get an installation access token from Orchestrator. For more details, see Installation key.
  1. Enable HTTPS on your server using an SSL certificate. The procedure is similar to the one provided for Orchestrator. See Using a Certificate for the HTTPS Protocol.
Click for details on using a self-signed certificate 1. Get self-signed certificate with your DNS and import it into `certlm.msc`.
  1. Run the following command:
$cert = New-SelfSignedCertificate -certstorelocation cert:\localmachine\my -dnsname <your-dns-name> -KeySpec KeyExchange
$pwd = ConvertTo-SecureString -String '<your-password>' -Force -AsPlainText
$path = 'cert:\localMachine\my\' + $cert.thumbprint
Export-PfxCertificate -cert $path -FilePath <path-to-save>\cert.pfx -Password $pwd

📘

Note:

Make sure to replace the following:

  • <your-dns-name> with the DNS name of your server or virtual machine
  • <your-password> with the password you want to encrypt the certificate with
  • <path-to-save> with the location where you want to save the exported .pfx format certificate
  1. Manually install the certificate in both Personal and Trusted using the certificate manager.

🚧

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 stores on the Insights machine, and must also be marked as Exportable.
  • Certificates submitted to a Certificate Authority only need to be installed in Trusted Root.
Click to see how to make the certificate exportable

Note that when using a self-signed certificate, you may experience issues if accessing Insights via Firefox or Edge. Internet Explorer support is no longer offered for Insights 2021.4 or newer.

  1. When specifying a hostname for Insights, make sure that the desired hostname is resolvable within your DNS.
  1. Verify that the server where Insights will be installed can communicate with the server(s) where Orchestrator is installed and vice versa.
  2. If you are using a VM, it must support nested virtualization.
  3. Make sure to use TLS 1.1 or 1.2.
  4. Make sure the following ports are open and accessible: 543 (default), 9999, and 19999.
Click for details on how to open the ports in Azure

Create an inbound port rule for each port to open it up: 543, 9999, 19999.

  • Port 543:
  • Port 9999:
  • Port 19999:
  1. Install Docker for Windows Server 2019.
Click for details on how to install Docker for Windows Server 2019
  1. Enable the following Windows features: Hyper-V and Container. To do this, take the following steps:
    a. Navigate to the Control Panel, then go to Programs.
    b. Click Turning the Windows features on or off.
    c. Select the checkboxes next to Hyper-V in the Server Roles tab and Container in the Features tab.
    d. Restart the server if required.
  1. Open PowerShell to install Docker and run the following command:
Install-Module -Name DockerMsftProvider -Repository PSGallery -Force
  1. Run the following command as well:
Install-Package -Name docker -ProviderName DockerMsftProvider
  1. Using PowerShell, restart the computer by running the following command:
Restart-Computer -Force
  1. Using PowerShell, set up the environment variable LCOW_SUPPORT by running the following command:
# Set LCOW_SUPPORTED Variable to 1 for enabled
[Environment]::SetEnvironmentVariable("LCOW_SUPPORTED", "1", "Machine")
  1. Using PowerShell, enable the Experimental Features in daemon.json by running the following command:
# Enable Experimental Features in Docker daemon.conf
$configfile = @"
{
    "experimental": true
}
"@
$configfile|Out-File -FilePath C:\ProgramData\docker\config\daemon.json -Encoding ascii -Force
  1. You can use PowerShell to download lcow kernel and unzip the Linux Containers to the Program Files folder, by running the following command:
Invoke-WebRequest -Uri "https://github.com/linuxkit/lcow/releases/download/v4.14.35-v0.3.9/release.zip" -UseBasicParsing -OutFile release.zip; Expand-Archive release.zip -DestinationPath "$Env:ProgramFiles\Linux Containers\."
  1. Next, using PowerShell, set the environment variable by running the following command:
[Environment]::SetEnvironmentVariable("LCOW_API_PLATFORM_IF_OMITTED", "linux", "Machine")
  1. Lastly, restart Docker by running the following command in PowerShell:
Restart-Service Docker
  1. If you use VMWare, make sure to use VMwareToolboxCmd 11.0.6+. Earlier versions may cause Docker container to restart unexpectedly.

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 is case insensitive (“InsightsDB” = “insightsdb”). If it is created during the Insights installation process, it is automatically set as such. If not, you have to configure it manually as case insensitive.

If you create your own Insights database, you need to set the collation sequence to Latin1_General_CI_AS.

Prerequisites

Make sure that you have the following either at hand or have them worked through, as the initial configuration steps:

  • The name of the SQL Server machine.
  • The name of the instance, if it’s not the default instance.
  • The SQL Server port is open in the firewall of the SQL Server machine.
  • 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.

SQL Server Authentication Methods

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 analytics platform used by Insights runs in a Linux container. To enable Windows Authentication, SQL Server needs to support this type of authentication through the Kerberos protocol.

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 Server needs to be on the same network as the AD Domain and SQL Server.
  • DNS should be configured so that Insights Server 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.
  • 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 server 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.
  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 cannot start, and the Event Viewer on the computer 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.

  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.
  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 computer 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 SQL database with the db_owner user mapping role, as in the following screenshot.

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

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

 

Insights Installation

📘

Note:

  • When upgrading to 2021.10, users with Insights permissions are not currently migrated to the new version. A script to do so will be available soon.

  • 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. Type cmd or powershell, then right-click the app and Run as administrator.

  3. Type the cd <path-to-msi> command, where <path-to-msi> is where your .msi installer is located. E.g., C:\Users\yourUsername\Downloads>.

  4. 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.

📘

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.
If you would like to specify a different directory, use the command msiexec.exe /i InsightsInstaller.msi /L*V logfilepath. For more details, see the Support page.

  1. Accept the License Agreement and click Next.
  1. Change the Insights server settings as follows:
  • Insights Server URL - the hostname or the URL of the Insights Server.
  • Port - the port you want to use to enable the communication between the computer and Insights.
  • Certificate - the Subject or Thumbprint of the SSL certificate you want to use to secure connections with Insights.
  1. Configure the Orchestrator settings as follows:
  • Orchestrator URL - the URL of Orchestrator
  • Separate Identity Server -
  • 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 Installation Access Token.

📘

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.

  1. Configure the Insights database settings as follows:
  • Server Name - the name of the SQL Server machine where the Insights database is located
  • 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.
  1. Configure the email settings as follows:
  • Configure Email Service (SMTP) - check to configure the email service
    • Server - the SMTP host
    • From - the email address to send mail messages from. It must match that provided for Username.
    • 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.
    • 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

📘

Note:

Once this step is completed, an email is sent using the SMTP server details. This is to ensure the SMTP details are correct.

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

🚧

Important!

After Insights installation has finished, make sure to restart Docker.

 

Post-Installation Steps

Verifying the Insights Services

📘

Note:

Do not remove the C:\\Users\\yourUsername\\_insights folder.

Accessing Looker

To verify that Looker is running, make sure the Docker container is up.

After Insights installation has finished, navigate to the browser to confirm a successful installation.

Tenant Setup

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

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.