Subscribe

UiPath Robot

The UiPath Robot Guide

About the Robot JavaScript SDK

About

The JavaScript SDK for Robot (UiPathRobot.js) allows you to contextually embed your local attended Robot directly into existing applications.

See it in action below:

Prerequisites

A few things need to be considered first, such as having Studio and Robot v2019.10 or greater, connecting the Robot to Orchestrator, and installing the Robot JavaScript add-on. With the add-on installed, download the JavaScript SDK and use these SDK specifications to build your custom application or web page.

To use the JavaScript SDK, the JS Add-On for Robot needs to be installed on the end-user's machine where the Process is executed. The Robot Add-In exposes a secure communication layer between your application or web page and the UiPath Robot on the target machine so that commands can be received and executed.

🚧

Important:

For the RobotJS Add-on to work on Windows Server 2012 R2, Windows 8 and Windows 8.1, make sure to use the latest Robot JS version (v1.2.5) and Robot version higher or equal than 2021.4.4.

Getting the JavaScript SDK

The Robot JavaScript SDK is provided out-of-the box for Studio v2020.4 version and greater. For the v2019.10 LTS version and older, a Stand-Alone Add-On Installer is also available. The Robot JavaScript SDK is available under Apache 2.0 License and can be downloaded and installed from the following sources:

Stand-Alone Add-On

  • Stand-Alone Add-On Installer only available for v2019.10 and older

https://download.uipath.com/UiPathBrowserInvocationEnterprise.msi

NPM

The SDK is available as an NPM package with TypeScript bindings. You can include it in your project by running the following at the root of your project directory.

  • NPM

npm install --save @uipath/robot

CDN

The easiest way to include the SDK is to add it before the closing of your </body> tag.

  • Versioned:

<script src="//download.uipath.com/js/1.2.1/UiPathRobot.js"/> </script>

  • Latest:

<script src="//download.uipath.com/js/Latest/UiPathRobot.js"/> </script>

Direct Download

Through direct download you can get the Minified Version of the Robot Javascript SDK in a .js package.

  • Direct Download

https://download.uipath.com/js/1.2.1/UiPathRobot.js

Documentation

The Developer Guide combined with the User Guide offer a comprehensive overview of the SDK and JavaScript Add-on for Robot, containing detailed information on how to use it, what pre-requisites you need, and a step-by-step guide to create your first robot enabled application.

The Robot JavaScript SDK functionality can also be developed in .NET by making use of the Robot API commands.

Specifications

  • The full documentation of SDK Specifications provides detailed information on Models and Methods used by the Robot Javascript SDK.

  • Sample References offer pre-built samples for Boilerplate and Office Applications that can be easily integrated in your custom application.

Try It!

To see it in action, we have created a demo with the help of the Robot Javascript SDK which securely connect to your already installed Robot, fetches the processes available in your UiPath Assistant and displays them on this page.

Click on the "List Processes" button below and grant consent to this page to see how it works in real life:

Updated about a month ago


About the Robot JavaScript SDK


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.