通知を受け取る

UiPath 製品のインストールとアップグレード

UiPath 製品のインストールとアップグレード ガイド

インストール

🚧

重要

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.4 requires a Windows machine and a Linux machine with RHEL 8.2-8.5.

Click to expand this section

In 2021.10, the Insights Windows machine ran Docker which hosted the Looker Linux container. Starting with 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 2 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.

概要

📘

はじめる前に

Check Insights Hardware and Software Requirements.

To install Insights Standalone v2022.4 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.

📘

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.
Click for details on preparing a Linux machine
AWS EC2 environment preparation

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.5)
  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:

Type

Port range

Source

Note

Custom TCP

9999

Anywhere-IPv4

This is the Looker port.

Custom TCP

19999

Anywhere-IPv4

This is the Looker API port.

Custom TCP

29999

Anywhere-IPv4

This is the LookML update port.

  1. Click Save rules.
Microsoft Azure environment preparation

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.5 from the Plan. For the offline RHEL bundle, click here.
  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 ranges

Name

Priority

Source

9999

Looker_Port

310

Any

19999

LookerAPI_Port

320

Any

29999

LookMLUpdate_Port

330

Any

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

Step 3 Increase storage allocation for Azure Linux machines

The default storage allocation in Azure Linux machine is 8GB and it might cause out of space errors when pulling images, creating backup, or if you are using multiple dashboards. Follow these steps to increase storage allocation.

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

You need to change <your-hostname> to your own machine hostname

  1. Change to root user.
sudo -i
  1. Check the disk size.
lsblk -f

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

  1. Check the size of /dev/sda2.
lsblk /dev/sda2

Where /dev/sda2 is get from step 3. You'll see the size for /var is 8G.

  1. Check available space.
vgdisplay rootvg

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

  1. Increase the size of rootvg-varlv.
lvresize -r -L +10G /dev/mapper/rootvg-varlv

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

  1. Check if the resize succeeded.
lsblk /dev/sda2

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

Click 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 543 inbound port. For AWS instructions, see Authorizing access to an instance. For Azure instructions, see NSG Quickstart Portal.

  3. Install the following prerequisites highlighted in steps 3.1 - 3.4.

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

3.1 Enable IIS 10+.

バージョン 10 以降の IIS の有効化について詳しくは、こちらをクリックしてください。

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

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

次の Web サーバー (IIS) モジュールを有効化します。

  • Web サーバー
    • HTTP 共通機能
      • 既定のドキュメント
      • ディレクトリの参照
      • HTTP エラー
      • 静的なコンテンツ
    • 健全性と診断
      • HTTP ログ
    • パフォーマンス
      • 静的なコンテンツ
    • セキュリティ
      • 要求フィルター
  • 管理ツール
    • IIS 管理コンソール

3.2 Download and install .NET Hosting Bundle version 3.1.17+.

3.3 In PowerShell, run the following commands:

net stop was /y ; net start w3svc

🚧

重要

• 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.4.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 enable Insights during the installation of Orchestrator.

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

  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. Insights のホスト名を指定する際は、DNS 内で解決できるホスト名であることを確認してください。

  1. Verify that the machine where Insights will be installed can communicate with the machine(s) where Orchestrator is installed and vice versa.

  2. TLS 1.1 または 1.2 を使用してください。

SQL Server 構成

Insights のインストール前に、使用する Insights SQL Server インスタンスを構成する必要があります。

📘

注:

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:

  • SQL Server マシンの名前
  • 既定のインスタンスではない場合は、インスタンスの名前

Also, ensure:

  • SQL Server マシンのファイアウォールで SQL Server のポートがオープンされている
  • SQL Server Configuration Manager で TCP プロトコルが有効化されている
  • SQL Server サービスが、動的に割り当てられたポートではなく固定ポートをリッスンするよう設定されている

Insights が SQL Server データベースに接続するための認証方法を構成します。認証方法は次のいずれかです。

Windows 統合認証 (クリックして展開)

このオプションを使用するには、SQL Server にサービス アカウントとして新しくログインする必要があります。サービス アカウントは、パスワードが無期限のドメイン ユーザーである必要があります。Insights で使用される分析プラットフォーム「Looker」は、Linux コンテナーで実行されます。Windows 認証を有効化するには、SQL Server が Kerberos プロトコル経由の認証をサポートしている必要があります。

