Automation Anywhere: Add Work Item to a Queue

🕙  4 minute read

Use this action to pass in a list of column names and values to create a Work Item that will be processed by a Queue.

How to configure this action

This action requires a preconfigured Automation Anywhere (AA) 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 work item information into AA as part of a Workflow process. For each work item, you can configure the same settings that would be available in AA, such as selecting the work item values and choosing a specific queue.

Fields for this action

  • Integration

    • Select your Automation Anywhere integration from the options. These are your team’s integration accounts.
  • Queue ID

    • Queue ID of the queue you want to add a work item to.
    • To find the Queue ID:
      1. Navigate to the Queue which ID you wish to find
      2. Select “View the queue”
      3. When viewing the queue, the ID is the number in the URL of this page. For example, https://ControlRoomURL/#/workload/queues/3/view, 3 is the Queue ID.
  • Work Item Column Names

    • A comma-separated list of column names for the work item you want to add to the queue. For example, in the image below, the work item columns are: description, work type, requested by. Add these here by entering: description, work type, requested by
    screen readers look here
  • Work Item Values

    • A comma-separated list of values for the work item you want to add to the queue, in the same order as the column names specified above. Enclose a value in quotation marks if it contains special characters such as commas or newlines.
    • For example, if the Work Item Column Names are description, work type, requested by, enter the values here in the same order Install lightbulbs in new office, Installation, Office Manager.
  • Mark complete immediately

    • Select True or False from the drop down.
      • Select True to have this task be marked complete as soon as the work item is added to the queue.
      • Leave blank or Select False to have this task stay open until the work item has been completed.
  • 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 AA API returns when a work item is added to a queue and each response item is added to its own Catalytic field. These fields are information like the start time, end time, work item values, or status. See Automation Anywhere’s Control Room API User Guide for a more detailed explanation of each response.

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

Output fields for this action

  • startTime

    • The date and time when adding the work item to the queue began. For example: 2019-01-30 3:34 PM
  • status

    • Returns the automation status, such as DEPLOYED, RUNNING, RUN_PAUSED, UNKNOWN, COMPLETED, RUN_FAILED, RUN_ABORTED, RUN_TIMED_OUT, or DEPLOY_FAILED. Catalytic considers the status COMPLETED to represent when the task is considered completed.
  • automationId

    • The ID of the automation to which the execution is associated. For example: 3
  • createdBy

    • The ID of the user who created the automation. For example: 1.
  • createdOn

    • The date and time when the add work item command was created. For example: 2019-01-30 3:33 PM
  • data–column header

    • Any work item values and column names defined during configuration are added to the queue and returned as output fields for convenience—each field is prepended by data--. For example, the queue column Description and the associated value become the output field data--Description with the value of Office Manager. Each column is converted into an output field, like the examples below:
      • data–Description
      • data–Requested By
      • data–Work Type
  • deviceId

    • The device ID where the bot is deployed. For example. 1
  • endTime

    • The date and time when adding the work item to the queue finished. For example: 2019-01-30 3:34 PM
  • id

    • The ID of this execution of the queue. For example: 8
  • queueId

    • The ID of the queue. This will be the same as the Queue ID entered during configuration. For example: 3
  • tenantId

    • The ID of the tenant. For example: 0
  • updatedBy

    • The ID of the user who last updated the automation. For example: 0
  • updatedOn

    • The date and time of the last update to the automation. For example: 2019-01-30 3:35 PM

Uncommonly used output fields

The following fields are uncommon or typically Null. Please see AA Control Room API documentation if one of these fields is required in your automation.

  • botId
  • brUserId
  • comment
  • poolId
  • result
  • error
  • totalPausedTime
  • lastPausedTime
  • version
  • col1 - 5

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.