UiPath System parameters

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bots > UiPath bot integration > Unattended bots > Using queues in UiPath >

UiPath System parameters

Overview

When you use a queue to trigger your process from Bizagi, you can access your UiPath System parameters. These are a set of additional inputs and outputs that you can map to customize your queue item execution or to obtain information about the executed Robot.

 

BotAdvance015

 

System parameters explained

Bizagi automatically adds these parameters after your configured inputs and outputs. They will now be available when you map the RPA Bot inputs and outputs to your Data Model.

 

The inputs let you configure your queue items, while the outputs retrieve information about the RPA process. The following section explains what each parameter does. You must save their value in a string attribute of your Data Model.

 

Inputs

With these parameters, you can set the priority, defer date, due date and reference for your newly created queue items. In this way, you can dynamically allocate when to execute your queue item and which queue items are more urgent than others.

 

BotAdvance016

 

priority: Importance assigned to the queue item, items with higher importance will be processed before ones with lower importance. Its possible values are High, Normal and Low.

deferDate: Before this date the queue item will not be processed. It must be in the format MM/DD/AAAA hh:mm:ss or AAAA-MM-DDTHH:mm:ss.mmmZ.

dueDate: The queue item must be processed before this date. It must be in the format MM/DD/AAAA hh:mm:ss or AAAA-MM-DDTHH:mm:ss.mmmZ.

reference: A text that can be used to identify the queue item or to give more information to the RPA process

 

Outputs

With these parameters, you can obtain information about the process. You can get information of the queue item status, process robot and exception.

 

BotAdvance017

 

reference: A text that can be used to identify the queue item or to provide more information of the RPA process

status: Status of the queue item. The possible statuses are:

oAll: Default value

oNew: the item has just been added to the queue or the item was postponed or a deadline was added to it.

oInProgress: Queue item that is currently been processed.

oFailed: The item did not meet a business or application requirement within the project and was therefore marked as Failed.

oSuccessful: The item was processed with out any exception, which marked it as Successful.

oAbandoned: The item remained in the In Progress status for a long period of time (approx. 24 hours) without being processed.

oRetried: The item failed with an application exception and was retried. After the Robot finishes retrying the item, the status changes to Failed or Successful, according to your workflow.

oDeleted: The item has been manually deleted. An item with this status can no longer be processed.

key: Unique identifier of the particular queue item.

processingExceptionType: This field is empty unless an error occurs during the execution of the RPA Process. Its possible values are ApplicationException or BusinessException.

oApplication Exceptions are technical issues of the triggered process.

oBusiness Exceptions are defined in the process and occur when external factors disrupt the expected flow of the process.

startProcessing: The time in which the Robot started its execution in format AAAA-MM-DDTHH:mm:ss.mmmZ.

endProcessing: The time in which the Robot stopped its execution in format AAAA-MM-DDTHH:mm:ss.mmmZ..

progress: A custom progress status configured specifically for this process during its execution.

id: Unique identifier of the particular RPA database

 

processingException: Information about exceptions thrown when the process failed.

oreason: Reason why the process failed.

odetails: Additional details about the exception

otype: This field is empty unless an error occurs during the execution of the RPA Process. Its possible values are ApplicationException or BusinessException.

 

robot: Information about the robot that executed the process.

omachineName: Name of the machine that hosts the robot.

omachineId: ID of the machine

oname:  Name of the robot.

ousername: Username that accessed the machine.

oid: Unique identifier of the particular queue item.