UiPath: Add a Queue Item to a Queue

🕙  5 minute read

Use this action to add items to a UiPath Queue from a Catalytic process. Build a bot with UiPath Studio, publish it to Orchestrator, then add queue items to it through Catalytic.

There are 2 steps in UiPath to set up before using this action:

  1. A UiPath studio bot must be published to Orchestrator
  2. The published package must be deployed to an environment

This action works best within a batch process routine, such as a process that adds a queue item for each row in a table.

How to configure this action

This action requires a preconfigured UiPath integration. For more information on integrating Catalytic with other systems, please refer to the Integrations section of our help center.

In Catalytic, use this action to add queue items to a UiPath queue from a Workflow process. For each queue item, you can configure the same settings that would be available in UiPath Orchestrator, such as selecting the deadline, priority, or passing in specific content.

Fields for this action

  • Integration

    • Select your UiPath integration from the options. These are your team’s integration accounts.
  • Queue name

    • Enter the name of the Queue name from UiPath. The name is case insensitive.
  • Priority

    • Set the priority, High, Normal, Low, for the queue item. UiPath will favor processing a higher priority queue item before a lower priority queue item.
  • Specific content

    • Enter the data to add to the queue as a new item. Queue items are made up of items and values, such as EmployeeID and E14232. Add these item and value pairs in valid JSON format, such as { "EmployeeID": "E14232" }.
      • For example { "EmployeeName": "John Doe", "EmployeeID": "E12345", "Designation": "CEO" }
  • Reference

    • Optionally, provide a reference string for the queue item. A reference can be used to link or identify and search for a queue item in Orchestrator.
  • Defer date

    • The date after which the queue item may be processed. Enter either a field reference or a date time in the ISO format YYYY-MM-DDThh:mm:ss.sTZD.
    • This may be named Postpone depending on your UiPath version.
  • Due date

    • The date before which the queue item should be processed. Enter either a field reference or a date time in the ISO format YYYY-MM-DDThh:mm:ss.sTZD.
    • This may be named Deadline depending on your UiPath version.
  • Mark complete immediately

    • Select True or False from the drop down to set if this task should be marked complete as soon as a queue item is added.
      • Select True to have this task be marked complete as soon as the queue item is added to the queue.
      • Select False or leave blank to have this task stay open until the queue item has been completed.

    💡   Tip: Set this to FALSE if you are using the UiPath: Start a Job action to run the queue. This will guarantee the queue item will be added.

  • Output Field Prefix

    • To help keep output fields organized, choose an output field prefix to add to the beginning of each output field name as this action may output more than one field.
    • The step’s name is used as the prefix by default.

What will this output?

This action outputs every response the Orchestrator API returns when a Queue Item is added to a Queue. Each response item is added to its own Catalytic field. These fields are information like the creation time, output or output data, and end processing time. For more UiPath response information see UiPath’s Queue Item API reference.

This action may generate multiple fields. To help keep output fields organized, the prefix above will be added to the beginning of each of the output field names, separated by two dashes. Each field will result as:{{output-field-prefix--output-field}}. Learn more

Output fields for this action

  • AncestorId

    • The id of an ancestor item connected to the queue.
  • CreationTime

    • The date the time the item was created. For example: 2019-01-29 2:33 PM
  • DeferDate

    • The date the time of the defer date set during configuration. For example: 2019-01-29 2:33 PM
  • DueDate

    • The date the time of the due date set during configuration. For example: 2019-01-29 2:33 PM
  • EndProcessing

    • The date and time at which the item processing ended. For example: 2019-02-27 11:38 AM
  • Id

    • The Id associated with the add queue item request. For example 11119529
  • Key

    • Returns the unique identifier for a queue item. For example: 9803334c-fcb1-493e-9c84-b1a54e8d8a81
  • Output

    • A collection of key value pairs output after successful processing.
  • OutputData

    • A JSON version of the key value pairs output after successful processing.
  • Priority

    • Returns the priority selected during configuration.
  • ProcessingException

    • The Id of the processing exception, if any.
  • ProcessingException–AssociatedImageFilePath

    • A path on the robot running computer to an image file that stores relevant information about the exception, such as a system print screen.
  • ProcessingException–CreationTime

    • The date the time the processing exception was created. For example: 2019-02-27T17:38:20.27Z
  • ProcessingException–Details

    • Additional details about the processing exception.
  • ProcessingException–Reason

    • The reason the processing failed.
  • ProcessingException–Type

    • The processing exception type, if any. For example: BusinessException
  • ProcessingExceptionType

    • The same result as the ProcessingException--Type field: returns the processing exception type, if any. For example: BusinessException
  • Progress

    • String field to keep track of the business process.
  • QueueDefinitionId

    • The Id of the parent queue. For example: 99341
  • Reference

    • Returns the reference set during configuration.
  • RetryNumber

    • The number of times this queue item has been processed. For example: 0
  • ReviewStatus

    • The review state of the item. Applicable only for failed items. For example: None
  • RowVersion

    • Identifier used by UiPath Orchestrator to figure whether data is out of date. For example: AAAAAAJFESQ=
  • SecondsInPreviousAttempts

    • The number of seconds the last failed processing lasted. For example: 2
  • SpecificContent–key-name1

    • During configuration, queue items are added in key:value pairs. If the key:value pair { "greetingType":"hello", "farewellType":"goodbye" } is entered for Specific Content, this field’s name will be SpecificContent--greetingType with the value hello.
  • SpecificContent–key-name2 (3,4,5,…)

    • The value of the second key name entered in Specific Content. For example, for the Specific Content { "greetingType":"hello", "farewellType":"goodbye" }, this field’s name will be SpecificContent--farewellType with the value goodbye

    • Each additional key:value pair entered in Specific Content is returned as an individual field following this format.

  • SpecificData

    • A JSON formatted list of all specific content added in the action’s configuration. For example: {"DynamicProperties":{ "greetingType":"hello", "farewellType":"goodbye" }}
  • StartProcessing

    • The date and time the item processing started. For example: 2019-02-27 11:38 AM
  • Status

    • The processing state of the item. For example: Failed

Sorry about that. What was the most unhelpful part?









Thanks for your feedback

We update the Help Center daily, so expect changes soon.

Link Copied

Paste this URL anywhere to link straight to the section.

Need more help?

If you're signed in to Catalytic Community, you can ask other users a question. You'll be redirected to Community where you can add more info.