Skip to main content


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

Configuring categories for mobile search

Updated on February 23, 2022

Provide mobile app users with more comprehensive search results by limiting the scope of the search to the categories that you define. For example, you can add a search category that displays the name and email of a person that matches the search parameters.

If you do not define any categories, the system searches all content in the Work- and Data- instances.
  1. In Dev Studio, search for and open the pySearchConfiguration rule.
  2. On the Editor tab, in the Search categories section, click Add category.
  3. Optional: To add a specific icon for the category, perform the following steps:
    1. In the new category row, click Select icon, and then click the Show image viewer icon.
    2. In the Image catalog window, enter an image name, and then click Find.
    3. Select an image that you want to use for the search category, click OK, and then click Submit.
  4. Optional: To set a new default icon for search categories, perform the following steps:
    1. In the Advanced section, click the Show image viewer icon.
    2. In the Image catalog window, enter an image name, and then click Find.
    3. Select the image that you want to use as default for new search categories, click OK, and then click Submit.
  5. In the new category row, define the parameters of the search category:
    1. In the Source data page column field, enter the name of the data page that you want to use as the source.
      Note: To guarantee efficient synchronization of the data page to the mobile client, consider using a large data page as the source for search categories. Add the pyModificationDateTime and pyIsRecordDeleted properties to the data source of the data page that you want to use as the source for a search category. The mobile client then pulls the data that have changed since the last synchronization instead of the whole content of the data page. For more information about using large data pages effectively, see Improving the synchronization of offline-enabled mobile apps with large data pages.
      For example: Enter the name of the data page that contains a list of contacts that you want to use as a source for the search.
    2. In the Category display name column field, enter the display name for the category.
      For example: Enter Contacts as the category name.
    3. In the Title source property column field, enter a property that displays the title of the search result.
      For example: Add the property that contains the name and surname of a contact.
    4. In the Description source property column field, enter a property that displays the description of the search result.
      For example: Add the property that contains the email of a contact.
  6. Optional: To define an action that occurs when users click a search category item, perform the following steps:
    1. Click Configure action.
    2. Click Add an actionAll actions, and then select an action that you want to use.
      For example: Add the Open work by handle action that opens the object of the class by using a unique identifier.
    3. Specify additional settings for the action that you selected.
      For example: In the Handle field, enter pzInsKey as the unique identifier for the Open work by handle action to enable users to display the contact details by clicking the search result.
      For more information, see Available UI actions.
    4. Click Submit.
  7. Optional: To add more categories to the list, repeat steps 2 through 6.
  8. Click Save.
Result: When the users of your mobile app perform a search, the app displays the results grouped by the categories that you defined. Each result has a title and a description that help users choose the best search result.

Related articles

Native search capability in mobile appsConfiguring search in mobile appsConfiguring a search action in a mobile app

Tags

Pega Platform 8.5 Mobile

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