通知を受け取る

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

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

インストールの前提条件

Orchestrator Server

  • Windows Server Operating System - 最低限必要なバージョン: 2012 R2。その他のサポートされるバージョンについては、「ソフトウェア要件」をご覧ください。
  • PowerShell - 必要となる最低バージョンは 4.0 です。
  • .NET Framework - 最低限必要なバージョン: 4.7.2。コンピューターにインストールされている .NET のバージョンを確認するには、「インストールされている .NET バージョンを確認する」をご覧ください。
  • IIS - minimum required version: 8. this is part of the Web Server (IIS) role and is automatically enabled by the provided InstallRolesAndFeatures.ps1script, which can be found in here.
  • ASP.Net Core IIS Module - minimum version 3.1.x, available here as part of the Hosting Bundle. To download it, make sure you click Hosting Bundle, as shown in the following image.
662662

📘

注:

Only the Core module is required, and can be installed without any runtimes by using the OPT_NO_RUNTIME=1 parameter from the command line.

  • URL Rewrite - minimum required version 2.1. Enables the website to redirect the calls to https (https://servername), instead of http (http://servername). Please download and install URL Rewrite by accessing this link.
  • サーバーの役割と機能。アプリケーション サーバーに必要な役割や機能を自動的に追加する PowerShell スクリプトを利用できます。役割と機能のリストは、「サーバーの役割と機能」に掲載されています。このページは、情報提供のみを目的として提供されています。
  • Web-Deploy extension - minimum required version: 3.6, 64bit version. Please note that this is required only for PowerShell script installations, such as the Azure one. Enables you to deploy a website. Please download and install Web Deploy Extension 3.6 by accessing this link.
  • Web.Config - The <system.webServer> element in web.config must not contain any locked sections. If such sections exist, you need to manually unlock them in IIS.
  • アプリケーション プール ユーザーには、ローカル コンピューター ポリシーで次の権限が割り当てられている必要があります。
    • バッチ ジョブとしてログオンする権限
  • 匿名認証有効化する必要があります。
10131013

Web 証明書 (SSL証明書)

ユーザーが Web アプリケーションにアクセスするすべてのブラウザーにおける Robot と Orchestrator 間の通信には、すべて HTTPS プロトコルが必須です。

次の 3 種類の Web 証明書を使用できます。

  • GoDaddy、VeriSign などの信頼された証明機関が発行した Web 証明書。Web 証明書は、IIS のサーバー証明書へインポートする必要があります。Windows インストーラーに入力を求められる際に「Issued To」エンティティの名前を提供する必要があるため、これを把握しておく必要があります。
  • 自分自身が証明機関として Windows ドメイン内で信頼された証明書を発行する。詳しくは、「証明書を使用して HTTPS プロトコルを有効化する」をご覧ください。
  • 自己署名証明書 (運用環境には推奨されません)。この証明書は、ドメイン内では信頼されません。そのため、公開キーをエクスポートし、すべてのロボット端末にインポートする必要があります。詳しくは、「証明書を使用して HTTPS プロトコルを有効化する」をご覧ください。

The name of the certificate you provide when prompted by the Windows installer, or the one mentioned in the command line using -sslCertificate is the same one that appears in the Issued To column in Server Certificates in IIS.

903903

🚧

重要

セキュリティ上の理由から、Identity Server で使用する証明書は次の要件を満たしている必要があります。
2048 ビットの公開キーがあること
署名可能
有効期間内である (失効していない)

The certificate's location is set in Identity Server's configuration file appsettings.Production.json, in the Signing Credential section.

自己署名証明書を使用する場合、(通常の個人用ストアに加え) 信頼されたルート証明機関の証明書ストアにも配置しておく必要があります。

証明書は OpenID アクセス トークンの署名に使用され、このトークンはブラウザー経由のユーザーの識別や、Orchestrator と Identity Server とのサービス間の通信に使用されます。 OpenID Connect について詳しくはこちらをご覧ください。

SQL Server

次のいずれかのバージョンを備えた SQL Server マシン: 2012, 2014, 2016, 2017, または 2019 の Standard または Enterprise Edition

  • SQL Server 製品は、アプリケーション サーバー (本番環境では推奨されていません) と同じ端末にインストールするか、または別の端末として使用することができます。SQL Server 端末は、他のアプリケーションと共有することができ、Orchestrator 専用にする必要はありません。Always On 可用性グループのデプロイ方法に関する前提条件、制限、推奨については こちら、フィジカル デプロイ オプションについての詳細については こちら をクリックしてください。
  • SQL Server ユーザーを使用して Orchestrator をデータベースに接続する場合はWindows および SQL サーバー認証モードを有効化します。または、「Windows 認証モード」でも可能です。SQL Server が既にインストールされている場合は、以下の画像に示されるようにこのオプションを選択してください。
487487 711711
  • The collation sequence has to be the default one - Latin1_General_CI_AS です。
  • SQL Server Management Studio は、SQL Server にアクセスするドメイン ユーザーのログイン構成を行うために必要となります。アプリケーション プールは、アプリケーション サーバー上においてドメイン ユーザー名で実行されます。

SQL Server 構成

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

📘

注:

Orchestrator SQL データベースは大文字と小文字を区別しないように設定する必要があります (「OrchDB」=「orchdb」)。Orchestrator のインストール プロセス中に作成された場合は、自動的にそのように設定されます。その他の場合は、大文字と小文字を区別しないように手動で設定する必要があります。

要件:

  • SQL Server 端末の名前
  • 既定のインスタンスではない場合は、インスタンスの名前
  • 既定のポートではない場合は、TCP ポートの値 - 1433
  • SQL Server 端末のファイアウォールで SQL Server ポートがオープンとなっています
  • SQL Server Configuration Manager の TCP プロトコルが有効であること
  • SQL Server サービスを、動的に割り当てられたポートではなく、固定ポートにリッスンするようにします。

Orchestrator が SQL Server データベースに接続するためのオプションを、次の中から選択します。

  1. Windows 統合認証。このオプションを選択すると、サービス アカウントで SQL Server への新規ログインが必要となります。サービス アカウントは、パスワードが有効期限内のドメイン ユーザーとする必要があります。

SQL Server Management Studio で新しいログインを作成するには:
a. [オブジェクト エクスプローラー] パネルで [セキュリティ] > [ログイン] の順に選択します。
b. [ログイン] フォルダーを右クリックして [新しいログイン] を選択します。[ログイン - 新規作成] ウィンドウが表示されます。
c. [Windows 認証] オプションを選択します。ウィンドウが適切に更新されます。

704704

d. [ログイン名] フィールドに、サービス アカウントとして使用するユーザー ドメインを入力します。
e. [既定の言語] リストから [英語] を選択します。

🚧

重要

[既定の言語][英語] に設定されていることを確認してください。そうでない場合、Web サイトは開始できず、Orchestrator がインストールされているコンピューター上のイベント ビューアーに、「varchar データ型から datetime データ型へ変換した結果、値が範囲外になりました」というエラー メッセージが表示されます。

f. [OK] をクリックします。設定が保存されます。
サービス アカウントが既に作成され、SQL Server の [セキュリティ] > [ログイン] セクションに追加されている場合、SQL アカウントの [既定の言語] が [英語] に設定されていることを確認してください。英語に設定されていない場合は、適切に変更します。

  1. SQL Server username and password. In this case, a SQL Server user is required. We strongly recommend not to use a sa account.

SQL Server Management Studio で新しい SQL ユーザーを作成するには:
a. [オブジェクト エクスプローラー] パネルで [セキュリティ] > [ログイン] の順に選択します。
b. [ログイン] フォルダーを右クリックして [新しいログイン] を選択します。[ログイン - 新規作成] ウィンドウが表示されます。
c. [SQL Server 認証] オプションを選択します。ウィンドウが適切に更新されます。

700700

d. [ログイン名][パスワード][確認パスワード] フィールドに適切な値を入力します。
e. オプションの [パスワードの有効期限を強制] および [次のログインでパスワードを変更する必要がある] が選択されていないことを確認します。

🚧

重要

[既定の言語][英語] に設定されていることを確認してください。そうでない場合、Web サイトは開始できず、Orchestrator がインストールされているコンピューター上のイベント ビューアーに、「varchar データ型から datetime データ型へ変換した結果、値が範囲外になりました」というエラー メッセージが表示されます。

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 Orchestrator, 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.

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

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.

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

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

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

High Availability Add-on

Orchestrator の High Availability Add-on (HAA) は、Orchestrator ノード間でのキャッシュと共有に使用するインメモリ データベースです。ほぼ即座の同期を提供します。

🚧

重要

HAA は、クラスター環境で必須です。

Orchestrator のマルチノード デプロイは、通信に REdis Serialization Protocol (RESP) を使用するため、このプロトコルを使用するあらゆるソリューションによる設定が可能です。UiPath がサポートしているソリューションは HAA のみです。

次の情報が HAA に格納されます。

  • セッション ステート - 複数のノードに Orchestrator をインストールした場合に自動的に設定されます。
  • ブラウザーからのユーザー セッション
  • ロボットのハートビートのキャッシュ
  • ユーザーとロールの関連付け
  • ユーザーと組織単位の関連付け
  • ライセンス情報
  • 設定

また、High Availability Add-on は、

  • すべての Orchestrator ノードにジョブの開始のコマンドを送信し、さらにこれが適切なロボットに送信されるようにします。
    • 例: Orchestrator ノード上で、ユーザーが手動でロボット上のジョブを開始します。この特定のノードは、どの Orchestrator ノードにロボットが接続しているかがわかりません。ジョブを開始したノードは、この要求を HAA に転送します。HAA は、この開始コマンドをすべての Orchestrator ノードにブロードキャストします。該当するロボットとの接続を確立していた Orchestrator ノードは、この開始コマンドをロボットに送信します。該当するロボットに接続していないその他の Orchestrator ノードは、このコマンドを無視します。
  • keeps all packages (.nupkg files) in sync on all nodes (if NuGet.EnableRedisNodeCoordination is set to true):
    • Example: - If you upload or delete a .nupkg file on one Orchestrator node, it sends a message to HAA. The HAA server broadcasts the message to all Orchestrator nodes. Each Orchestrator node, except the one that sent the message, starts to rebuild its own NuGet cache.

It is also possible to enable SSL encrypted connections between the Orchestrator nodes and the HAA service, through the LoadBalancer.Redis.ConnectionString web.config parameter. For more information, please see this page.

ネットワーク ロード バランサー

ネットワーク ロード バランサーでは、マルチノード間に負荷を分散し、Orchestrator インスタンスの全体的なパフォーマンスを向上させることができます。さらに、1 つのノードで障害が発生した場合、残りのノードが負荷を引き受けて、ダウンタイムが生じないようにします。

🚧

重要

Orchestrator をクラスタに配備する場合は、高可用性モデルを活用するため、ネットワーク ロード バランサーが必須です。

ノード間に負荷を分散してノードのパフォーマンスを向上させ、Orchestrator の全体的なパフォーマンスを高めることから、予測アルゴリズムによる F5 ロード バランサーが推奨されます。アルゴリズムの詳細については、こちらをご覧ください。

Elasticsearch サーバー

Elasticsearch is optional and is used to store messages logged by the Robots. Logs can be sent to ElasticSearch and/or to a local SQL database, thus enabling you to have non-repudiation logs. When using both ElasticSearch and SQL, they do not affect each other if one of them encounters a problem. These parameters can be changed from the web.config file (C:\Program Files (x86)\UiPath\Orchestrator). For more information, see Logging Configuration.

ElasticSearch の使用を選択した場合、ElasticSearch が、Windows、Linux、または Unixで動くクロスプラットフォーム製品であり、Java を必要とすることにご注意ください。OpenJDK または Oracle JRE を使用できます。相互運用性マトリクスは Elasticsearch によってこちらで提供されています。

📘

注:

2019 年 4 月 16 日以降、Oracle はライセンス モデルを変更しました。変更に関する詳細についてはこちらをご覧ください。

If the computers are in a domain, you have to ensure that they are added in the Computers section of the domain server, in Active Directory Users and Computers. This step is required because the computer name is used during the installation process. For example, http://computername.domain.name または http://computername is used instead of http://localhost です。
不可能な場合は、コンピューター名または IP アドレスをインストール プロセスの間に使用します。

Elasticsearch をインストールする

  1. Elasticsearch をダウンロードします。
  2. エラスティック検索 Windows インストーラーをダブルクリックします。[場所] の手順で、Elastisearch ウィザードが表示されます。
943943
  1. インストール、データ、構成およびログについて、既定のディレクトリを用いるか、それぞれ独自の場所を選択します。

📘

注:

Elasticsearch のインストール先に別のディスクがある場合、Elasticserarch に対し、自由に使用できるスペースがより多いディスク上にデータを格納するよう設定することができます。

  1. [Next] をクリックします。[Service] の手順が表示されます。
941941
  1. 次のオプションが選択されていることを確認してください。
    • サービスとしてインストール
    • インストール完了後にサービスを開始
    • Windows の起動時にサービスを開始 (自動)
  2. [Next] をクリックします。Configuration の手順が表示されます。
  3. 必要に応じて、次のオプションの設定が必要です。
    • Cluster name - Elasticsearch のインストール目的を反映する値に変更します。お使いのイントラネット内に Elasticsearch を使用する複数のサーバーがある場合、オートディスカバリー機能が働くのを避けるためにも重要です。
    • Node name - お使いのノードに関する適切な名前。
    • Roles - 既定のオプションが推奨されます。
    • Memory - 既定のオプションが推奨されます。
    • Network host - コンピューターのホスト名/IP アドレス (コマンド プロンプトで hostname コマンドを実行してマシン名を取得できます)。
    • HTTP Port - Elasticsearch の既定のポートは 9200 です
    • Discovery - クラスターの最初のノードに対して [This is the first master in a new cluster] チェックボックスをオンにします。
942942

🚧

重要

Orchestrator が別の端末にインストールされている場合、Elasticsearch がインストールされている端末のファイアウォールでポート 9200 を開放してください。

  1. [Next] をクリックします。[Plugins] 手順が表示されます。
  2. (任意) セキュリティ用の X-Pack など、Elasticsearch の追加のプラグインを選択します。
936936
  1. [Install] をクリックすると、Elasticsearch がインストールされます。
671671

インデックス シャーディングの数を減らす

既定では、新しく作成された Elasticsearch インデックスには 5 つのシャードが作成されます。ただし、パフォーマンスを向上させるために、作成数を 2 つに減らすことをお勧めします。詳細については、Elasticsearch の公式ドキュメントをご覧ください。

To make this change, all you have to do is make a PUT request to your Elasticsearch instance URL in the elasticUrl/_template/uipath_logs format, with the following body:

{
    "template": "*",
    "order": 1,
    "settings": {
        "number_of_shards": 2
    }
}

To test your ElasticSearch connection, use any browser to open the following URL: http://computername:9200/ です。 Computername stands for the name of the computer on which Elasticsearch is installed. The browser should either ask you to download a .json file or open and display the file as in the picture below.

431431

Kibana

Kibana を Elasticsearch と組み合わせて使用すると、Elasticsearch に送信したログ (この場合はロボットが送信したログ) に基づくカスタム表示を作成できます。

Kibana をインストールする

📘

注:

Kibana の実行に Java は必要ありません。Kibana が Elasticsearch とは異なる端末にインストールされている場合、Kibana の実行のために Java をインストールする必要はありません。

  1. Kibana をダウンロードします。
  2. Kibana パッケージを解凍します。

📘

注:

Unzip to C:\ or D:\ . You do not need to create a new folder named kibana-x.y.z-windows, because the files in the archive are already placed in a folder with that name.

  1. Edit the Kibana configuration file (C:\kibana-x.y.z-windows-x86\config\kibana.yml), as follows:

📘

注:

最初にワードパッドでファイルを開き、内容を保存して LF (Line Feed) 文字を CRLF (Carriage Return Line Feed) 文字に変換します。その後、ノートパッドでそのファイルを開きます。

3.1. Uncomment the line that contains server.port. The default value is 5601. It does not need to be changed unless you want Kibana to run on a different port.
3.2. Uncomment the line that contains server.host. Change the value to the name of the computer.
3.3. Uncomment the line that contains elasticsearch.url. Change the value to the Elasticsearch URL, using the name of the computer on which Elasticsearch is installed. For example, http://computername:9200 です。
Note: For Kibana 6.6.0 or later this line has been replaced by elasticsearch.hosts です。
下のスクリーンショットでは、Kibana および Elasticsearch 両方のコンピューター名が JLTSQL である Kibana 構成ファイルの例を表示しています。

967967

3.4. ファイルを保存します。

  1. Download the setup-kibana-service.zip archive.
  2. Copy the nssm.exe and setup_kibana.bat files from the setup-kibana-service.zip archive to C:\kibana-x.y.z-windows-x86\bin です。
  3. Open the setup_kibana.bat file to check whether Kibana is installed in accordance with the location set in the KIBANA_HOME variable in the BAT file. If you extracted Kibana to a diferent location, make the necessary changes.
  4. Open Command Prompt as an Administrator and change the folder to C:\kibana-x.y.z-windows-x86\bin です。
  5. 実行 setup_kibana.bat to install Kibana.
  6. Test whether Kibana responds by typing http://computername:5601 in any web browser. computername represents the name of the computer on which you installed Kibana.

🚧

重要

Kibana のインストール先の端末のファイアウォールで、ポート 5601 を開きます。

  1. 次のように Kibana を使用して Elasticsearch データベースにテスト メッセージを追加します。
    10.1. Kibana で [Dev Tools] タブに移動します。
    10.2. Submit a POST request in the format displayed below. If no error is returned, the Elasticsearch index named default-yyyy.mm is created and the message is added.
POST default-2018.08\logEvent
{
	"message": "Hello Elasticsearch!", 
	"@timestamp": "2018-07-03T08:56:56.1219306Z" 
}

🚧

重要

Each time a new tenant is added, a corresponding index pattern should be created in Kibana, starting with the name of the tenant. yyyy stands for the year in which the message was added. mm stands for the month in which the message was added. Read Creating an Index Pattern to Connect to Elasticsearch to learn how to create an index pattern in Kibana.

時間同期

選択したインストールの種類に関係なく、スケジューリング機能を適切に動作させるために、次のことを必ず確認するようにしてください。

  • 冗長化構成では、すべてのマシンのシステム時刻が誤差 1 秒以内で同期されていること
  • データベースおよび Orchestrator マシンのシステム時刻も同様に同期されていること
  • SQL データベースがエラー ステートの場合は、IIS から Orchestrator Web サーバーを再起動することが推奨されます。NLB 環境の場合は、すべての Web サーバーを再起動してください。

1 年前に更新


インストールの前提条件


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

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