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

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

インストールの前提条件

Orchestrator Server

  • Windows Server Operating System - 最低限必要なバージョン: 2012 R2。その他のサポートされるバージョンについては、「ソフトウェア要件」を参照してください。
  • PowerShell - 必要となる最低バージョンは 4.0 です。
  • .NET Framework - 必要となる最低バージョンは、4.7.2 です。コンピューターにインストールされている .NET のバージョンを確認するには、「インストールされている.NETバージョンの確認」を参照してください。
  • IIS - 最低限必要なバージョン: 8。Web Server (IIS) の役割の一部であり、提供される InstallRolesAndFeatures.ps1 スクリプトにより自動的に有効になります (こちらを参照)。
  • ASP.Net Core IIS モジュール - 最小バージョン: 3.1.x。ホスティング バンドルの一部としてこちらからダウンロードできます。

📘

注:

コア モジュールのみが必要で、コマンド ラインから OPT_NO_RUNTIME=1 パラメーターを使用してランタイムなしでインストールできます。

  • URL Rewrite - 1URL Rewrite1 - 最低限必要なバージョン: 2.1。Web サイトで http (http://servername) ではなく、https (https://servername) にコールをリダイレクトできるようにします。URL Rewrite は、このリンクからダウンロードしてインストールしてください。
  • サーバーの役割と機能。アプリケーション サーバーに必要な役割や機能を自動的に追加する PowerShell スクリプトを利用できます。役割と機能の一覧は、「サーバーの役割と機能」に掲載されています。この章は、情報提供のみを目的として提供されています。
  • Web-Deploy extension -最低限必要なバージョン: 3.5、64 ビットバージョン。Azure one などの PowerShell スクリプトのインストールでのみ必要です。ウェブサイトの導入が可能になります。Web Deploy Extension 3.5 は、このリンクからダウンロードしてください。
  • アプリケーション プール ユーザーには、ローカル コンピューター ポリシーで次の権限が割り当てられている必要があります。
    • バッチジョブとしてログオンする権限
  • 匿名認証有効化する必要があります。

Web 証明書 (SSL証明書)

ユーザーがウェブアプリケーションでのアクセスに使用するすべてのブラウザ上にあるロボットと Orchestrator 間のすべての通信については、HTTPS プロトコルが必須となります。

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

  • GoDaddy、VeriSign などの信頼された認証機関が発行した Web 証明書です。Web 証明書は、IISのサーバー証明書へインポートする必要があります。Windows インストーラーによりプロンプト表示された際に入力する必要があるため、「Issued To」エンティティの名前を把握しておく必要があります。
  • これで、Windowsドメインで信頼された証明書を発行できる認証機関となりました。「HTTPS プロトコルへの証明書の使用」を参照してください。
  • 自己署名証明書 (Production には推奨されません)。この証明書は、ドメイン内では信頼されません。そのため、公開鍵をエクスポートし、すべてのロボット端末にインポートする必要があります。詳細については、「HTTPS プロトコルへの証明書の使用」を参照してください。

Windows インストーラーでプロンプト表示される際に入力する証明書の名前、または -sslCertificate を使用するコマンドラインに記載のものが、IIS のサーバー証明書Issued To 列に同じものが表示されます。

🚧

重要!

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

証明書の場所は、Identity Server の構成ファイル appsettings.Production.json署名資格情報セクションに設定します。

If a self-signed certificate is used, this must also be placed in the Trusted Root Certification Authority certificate store (beside the usual Personal location).

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

SQL Server

SQL Server コンピューターには、2008 R2 SP3 (最小要件)、2012、2014、2016、2017、または 2019 の Standard Edition または Enterprise Edition のいずれかのバージョンが必要です。

  • SQL Server 製品は、アプリケーション サーバー (本番環境では推奨されていません) と同じ端末にインストールするか、または別の端末として使用することができます。SQL Server 端末は、他のアプリケーションと共有することができ、Orchestrator 専用にする必要はありません。Always On 可用性グループのデプロイ方法に関する前提条件、制限、推奨については こちら、フィジカル デプロイ オプションについての詳細については こちら をクリックしてください。
  • SQL Server ユーザーを使用して Orchestrator をデータベースに接続する場合はWindows および SQL サーバー認証モードを有効化します。または、「Windows 認証モード」でも可能です。SQL Server がすでにインストールされている場合は、以下の画像に示されるようにこのオプションを選択してください。
  • 照合シーケンスは既定の 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 認証] オプションを選択します。ウィンドウが適切に更新されます。

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

🚧

重要!

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

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

  1. SQL Server のユーザー名およびパスワード。この場合、SQL Server ユーザーが必要となります。sa アカウントを使用されないことを強く推奨します。

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

d. [ログイン名][パスワード][パスワードの確認入力] の各フィールドに適切な値を入力します。
e. [パスワードの期限を適用する][ユーザーは次回ログイン時にパスワードを変更する] の 2 つのオプションが選択されていないことを確認します。

🚧

重要!

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

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

SQL Server に接続するユーザーの種類 (ドメインまたは SQL) に関係なく、Orchestrator をインストールする前にユーザーに dbcreator サーバー役割を割り当てる必要があります。データベースがこのインストール処理中に作成されるためです。

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

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

データベース作成後、次のスクリーンショットのようにdb_ownerユーザーマッピングの役割で SQL データベースに接続するユーザーを入力します。

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

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

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

  • 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

