Resetting a Search

Learn about resetting a search.

By default, the info area-specific searches (i.e. searches for which a Search&List configuration and/or Search action exists) can be reset by clicking on (Settings) > Clear/Reset search settings:

Note: In addition to these options you can also provide Clear Search and Reset Searchh buttons beside the Start Search button by enabling the Search.ShowClearSearchButton and Search.ShowResetSearchButton web configuration parameters. These are global options and will be applied across all info areas providing search capabilities. For more information, see Search.ShowClearSearchButton and Search.ShowResetSearchButton.

Generic searches are searches without info area context. Example - Queries, Analyses, etc. They only offer the Clear search settings option since you can not specify predefined search settings like defaultFilterName etc. Therefore there is nothing to reset a generic search to.

The reset/clear options work as follows:

  • Clear search settings (A_ClearSearch): Selecting this option clears all search criteria (default and user-defined search values and filters) from the search mask.

    Additional search fields are not removed but the search values are cleared.

  • Reset search settings (A_ResetSearch): Selecting this option restores the settings as defined in the Search action (search fields, defaultFilterName, defaultFieldValues).

    Additional search fields and filters are removed, search values are cleared or reset to defaultFieldValues if applicable.

In both cases fixed search criteria (fixedFilterName and fixedFieldValues) are retained.

The availability of the reset/clear options is controlled via Web Configuration parameters:

Enabling the Search.ShowSettingsButton Web Configuration parameter adds a SearchSettings button to all info area-specific search pages and a SearchSettingsGeneric button to all other search pages. For further details, see Search.ShowSettingsButton.

Note: The SearchSettings and SearchSettingsGeneric buttons are hard-coded; you can not remove such a button from a specific search since it is not visible in the header definition.
Note: If a search page's header already contains a Settings button (i.e. a button with a name ending with _Settings), SearchSettings / SearchSettingsGeneric will not be used.

The SearchSettings and SearchSettingsGeneric buttons call the menus M_SearchSettings and M_SearchSettingsGeneric respectively.

M_SearchSettings contains the menu actions A_ClearSearch and A_ResetSearch, M_SearchSettingsGeneric only contains A_ResetSearch.

Enabling/disabling the options of the Search.ClearSearch Web Configuration parameter determines the availability of A_ClearSearch and A_ResetSearch. For further details, see Search.ClearSearch.