Managing Queue Handlers

This is a Pipes Pro feature.

Creating a Queue Handler

You can create a queue handler using the SYSADMIN.createQueueHandler procedure:

CODE

SYSADMIN.createQueueHandler(IN queueHandler string NOT NULL, IN threadCount string NOT NULL)

This procedure takes the following parameters:

Parameter	Description
`queueHandler`	Unique queue handler name
`threadCount`	Defines how many jobs can be run in parallel with this handler. Must be greater than or equal to `0`. `0` means no jobs can run and all jobs will be placed in queue

To change an existing queue handler, use the SYSADMIN.editQueueHandler procedure:

CODE

SYSADMIN.editQueueHandler(IN queueHandler string NOT NULL, IN threadCount string NOT NULL)

This procedure takes the following parameters:

Parameter	Description
`queueHandler`	Queue handler name to be edited
`threadCount`	Thread count for this queue handler. Must be greater than or equal to `0` for all handlers except `system`. For the `system` handler, must be greater than `0`. `0` means no jobs can run and all jobs will be placed in queue. The `service` queue handler cannot be changed

To drop a queue handler, you can use the SYSADMIN.dropQueueHandler procedure:

CODE

SYSADMIN.dropQueueHandler(IN queueHandler string NOT NULL)

This procedure takes the following parameters:

Parameter	Description
`queueHandler`	Queue handler name to be dropped. `service`, `system`, and `default` handlers cannot be dropped

You can delete jobs from a queue using the SYSADMIN.cleanupJobQueue procedure:

CODE

SYSADMIN.cleanupJobQueue(IN jobQueueItemIDs string NOT NULL, IN queueHandler string NOT NULL)

This procedure takes the following parameters:

Parameter	Description
`jobQueueItemIDs`	An array of job queue item IDs. See `SYSADMIN.JobQueue`. To define one item ID, use the `('<itemID>',)` notation
`queueHandler`	Queue handler. All jobs with this queue handler are deleted from the queue if this parameter is set

Only one parameter can be used. An error is displayed if both parameters are defined.

CODE

CALL SYSADMIN.cleanupJobQueue(jobQueueItemIDs => ('f1333218-95a4-11ec-8948-0a002700000a',))

CODE

CALL SYSADMIN.cleanupJobQueue(jobQueueItemIDs => ('f1333218-95a4-11ec-8948-0a002700000a','f1333218-95a4-11ec-8948-0a002700000b'))