Orchstrator の 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 ノードは、このコマンドを無視します。
  • すべてのノード上ですべてのパッケージ (.nupkg ファイル) の同期を維持します (NuGet.EnableRedisNodeCoordinationtrue に設定されている場合)
    • 例:- Orchestrator ノード上で .nupkg ファイルをアップロードまたは削除した場合、このノードは HAA にメッセージを送信します。HAA Server はこのメッセージをすべての Orchestrator ノードにブロードキャストします。各 Orchestrator ノードは、メッセージを送信したノードを除き、自身の NuGet キャッシュを再構築します。

また、LoadBalancer.Redis.ConnectionString web.config パラメーターを通じて、Orchestrator ノードと HAA サービスの間で SSL 暗号化接続を有効化することもできます。詳細については、このページを参照してください。

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

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

🚧

重要!

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

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

Elasticsearch サーバー

Elasticsearch はオプションであり、Robot によってログ記録されたメッセージを保存するために使用されます。ログは ElasticSearch および/またはローカル SQL データベースに送信できます。これにより、否認不可 (non-repudiation) のログを保持することができます。ElasticSearch と SQL の両方を使用するときは、いずれかで問題が発生しても、互いに影響することはありません。これらのパラメーターは web.config ファイル (C:\Program Files (x86)\UiPath\Orchestrator) から変更できます。詳細については、「ログの構成」を参照してください。

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

📘

注:

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

コンピューターがドメイン内にある場合は、[Active Directory ユーザーとコンピューター] 内ドメイン サーバーの [コンピューター] セクションに追加されていることを確認する必要があります。インストール プロセスの間にコンピューター名が使用されるため、この手順が必要となります。例えば、http://computername.domain.name または http://computernamehttp://localhost の代わりに使用します。
不可能な場合は、コンピューター名または IP アドレスをインストール プロセスの間に使用します。

Elasticsearch のインストール

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

📘

注:

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

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

🚧

重要!

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

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

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

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

この変更を行うためには、Elasticsearch インスタンスの URL に対して、次の本文で [PUT] 要求を elasticUrl/_template/uipath_logs というフォーマットで行います。

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

ElasticSearch の接続の検証のため、任意のブラウザを使用して URL (http://computername:9200/) を開きます。Computernameは、Elasticsearch のインストール先のコンピューター名を表します。下の画像のように、ブラウザによって、.json ファイルをダウンロードするか、またはこのファイルを開いて表示するか確認されます。

Kibana

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

Kibana をインストールする

📘

注:

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

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

📘

注:

C:\ または D:\ に解凍します。アーカイブ内のファイルは既に同じ名前でフォルダ内に置かれているため、kibana-x.y.z-windows の名前で新規ファイルを作成する必要はありません。

  1. 次のように、Kibana 構成ファイル (C:\kibana-x.y.z-windows-x86\config\kibana.yml) を編集します。

📘

注:

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

3.1.server.port を含む行のコメントを解除します。規定値は 5601 です。既定値は5601です。別のポートで Kibana を動作させたい場合を除き、変更は不要です。
3.2.server.host を含む行のコメントを解除します。値をコンピューター名に変更します。
3.3.elasticsearch.url を含む行のコメントを解除します。Elasticsearchのインストール先のコンピューター名を用いて、値をElasticsearch URLに変更します。たとえば、http://computername:9200 です。
: Kibana 6.6.0 以降の場合、この行は elasticsearch.hosts で置き換えられました。
下のスクリーンショットでは、Kibana および Elasticsearch 両方のコンピューター名が JLTSQL である Kibana 構成ファイルの例を表示しています。

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

  1. setup-kibana-service.zip アーカイブをダウンロードします
  2. setup-kibana-service.zip アーカイブから C:\kibana-x.y.z-windows-x86\bin に、nssm.exe および setup_kibana.bat をコピーします。
  3. setup_kibana.batファイルを開き、BATファイルのKIBANA_HOME変数に設定されている場所に従って Kibana がインストールされているか確認します。Kibana を異なる場所に抽出した場合は、必要に応じて変更します。
  4. 管理者としてコマンドプロンプトを開き、フォルダーをC:\kibana-x.y.z-windows-x86\bin に変更します。
  5. setup_kibana.bat を実行して Kibana をインストールします。
  6. 任意のブラウザに http://computername:5601 を入力して Kibana が応答するかテストします。computername は、Kibana のインストール先のコンピューターの名前を表します。

🚧

重要!

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

  1. Kibana を使用して Elasticsearch データベースにテスト メッセージを追加します。
    10.1. Kibana で、[Dev Tools] タブに移動します。
    10.2. 以下に示す形式で POST 要求を送信します。何もエラーが返されない場合、default-yyyy.mm という名前の Elasticsearch インデックスが作成され、メッセージが追加されます。
POST default-2018.08\logEvent { "message": "Hello Elasticsearch!", "@timestamp": "2018-07-03T08:56:56.1219306Z" }

🚧

重要!

新しいテナントが追加されるたびに、Kibana でテナント名から始まる対応インデックスパターンを作成する必要があります。yyyyはメッセージが追加された年を意味し、mmはメッセージが追加された月を意味しています。「Elasticsearch 接続のインデックスパターンの作成」 を読み、Kibana のインデックスパターンの作成方法を確認してください。

時間同期

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

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

約 1 か月前に更新


インストールの前提条件


改善の提案は、API 参照ページでは制限されています

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