16.9.8 Editing a Search Configuration

Edit an existing search configuration in Shared Components on the Search Configurations, Edit page.

To access the Search Configurations, Edit page:

  1. Access the Search Configurations page:
    1. On the Workspace home page, click the App Builder icon.
    2. Select an application.
    3. On the Application home page, click Shared Components.
    4. Under Navigation and Search, click Search Configurations.
      The Search Configurations page appears.
  2. Select the appropriate search configuration label.

    The Edit page appears.

  3. On the Edit page, configure the attributes.
    To learn more about an attribute or view examples, see field-level Help.
  4. Settings:
    1. Search Type - Displays the search type (Standard, Oracle TEXT, Oracle Ubiquitous Search, or List).
    2. Label - Enter the label to be displayed in Search results. When using a search configuration within a search region, the label can be overridden in Page Designer.
    3. Search Query Prefix - Enter a prefix to be used by end users in search queries. A search term which is prefixed will only be used for search configurations with the same prefix. If a prefix is used in a search query, but not defined in any search configuration, the prefix is ignored and the whole term is used for searching
    4. Static ID - Use the Static ID to reference the search configuration definition in API calls (for example, when using the APEX_SEARCH.SEARCH function).
  5. Subscription - Select a master search configuration from which to subscribe. See Subscribing to a Search Configuration
  6. Source:
    1. Source Type - Specifies the source of the search configuration. Search configuration can be based on a Table, SQL Query, or Function Body returning a SQL Query.

      The UI changes depending upon the Source Type you select. This topic assumes Source Type is set to SQL Query. To learn more about an attribute, see field-level Help.

    2. Order By Clause - Enter a valid SQL ORDER BY expression, used to sort the records retrieved.
    3. Index Column Name - Select the column which is indexed with an Oracle Text index. Note that an Oracle Text index is always created in one specific column, but can actually index multiple columns or even multiple tables. See "Multicolumn Datastore" or "User Datastore" within the Oracle Text documentation for more details.
    4. Text Query Function - Select the Text Query Function type to use.

      The Oracle Text query syntax is very complex and powerful and provides a rich set of query operators to deal with wildcards, stemming, fuzzy searches, and so forth. For end users, this syntax is often hard to understand. You can select a function to convert simple end user input to an Oracle Text query with the advanced search features automatically applied.Text Query Function options include:

      • None - Oracle APEX encloses each query term with "{" and "}", except the keywords and and or.
      • Search Engine - This function performs a query relaxation search to retrieve relevant results beyond just exact matches. The goal is to get as many related results as possible, allowing users to easily find related information without needing to input precise queries. The search process begins with an exact match search and then progressively relaxes the query using techniques like stemming and fuzzy matching. While maximizing the number of results, the search engine function ensures that the most exact and relevant matches are always ranked at the top of the search results.

      • Expert Search - This function supports more advanced search operators for precise queries. It allows exact matching, Boolean operators (AND, OR, NOT), precedence with parentheses and proximity search. Additional parameters allow customizing search behavior. This is best when requiring highly accurate results from very specific queries.

        See APEX_SEARCH, QUERY_EXPERT_SEARCH in Oracle APEX API Reference

      • Custom - Provide a custom function in the Custom Function Name attribute.

  7. Column Mapping - Select the appropriate columns To learn more or view an example, see field-level Help.
  8. Icon and Display - Configure icon and icon display options. The UI changes depending upon the Icon Source you select. To learn more, see field-level Help.
  9. Link - Select the type of link. The UI changes depending upon the Link Type you select. To learn more, see field-level Help.

    Tip:

    To see an example of linking to another page, see Editing Search Configurations to Include Links.
  10. Server-Side Condition - Select a condition type from the list that must be met in order for this component to be rendered processed. The UI changes depending upon the Condition Type you select.
  11. Advanced:
    • Authorization Scheme - Optionally select an authorization scheme which must evaluate to TRUE in order for this component to be rendered or otherwise processed.
    • Build Option - Select a build option for this component. Build options are predefined settings that determine whether or not components within an application are enabled.
    • Comments - Enter developer comments or notes.
  12. Click Apply Changes to save your changes.