Skip to main content


Configuring the portal search

Suggest edit Updated on May 14, 2021

With the search functions of the Pega Customer Service portal, users can search for cases (work objects), knowledge content, and data sources such as accounts, contacts, and business units. A basic search and an advanced search is available for use in the Interaction portal.

You can perform a basic search by entering the search text in the search field of the Interaction portal. In the advanced search section, you can configure more fields as filters for a better search experience. When you select the fields for the Search results field as filters, the sequence of your selection determines the order in which you want the fields to appear in the Search results section.

Complete the following tasks to configure portal search:

Enabling the data source for portal search

In the Pega Customer Service application, to enable a data page for portal search, you must enable the data source rule to adopt the data page. Every data page is associated with one or more data source rules. Ensure that you create the list based data page for the targeted data source object and source it from a report definition.

To enable the portal search for a data source, perform the following steps:

  1. In Dev Studio, create a new section as a wrapper section which includes two sections, one for advance search filters and other for displaying search results. The Search result section contains a grid that is sourced from the clipboard page pySearchResults.pxResults. This requires an open ruleset on top of your current application ruleset. For more information to create a new section, Creating sections.
    Note: The name of the wrapper section that includes the search filter and the search grid section must be in the given format: Search_<data source name> and is case sensitive. For example, Search_Account where the Account is the data source name.
  2. Create a new data page or open an existing data page by clicking the Data types category in the Records Explorer. For more information to create a new data page, see Creating a data page.
    Note: When you create a data page, do not add any Refresh Strategy under the Load Management tab.
  3. In the Definitions tab, change the Edit mode field to Read only.
  4. Configure the Scope as Requestor.
  5. Click Save.
  6. Search for the MatchingRecordsCountForFilter data transform rule.
  7. In the Definitions tab, click the Add a row icon.
  8. Add a When rule condition to pass the data source specific search properties.
  9. Call the data source specific data page that fetches the records.
  10. Check for the records, if they exist, then add Append and Map to under Action and map the data page results to pySearchResults.
  11. In the next sub-step, set the properties to data page property type.
  12. Click Save.

Configuring the portal search for data sources

Pega Customer Service uses data source rules to configure portal search functions for data sources.

In App Studio, you can configure the search fields that you want to appear in the advance search and the search results section of the portal search page. Note: The Search configuration option does not appear in App Studio if the data source is not added to the SetRDandClass and SetDTandClass decision tables.

For any data source that you want to include in the Pega Customer Service portal search, complete the following steps:

  1. In the navigation pane of App Studio, click Data.
  2. From the list, select the data type for which you want to configure the portal search.
  3. In the Settings tab, click Search Configuration.
  4. In the Search Configuration section, select your data source from the Select your data source category list.
    Note: The data source list appears only if your data page is associated with multiple data sources.
  5. To enable the portal search for the selected data source, select the Portal search check box.
  6. To make the selected data source the default tab when any search is performed, select the Default tab in search results? check box.
    Note: If no data sources are configured as default, then the Cases tab is selected as default.
  7. From the list of available Field names, select the fields that you want to display in the Advanced search section and in the Search result section.
    Note: Select the fields in the order that you want them to be displayed in the Search results section of the Interaction portal. Ensure that you have at least one field selected for both the advanced search and search results. You can select a maximum of seven fields to display.
  8. Click Save.

Configuring search for cases and work objects

Pega Customer Service uses the Pega Platform search facility for work objects and case data. Pega Customer Service searches for your work types and other objects only if they are listed on your application rule or an inherited application rule. 

When a user selects a work object or case from the portal search results list, a tab opens in the general work area using the Review harness for that work type.

For information about adding search capabilities to the PDF files attached to your cases, see Implementing the Advanced PDF Search component in your application.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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