More about Service MQ rules

Preparing the Pega Platform server

MQ facilities depend on an IBM SupportPac® library. On some WebSphere systems, this file is already installed. If it is not installed, download the library for your server platform from IBM.

  1. Install the client application according to the instructions for your application server.
  2. Note the complete path to the file and the connection.jar file.
  3. Add both jar files to the Pega Platform compile time and runtime class paths. See Pega Community article About the Process Commander class paths.

Development procedure

1. Confirm that the initServices/initMQ entry in the prconfig.xml file to set Value="true".

2. Service MQ rules run in a background requestor that uses the APP requestor type to sign on. Development requires:

  • A service package data instance ( Data-Admin-ServicePackage ) to define the package name.
  • An MQ Listener data instance to specify the name and properties of the remote queue of the WebSphere MQ server where the service request messages are read from.
  • An MQ Server data instance defines the environment properties needed to connect to the WebSphere MQ server.
  • A collection of Service MQ rules, each referencing a service activity.

One MQ Server instance can be used by multiple MQ Listener instances, and one MQ Listener instance can be used for all Service MQ instances of a specific customer package and class.

3. The development process involves designing the interface, deploying the service, and then interacting with the MQ service as necessary.

For clients to interact with the Pega Platform MQ services, they create client-side request messages, place them on the remote queue on which the Pega Platform listens, and wait for a response message from the Pega Platform.


The coded character set identifier (CCSID) for MQ messages to and from the Pega Platform is the default value 819.

Performance statistics

Through changes to the prlog4j2.xml file, you can obtain performance statistics on the execution of services. See Performance tool — Statistics for services.

Through changes to the prconfig.xml file or Dynamic System Settings, you can be alerted to unusually long service operations. See How to detect lengthy service operations.

As an alternative to updating the prconfig.xml file, you can use Dynamic System Settings to configure your application. See Dynamic System Settings data instances.