Skip to main content


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

Creating a help site

Updated on January 19, 2022
The Knowledge portal lets you create a help site that provides a forum for your customers to explore articles and discuss solutions to common questions. You can create and configure a help site by specifying a name, welcome message, selecting categories, and selecting layout template and styles.
Pega Knowledge Implementation Guide
  1. In Pega Knowledge portal, go to the left navigation panel, expand Knowledge and click Help sites.
  2. Click New site.
  3. On the General tab, to change the layout of the help site, configure the following:
    1. Enter the help site name in the Name field.
    2. Optional: To hide the help site name on the help site, select the Do not display check box.
    3. Select the desired help site layout from the Template list.
    4. In the Welcome message field, enter the welcome message to display on the help site.
    5. Optional: To hide the welcome message on the help site, select the Do not display check box.
    6. To enable the external search engine optimization for the help site, select the Optimize for external search check box.
    7. To enable access roles based content visibility settings on the help site, select the Check the category access roles for this site check box. For more information on adding category access roles based visibility settings, see Optional: Defining security.
    8. To add the content categories to the help site, click Add category. Select the category that you want to display on the help site.
    Note: Your Pega Knowledge help sites must be registered with your preferred search engines. For example, to register your sites with Google®, navigate to the Google® Search console and follow the registration instructions.
  4. On the Gadgets tab, to allow your customer to suggest topics on the help site, configure the following:
    1. To display the list of top rated content that you want to highlight in your Pega Knowledge help site, select the Top rated content check box.
    2. To display the list of recently published articles that you want to highlight in your Pega Knowledge help site, select the Recently published check box.
    3. To display articles, links, or file attachments that you want to highlight in your Pega Knowledge help site, select the Featured content gadget check box.
    4. Select the Suggest content gadget check box. In the Knowledge portal, the feedback submitted using the Suggest content gadget on the help site is automatically routed to the Knowledge Content – Customer Suggestions workbasket.
    5. To add categories and sub-categories to display on the help site, click the Add category icon and then select the category or sub-category from the list.
      Note: You should create taxonomy categories and related content prior to configuring a help site. Categories or sub-categories that are not selected are not displayed on the help site. A category without any linked and published articles are not displayed in the help sites. For more information, see Configuring a taxonomy.
    6. To save the changes, click Save Draft.
  5. On the Style tab, to change the default style settings, configure the following:
    1. To select the Help site banner image, click Upload file, and select the image. The suggested image size is 1100 x 290 pixels in .jpg, .png, or .gif format.
    2. To select the font color and font size (in pixels) for the Welcome text, Category titles, Links, and Breadcrumb trail, use the respective color picker and enter the font size in pixels.
    3. To select the color for the Page background, Side panel background and Title border, use the respective color picker.
    4. To display category images on the help site, select the Display category images check box.
      Note: For all color fields, you can manually enter a hexadecimal (hex) color code. For example, #FFFFFF for white color.
    5. To select the color for the 'Suggest article' button, and 'Suggest article' icon color, use the respective color picker.
    6. To save the changes, click Save Draft.
  6. Optional: To preview the help site, click Preview.

Tags

Pega Knowledge 8.7

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

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