Working with your run queue
Introduction
When a process flow run is initialised automatically (via a trigger shape or a Patchworks API request), the run job is added to your queue.
Manual runs (initialised from the canvas actions bar) and manual retries are NOT added to your queue:
| Initialise method | Queued? |
|---|---|
queued | |
queued | |
queued | |
queued | |
queued | |
not queued | |
not queued |
How it works
The time that run jobs remain in the queue depends on various factors which are summarised below:
| Factor | Summary |
|---|---|
Concurrent process flows allowance | Refers to the maximum number of process flows that can be run simultaneously - the greater your allowance, the faster your queued run jobs are processed. This allowance is determined by your Patchworks subscription. |
Scheduled process flows allowance | Refers to the maximum number of process flow run jobs that can be queued at any given time. If this allowance is exceeded, any subsequent run jobs are held until a queue slot is released (i.e. until an existing item in your queue is picked to be run). This allowance is determined by your Patchworks subscription. |
The 'add to queue' frequency | The frequency that run jobs are added to your queue. This is a general system setting across the Patchworks platform - it's currently set to |
The 'pick from queue' frequency | The frequency at which run jobs are picked from your queue and run. This is a general system setting across the Patchworks platform - it's currently set to |
Queue priority | When configuring a process flow, you can set a queue priority ( |
Points to note:
Every
05seconds, the system checks if any process flows are running:If NO, it checks the queue and picks more flows to run - the number of flows picked will be the maximum allowed to meet your
concurrent process flowslimit.If YES, it checks if our
concurrent process flowslimit has been reached. If it has, no more flows are picked from the queue. If it has not, the queue is checked and more flows are picked to run. The number of flows picked will be the maximum allowed to meet ourconcurrent process flowslimit.
If a process flow is triggered manually, it bypasses the queue and is run as soon as possible. A manual run still consumes one flow from your
concurrent process flowsallowance - so while it's running, one less job can be picked from your queue.By default, run jobs are picked from the queue in the sequence they were added. However, if a queue priority has been set for a process flow, it takes precedence. For example, if your queue contains 6 run jobs with no
queue priorityand then a new job is added for a process flow with aqueue priorityset tohigh, this will be the next job to be picked (despite being the last to be added to the queue). Conversely, if a job is queued for a process flow with aqueue priorityset tolowest, this will be the last job to leave the queue.
Viewing your run queue
You can view all of your pending runs from the queue tab - entries are listed chronologically based on the time that the job was added to the queue:
At a glance, you can see:
Process flow name (hyperlinked so you can quickly access the flow)
Trigger
Queued at time
As soon as a pending job starts running, the entry is removed from this table and moves to the active run logs section.
Whether or not a process flow is queued depends on how it is initialised - see Are all run jobs queued? for more information.
Deleting a run job from your queue
To delete a run job from your queue (so it doesn't run), click the associated using
When prompted, confirm this action:
In the unlikely event that you choose to delete a run job that has already left the queue (because the dashboard has not refreshed), you'll be advised of this when you attempt to confirm the delete action.
Related information
Last updated