Windows 統合認証を構成する際の考慮事項

  • Kerberos 認証を構成する前に、Insights サーバーがお使いの Active Directory (AD) および SQL Server にアクセスできることを確認してください。IT 管理者とともに確認することをお勧めします。
  • SQL Server は AD ドメインに追加されている必要があります。
  • 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.
  • Active Directory ユーザーは、「権限」セクションで定義されているように、SQL サーバーと DB へのアクセス権を持つ必要があります。このユーザーのドメイン、ユーザー名、パスワードを、Insights のインストール プロセスで指定する必要があります。ユーザー名は大文字と小文字が区別され、ユーザーの sAMAccountName としても機能しますのでご注意ください。
  • SQL Server は Active Directory に SPN エントリを登録する必要があります。詳しくは、「Kerberos 接続用にサービス プリンシパル名を登録する」をご覧ください。

🚧

重要

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.

SQL Server Management Studio で新しいログインを作成する

  1. [オブジェクト エクスプローラ] パネルで [セキュリティ] > [ログイン] に移動します。
  2. [ログイン] フォルダーを右クリックして [新しいログイン] を選択します。
  3. [Windows 認証] オプションを選択します。ウィンドウが適切に更新されます。
  1. [ログイン名] フィールドに、サービス アカウントとして使用するユーザー ドメインを入力します。
  2. [既定の言語] リストから [English] を選択します。

🚧

重要

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. [OK] をクリックして構成を保存します。
    サービス アカウントが既に作成され、SQL Server の [セキュリティ] > [ログイン] セクションに追加されている場合、SQL アカウントの [既定の言語] が英語に設定されていることを確認してください。英語に設定されていない場合は、適切に変更する必要があります。
SQL Server 認証 (クリックして展開)

この認証方法では、SQL Server ユーザーが必要です。
セキュリティ上の理由から、非 SA (非システム管理者) アカウントの使用を検討してください。

SQL Server Management Studio で新しい SQL ユーザーを作成する

  1. [オブジェクト エクスプローラ] パネルで [セキュリティ] > [ログイン] に移動します。
  2. [ログイン] フォルダーを右クリックして [新しいログイン] を選択します。[ログイン - 新規作成] ウィンドウが表示されます。
  3. [SQL Server 認証] オプションを選択します。ウィンドウが適切に更新されます。
  1. [ログイン名][パスワード][パスワードの確認入力] の各フィールドに適切な値を入力します。
  2. [パスワードの期限を適用する][ユーザーは次回ログイン時にパスワードを変更する] の 2 つのオプションがオフになっていることを確認します。

🚧

重要

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

SQL Server アカウントが既に作成され、SQL Server の [Security] > [Logins] セクションに追加されている場合、Default Language が英語に設定されていることを確認してください。英語に設定されていない場合は、適切に変更します。

アクセス許可

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.

セキュリティの規制としてサービス アカウントで dbcreator サーバーの役割の使用を許可していない場合、SQL Server で空のデータベースを作成します。

Windows インストーラーが SQL Server に接続され、データベースの存在が確認されます。

データベース作成後、Orchestrator SQL データベースに接続するユーザーに db_owner ユーザー マッピング ロールを付与する必要があります。以下のスクリーンショットをご覧ください。

セキュリティ規制により UiPath ログインで db_owner ユーザーマッピングの役割が使用できない場合、次の許可を設定します。

  • db_datareader
  • db_datawriter
  • db_ddladmin
  • dbo スキーマに対する EXECUTE 権限

EXECUTE 権限は、GRANT EXECUTE SQLコマンドを用いて次のように許可を設定する必要があります。

  • Windows 統合認証を使用している場合:
USE UiPath Insights
GO
GRANT EXECUTE ON SCHEMA::dbo TO [domain\user]
GO
  • SQL サーバー認証を使用している場合:
USE UiPath Insights
GO
GRANT EXECUTE ON SCHEMA::dbo TO [sql_user]
GO

📘

推奨

データベースの既定の MAXDOP を構成するには、「max degree of parallelism サーバー構成オプションの構成」をご覧ください。

 

Install Orchestrator and Enable the Insights Feature

