Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

JMS MDB Listener form – Completing the Listener Properties tab

Updated on April 5, 2022

Use the Listener Properties tab to set up the Pega Platform configuration options for the listener, including to which service rule it routes the JMS messages from the queue or topic it monitors.

Note: JMS MDB Listener rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using JMS MDB Listener rules does not follow Pega development best practices. Consider other implementation options instead.

Listener properties

Service package Use the Service package, Service class, and Service method fields to identify which JMS service rules ( Rule-Service-JMS ) are to process the messages this listener retrieves. Use the Service package field to specify the first key part — the Customer Package Name — of the rule.
Service class Optional. Select the second key part — Customer Class Name — of one or more Service JMS rules within the package identified. This listener ignores messages that reference other classes within the package.

If this field is blank, the listener uses the PegaRULES_ServiceClass property in the request message as the second key part.

Service method Optional. Enter the third key part — Customer Method Name — of the Service JMS rule that will process the requests. This listener ignores messages that reference other methods within the Service class and Service package.

If this field is blank, the listener uses the PegaRULES_ServiceMethod property in the request message as the third key part.

Send error messages If this check box is selected, and a processing error occurs that is not handled by a configured response message, the listener responds with a text message that contains the error message.

Error messages can be sent only if the sender of the message identified a Reply To queue in the JMSReplyTo header field of the message. The queue specified in the header field must be located on the server specified in the JNDI server field on the JMS Properties tab of this listener.

This option is disabled if you select No Reply as the Preference on the JMS Properties tab.

Container-managed transaction Select this check box to generate the MDB deployment descriptor with transaction attributes that cause message redelivery in the case of processing failure. This allows the Pega Platform service to re-process the message.

Requestor login

Requestor user idOptional. If the service rule is to run as an authenticated user, specify the name of an Operator ID record to use for authentication.
Password Optional, but required if an Operator ID is specified in the Requestor user id field. Enter the password for the operator specified in the Requestor user id field.


Diagnostics The remote logging feature streams the contents of the Pega log file to the LogFactor5 application installed on your workstation. For information about this feature, see How to install and use remote logging.

To view only those log messages that are about the service rule this listener listens for, complete the fields in this section. Remember to start the LogFactor5 application on your workstation before updating this form to identify your workstation as a logger.

Remote hostOptional. To use the remote logging feature, specify the server name of your workstation.
PortOptional. To use the remote logging feature, specify the TCP/IP port number of the port where the log4j Socket Server applet listens. The default port is 8887.
  • Previous topic JMS MDB Listener data instances – Completing the New or Save As form
  • Next topic JMS MDB Listener form – Completing the JMS Properties tab

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