16.6.8 Editing a Search Page

Learn how attributes can change search page behavior

Tip:

The examples in this section use the tables and search configurations described in Creating Standard Search Configurations.

• Reviewing Search Page Components
  Review the components that comprise a search page by viewing attributes in Page Designer.
• Editing Search Results Region Attributes
  Edit Search Results region attributes to change region behavior.
• Editing Search Results Attributes
  Edit Search Results Attributes to control how a search works.
• Editing Search Source Attributes
  Edit the behavior of a search source by editing Search Source attributes in Page Designer.

16.6.8.1 Reviewing Search Page Components

Review the components that comprise a search page by viewing attributes in Page Designer.

A search page features a Search Results region which contains Search Sources that map to search configurations defined in Shared Components.

To review the components of a search page:

1. View the search page in Page Designer:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.
2. Review the Search Results. In the Rendering tab under Body, locate and select the Search Results region.
   
   Description of the illustration search_page_components.png

   Note that the Property Editor contains two tabs: Region and Attributes. Under Region, note that the region Type is Search.

3. In the Rendering tab, select a Search Source (for example, Search Projects).
   
   Description of the illustration search_page_search_source.png
4. In the Property Editor, review the Search Source attributes.

   In the previous example, note that the attributes indicate that the Search Source maps to the Search Configuration, Search Projects.

16.6.8.2 Editing Search Results Region Attributes

Edit Search Results region attributes to change region behavior.

To edit Search Results Region attributes:

1. View the search page in Page Designer:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.
2. View the Search Results Region attributes:
   1. In the Rendering tab (or left pane), select the Search Results region.
   2. In the Property Editor, select the Region tab (if not already selected).
      
      Description of the illustration search_page_components.png
3. Edit the attributes.

   To view help for an attribute, select the attribute in the Property Editor and click the Help tab in the central pane.

4. To save your changes click Save. To save and run the page, click Save and Run Page.

16.6.8.3 Editing Search Results Attributes

Edit Search Results Attributes to control how a search works.

To edit Search Results Attributes:

1. View the search page in Page Designer:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.
2. View the Search Results Attributes:
   1. In the Rendering tab (or left pane), select the Search Results region.
   2. In the Property Editor, select the Attributes tab.
      
      Description of the illustration search_results_attributes.png
3. Edit the Setting attributes.

   To view help for an attribute, select the attribute in the Property Editor and click the Help tab in the central pane.

   • Settings, Search Page Item - Reference the page item for end users to type their searches in (for example, P11_SEARCH).
   • Settings, Search as You Type - When enabled, the search is executed as you type in the search field. Otherwise the search is not executed until the user presses Enter or a button.
   • Settings, Minimum Characters - Specify the minimum number of characters required in a search term before the search executes. This setting can be useful to reduce the amount of searching done when queries are expensive.
   • Settings, Lazy Loading - Specify whether to load the region independently of the data for the region.

     When lazy loading is enabled, the page renders immediately, showing an empty region until the data loads. Generally, the page does not display until the entire page loads and is ready to be rendered. For example, if it takes 5 seconds to load all of the data for a region, without lazy loading, the end user would have to wait 5 seconds before the page started to render.

   • Settings, Use Pagination - Specify whether to use pagination for displaying search results.
   • Settings, Results per Page - Determine the amount of results that display on each page.
   • Settings, Show Result Count - Specify where to display the search results row count. See Help in the central pane for more details.
   • Settings, Custom Layout - Specify whether to use a custom template for search results, instead of the display templates specified within the search configuration.
   • Settings, Custom Layout - Specify whether to use a custom template for search results, instead of the display templates specified within the search configuration.
   • Settings, Last Modified Format Mask - Provide the format mask to use for displaying the Last Modified attribute of a search result. Values are returned as the TIMESTAMP WITH LOCAL TIME ZONE data type.
   • Settings, Overall Sort - Search results are returned in the order they appear on the Search Configurations page. The order within each search configuration is defined on the Shared Components, Edit page. To override the default order, select a column from the list.

     See the Help tab in the central pane for more details.

   • Settings, No Query Entered Message - Enter a message to display when no query is entered and no Search Source has the Use as Initial Result switch enabled.

     See the Help tab in the central pane for examples.

   • Settings, No Results Found Message - Enter a message to display when no results are found. If specified, messages defined in the search configurations are ignored.
4. To save your changes click Save. To save and run the page, click Save and Run Page.

16.6.8.4 Editing Search Source Attributes

Edit the behavior of a search source by editing Search Source attributes in Page Designer.

A search configuration contains information about searchable data source. When you add a search configuration to a search page, it displays under Search Sources in the Rendering tab in Page Designer. You can further refine search behavior by selecting the search source in Page Designer and editing attributes in the Property Editor.

The following task demonstrates how to edit the search source so that the each result is prefaced by an icon.

To edit Search Source attributes:

1. View the search page in Page Designer:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.
2. Edit the first Search Source:
   1. In the Rendering tab (or left pane), select the Search Source (for example, Search Project Tasks).
      The Search Source attributes display in the Property Editor.
   2. Icon and Badge - Select an icon to display with the search result (for example, fa-tasks-alt),
3. Edit the first Search Source:
   1. In the Rendering tab (or left pane), select the Search Source (for example, Search Projects).

      The Search Source attributes display in the Property Editor. To view help for an attribute, select the attribute in the Property Editor and click the Help tab in the central pane.

   2. Icon and Badge - Select an icon to display with the search result (for example, fa-chevron-circle-down).
   
   Description of the illustration search_source_icon_badge.png
4. Run and test the change:
   1. Click Save and Run Page.

      The Search Projects page appears.

   2. In the search field, enter a search (for example, Web environment) and press Enter.
   The search results appear.

   
   Description of the illustration runtime_search_page_new_icons.png

   Note that each search result is prefaced by a new icon.