Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Jobs / Start

  • Article
  • 3 minutes to read

Operation Information

Starts a new Job on UiPath. See the UiPath UI Documentation for more information: https://postman.uipath.rocks/#2715a573-80d0-4a85-be22-a5d637e4c5fb.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type UiPath Cloud.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose UiPath Cloud in the Type pick list;
  • Give the UiPath Cloud KeySafe key a Title (this is the name / identifier for the UiPath Cloud account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Organisation/Folder ID string UiPath Organisation/Folder ID
Account Logical Name string The Account Logical Name for your UiPath account
Tenant Logical Name string The Tenant Logical Name for your UiPath account
Client ID string UiPath API access Client ID
User Key string UiPath API access User Key
Token string Authentication Token

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked UiPath Cloud account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Process releaseKey string The Key of the Release/Process Yes None provided
Input Arguments inputArguments array Any input arguments for the Job being started No None provided
Robot robotId number The ID of the Robot to execute the Job on, used when the value of Strategy is Specific No None provided
Strategy strategy string Dictates how the process should be run. No Specific, JobsCount, All
Number of Robots noOfRobots number The number of Robots No None provided
Jobs Count jobsCount number The process will run x times, used when the value of Strategy is JobsCount No None provided

Output Parameters

Display Name ID Type Description
Status status string Integration call return status (ok/fail)
Error error string Any errors returned from the integration, should the Status be fail
Key Key string The Job Key
ID Id number The Job ID
State State string The current State of the Job
Job Priority JobPriority string The Priority of the Job
Info Info string The Info from the Job
Release Name ReleaseName string The Release Name from the Job
Type Type string The Type of the Job
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document