MQ Listener form
Completing the Listener Properties tab

Field

Description

Select to control how listeners start:

• Run on all nodes — The listener is run on all nodes and all servers in a cluster.
• Node based startup — The listener is started only on specified nodes.
• Host based startup — The listener is started on a specified number of nodes on specific servers within the cluster.

Appears when the Node based startup option is selected. In a multinode cluster, using the SmartPrompt, enter the node ID of the server host node or nodes where this listener will run. When a node starts it activates the listener on the current node if the current node matches any node in the list (and if other requirements are met).

• If a node is specified, the current node must match a name in the list for PRPC to activate the listener.
• If a node is not specified, PRPC activates the listener on each node. See More about MQ Listeners.

Operating a listener on multiple nodes can increase throughput. However, when instances of a listener are active on multiple nodes (even in a single server), consider using semaphores to coordinate access and locking. Additionally, if the application requires processing messages in exact arrival sequence, such synchronization requires design and testing.

Appears when the Server based startup option is selected. Enter a number of nodes on which the listener is to start.

Deletes all the instances from the class Log-Connect-AssignedNodes, so that listeners can be started.

Field

Description

Optional. Enter a text value to use to filter arriving messages. Typically used only when testing an MQ service during development.

If a value is specified, the listener reads only messages with the specified value (converted to bytes) in the MessageID header field from the queue. Leave this field blank on a production system.

Optional. Enter a Single Value property reference or a literal constant in double quotes to use to filter messages arriving on the request queue. Typically used only when testing an MQ service during development.

If a value is specified, the listener reads only messages with the specified value (converted to bytes) in the CorrelationID header field from the queue. Leave this field blank on a production system.

Enter 1 or a small integer to determine the number of threads per server node that this listener requestor creates when it starts.

As a best practice, start by setting it to no more than two times the number of CPUs on the server. Then tune it for your application. Depending on what your application does, you may need to set it lower or higher.

Specify the first key part — the Customer Package Name — of a Service MQ service rule in this field. Use the Service Package, Service Class, and Service Method fields together to identify which Service MQ service rules will process the request messages.

Specify the second key part — the Customer Class Name — of the Service MQ rules that are to process the requests.

Optional. Specify the third key part — the Customer Method Name — of the Service MQ service rule that is to process the requests. If this field is blank, the listener obtains the third key part from the ApplicationIdData header field of each incoming request message.

Wait Interval (seconds)

As this PRPC server is deployed in the Web tier, the listener cannot be shut down while it is listening to the queue ("sleeping"). Use this field to specify a regular interval, in seconds, when the listener pauses ("wakes up") and determines whether a shutdown request was sent.

Use the Listener Management menu item in the System Management application to start and stop listeners.

If this PRPC server is deployed in the Enterprise tier of a Java EE application server, enter a value in seconds to determine how often the listener polls the application server.

Optional. After you complete this tab and save the data instance, click to confirm that PRPC can connect to the MQ server.

The system attempts to connect to the queue manager and access the message queue. No messages are accepted. 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 the Blocked checkbox is selected when you click this button, testing ends with a Failed message.)

Field

Description

Select to enable transacted message processing.

Specify the number of times the service rule attempts to process a message after failing to process it correctly. After this number of attempts, the listener routes the message to the backout queue specified in the Backout Queue field.

Specify the name of the backout queue that the listener routes failed messages to when transacted message processing is enabled.

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

Field

Description

Optional. Select the Operator ID that MQ processing will use for processing associated with this listener. The access group associated with the Operator ID instance for this User ID determines RuleSets, security, workbaskets, and so on.

Enter a password for the Operator ID.

Field

Description

The Remote Logging feature streams the contents of the Pega log file to the LogFactor5 application installed on your workstation.

After you add your workstation as an active logger through the Logging and Tracing > Remote Logging menu item in the System Management application, your workstation receives all messages for all processes running on the server. To specify that you want 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 window on your workstation before you use this form to identify your workstation as a logger.

Optional. Enter the name of your computer. See also How to install and use remote logging

Optional. Enter the TCP/IP port number that the log4j package on your computer listens on. By default this port is 8887.

Field

Description

Select to prevent this listener from being started by any means. If cleared, the listener starts with system startup, or can be started using the System Management application. See More about MQ Listeners.