|
Add WorkItem to Queue Action
|
Adds WorkItem in a specified queue in the RPA Hub application and returns the WorkItem ID.
|
- **Queue Name**: Record
- **Name**: String
- **Content**: String
- **Type**: String
- **Priority**: String.Choice
- **Stage**: String
- **SLA**: Date/Time
The maximum limit for **Content** field \(Request Content and Response Content\) is 8000 characters.
If the **Is Work Item Name Sensitive** check box on the associated work queue form is selected, the data in the **Request Content** field is encrypted. Sensitive data with encryption is stored in the work item, so that it can be passed to the RPA Desktop Design Studio or robots.
|
- **Action Status**: Object
- **WorkItemID**: GUID
- **IsNameExists**: Boolean
- **status**: String
- **message**: String
|
|
Assign User to Attended Automation Process Action
|
Assigns a user to the attended automation process.
|
- **Process Name**: Record
- **Username**: Record
|
- **Action Status**: Object
- **status**: String
- **Message**: String
|
|
Assign User to Attended Robot Action
|
Assigns a user to the attended robot.
|
**Username**: Record
|
- **Action Status**: Object
- **status**: String
- **Message**: String
|
|
Change Life Cycle Stage Status of a Bot Process Action
|
Changes the life cycle stage status of a bot process that is not retired.If a bot process is in **Build** life cycle stage status, if you have the required role, you can update it to **Published** state, but you cannot update it to **In Maintenance**.
If a bot process is in **Published** life cycle stage status, if you have the required role, you can update it to **In Maintenance** state, and vice versa.
|
- **Process name**: Record
- **Life cycle stage status**: Choice
|
- **result**: String
- **message**: String
- **Action Status**: Object
|
|
Fetch Created Jobs Action
|
Fetches the process jobs in RPA Hub.
|
- **Process Number**: String
- **Robots**: Array\[String\]
|
- **Action Status**: Object
- **Result**: String
- **Jobs**: Array\[String\]
- **startedRobots**: Array\[String\]
- **pendingRobots**: Array\[String\]
|
|
Fetch Execution Status Action
|
Fetches the execution status of a specific process job in RPA Hub.
|
**Process Job Number**: String
|
- **Action Status**: Object
- **ProcessJob**: Object
- **Process Name**: String
- **Robot Name**: String
- **State**: String
- **Started At**: Date/Time
- **Completed At**: Date/Time
- **Message**: String
- **status**: String
- **message**: String
|
|
Fetch Work Item Status Action
|
Fetches the status of specific work queue items, asynchronously.
|
**Work Queue Item ID**: GUID
|
- **Action Status**: Object
- **Code**: Integer
- **Message**: String
- **WorkItem**: Object
- **sysId**: String
- **name**: String
- **type**: String
- **priority**: String
- **status**: String
- **lockedBy**: String
- **additionalComments**: String
- **requestContent**: String
- **responseContent**: String
- **deferredTill**: Date/Time
- **sla**: Date/Time
- **created**: Date/Time
- **startedOn**: Date/Time
- **completedOn**: Date/Time
- **lastStartedTime**: Date/Time
- **status**: String
- **message**: String
|
|
Start Process Action
|
Triggers a specific bot process in RPA Hub and returns the status.
|
- **Process Name**: Record
- **Robots**: Array\[String\]
Ignore an entry in this field if a robot pool is assigned to the bot process.
When invoking the **Start Process** Workflow Studio action, the robots that are in the **In Maintenance** life-cycle stage status are treated as failed robots.
|
- **Action Status**: Object
- **Result**: String
- **Robots**: Array\[String\]
- **Process**: String
- **Failed Robots**: Array\[Object\]
|
|
Stop Process Action
|
Stops a bot process. If Graceful Stop is enabled, this action gracefully stops the bot process.
|
- **Process Name**: Record
- **Robots**: Array\[String\]
- **Wait For Graceful Stop**: True/False
If this check box is selected, then bot process must stop gracefully.
For more information about stopping a bot process, see [Stop an unattended bot process in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/stop-bot-process.md).
For more information about Graceful stop, see [Using Graceful Stop functionality in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/graceful-stop-rpa.md).
For more information about Robot Pool, see [Robot pool in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/robot-pool-rpa.md).
|
- **Result**: String
- **Action Status**: Object
- **Robots**: Array\[String\]
- **Process**: String
- **Failed Robots**: Array\[Object\]
|
|
Unassign User from Attended Automation Process Action
|
Unassigns the user from the attended automation process.
|
- **Process Name**: Record
- **Username**: Record
|
- **status**: String
- **message**: String
- **Action Status**: Object
|
|
Unassign User from Attended Robot Action
|
Unassigns the user from the attended robot and retires the attended robot.
|
**Username**: Record
|
- **Action Status**: Object
- **Status**: String
- **Message**: String
|
|
Update Process Parameter Action
|
Updates the **Value** field for the process parameter.
|
- **Process**: Record
- **Parameter Name**: String
- **Value**: String
|
- **status**: String
- **Action Status**: Object
- **message**: String
|
|
Update WorkItem Action
|
Updates work queue items.
|
- **Queue Name**: Record
- **WorkItemID**: String
- **Stage**: String
- **DefferedTill**: Date/Time
- **Name**: String
- **Priority**: Choice
- **Status**: Choice
- **Request Content**: String
- **Type**: String
- **Remarks**: String
- **SLA**: Date/Time
- **Response Content**: String
The maximum limit for **Request Content** and **Response Content** fields is 8000 characters.
If the **Is Work Item Name Sensitive** check box on the associated work queue form is selected, the data in the **Request Content** field is encrypted. Sensitive data with encryption is stored in the work item, so that it can be passed to the RPA Desktop Design Studio or robots.
|
- **IsNameExist**: True/False
- **Status**: String
- **Message**: String
- **Action Status**: Object
|
|
Verify HashCode of a Package Version
|
Verifies the HashCode of a package version in RPA Hub to validate the HashCode of the manually uploaded automation zip file with the associated package version record.For more information about verifying the HashCode of a package version, see [Verify the HashCode of a package version in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/view-hash-code.md).
|
**Package Version**: Record
|
- **Action Status**: Object
- **Message**: String
- **isAttachmentValid**: True/False
|