Skip to main content

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

Queue processor rules

Updated on July 8, 2022

A queue processor rule is an internal background process on the server that you can use for queue management and asynchronous processing. You can use standard or dedicated queue processor rules.

Queue processor rules replace standard agents. You can use standard queue processors for simple queue management, or dedicated queue processors for customized or delayed processing of messages. Queue processor rules support higher scaling throughput than agents. Each queue processor can process messages across 20 partitions, which means that Queue processor rules can support up to 20 separate processing threads simultaneously with no conflict. Use queue processor rules by using the Queue-for-Processing method or the Run in Background SmartShape.

Standard queue processor rules

Pega Platform provides the following default queue processors that you can use in your application:
A queue processor that you can use for standard asynchronous processing when:
  • Processing does not require high-throughput or processing resources can be slightly delayed
  • Default and standard queue behaviors are acceptable
You can use this queue processor for tasks such as submitting each status change to an external system. This queue processor uses a general queue. You can also use pzStandardProcessor to run bulk processes in the background. When the queue processor resolves all the items from the queue, you receive a notification with information about the number of successful and failed attempts.
A queue processor that sends notifications to customers and runs the pxNotify activity to calculate data such as the list of recipients, the message, or the channel. The possible channels include an email, a gadget notification, or a Push notification.
A queue processor that performs incremental indexing in the background. This queue processor posts Rule, Data and Work objects into the Search subsystem, as soon as you create or change them. This helps to keep search data current, and reflects the content of the database closely.

Dedicated queue processor rules

You can create dedicated queue processor rules to meet your specific needs and use these rules when you perform a high-throughput, distributed process that is critical to an application. You can use dedicated queue processor rules when the background process requires vertical and horizontal scaling, for tasks such as inbound batch file processing.

You can use these rules for immediate processing, for tasks such as updating a database of user names. If you select this option, an item is pushed immediately to the queue. You can also use dedicated queue processor rules for delayed processing, for tasks that you want to be processed with a specified delay. For example, when you want to process an activity to send an email to a user two hours after the deadline. Utilize the dedicated queue processor rules by using the Queue-for-Processing method or a Run in Background SmartShape.

Queue Processor management

Create standard and dedicated queue processors in Dev Studio. Use the queue processor landing page in Admin Studio to trace and override queue processor rules in your application. To create and manage queue processor rules, make sure that you have one of the following privileges:

  • pzQueueProcessorAdministrator
  • pzClusterAdministrator
To view the list of queue processors, you must have the pzQueueProcessorObserver privilege.

For more information about the queue processor rule, see Background processing best practices.

  • Creating a queue processor rule

    Create a queue processor rule to queue your items. You can use a queue processor rule for immediate or delayed processing, for tasks such as sending emails to users or updating the database of user logins.

  • Queue-For-Processing method

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

  • Node classification for queue processor rules

    For better performance, use node classification for your queue processor rules. Decide on which nodes your queue processor rules run by associating node types with queue processor rules.

  • Stream node configurations for a queue processor rule

    A queue processor rule requires at least one stream node to run. Without a stream node, messages cannot be queued to or retrieved from the Kafka server.

  • Changing a queue processor rule state

    Save system resources by conveniently controlling which queue processors run in your application. You can disable and enable specific queue processors anytime. For example, if the system indicates issues with queue processors, you can temporarily disable the faulty rules, and analyze the issue.

  • Previous topic Setting up large message handling for on-premises environments
  • Next topic Creating a queue processor rule

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