Orchestrator をインストールし、Insights の機能を有効化します。Orchestrator からインストール アクセス トークンを取得する必要があります。詳しくは、「インストール キー」をご覧ください。

📘

Information

Your Orchestrator and Insights products must be of the same version (e.g., v2022.4.0).

Initialize Looker on the Insights Linux Machine

Generate Looker files on the Insights Windows Machine

Run the LookerPreinstallationTool.exe tool to generate a ZIP file for Looker.

  1. Download LookerPreinstallationTool.exe and run it on the Insights Windows machine.
  2. Follow the initial steps to generate the ZIP file.
  3. Select the language.

🚧

If 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.
  1. (Optional) Configure and validate SMTP settings.
  2. (Optional) Configure Windows Auth, if you use it.

📘

If you upgrade from 21.10, you can export your current dashboards, views, and settings in step 7 and migrate this information to the new Linux machine.

  1. (Optional) Export data to continue using your previous dashboards, views and app settings in this new environment. The tool can detect if a looker_container is running on the machine. If you move your data, the current Looker password stored in _insights/LookerSecret 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 completed step 7, please consider using a password to protect the ZIP file.
  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
scp <path-to-Insights_Lookerfile>.zip <[email protected]>:~/

📘

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 a command to authenticate.

📘

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 this information.

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.

  1. Unzip the Looker files.
unzip <Insights_Lookerfiles_timestamp.zip>
  1. Run the Looker initialization script.
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 your Looker password.

📘

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 effect on the Insights installation.

  1. Exit Powershell and download looker.json by running the following command from the Local machine (Insights).
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.

Insights のインストール

📘

注:

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

  • Windows の表示言語が次のいずれかである場合、インストーラーではその言語が使用されます: en-US、fr-FR、de-DE、es-ES、es-MX、ja-JP、ko-KR、pt-BR、pt-PT、ru-RU、tr-TR、zh-CN。Windows の表示言語がこれら以外の言語である場合、インストーラーでは英語が使用されます。
  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. 次のコマンドを使用して Insights インストーラーを実行します。

msiexec /i InsightsInstaller.msi

または、次のコマンドを実行します。

.\InsightsInstaller.msi
  1. Insights インストーラーによって前提条件が確認されます。前提条件がすべて満たされている場合は、UiPath Insights セットアップ ウィザードが表示され、Insights のインストールと構成についての説明が表示されます。

📘

注:

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. This directory is nonpersistent. 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. ライセンス契約に同意し、[次へ] をクリックします。
  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.
  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 Windowsmachine.
  • 証明書 - Insights との接続のセキュリティ保護に使用する SSL 証明書のサブジェクトまたは拇印です。
  1. Orchestrator の設定を次のように構成します。
  • Orchestrator URL - Orchestrator の URL です。
  • 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.

📘

注:

インストールするたびに、新しいインストール アクセス トークンが必要です。トークンの有効期間は 2 時間です。インストールに失敗した場合は、新たなトークンを生成します。

  1. Insights データベースの設定を次のように構成します。
  • サーバー名 - Insights データベースが配置されている SQL Server マシンの名前です。
  • データベース名 - Insights データベースの名前です。
  • 認証の種類 - 次のいずれかの認証方法を選択します。
    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.

🚧

重要

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

  1. メールの設定を次のように構成します。
  • メール サービス (SMTP) を設定 - オンにすると、メール サービスを設定できます。
    • Server - the SMTP hostname.
    • 送信元 - メール メッセージの送信元となるメール アドレスです。
    • ユーザー名 - 認証が必要な場合の SMTP サーバーのユーザー名です。たとえば Gmail を使用している場合は、メッセージの送信に使用するメール アドレスをこのフィールドに入力します。
    • Password - the email account password.
    • ポート - SMTP ポートです。
    • TLS/SSL - オンにすると、TLS/SSL が有効化されます。
      * TLS/SSL Version - only visible TLS/SSL is checked. Choose between TLSv1_1 and TLSv1_2

📘

注:

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.

 

インストール後の手順

テナントのセットアップ

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.

Insights のサービスを検証する

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

Insights を変更する

インストールを変更またはアンインストールできるよう、元のインストール ファイルは保存しておきます。

For more information, see Modifying Insights configurations.

関連ドキュメント

1 日前に更新


インストール


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。