Using the Run with queue

Collectively process all work items of a queue across all the Bot Runners present in one or more device pools.

Prerequisites

To run a bot with queue, ensure that you are allocated the following roles and permissions:

Feature type Privileges
Activity permissions Provide the following permissions for all bots and its dependencies:
  • View my in progress activity
  • View my scheduled bots
  • Schedule my bots to run
  • View ALL scheduled activity from my Folders
  • Manage ALL scheduled activity from my Folders
  • Schedule permission at the folder level.
Note: The bot must be linked to the same work item structure as the queue.
User role Your custom role must have the following:
  • Consumer access to the queue you want to process
  • Consumer access to the device pool on which you want to process the queue
  • Run as user assigned to the role
To Run bot with queue, note the following:
  • You can run bots only on unattended Bot Runners. You cannot run bots on attended Bot Runners from the Control Room.
  • The bots have to be checked in to the public folder in order for the bots to qualify to be run with queue.
  • Work item sorting is done on the batch added to the queue. For example, if you add 2 batches of work items a, c, b and a, c, b to be sorted by name, the work items will be processed for queuing as a, b, c and a, b, c.
  • If you use the same device pool for inserting and processing work items for the same queue, you will see duplicate entries in the In-progress activity and Historical page. To resolve this issue, use one device pool to insert work items and a different device pool to process work items in a queue.

Procedure

  1. Use one of the following methods to click the Run with queue option:
    • Activity > In progress > Run
    • Manage > Devices > Run
    • Manage > Device pools > Run
    • Manage > Queues
  2. In the Automation and dependencies screen, click Choose to select an available bot to run with queue.
    Ensure that the bot that you have selected is linked to the Work item template. For more information, see Attach work item template to bot.
    Note: Ensure that the bot does not have a timeout setting. For more information, see Configure timeout for bot execution.
    The Run with queue screen is displayed.
  3. Use the Automation and dependencies tab for the following:
    1. Optional: Click Choose to select a different bot.
    2. Use the Run automation and dependencies using field to select one of the following tabs:
    • Latest version: To select the latest version of the bot.
    • Production label: To select the labeled version of the bot.
  4. Click Next.
  5. In the Queue screen, click Choose to select a queue that must be used to run the bot.
    Note: Ensure the following to see the list of available queues:
    • You do not have the AAE_Admin role
    • Your role is added to Queue > Consumers
    • The bot and queue work item templates are identical
  6. Click Next.
  7. Optional: In the Processing time tab, set the queue running time.
    1. Click Add running time.
      Note: If the running time is not set, the queue runs for 24 hours.
    2. Select the days from Days of the week field.
    3. Select or enter the Start time and End time.
    4. (Optional) Click Add time to add another time period for the days selected.
      You can add up to three time periods which cannot overlap with each other.
    5. Optional: Click Remove running time to delete any running time.
  8. Click Next.
  9. In the Device pool tab, click Choose to select an available device pool.
  10. Click Next.
  11. Use the Run-as users tab for the following options:
    • Click one of the following tabs:
      • Run on default device: Is selected as the default option and the bot is deployed only on the default device of the user.

        In this option, the unattended Bot Runner user should own the default device. If the device is jointly owned by the unattended Bot Runner user along with another licensed user, the device will not used as the unattended Bot Runner user is considered to have no default device. If the scheduler user has multiple unattended Bot Runner users and one of those users do not have a default device, the bot deployment fails.

      • Any: To deploy the bot on any available device.

        The bot is deployed on the available device in the device pool. It overrides the default device of the user.

    • In the Available run-as users, select the Bot Runner user from the list.
      Ensure that a device is connected to the Control Room in order to enable it. Also ensure that the Bot Runner users are a part of queue consumers.
      Note: If a run-as user does not appear in the list, ensure that it is assigned to your role. Also, you cannot select the run-as users who have not set their auto-login credentials.
  12. Click Next.
  13. Use the Resiliency settings tab to change the following options
    1. In the Pop-up handling field, select the Ignore unexpected pop-ups if you want the automation to continue even when there are unexpected pop-ups during the bot runtime.
      This option is enabled by default. If you disable this option, any unexpected pop-ups that occur during the bot run can impact the automation or delay the runtime.
    2. In the Bot execution recording field, change the following options:
      • Store bot execution recording: Clear this check box if you want to prevent the bot execution from being recorded.
      • Recording preferences: If you have opted to record automations, you can further select one of the following options for recording bot executions:
        • Only failed executions: Recording will be stored only when the automation execution fails.
        • All bot executions: Recording is stored irrespective of whether the execution is successful or failed.
      Note: Functionality to record automation execution requires the Enterprise Platform license. See Enterprise Platform.
  14. Optional: Use the General settings tab to change the default settings for the following options
    1. Name: Edit or rename the automation.
    2. Automation priority: Click the drop-down menu to set the automation priority.
      While Medium is the default automation priority, you can change it so that automations are processed for deployment accordingly.
  15. Click Run with queue.
    Note:
    • If a user who created the WLM automation using the Run bot with queue option is deleted, the automation is also affected and queues cannot be processed.
    • Bots are not deployed when Bot Runners are mapped one-on-one with their default (single user) devices with Run on bot running devices option selected and one or more devices in the selected device pool is disconnected.
    • If you have more number of resources (devices and run-as users) than the number of work items added, you might observe the proxy deployments on the Activity > Historical page. To view the appropriate work item status, refer Work item status and actions.

    • Historical activity displays only the bots that are processing the work items, while each bot deployment can include multiple work items processed as one activity.

    • With work items getting processed regularly, the number of completed work items will increase in Control Room, which might impact the system performance. We recommend that you use the Auto-purge settings in the Workload management to remove the completed work items.

      For more information , see Purge work items.

    The following video demonstrates how to run a bot with queue: