- Robot JavaScript SDK
設定手順
Robot JavaScript SDK の前提条件と設定手順: JavaScript アドオンのインストールとアプリケーション アクセスの設定。
このページでは、ブラウザーとロボットの同意アクセスの設定、SDK のインストール、JavaScript アドオンの設定など、カスタム Web アプリケーションで Robot JavaScript SDK を使用するための前提条件と設定について説明します。
前提条件
オートメーション プロジェクトで Robot JavaScript SDK を使用するには、次の前提条件を満たす必要があります。
- UiPath Robot 2026.10 installed
- ロボット端末に UiPath JavaScript アドオンがインストールされている
アクセスを許可する
UiPath Robot JavaScript アドオンを実行する場合、カスタム アプリケーションまたは Web ページをロボットに接続するためのアクセス権を付与する必要があります。アクセスは 2 段階のダイアログによって行われます。RobotJS を実行するには、両方の手順を確認する必要があります。どちらのダイアログも、以下のセクションで説明する自動化をサポートしています。
ブラウザーへのアクセス ダイアログ
1 つ目のダイアログでは、ブラウザーにより UiPath Assistant を開く権限が要求されます。
ブラウザーのアクセス ダイアログを自動的に受け入れる
The uipath-web protocol is the UiPath Robot web protocol handler. Browsers ask for permission before they open it. You can automate this dialog through your browser's enterprise policies.
Based on the browser used, different settings need to be configured. For the exact policy and value format, see the enterprise policy documentation of your browser.
ロボットの同意ダイアログ
ロボットの同意ダイアログでは、Robot JavaScript SDK と Robot Executor 間の接続を許可します。
ロボットの同意ダイアログを自動的に受け入れる
UIPATH_ROBOTJS_ALLOWLIST システム環境変数は、ロボットの同意ダイアログを自動的に受け入れます。
The value is a list of origins separated by semicolons. Each origin includes the scheme, for example https://myapp.contoso.com. Add the port only if it is not the default (80 or 443).
例:
UIPATH_ROBOTJS_ALLOWLIST=https://cloud.uipath.com;https://mydomain.com
UIPATH_ROBOTJS_ALLOWLIST=https://cloud.uipath.com;https://mydomain.com
The Robot already accepts the UiPath cloud origins by default, so you only add your own origins. For the default list, see the AllowUrlList key in Configuration files.
Robot JavaScript SDK
This SDK provides all the necessary methods and properties you can include in your custom application or web page. It is available as an npm package with TypeScript bindings. To include it in your project:
-
プロジェクト ディレクトリのルートで次のコマンドを実行します。
npm install --save @uipath/robotnpm install --save @uipath/robot
To load the SDK with a <script> tag instead, use dist/js/UiPathRobot.js from the package.
Version 1.3.3, the last one published to download.uipath.com, remains available at https://download.uipath.com/js/1.3.3/UiPathRobot.js. Newer versions are published only on npm.
アドオンの設定
アドオンの設定を行うには、以下の手順を実行します。
- Open the
UiPath.configfile:%ProgramFiles%\UiPathPlatform\Robot\<version>\UiPath.configfor a per-machine installation, or%LocalAppData%\Programs\UiPathPlatform\Robot\<version>\UiPath.configfor a per-user installation. For details, see Configuration files. - [
ListenerPort] パラメーターと [TokenExpiryInDays] パラメーターを [<robotJsSettings>] セクションに追加します。既定では、このセクションにはキーは含まれません。
<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 | The UiPath.RobotJS.ServiceHost.exe starts a HttpListener on the configured port and contains the information about other local listeners from the active user session on that system. The port value must match the one configured in the SDK Settings. The default value is 2323. |
TokenExpiryInDays | Any request coming from a new domain needs to have consent from the user to allow access of UiPath Robots from a web application. These consents are valid for the said number of days mentioned in this setting. The default value is 30. |
After you edit the file, restart the UiPath RobotJS Service service for the changes to take effect. For the steps, see Restarting robot components.