This documentation supports the 20.08 version of BMC Helix Platform. 
To view an earlier version, select 20.02 from the Product version menu.

Enabling global search for use in an application

The global search functionality allows the end users to perform search operations within an application. Global search searches across multiple forms for records that match a word or phrase that users type in the search area. 

Global search leverages the full-text search functionality and searches all fields that have the FTS property enabled. For example, if you have multiple record definitions with multiple fields that are FTS enabled, the global search searchs all those fields. 

By default, the Global search option is disabled. You must configure the global search and enable it. 

Before you begin

  • To enable full-text search in fields.
  • Your application must consist of the following elements:
    • Record definition that consists of at least one text field that has the FTS property enabled (search field). You can create multiple record definitions to include in the search.
    • View definition that consists of the record editor component for each record definition that includes search fields. The view needs to have an input parameter that is bound to the ID of the record from the search results, and the record editor Record ID should point to that view parameter.

To configure global search  

  1. Log in to the BMC Helix Innovation Studio and navigate to the Workspace tab.
  2. Select the application.
  3. Navigate to Application Shell and click Navigation.
  4. On the canvas, select the navigation bar and in the properties, and clear the Disable Global Search checkbox.
  5. Select Use default search result view and click Configure results view.
  6. On Configure Results View, add the records to include in the search result, select the view from the Display View When Clicked drop-down list, and click Save.
  7. Save the changes and close the shell.

The following image shows a sample search result with the default configuration:

The annotations in the image are described in the following table:

1Search string used to perform the search.
2Search results are stored in the order of relevancy. You can use the filter to specify the record definitions that should be included in the search results.
3Search results have the following format:
  • Record definition name is displayed as static text.
  • The ID is displayed as a clickable link that navigates to the view set for the record definition in default search view properties.
  • The second line displays the title of the result.
  • The third line is the hit for the search match. The exact search string is highlighted.
4Search results are sorted in descending order by relevancy.
5By default, the first 50 search results are displayed. The search page uses an infinite scroll pattern. When you scroll down, the page loads a chunk of 50 additional search results at the bottom of the page.

Related topics

Search capabilities for custom applications

Leveraging full-text and global search capabilities in your application

Enabling full-text search capabilities in your application

Was this page helpful? Yes No Submitting... Thank you