Skip to main content


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

Creating troubleshooter services

Updated on April 28, 2021

As an administrator, you can configure the external diagnostic APIs (services) that you specify in troubleshooter questions. To configure external APIs, you first create a troubleshooter service in the Pega Knowledge portal. External APIs help minimize the need to customize troubleshooters, which can help authors select the most appropriate API to run from a troubleshooter question.

Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide
  1. Log in to the Pega Knowledge portal
  2. In the left navigation pane, expand Configurations > Troubleshooter services, and then click Add a service.
  3. In the Add service config dialog box, enter the service identifier details in the Service identifier text box.
    The Service identifier provides the ability to call external APIs for several services.
    Note: You cannot edit the service identifier after you create it.
  4. Enter the name of the service identifier in the Service name text box.
  5. Optionally, enter a description for the troubleshooter service.
  6. Click Submit.
Result: You have successfully created the troubleshooter service.
What to do next: Configure the troubleshooter service to call the external API service.

Configuring troubleshooter services

As an administrator, configure the service identifiers that call the external API services that you specify in troubleshooter questions. External APIs help minimize the need to customize troubleshooters, which can help authors select the most appropriate API to run from a troubleshooter question.

To configure your troubleshooter services, you add a service identifier to the KMRunQueryService activity, which is the activity that calls the external API service. You then add a check for the service identifier using a when condition, and add logic to execute the API service. For each service identifier that you add, you override the KMRunQueryService activity and save the activity in your application ruleset.

Note: Create a specific ruleset for saving troubleshooter questions related to paragraph rules. This ruleset should be open.

  1. In the header of Dev Studio, search for and click the KMRunQueryService activity.
  2. Add a service identifier using a when condition in the KMRunQueryService activity.
    Note: You should update the When condition with logic based on the external API that you configure.
  3. Click Save as to save the activity in your application ruleset.
  4. In the header of Dev Studio, search for and click the D_KMApplicationSettings activity.
  5. In the Data source section, open the pyDefault data transform.
  6. In the pyDefault transform, search for .KMTSParagraphRulesetName, and then add the ruleset that you create for the troubleshooter services.
Result: After successfully creating and configuring a troubleshooter service, you can add this service to troubleshooter questions.
  • Previous topic Configuring troubleshooters for Pega Customer Service
  • Next topic Configuring Pega Mashup for launching service cases

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