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 Listener form – Completing the JMS Properties tab

Updated on April 5, 2022

Use the JMS Properties tab to set up JMS configuration options for the listener, including the topic or queue and which messaging domain to use.

Messaging model

FieldDescription
Messaging Model Specify which messaging model to use: Publish-and-Subscribe or Point-to-Point.

Session

FieldDescription
Resource Name Resolution

To use resource references to identify the JMS resources, select Resource Reference. Otherwise, select Direct JNDI Lookup. See the Pega Community article Configure a JMS service or connector to find JMS resources through resource references.

JNDI Server If you selected Direct JNDI Lookup in the Resource Name Resolution field, select the JNDI Server data instance that represents the server hosting the queue or topic specified below. Your system connects to the JNDI server identified in that data instance to obtain JMS producer properties.

This field supports the Global Resource Settings syntax (= PageName.PropertyName ). The default property name for this field is pyJNDIServerName. For more information, see Using the Global Resource Settings feature.

Connection Factory Name

Select or enter the name of the JMS Connection Factory. If you selected Resource Reference in the Resource Name Resolution field, the list shows the connection factory references from the deployment descriptor file. If you selected Direct JNDI Lookup, SmartPrompt is available if you can connect to the JNDI server identified in the JNDI Server field.

For example:

weblogic.jms.XAConnectionFactory
This field supports the Global Resource Settings syntax (= PageName.PropertyName ). The default property name for this field is pyConnectionFactory. For more information, see Using the Global Resource Settings feature.
Factory UsernameOptional. If the Connection Factory is to connect to the topic or queue specified below as an authenticated user, enter the name of a valid user.
Factory Password Optional, but required if a user name is specified in the Factory Username field. Enter the password for the user specified in the Factory Username field.
Acknowledgement Optional. Select:
  • Blank to send no acknowledgments.
  • On Message Receipt to cause the listener to acknowledge an arriving message automatically when it receives a message, but before the service rule processes the message.
  • After Message Processing to cause the listener to wait to acknowledge that it received a message until after the service processes the message. With this option, no acknowledgment is sent if an error occurs during message processing.
Durable Subscriber? If the Topic or Queue Name field specifies a topic and the messaging domain is set to Publish and Subscribe, select to indicate that the listener is a durable subscriber.
No Local Messages A local message is one whose client ID identifies it as being posted to the queue by the services specified in the Service Package, Service Class, and Service Method fields.

Select the No Local Messages option to specify that the listener will leave local messages on the queue. Clear this check box to specify that the listener will process all messages posted to the queue.

If a publisher and subscriber share a common client ID, messages from the publisher are considered to be local, too. In such a case, clear the No Local Messages option.

Request

FieldDescription
Request Destination Name If the messaging domain is Publish-and-Subscribe, select or enter the JMS Topic object from which the listener will receive messages. If the messaging domain is Point-to-Point, select or enter the JMS Queue object from which the listener will receive messages.

SmartPrompt is available if you can connect to the JNDI server identified in the JNDI Server field.

This field supports the Global Resource Settings syntax (= PageName.PropertyName ). The default property name for this field is pyRequestDestination. For more information, see Using the Global Resource Settings feature.

Click Message explorer to display a list of JMS messages, add a message, or remove a message.

Message Selector Optional. To filter messages, enter a JMS selection expression. A message selector is a string whose syntax is based on a subset of the SQL 92 conditional expression syntax.

For details and examples, see the Javadoc documentation for the Java class named javax.jms.Message.

Response

FieldDescription
Response
Preference Determines whether this listener, or the incoming messages, provide the identity of the response destination:
  • Message (default) indicates that the listener is to use the response destination information from the ReplyTo headers of the incoming messages.
  • Listener indicates that the listener is to use the destination specified in the Response Destination Name field, below.
  • No Reply indicates that the listener does not send any response, including error messages. Selecting "No Reply" disables the Send Error Messages check box on the Listener Properties tab.
Response Destination Name If the Preference field is set to Listener and this listener is to send responses, specify the destination of the response. If the messaging domain is Publish-and-Subscribe, select the JMS Topic object from which messages are to be received. If the messaging domain is Point-to-Point, select the JMS Queue object from which messages are to be received.

This field supports the Global Resource Settings syntax (= PageName.PropertyName ). The default property name for this field is pyResponseDestination. For more information, see Using the Global Resource Settings feature.

This field is not available if you selected No Reply for the Preference field.

Click Message explorer to display a list of JMS messages, add a message, or remove a message.

Test Connectivity After you save the JMS Listener form, click Test Connectivity to test whether your system can connect to the server identified by the JNDI Server data instance selected in the JNDI Server field above.

The system presents test results in a separate window, identifying the parameters used in the test, the steps attempted, and the outcome of each step.

If this system is not correctly configured as a JMS client, a Java exception appears when you click this button.

If the Blocked check box on the Listener Properties tab is selected when you click this button, testing ends with a Failed message.

  • Previous topic JMS Listener form – Completing the Listener Properties tab
  • Next topic More about JMS Listener data instances

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us