Administrators can control how global text search behaves with system properties.

Before you begin

Role required: admin

Procedure

  1. Navigate to All > System Properties > Global Text Search.
  2. Review the values for the following global text search properties and change them as needed.
    Table 1. UI properties for global text search
    Property Description
    Enable Global Text Search (glide.ui.text_search.enable) Option to enable global search in Core UI and UI15.
    • Type: Boolean
    • Default value: true
    • Supported values:
      • true: Global search is enabled in Core UI.
      • false: Global search is disabled in Core UI.
    Note: When Next Experience is enabled, this system property has no effect. To enable or disable the Unified Navigation search field in Next Experience, set the glide.ui.polaris.global_search system property described in Next Experience system properties.
    List of roles (comma-separated) that can use the Global Text Search capability (glide.ui.can_search) Comma-separated list of user roles that allow access to global search. To enable global search for users with a role, add the role to this list.
    • Type: String
    • Default value: itil, text_search_admin, admin
    List of tables (comma-separated) that won't appear as options when setting up Global Text Search tables (glide.ui.no_text_search) Comma-separated list of tables that don't appear as options when defining text search groups for Core UI. Examples are system or maintenance tables.
    • Type: String
    • Default value: sys_audit, sys_event, ecc_queue, ecc_event, syslog, syslog_transaction, sys_journal_field, sys_audit_relation, ecc_agent_log, ecc_mi_result, sysrule_escalate_history, sys_user_token, sys_time_dimension, sys_attachment_doc, sys_audit_delete
    Number of Global Text Search matches returned per table (glide.ui.text_search.rowcount) Maximum number of matching records previewed for each table on the global text search results page. Users can select a table to see all matching results for that table.
    • Type: Integer
    • Default value: 10
    Note: This system property only controls the global text search preview limit in Core UI. In Next Experience UI, you can set the global search preview limit by editing the Now Experience Search Configuration record in the Workspace Global Search Configurations [sys_aw_global_search_config] table.
    Global Text Search background color for Knowledge Base results (css.textsearch.kb.background.color) Background color for Knowledge article global text search results. This property only affects display of results on the legacy global search results page.
    • Type: String
    • Default value: #f0f7f9
    Global Text Search background color for Catalog results (css.textsearch.catalog.background.color) Background color for Catalog global text search results. This property only affects display of results on the legacy global search results page.
    • Type: String
    • Default value: #ffffdd
    Form view to use for Global Text Search exact match - blank means Default view (glide.ui.text_search.match_view) Name of the form view that global text search uses to display exact match results. If no value is specified, global text search uses the default form view.
    For information on creating and managing views, see View management.
    • Type: String
    • Default value: (empty)
    List and form view to use for Global Text Search results. Blank means default view (glide.ui.text_search.view) Name of the list view that global text search uses to format results for each searched table. If no value is specified, global text search uses the default list view.
    For information on creating and managing views, see View management.
    • Type: String
    • Default value: text_search
    Query method for global text search. Run a query for each table, for each base class (parent table), against a single index regardless of table (requires text index regeneration), or let GlideRecord handle the query (simple). With the Zing text search engine, the preferred value is "simple" (glide.ir.query_method) Query method to use for global text search.
    Note: The base, single, and table values aren't supported. Leave this system property set to its default simple value.
    • Type: Choice list
    • Default value: simple
    • Available values:
      • base: Run a search query for each base class. This value is no longer supported.
      • simple: Let GlideRecord handle the search query.
      • single: Run a search query against a single text search index. To use this method, you must regenerate text search indexes. This value is no longer supported.
      • table: Run a search query for each searchable table. This value is no longer supported.
    The maximum number of results that will be returned during a text index search. This limits the number of records that will be extracted from the text index and displayed (glide.lucene.base_result_max) Maximum number of results that global text search will return when searching a text search index.
    Note: When the query method is set to simple, this property is ignored.
    • Type: Integer
    • Default value: 100
    The maximum number of entries that will be retrieved from the text index. Only the table that is involved will be returned from the text index for all entries that are between the value specified for maximum results and this value. This is done so that it can be indicated that more results exists for any given table that are going to be displayed (glide.lucene.base_hits_max) Maximum number of entries that global text search will retrieve from a text search index.
    Note: When the query method is set to simple, this property is ignored.
    • Type: Integer
    • Default value: 500
    Number of simultaneous processes (1 to 16) used when searching though multiple groups in a global search (glide.ts.global_search.parallelism) Number of concurrent threads global text search uses when searching multiple search groups. Each search group requires one thread.
    Set this value to yield optimal results for your search group configuration. For example, if you have five search groups and four threads, the first four groups run in parallel and the fifth group starts when one of the first four groups finishes. This setup may work well if one of the groups is much larger than another. Similarly, if you have five search groups, setting this value higher than five yields no benefits.
    • Type: Integer
    • Default value: 4
  3. Select Save.
    The business rule Text Search Property Change Rationally validates the new values and aborts the update if they are outside its acceptable ranges.
  4. To set the maximum number of matches to display for a wildcard search term, follow these steps.
    1. Open the System Properties table and search for the property glide.ts.max_wildcard_expansion.
      Field Description
      Name glide.ts.max_wildcard_expansion
      Description Maximum number of matches for a wildcard search term that are allowed as unambiguous.
      Type Integer
      Default value 500
    2. Edit the Value.
      If a wildcard search matches more words than this value, the system displays a message asking the user to refine the search.
    3. Select Update.
  5. To set the Zing text search stemming language, follow these steps.
    1. Install the internationalization (i18n) plugin for the language you want to stem text search terms in.
    2. Add a new system property, glide.ts.stemming_language:
      Field Description
      Name glide.ts.stemming_language
      Description Language to use for text search stemming. For details on stemming, see Zing matches derived words with stemming.
      Type String
      Values supported
      • English
      • French
      • German
      Default value English
    3. To make tables use the new stemming language for text search, manually regenerate their text search indexes.
      For details on this procedure, see Regenerate a text index for a table.
  6. (Optional) To enable and configure fallback number search for exact matches, follow these steps.
    Note: Fallback number search is disabled by default. When it's enabled, if a global text search finds no exact match for a record number, the system searches a list of specified tables for matches. This additional search can make global text searches take longer, so enable fallback number search only if you need it.
    1. To enable fallback number search, add a new system property, glide.ui.text_search.enable_fallback_number_search:
      Field Description
      Name glide.ui.text_search.enable_fallback_number_search
      Description Option to enable fallback number search for use when global text search finds no exact matches for a record number.
      Note: Fallback number search can make global text searches take longer. Enable the option only if you need it.
      Type Boolean
      Default value false
    2. To configure the list of tables searched by fallback number search, add a new system property, glide.ui.text_search.fallback_table_list:
      Field Description
      Name glide.ui.text_search.fallback_table_list
      Description Comma-separated list of names of tables to search when performing fallback number search.
      Use the special value all to search all tables that have prefixes defined in the Number [sys_number] table.
      Note: Increasing the number of tables to search may increase the time required for fallback number search. Test any changes to this system property before putting them into production.
      Type String
      Default value task,kb_knowledge