This action plugin is a tool to stage items into a managed queue. It provides a way to pause
a workflow until all items queued ahead have been released from the queue. While staged in the
queue, the items can be re-ordered by a user with appropriate privileges.
Saved Parameters Description
- Name: The name used to identify a saved QueueStager configured instance.
- Comments: Some comments about this saved QueueStager configured instance.
- Create queue ad-hoc?: On checking this, if the queue is not present Orchestrator
would create the queue with the given name automatically irrespective to the action
chosen
- Queue ID: The identifier for the queue to be created
- Users: Choose or Name the users who can have access to this queue
- Group: You can also choose the entire group to assign the permissions.
- Auto-purge: Choose from the 2 options provided. 1. Never and 2. On Work-Order stop.
(the elements can be cleared manually from the Queues page in the Dashboard)
- Action: This option lists the different operations the queue can perform. Explained
in Detail below. Please choose the respective option
- Queued Item: List the element to be queued here
- Queued Item Description: This variable holds the description of the queuing
item
- Queued Item Priority: Using this parameter priority can be assigned to the Queuing
item. (100 is the minimum priority. With 0 being the highest)
- Queued Item Weight: This Parameter holds the weight of the Queuing item(0 is the
minimum weight and 100 is the maximum)
Inputs Description
The list of inputs depends on the configuration of the QueueStager action template.
- Add: This action is used to add an element into the queue. Queue Item - Required
and Queue Item Description, Weight and Priority - Optional
- Add Multiple: This action is used to add multiple elements into the queue. Queue
Item - Required and Queue Item Description, Weight and Priority - Optional
- Wait for: This action will make the step wait for a given queue id. Queue Item -
Required. Priority filter - Required
- List All: This action fetches all the elements present in the queue as output
- Clear: This action Clears the elements present in the queue
- Pause: This action Pauses the Queue Processing
- Resume: This action Resumes the Queue Processing
- Remove: This action removes an item. Required - Queue Item
- Get Next: This action gets the next element in the queue
Outputs Description
- Queued_items: This is available as output for ListAll action to show the list of
items in the queue.
- Total_weight: An Integer showing cumulative weight of the items in the queue.
Available for ListAll option
- Queued_item: The item that was queued/removed. Available for Add and remove
action
- Queued_item_description: The description provided for the item. Available for Add,
Remove, Wait for, Get next actions.
- Weight: The weight of the queued item. Available for Wait For and Get Next
action.
- Queue_status: Shows the status for the Pause, Resume, Clear operations
- Items added: List of all the added items. Available for Add Multiple Operation
Supported Actions
None
Dependencies
None
Operating Instructions
This plugin is used to create and manage a queue.
Note: For any action chosen, the system
will create a queue with the name provided by the user if another queue with the same name
is not found in the database.
QueueStager provides the ability to manage and prioritize processes, such as a situation in
which there are multiple files in a watch directory and the user needs to transfer a
particular set of files immediately, but the rest of the files on a more leisurely
schedule.