Documentation

{{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}}

Jobs / Stop

Operation Information

Stops a Job on UiPath.

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
Job ID jobId number The ID of the Job to stop Yes None provided
Stop Type stopType string Soft Stop or Kill the Job Yes SoftStop, Kill

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
In This Document