Queues

The Queues page shows the list of all Queue objects indicating their status and settings. In client 0, it displays all queues in your system. In clients other than 0, it displays the client's queues only.

Tip: You may need to work with many objects, lists and monitors simultaneously. To make your work easier, you can open them in different browser windows and arrange them side by side on your screen. For more information about this and other useful functions, see Opening and Arranging Multiple Views.

This page includes the following:

Assigning Queues to Objects

You have two possibilities to assign a Queue to an executable object:

  • On the object's Attributes page, see Attributes Page

  • At runtime using the :PUT_ATT script element for attribute QUEUE

    When you modify object attributes dynamically and assign them new values, these values apply to only that particular generation. They are not stored in the object.

If an object has no specific Queue, the system automatically uses the Client Queue to process it. For more information, see CLIENT Queue.

Queues can be assigned to the following objects:

  • Workflow
  • Notification
  • Event
  • File Transfer
  • Group
  • Job
  • Remote Task Manager
  • Schedule
  • Script

There is no limit to the number of objects that you can assign to a Queue object.

Queue List

The following columns are displayed by default:

  • Name

  • Status

  • Priority

    Priority of queue tasks

  • Max. slots

    Max. queue tasks running in parallel

    The value displayed always complies with the object definition, see Attributes Page.

    Value: -1 signals that there is no queue limit.

  • Used slots

    Number of active tasks that occupy a position in the queue

    This value can exceed the defined queue limit (max. slots) because of limit modifications or the execution of the command Ignore Queue.

  • Hold

    Number of queue tasks that have a slot reserved but must not start because of the stopped execution of a queue, client or workflow (STOP)

  • Waiting

    Number of queue tasks with status Waiting for queue slot

  • Consider ERT

    The Queue object includes the setting Consider Estimated Runtime for Calculation

The following column is also available:

  • ID

    ID number of the queue

For more information, see Main Page Tables.

In the toolbar, the buttons Export and Refresh are available by default. These buttons allow you to refresh the content of the table and export it as a CSV file.

Queue Status

Queues can have the following status:

  • Active

  • Inactive

  • Queue with 0 slots (it is not possible to start tasks), see Maximum Slots

Right-click a Queue to display the following options:

  • Stop Queue/Start Queue

  • In Client 0, Open Parameters to see the current definition

  • In Clients other than 0, Modify its settings, including its maximum slots

Starting/Stopping a Queue

Queue objects cannot be executed. You start and stop them.

When stopping a Queue, Workflows and Schedules change their state to STOP - Queue processing has been stopped. This does not affect any other active tasks, though. Any other objects that are activated in a stopped Queue get the Waiting for queue slot status. If you start the Queue again, the tasks that were in a "waiting" state can also start.

You start and stop Queues from the Administration and from the Process Monitoring perspectives:

  • Administration perspective

    1. Select Queues in the Administration navigation pane.
    2. Select one or more Queues and right-click to select Stop/Start Queue.

  • Process Monitoring perspective

    1. In the Tasks pane, select Queue from the Grouped by dropdown list.

      The pane displays all Queues available for the Client.

    2. Right-click a Queue and select Start/Stop Queue.

An icon helps you identify the status of the Queue object, a green triangle indicating an active queue and a red square an inactive one.

Modifying a Queue

After you have defined a Queue object, you can still edit its definition:

  • In the Administration perspective

    Right-click a Queue to select Open or Open in New Window. The Queue opens in edit mode.

  • In the Process Monitoring perspective

    From the Process Monitoring you can only edit the number of maximum concurrent tasks and the priority.

    On the Tasks navigation pane on the left hand side select Queues, right-click one and select Modify.

    Note: In Client 0 it is not possible to modify Queue parameters.

Viewing Queue Parameters in Client 0

You cannot modify Queue parameters in Client 0, you can only see their definition from the Administration and Process Monitoring perspectives:

  • In the Administration perspective, you have two options:

    1. Right-click one or more Queues to select Open. The Queue definition page (one for each selected Queue) opens in read only mode.

    2. Right-click one Queue to select Open Parameters. A dialog opens displaying the current settings.

  • In the Process Monitoring perspective, where you can only select one Queue at the time.

    On the Tasks navigation pane on the left hand side, select Queues and right-click one to select Open Parameters. A dialog opens displaying the current settings.

Accessing the Queue Execution Data and Last Report

You can open the list of the executions that have been processed in one or more queues so far. Select one or more queues in the list and right-click to select Monitoring > Executions. For more information, see Execution Data.

You can also open the last report of a queue right-clicking on it and select Monitoring > Last Report. In this case, bulk selection is not possible. For more information, see Reports and Working with the Reports View.

Opening the Queue Monitor

Right-click a queue and select Monitoring > Show in Process Monitoring. The system opens the Tasks list and the filter is predefined using the name of the selected queue as criterion so that the list displays only the tasks that are processed in it. For more information, see Monitoring Tasks.

Exporting the Contents of the Queues List

Follow the steps below to export the contents of the Queues List to a CSV file.

  1. Click the Export Table button on the top right corner of your environment.

  2. Choose if you want to export all columns or only the visible ones.

  3. Click the Export button to export the data or Cancel to stop the process.

Note: Depending on the browser you are using, you will either be prompt to define the location of the file or you will find it at the bottom of your browser.

See also: