Close popover

Table of Contents

Configuring categories for mobile search

Version:

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.

      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 Creating and sourcing large data pages to store large reference data in offline-enabled applications.
      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.

      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.

      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.

      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 action All actions , and then select an action that you want to use.

      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.

      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 actions and conditions.

    4. Click Submit.

  7. Optional:

    To add more categories to the list, repeat steps 2 through 6.

  8. Click Save.

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.

  • Native search capability in mobile apps

    Mobile apps that you develop in Pega Platform do not provide search by default. Since search is critical and provides the user with a quick and a customized way to look for content within the app, you must add the native search capability to the app separately. This improves the overall user experience of the mobile app by providing the needed speed and responsiveness.

  • Configuring search in mobile apps

    Enhance the overall user experience by configuring the search in a mobile app. For example, modify the search parameters and define the scope of the search in your app.

  • Configuring a search action in a mobile app

    To use the native search capability in a mobile app, you must define a mobile search action in the user interface. You can define the mobile search action anywhere within a section. For example, you can define this action for a button. When a user clicks that button, a native search is enabled so that the user can more quickly find the relevant content.

Have a question? Get answers now.

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