PPM Broker Troubleshooting

Products

• Clarity PPM SaaS
• Clarity PPM On Premise

Issue/Introduction

Troubleshooting steps for PPM Broker (ppmbroker) service setup with Clarity

Environment

All Supported Clarity Releases

Resolution

Configuration Status Checkup

• Make sure ppmbroker is correctly enabled in properties.xml ( ensure the following parameter is set: enableBroker="true")
• The entryURL has to be set up correctly for ppmbroker service
• All necessary network ports used by Clarity and ppmbroker have to be open in the firewalls on the environment to allow traffic between clients, Clarity application servers and the ppmbroker instance
• Check that the ppmbroker service is up and running on the server

Connectivity and Broker Endpoint Validation

• Check Clarity - Administration - Health Report - Application to see how the broker setup is displaying there and whether you see the Web Socket connections open after connecting to MUX
• Check the servicePing page by opening the URL: https://<clarity.example.com>:<port>/niku/nu#action:security.servicePing
  • If servicePing is showing Service Unavailable, the broker is not working
  • If it's available, check the details further
• You can copy the Broker URI from that servicePing page and replace "ppm-ping" with "status", now try to access the URL in browser: https://<ppmbroker.example.com>/ppmbroker/mercury/broker/status
• In the resulting JSON output you can check if dbAccessible is true and look for any error messages or unexpected values
• Open in DevTools after opening a new connection to MUX. Review the userContext request  - Preview - systeminfo - environment - to see if the broker URL is correctly pointing to the ppmbroker endpoint.

Debugging:

• You can set up DEBUG as below categories in security.logs
  • DEBUG on STDOUT:
  • ppm.push.server
  • ppm.broker.service
  • ppm.push.service
• Check ppmbroker-ca.log and app-ca.log. You may want to enable it on both app and broker app if separate servers to review.