Contextual search properties

  • Release version: Zurich
  • Updated July 31, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Contextual search properties

    Contextual search properties in ServiceNow allow you to configure how search behaves within table and record producer contexts, including control over searchable fields, search triggers, result limits, and display options. These properties are managed underContextual Search > Propertiesand help optimize search performance and user experience.

    Show full answer Show less

    Key Features

    • Result Limits: Control the maximum number of search results returned (default is 10) and define thresholds to log warnings when large result sets (default 10,000) may impact performance.
    • Search Trigger Settings: Set the minimum number of characters (default 3) required before a search initiates and specify wait time delays before the search triggers (default 1000 ms).
    • Default Search Field: Automatically create a search field when configuring forms, defaulting to shortdescription.
    • Search Results Widget Behavior: Configure whether the search results widget collapses or expands when creating new or opening existing records, or when the search field updates. Defaults vary by scenario, enhancing UI efficiency and saving space.
    • Metadata Display: Enable or disable showing additional metadata with search results on forms, such as author or knowledge base details for Knowledge articles.
    • Link Handling: Control whether links opened from the contextual search modal window are forced to be relative links for security and consistency (default is true).

    Practical Use and Benefits

    These properties enable ServiceNow customers to fine-tune contextual search to improve relevance, reduce unnecessary load, and maintain a clean user interface. Adjusting minimum character thresholds and wait times can reduce server strain, while widget behavior settings optimize space during form interactions. Metadata and link handling settings enhance information clarity and security.

    Administrators can review and modify these settings in the sysproperties table by filtering on sysproperties.list, allowing tailored search experiences aligned with organizational needs and performance goals.

    Contextual search properties are used to control the fields that you can search from and the number of results displayed per page.

    The contextual search properties are available at Contextual Search > Properties.

    Table 1. Properties for contextual search
    Property label Description
    Default value for maximum number of search results returned for table and record producer configurations

    [com.snc.contextual_search.result.default.limit]

    		 Default value for the maximum number of search results returned when you create a table or record producer configuration. By default, the value is 10.
    Number of characters that a configured field needs before triggering a search

    [com.snc.contextual_search.min_length]

    		 Number of characters that contextual search requires before triggering a search based on the text entered in the search field. By default, the value is set to 3 characters.

    This property also applies to the Agent Assist search.
    Number of milliseconds that a configured field will wait before triggering a search

    [com.snc.contextual_search.wait_time]

    		 Number of milliseconds that contextual search waits before triggering a search based on the text entered in the search field. By default, the value is set to 1,000 milliseconds (one second).
    Records returned above this threshold will log warnings

    [com.snc.contextual_search.result.threshold]

    		 Triggers a warning message within the system log whenever more than this number of results are returned in a search. This logging helps if you’re experiencing performance issues because of large searches. By default, the value is set to 10,000 results.
    When a Form configuration is created a search field with a name matching this property will be automatically created

    [com.snc.contextual_search.widget.form.default_field]

    		 The default field that is used for searching when you create a table configuration. By default, the value is set to short_description.
    Collapse the search results widget when creating a new record in a form

    [com.snc.contextual_search.widget.form.open_collapsed_new_records]

    		 When the value is set to true and you create a record, the search results widget is collapsed to save space. By default, the value is set to false.
    Collapse the search results widget when opening an existing record in a form

    [com.snc.contextual_search.widget.form.open_collapsed_existing_records]

    		 When the value is set to true and you open an existing record, the search results widget is collapsed to save space. By default, the value is set to true.
    Note:
    The property applies only to existing records and not to new records.
    Auto expand the search results widget when search field updates in a form

    [com.snc.contextual_search.widget.form.expand_on_search_field_update]

    		 When the value is set to true and you update the search field in a form, the search results widget automatically expands and runs the search. By default, the value is set to true.
    Show meta data on form contextual search results

    [com.snc.contextual_search.widget.form.show_meta_data]

    		 When the value is set to true, each search result includes additional metadata below each result record. By default, the property is set to true.
    • For Knowledge articles, you configure the metadata fields to display by modifying Knowledge search properties. As an example, you can display the article's author, article number, and knowledge base name. For details on Knowledge search properties, see Knowledge Management properties.
    • Configure the search result display fields for other resources by editing search result display configurations. For details on search result display configuration settings, see Edit search resource display field record.
    Always force a relative link in the cxs_new_window UI Page

    [com.snc.contextual_search.cxs_new_window.force_relative_link]

    		 The property ensures that only relative links open from the contextual search modal window. By default, the property is set to true.

    When the value is set to true, a link opened from the contextual search modal window is forced to be a relative link.

    When the value is set to false, a relative or external link can be opened from the contextual search modal window.

    To review this property in the System Properties [sys_properties] table, enter sys_properties.list in the navigation filter.

    Note:
    The contextual search window is displayed in the core UI.