- Robot JavaScript SDK
- About the Robot JavaScript SDK
- Configuration Steps
Prerequisites and configuration steps for the Robot JavaScript SDK: JavaScript Add-On installation and application access setup.
This page covers the prerequisites and configuration for using the Robot JavaScript SDK in custom web applications, including setting up browser and Robot consent access, installing the SDK, and configuring the JavaScript Add-On.
Prerequisites
The following prerequisites must be met for automation projects to use the Robot JavaScript SDK:
- Studio and Robot version 2021.10 or greater installed
- The UiPath JavaScript Add-On installed on the Robot machine
Allowing access
When the UiPath Robot JavaScript Add-On is run, access must be granted for your custom application or web page to connect to the Robot. The access is handled by a two-step dialog — both steps must be confirmed to run RobotJS. Both dialogs support automation as described in the following sections.
Browser access dialog
This step refers to the browser requesting permissions to open the UiPath Assistant.
Automatically accepting the browser access dialog
The uipath-web://* value, added as a trusted URL in the browser's settings, automates this dialog. The uipath-web://* refers to the UiPath Robot web protocol handler.
Based on the browser used, different settings need to be configured. For example, if you are using Google Chrome, follow the steps described in the Google Chrome URLAllowlist documentation.
Robot consent dialog
The robot consent dialog is used to allow the connection between the Robot JavaScript SDK and the Robot Executor.
Automatically accepting the robot consent dialog
The UIPATH_ROBOTJS_ALLOWLIST System Environment Variable automatically accepts the robot consent dialog.
The variable value must contain the URLs of your custom application or web page, separated by semicolons. The URL should contain the port number only if a standard port is not used (80 or 443).
The Robot JavaScript SDK
This SDK provides all the necessary methods and properties you can include in your custom application or web page. You can download it as follows:
NPM
The npm package is available with TypeScript bindings. To include it in your project:
-
Run the following command at the root of your project directory:
npm install --save @uipath/robotnpm install --save @uipath/robot
CDN
For CDN:
-
Add the following script tag before the closing
</body>tag:<body> ... ... <script href="//download.uipath.com/js/1.3.2/UiPathRobot.js"></script> </body><body> ... ... <script href="//download.uipath.com/js/1.3.2/UiPathRobot.js"></script> </body>
Direct download
Download the Robot JavaScript SDK via direct download.
Add-on settings
To configure add-on settings:
- Open the
uipath.configfile in the installation folder. - Add the
ListenerPortandTokenExpiryInDaysparameters to the<robotJsSettings>section. By default, the section does not contain any keys:
<robotJsSettings>
<add key="ListenerPort" value="2323" />
<add key="TokenExpiryInDays" value="30" />
</robotJsSettings>
<robotJsSettings>
<add key="ListenerPort" value="2323" />
<add key="TokenExpiryInDays" value="30" />
</robotJsSettings>
| Attribute | Description |
|---|---|
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. |
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. |