Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Queue-For-Processing method

Updated on May 11, 2022

Use this method to specify the details of queue processors that run in your application.

Step Page

Optional. Identify the class of the work item or other item that is to be processed. This page is available later as context to the queue processor activity that processes the item, for example:

  • If the queued item refers to a work item, set the step page to the work page (typically pyWorkPage).
  • If the queued item is an assignment, set the step page to the assignment page (typically NewAssignPage).
  • If the Step Page value in the step is blank, the primary page of the calling activity is used.


This method has the following parameters:

Field nameAvailable field valuesDescription

Default value

Type of queueStandardAn item is queued to a standard queue processor. You do not need to create a new queue processor.Standard
DedicatedAn item is queued to a custom queue processor.
Queue processorPress the Down arrow key to view the list of available queue processors.A name of the queue processor to which items are queued.N/A
Date/time for processingA DateTime property in the class of the step page.This option is available for dedicated queue processors only. A DateTime property by which you specify when a dedicated queue processor resolves the activity. The property represents the time after which an item can be processed.N/A
Activity namePress the Down arrow key to view the list of available activities. Enter parameter values in the appropriate fields.A name of the activity that is resolved by the queue processor. When you enter the name of the activity, the parameters for that activity are displayed.N/A
Lock usingPrimary pageOpen a page by using a pzInskey property and lock it. This page is available to Processing activity as pyQueuePage.Primary page
Key defined on propertyOpen a page by using a key defined on a property. This page is available to Processing activity as pyOtherPage. You need to enter a name of the property.
NoneOpen a page without a lock from the database by using the pzInskey property.
Long running queue processor thresholdNumber of milliseconds greater than 0A performance alert is generated when the activity runs longer than the threshold value.

For more information, see PEGA0117 alert: Long-running queue processor activity.

Write nowNoThe message is queued as a part of the next database commit.No
YesThe message is queued immediately and is not a part of any transaction.
Timeout to acquire lock (in minutes)Number of minutes greater than 0The system attempts to acquire the lock every minute until the specified value is reached. The system increases the retry attempt counter when the time-out value is reached.30
Number of minutes less than 0The system attempts to acquire the lock every minute and does not treat retries as failed attempts. The system does not increase the retry attempt counter.
0The system treats a failed lock try as a failed attempt and increases the retry attempt counter.
Queue current snapshot of pageNoWhen a page that has a pzInskey property is queued, the message stores the pzInskey value only. When an item is processed by using the pzInskey property, the corresponding record from the database opens. No
YesThe message that is queued stores the entire page. This is an advanced option that you can use for performance optimization.
Note: This option is available only when locking is set to None.
Alternate access groupPress the Down Arrow key to prompt the list of available access groups.Define an alternate access group when you want to process the item in a different context from the access group that is defined in the queue processor.N/A


The system queues the page to the embedded Kafka data instance. This occurs immediately or at the next Commit method run, depending on the Write Now setting. The queue processor picks up this item from the queue and processes the activity configured. A unique ID is generated to represent the ItemID and is available on the parameter page as the parameter, pxItemID.

Broken queue

When a queue processor tries to process an item for the number of times that you specify in the MaxAttempts parameter, and the queue processor is not successful, the item is moved to the broken queue. You can view the list of broken items in Admin Studio, on the Queue Processor landing page. To view the list of the broken items, you must have the pzQueueProcessorObserver privilege. To resubmit or delete items from the broken queue, you must have the pzQueueProcessorAdministrator privilege.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us