Working with Queues
Creating a Queue
To create a Queue:
-
Navigate to Environment > Queues.
-
Click
. -
Configure the queue using the tabs described below.
-
Click Save & Close.
Deleting Queues
You can delete a Queue only when no other objects relate to it. For example, if there are processes that have run in a Queue, the Queue cannot be deleted until all processes that ran in it have been deleted. You can see all processes that relate to a Queue under Related Objects in the Detail View.
Queue Tabs
| Tab | Field | Description |
|---|---|---|
| Queue | Partition | The Partition the Queue belongs to. |
| Queue | Name | The name of the Queue. |
| Queue | Description | An optional description of the Queue. If you specify a Description, it displays instead of the Name. |
| Queue | Application | The name of the Application used to group this object. |
| Queue | Execution Size | The number of concurrent processes allowed in the Queue. |
| Queue | Include processes in status: Waiting | If checked, the Queue size includes processes in status Waiting. |
| Queue | Include processes in status: Console | If checked, the Queue size includes processes in status Console. |
| Queue | Hold Level | Processes below this priority level will not be started. |
| Queue | Time Window | The Time Window during which the Queue will release its processes. |
| Queue | Time Zone | The time zone to use for the Time Window (if specified). If the Time Window already has a time zone, this field is ignored. |
| Queue | Overdue | Sets processes that are not run within their Time Window to status Overdue. |
| Queue | Monitor On Dashboard | Monitor this Queue on the Monitoring dashboard. |
| Process Servers | Process Server | The name of the Process Server associated with this Queue provider. |
| Process Servers | Held | If this is checked, the Queue starts out in status Held. |
| Process Servers | Execution Size | The number of concurrent processes in the Queue. |
| Process Servers | Include Waiting Processes | If set to true, the Queue size includes waiting processes. |
| Process Servers | Hold Level | Processes below this priority level will not be started. |
| Process Servers | Time Window | The Time Window during which the Queue provider will release the processes. |
| Process Servers | Time Zone | The time zone to use for the Time Window (if specified). If the Time Window already has a time zone, this field will be ignored. |
Context Menu
Queues support the following context menu options.
Note: For generally applicable object context menu options, see Object Context Menu.
| Action | Description |
|---|---|
| Hold | Holds the Queue, this prevents new processes from starting (changing from state Queued to Running) in the Queue. Processes that are already running will continue to run. |
| Release | Releases the Queue, this releases a Queue that is held. This action only works if the Queue is in status ClosedHeld (which means that it is held by the operator). |
Holding Queues
A Queue can be open or held. While a Queue is held, RunMyJobs will not start any new processes in the Queue.
A Queue is automatically held if:
-
There are no Process Servers associated with the Queue.
-
The Time Window on the Queue is held.
-
All Queue providers are held. A Queue provider is held if:
- The Queue provider has been put on hold by an Operator.
- The Process Server associated with the Queue provider is stopped.
A Queue can also be held and released by an Operator.
Holding Queue Providers
It is also possible to hold individual Queue providers (for example, to hold a provider linking the Queue CRM to the Process Server CR6). This allows a Queue to continue feeding processes to other Process Servers. This is useful when it is necessary to shut down a single Process Server, but leave the Queue feeding others. The process to follow in this case is:
- Hold each Queue provider connected to the Process Server you want to shut down.
- Wait for all processes currently running on the Process Server to reach a final state.
- Shut down the Process Server.
When starting up, the reverse process is necessary:
- Start up the Process Server.
- Release each Queue provider.
Note: A Queue may appear held to you while it is open to others. This is usually due to the fact that you cannot see any of the running Process Servers that are serving the Queue.
Security
The privileges available in the Security tab are as follows.
For more information, see Security Tab.
| Privilege | Description |
|---|---|
| Queue.Create | Create Queues |
| Queue.Delete | Delete Queues |
| Queue.Edit | Edit Queues |
| Queue.View | Access Queues |
| Queue.ViewJobs | View the processes in the Queue |
| Queue.SubmitOnto | Submit processes onto the Queue |