Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.

Installed with contextual search

Log in to subscribe to topics and get notified when content changes.

Installed with contextual search

Activating the Contextual Search plugin installs the following components:

Business rules installed with contextual search

Contextual search adds the following business rules.

Table 1. Business rules installed with contextual search
Name Table Description
Add variable to record producer Record Producer Configuration

[cxs_rp_config]

Contains script that adds contextual search to the selected variable on a record producer.
Add variable to wizard Wizard Configuration

[cxs_wizard_config]

Contains script that adds contextual search to the selected variable on a wizard.
Cascading delete for removed config Table Configuration

[cxs_table_config]

Deletes search fields when the related table configuration is deleted.
Check for duplicate Table Configuration

[cxs_table_config]

Avoids duplicate table configurations.
Check for duplicate Email Configuration

[cxs_table_email_config]

Avoids duplicate table email configurations.
Check for duplicate Wizard Configuration

[cxs_wizard_config]

Avoids duplicate wizard configurations.
Check for duplicate Record Producer Configuration

[cxs_rp_config]

Avoids duplicate record producer configurations.
Check for invalid action values Base UI Configuration

[cxs_ui_config_base]

Checks for invalid action values against the related search configuration.
Create default search field Table Configuration

[cxs_table_config]

Creates a default search field when an insert or update is performed on a table configuration.
Create m2m_kb_task record on attach Relevant Document Detail

[cxs_rel_doc_detail]

Creates a knowledge base task record.
Delete m2m_kb_task record on remove Relevant Document Detail

[cxs_rel_doc_detail]

Deletes a knowledge base task record.
Display default context config message Client Configuration

[cxs_client_config]

Confirms the default search context configuration.
Display default field message Search Field

[cxs_table_field_config]

Confirms the default table field.
If searcher changes check interleaved Search Context

[cxs_context_config]

Check weather a search context needs to interleaved
Maintain context resource properties Search Context

[cxs_context_config]

Is used to update context properties
Make default Search Context

[cxs_context_config]

Sets the client configuration as the default.
Make default config Search Field

[cxs_table_field_config]

Sets the table field as the default.
Populate "Order" field Search Field

[cxs_table_field_config]

Sets the order for new search field configurations. Order will be set to the highest order in the list.
Remove related search field records Table Configuration

[cxs_table_config]

Removes related search fields when changes are made to a record producer
Remove related search field records Record Producer Configuration

[cxs_rp_config]

Removes related search fields when changes are made to a table.
Set "Name" field Record Producer Configuration

[cxs_rp_config]

Sets the name of a record automatically for record producers.
Set "Name" field Table Configuration

[cxs_table_config]

Sets the name of a record automatically for forms.
Set "Name" field Email Configuration

[cxs_table_email_config]

Sets the name of a record automatically.
Set "Name" field Search Field

[cxs_table_field_config]

Sets the name of a record automatically.
Update related context config records Search Resource

[cxs_search_res_config]

Used to update related search context configuration records
Validate active context Base UI Configuration

[cxs_ui_config_base]

Used to confirm that the search context is valid
Validate limit Email Configuration

[cxs_table_email_config]

Ensures the limit is not negative or zero for email configurations.
Validate limit Record Producer Configuration

[cxs_rp_config]

Ensures the limit is not negative or zero for record producer configurations.
Validate limit Table Configuration

[cxs_table_config]

Ensures the limit is not negative or zero for form configurations.
Validate results per page Table Configuration

[cxs_table_config]

Ensures the limit is not negative, zero or greater than limit for forms.
Validate results per page Record Producer Configuration

[cxs_rp_config]

Ensures the limit is not negative, zero or greater than limit for record producers.

Client scripts installed with contextual search

Contextual search adds the following client scripts.

Table 2. Client scripts installed with contextual search
Name Table
Set default limit and results per page Record Producer Configuration

[cxs_rp_config]

Clear field when Record Producer changes Record Producer Configuration

[cxs_rp_config]

Set default limit and results per page Table Configuration

[cxs_table_config]

Warn about search fields being removed Table Configuration

[cxs_table_config]

Set default limit Email Configuration

[cxs_table_email_config]

Set default limit and results per page Wizard Configuration

[cxs_wizard_config]

Clear field when Wizard changes Wizard Configuration

[cxs_wizard_config]

Email notifications installed with contextual search

Contextual search modifies the following email notifications.

Table 3. Email notifications installed with contextual search
Name Table Description
Incident opened for me Incident

[Incident]

Shows the search result records that contextual search finds for that incident record.
Note: A note indicates neutral or positive information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases. Examples are memory limitations, equipment configurations, or details that apply to specific versions of a program.

Script includes installed with contextual search

