SDK

設定手順

前提条件

オートメーションプロジェクトで Robot JavaScript SDK を利用するには、以下の前提条件を満たしている必要があります。

バージョン 2019.10 以降の Studio と Robot がインストールされている
ロボット端末に UiPath JavaScript アドオンがインストールされている
Robot JavaScript SDK

重要:
Robot JavaScript SDK は、v2020.4 以降の Studio ではすぐに使えるコンポーネントとして提供されます。v2019.10 LTS の Studio では、スタンドアロンのアドオンインストーラーを利用できます。

v2019.10 から v2020.2 以降のバージョンにアップグレードする場合は、Studio および Robot インストーラーを実行する前に、UiPath Robot JS アドオンを手動でアンインストールする必要があります。

アクセスを許可する

UiPath Robot JavaScript アドオンを実行する際は、お使いのカスタムアプリケーションまたは Web ページにアクセス許可を付与してロボットに接続できるようにする必要があります。

アクセス許可を付与する手順ではダイアログが 2 つ表示されます。RobotJS を実行するには両方を確認する必要があります。この操作は、以下に記載されているように自動化できます。

ブラウザーへのアクセスダイアログ

1 つ目のダイアログでは、ブラウザーにより UiPath Assistant を開く権限が要求されます。

ブラウザーのアクセスダイアログを自動的に受け入れる

自動化するには、ブラウザーの設定に uipath-web://* という値を信頼された (許可された) URL として追加します。uipath-web://* は、UiPath Robot Web プロトコルハンドラーを指します。

注: 使用するブラウザーによっては、異なる設定を行う必要があります。たとえば、Google Chrome を使用している場合は Google Chrome のドキュメントの「URLAllowList」に記載されている手順を実施します。

ロボットの同意ダイアログ

ロボットの同意ダイアログでは、Robot JavaScript SDK と Robot Executor 間の接続を許可します。

ロボットの同意ダイアログを自動的に受け入れる

この操作を自動化するには、UIPATH_ROBOTJS_ALLOWLIST システム環境変数を追加します。

変数で使用する値は、カスタムアプリケーションまたは Web ページの URL をコンマで区切った値である必要があります。URL には、標準ポート (80 または 443) を使用していない場合にのみポート番号を含める必要があります。

Robot JavaScript SDK

この SDK には、カスタムアプリケーションまたは Web ページに含めることができるすべての必要なメソッドとプロパティが含まれます。ダウンロードの手順は以下のとおりです。

NPM

npm パッケージは TypeScript のバインディングで利用できます。このパッケージをプロジェクトに含めるには、プロジェクトディレクトリのルートで以下のコマンドを実行する必要があります。

npm install --save @uipath/robotnpm install --save @uipath/robot

CDN

CDN の場合、</body> タグを閉じる前に SDK を含める必要があります。

<body>
...
...
<script href="//download.uipath.com/js/1.2.9/UiPathRobot.js"></script>
</body><body>
...
...
<script href="//download.uipath.com/js/1.2.9/UiPathRobot.js"></script>
</body>

ダイレクトダウンロード

Robot JavaScript SDK はダイレクトダウンロードでも入手できます。

アドオンの設定

アドオンの設定を変更するには、インストールフォルダーの uipath.config ファイルで ListenerPort パラメーターと TokenExpiryInDays パラメーターを追加する必要があります。既定では、このセクションにはキーは含まれていません。

構成ファイルには、以下が含まれている必要があります。

<robotJsSettings>
    <add key="ListenerPort" value="2323" />
    <add key="TokenExpiryInDays" value="30" />
</robotJsSettings><robotJsSettings>
    <add key="ListenerPort" value="2323" />
    <add key="TokenExpiryInDays" value="30" />
</robotJsSettings>

属性	説明
`ListenerPort`	`UiPath.RobotJS.ServiceHost.exe` は設定されたポートで HttpListener を開始します。そのシステム上でアクティブなユーザーセッションからの他のローカルリスナーに関する情報を含みます。ここでのポート値は、SDK の設定で設定した値と一致する必要がある点にご注意ください。
`TokenExpiryInDays`	新しいドメインからの要求には、Web アプリケーションから UiPath Robots のアクセスを許可するためのユーザーの同意が必要です。この同意は、この設定で指定されている日数の間有効です。