Skip to main content

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

Preparing for the implementation

Updated on September 14, 2021

To prepare the implementation environment and to create your application, complete the following tasks:

Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide

Loading Pega Knowledge sample data

Pega Knowledge includes a sample data file that consists of content, categories, and community posts, which helps to expedite implementation testing. The sample content can be deleted or edited based on your Pega Knowledge solution.

Creating the application

Before you begin:

When you run the New Application Wizard for Pega Knowledge, it creates a set of Pega-provided operators. For security purposes, these operators are disabled. To use the new application, you must enable the appropriate operators. See Enabling sample operator accounts.

  1. Log in by entering the administrator user name with the password that you specified for the Pega Knowledge application that you are implementing.
  2. Click Application menu > New Application.
  3. In the New Application wizard, click Pega Knowledge.
  4. Click Build with Pega Knowledge.
  5. Note the following when completing the configuration options:
    • Important: On the Select case types page, clear all of the selected case type check boxes. Pega Knowledge does not provide case types to extend in the implementation layer. They are used only for demonstration purposes.
    • There are no data types displayed on the Data types page. Pega Knowledge does not provide data types to extend in the implementation layer. They are only used for demonstration purposes.
  6. On the Name your application page, enter a name for your application.
  7. Click Create application.
    Result: Based on the application type and the information that you specify, the system creates an application with the required access groups, and operators. For example, the system clones the access groups that point to the application, clones the roles in that access group, and creates any users that you defined on the Application wizard tab of the Application rule form.
  8. Log in to your new application after you enable the appropriate operator IDs.
    Note: All procedures in this guide require that you log in to your new application by entering credentials for that application, unless otherwise noted.
What to do next:

The New Application wizard creates the application ruleset structure for you. You can reuse the rulesets that are created by the wizard for any further implementation. As you implement this application and future applications, you can apply Class layers principles to help you decide where in the class structure to create your rules to improve the maintainability and overall efficiency of your application.

For more information, see class hierarchy and inheritance.

Configuring access groups

A new application includes Pega-provided access groups and access roles that you can view in Dev Studio by clicking Dev Studio > Org & Security > Groups & Roles.

It is a best practice to create new access groups and roles that are based on the default access groups and roles that come with the product. This insulates your application from changes if the roles and groups change permissions in a future release.

Important: Misconfiguration of the KM Help Site access groups might lead to unintended data exposure and cause a security risk to your enterprise. The ExternalKMUserAG and ExternalKMAG access groups are intended for external users and default to the KM help site portal. The Pega Knowledge application uses KMHelpPortal as the default portal for the ExternalKMUserAG and ExternalKMAG access groups. Therefore, the activated portal must be KMHelpPortal. If your organization has changed or customized these access groups, ensure that the activated portal is set to KMHelpPortal. For more information, see Pega Security Advisory – B21.
  1. Click Dev Studio > Org & Security > Groups & Roles >Access Groups.
  2. Select the access group that you want to use, for example Pega:Manager.
  3. Select the access role that you want to use, for example KMApprover.
  4. Click Save as to save the role to your application. It is recommended that you name the role with a different name. Update the roles to use the ones that you created for your application.
  5. Click Create and open.
  6. In the Definition tab, map the Name and Version field details with your application and click Save.
What to do next: Add an access role.

To add an access role:

  1. In the Explorer panel, click Records > Security > Access Role Name.
  2. Select the access role that you want to use, for example KMAuthor.
  3. In the Access Role field, click the filter icon and enter PegaKM in the Search Text box.
  4. Click Apply.
  5. Select the access role that you want to use, for example KMApprover.
  6. Click Save as to save the role to your application. It is recommended to give the role a different name.
  7. Click Create and open.
  8. Click Save.

Integrating the Pega Knowledge rulesets

To integrate the Pega Knowledge application with your existing Pega application, you must add specific Pega Knowledge rulesets in your application. After integrating the Pega Knowledge rulesets with your application, you can use the Pega Knowledge features in your application.

The lead system architect (LSA) or project architect can provide guidance on the features that are included in each ruleset. Add these rulesets at the bottom of the ruleset stack so that you do not overwrite implementation rulesets in your application.
Note: For Pega Customer Service applications, the Pega Knowledge rulesets have already been added. You can skip the following steps.
  1. Click Application MenuDefinition.
  2. To add the Pega Knowledge rulesets, in the Application rulesets section, click Add ruleset, and then add the following rulesets in the defined sequence:
    • PegaKM
    • PegaKMDiagnostics
    • PegaKMInt
    • PegaKMToggles
    • KMReports
  3. Click Save.
Result: You can now use the Pega Knowledge features in your application.

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us