Table 4. Script includes installed with contextual search
Name Description Extends
cxs_App Configures business rules, action scripts, and security script against tables using contextual search. N/A
cxs_ContextConfig Configures Table Configuration [cxs_table_config] attributes. N/A
cxs_FormatResults Determines and runs the macro to be used for displaying search results. N/A
cxs_Knowledge Attaches knowledge articles to records such as incidents, change requests, and problems. AbstractAjaxProcessor
cxs_RPAjax Gets and retrieves record producer configurations. AbstractAjaxProcessor
cxs_RPConfig Configures the Record Producer Configuration [cxs_rp_config] table and manipulates contextual search on record producers. N/A
cxs_RPVarTypes Returns the types of variable that can be used when defining a contextual search for a record producer. N/A
cxs_SearchContextAJAX Configures records in the Search Resource Context Configuration [cxs_res_context_config] table. AbstractAjaxProcessor
cxs_SearchResourceConfig Contains method that will update Context Configuration for [cxs_search_res_config]. N/A
cxs_SearchResultsAJAX Returns results from a search formatted using the specified macro. AbstractAjaxProcessor
cxs_SearchServerAJAX Checks that the search context is configured. AbstractAjaxProcessor
cxs_TableActions Gets email search request records. N/A
cxs_TableAjax Gets table configuration from the Table Configuration [cxs_table_config] table. AbstractAjaxProcessor
cxs_TableConfig Creates and configures fields that have contextual search attached from the cxs_table_field_config table. N/A
cxs_TableEmailConfig Configures and checks duplicates in the Email Configuration [cxs_table_email_config] table. N/A
cxs_TableEmailConfigAJAX Configures the Email Configuration [cxs_table_email_config] table. AbstractAjaxProcessor
cxs_TableFieldConfig Configures records in the Search Field [cxs_table_field_config] table. N/A
cxs_TableFieldTypes Used to validate field types. Search Field [cxs_table_field_config] table.
cxs_WizardAJAX Gets and retrieves wizard configuration. AbstractAjaxProcessor
cxs_WizardConfig Creates and configures fields that have contextual search attached. N/A

Tables installed with contextual search

Contextual search adds or modifies the following tables.

Table 5. Tables installed with contextual search
Display Name [Table Name] Description
Available Search Resource

[v_cxs_search_resource]

A virtual table that contains a list of available search resources used in configuration of searches.
Email Configuration

[cxs_table_email_config]

Contains a list of email notifications configured to have contextual search results attached.
Record Producer Configuration

[cxs_rp_config]

Contains a list of record producers configured to have contextual search.
Relevant Document

[cxs_relevant_doc]

Contains incident record references where users have indicated that a search result record was useful by clicking the This helped button. Significant fields include:
  • Displayed on: Whether the contextual search results were shown on a table form or a record producer.
  • Session id: The id of the search session that the action button was triggered for.
  • Helped with: The record that the search result helped resolve.
Relevant Document Detail

[cxs_rel_doc_detail]

Contains all the search result records which users have indicated were useful or have attached to a form, as well as the search terms used in the search query. Significant fields include:
  • Relevance: The internal value of the action button (This helped or Attach).
  • Help document: The search result that was marked as helped or attached.
  • Help document URL: The URL to the article that was marked as helped or attached.
  • Search request: The JSON object that was used by the search engine to perform the search.
  • Search term: The search term that was used to initiate the search.
Search Context

[cxs_context_config]

Contains available search contexts for contextual search.
Search Field

[cxs_table_field_config]

Contains all form fields which have contextual search configured to it.
Search Resource

[cxs_search_res_config]

Contains search resource configurations for the related searcher.
Search Resource Context Configuration

[cxs_res_context_config]

Contains conditions for this search context that will restrict the results returned to a user.
Search Resource Context Property

[cxs_res_context_config_prop]

Contains the property values for search resource context configuration.
Search Resource Property

[cxs_search_res_config_prop]

Contains the property values for search resource searcher configuration.
Searcher Configuration

[cxs_searcher_config]

Contains the details of available search configurations.
Table Configuration

[cxs_table_config]

Lists the tables configured for table configurations.
Wizard Configuration

[cxs_wizard_config]

Lists the tables configured for wizard configurations.
Base UI Configuration

[cxs_ui_config_base]

Contains the common elements for the record producer, table, and wizard configurations.

UI macros installed with contextual search

Contextual search adds the following UI macros.

Table 6. UI macros installed with contextual search
Name Description
cxs_result Represents a single search result when processed by cxs_results.
cxs_results Processes the results returned by a contextual search.
cxs_results_header_email Adds the header when sending contextual search results by email.
cxs_results_header_rp Displays the header that is shown above the search results on record producers.
cxs_results_header_table Displays the header that is shown above the search results on forms.
cxs_results_header_wizard Displays the header that is shown above the search results wizards.
cxs_results_table Processes the results returned by a contextual search.
cxs_results_vcr Provides the pagination controls.
cxs_result_default Represents a single search result where there is no specific macro for the source table.
cxs_result_email Represents a single search result when the search results are being sent by email.
cxs_result_kb_knowledge Represents a single search result returned from the kb_knowledge table
cxs_result_sc_cat_item Represents a single search result returned from the sc_cat_item table.
cxs_result_table Represents a single search result for displaying on a form.
cxs_rp_search Initiates a contextual search from a record producer.
cxs_table_search Initiates a contextual search from a form.
cxs_wizard_search Initiates a contextual search from a record producer.

UI policies installed with contextual search

Contextual search adds the following UI policies.

Table 7. UI Policies installed with contextual search
UI Policy Table Description
Hide Table field Email Configuration

[cxs_table_email_config]

Changes email configuration visibility to false and read only.
Hide table config field Search Field

[cxs_table_field_config]

Hides the table field on the form.
Feedback