Skip to main content

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

Deploying a help site

Updated on March 22, 2022

You can deploy your help site to your web self-service portal or other web applications. Pega Knowledge automatically generates the required JavaScript and HTML snippets.

Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide Pega Knowledge Implementation Guide
  1. Log in to Pega Knowledge portal.
  2. Click Knowledge > Help sites.
  3. Select the help site link you want to publish and click Publish.
  4. Click Embed site to generate the JavaScript and HTML snippets.
  5. Follow the instructions provided in the JavaScript code and embed the snippet in the desired placeholder.
    1. You can insert the JavaScript code into a .js file on the web server that is serving your targeted self-service web site or other web application. This allows the referencing HTML code visibility when being called. Alternatively, you can embed the JavaScript code directly into the source code of the targeted self-service web pages.
    2. Insert the HTML code where you want the help site to be called or redirected, such as a button, link, or image. To pass a specific articleID to display upon reaching the help site, insert the related "KC-" article number in the HTML code as the articleID parameter. This is passed with the calling URL and allows the help site to display this specific article once the user reaches the redirected help site.
  6. To test your code, open the web page that contains the Pega Knowledge code, and click the UI element (button, link, or image) that contains the JavaScript and HTML snippet. You are directed to your help site.

Configuring access to the help site

To configure and provide help site access for external users, follow these steps:

  1. In the Explorer panel, click App.
  2. Open PegaFW-KM-Admin-ApplicationSetting class.
  3. Click Data Model > Data Transform > pyDefault.
  4. Update the .KMPrefHelpSiteName source column with Organization-helpsite, for example, Uplusbank.
  5. Click Save to save and update the data transform sources.

Launching the help site

The following information describes the process to launch the deployed help site:

  • To launch the help site, identify the details such as host name, IP address, and port details. To launch a particular help site, add the host name, IP address, and port details along with the given help site name to this URL pattern: https://< hostname>:<port> /prweb/PRServletCustom/help/< helpsitename >.
  • Another way of launching a help site is by accessing the activity KMDisplayHelpPortal. The KMDisplayHelpPortal activity considers parameters like help site name, status, community site name. This activity can also be used to open a particular article in a given help site or a post in a given community.

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