Manage the Basic Configuration of a Query Pipeline

The Overview tab of a query pipeline configuration allows users with the required privileges to manage the pipeline’s name, note, condition, and access levels.

Rename a Query Pipeline

If you want to rename a query pipeline used in production, you should do so by following the pipeline testing procedure instead. This is because you need to update all references to the old query pipeline name, lest you break your search solution. For example, if you set the pipeline name in search tokens, you’ll need to update it and ensure that everything works as desired.

Once a query pipeline has been created, you can rename it if needed.

  1. On the Query Pipelines page, click the query pipeline whose name you want to change, and then in the Action bar, click Edit Components.

  2. On the page that opens, select the Overview tab.

  3. In the Overview tab, under Pipeline name, make the desired changes.

  4. Click Save.

Manage a Query Pipeline User Note

Once a query pipeline has been created, you can add or edit the pipeline’s associated User Note.

  1. On the Query Pipelines page, click the desired query pipeline, and then in the Action bar, click Edit Components.

  2. On the page that opens, select the Overview tab.

  3. In the Overview tab, in the User note input, you can add or edit the note associated to the query pipeline.

  4. Click Save.

Manage a Query Pipeline Condition

Once a query pipeline has been created, you can add or edit the pipeline’s associated query pipeline condition.

  1. On the Query Pipelines page, click the desired query pipeline, and then in the Action bar, click Edit Components.

  2. On the page that opens, select the Overview tab.

  3. In the Overview tab, under Condition, you can select a query pipeline condition in the drop-down menu or create a new one. The query pipeline will apply to queries meeting this condition.

  4. Click Save.

Manage Query Pipeline Access

Once a query pipeline has been created, you can edit the organization’s groups or API keys level of access to this pipeline.

  1. On the Query Pipelines page, click the query pipeline for which you want to edit group or API key access levels, and then in the Action bar, click Edit Components.

  2. On the page that opens, select the Overview tab.

  3. In the Overview tab, under Access management, click Edit.

  4. In the Access Management panel that opens, determine whether each group and API key can view or edit the query pipeline configuration:

    • In the Access Level column, select View or Edit for each available group.

    • On the left-hand side of the panel, click Groups or API Keys to switch lists.

  5. In the Access Management panel, click Save.

  6. Back in the Overview tab, click Save.

Groups and API keys for which there’s no drop-down menu in the Access Level column are either groups that can edit all query pipelines created in the organization or groups that aren’t allowed to see query pipelines at all (see Resource Access and Query Pipelines Domain).

Required Privileges

By default, members of the Administrators and Relevance Managers built-in groups can view and edit elements of the Query Pipelines page.

The following table indicates the required privileges to view or edit elements of the Query Pipelines page (see Manage Privileges and Privilege Reference).

Action Service - Domain Required access level

View Query pipeline basic configuration

Search - Query pipelines

View

Edit Query pipeline basic configuration

Search - Query pipelines

Edit

Recommended Articles