Define contextual search for record producer

You can define a record producer to trigger a search based on text entered in a variable field. Search results appear at the bottom of the record producer form.

About this task

For example, add contextual search to the Description variable in the Report an Issue record producer to provide potential answers to users who submit the form.
The base system Create New Incident record producer is configured to use contextual search. If you have customized this record producer, you can configure contextual search to link to a specific field on your record producer.
Note: Only one variable within a record producer can use contextual search.

Procedure

  1. Navigate to Contextual Search > Record Producer Configuration.
    You can also open a search context and click New in the Record Producer Configurations related list.
    Contextual search: record producer configuration
  2. Complete the form.
    Table 1. Configuration fields
    Field Description
    Record producer Name of the record producer to add the search to.
    Search context Name of the search context to use.
    Search variable Variable within the selected record producer which uses the contextual search.
    Results header text Label for the search results area that appears on the record producer.
    Result action label Label of the action button that appears when the user opens a search result record. By default this label is set to This Helped.
    Result action value Internal value of the action button that appears when the user opens a search result record. By default this value is set to helped. This value is stored within the Relevant Document [cxs_relevant_doc] table.
    Active Check box for activating this record producer configuration.
    Limit Maximum number of items to display in the results area. By default, this limit is set to 10. To return an unrestricted number, leave this field blank.
    Results per page Number of results that are shown per page in the results area.
    Allow expand/collapse Check box to allow the user to collapse the search results in the form.
  3. Open the form context menu and click Save.
  4. (Optional) Complete the following steps to add a filter configuration.
    Filter configurations are defined to map record producer variables to the resource table to provide a more targeted search result set.
    1. Click New in the Filter Configuration related list.
    2. Select the Resource configuration: pinned, knowledge, or social.
    3. Open the form context menu and select Save.
    4. In the Filter Conditions related list that appears, click New.
      Based on the selected Search resource, the filter condition provides a query table to compare with the record producer, for example, Report an Issue. You select a field from the Query table and a variable from the Record Producer. The search results only include items where the values in the compared fields match.
    5. Select the Field to compare and the Compare to fields for the Query table and the Record producer.
    6. Select what value is compared, the value or the display value.
    7. Select the Include if blank check box to include results if the Compare to field has no value.
    8. Click Submit.
    9. Click Update in the Filter Configuration form.
    You can also select Scripted filter in the Filter Configuration form and add a script instead of using a filter condition record.
  5. Click Update to save and close the Record Producer Configuration record.