Manage the basic configuration of a query pipeline

This is for:

Developer System Administrator

When you create a query pipeline in the Coveo Administration Console, you define its basic configuration such as its name, description, conditions, and more. However, you can also manage this information after the pipeline has been created, if you decide to edit it. The Configuration tab of a query pipeline allows members with the required privileges to review and modify some basic information of an existing pipeline.

Access the Configuration tab

To access the Configuration tab of a query pipeline:

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the desired query pipeline, and then click Edit components in the Action bar.

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

In this tab, you can:

"Identification" section

In the Identification section, you can manage the following fields:

"Pipeline name"

The query pipeline name is the one that appears on the Query Pipelines (platform-ca | platform-eu | platform-au) page and can be renamed as needed.

  1. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Identification section, in the Pipeline name input, you can change the name as needed.

  3. Click Save.

Important

When you rename a query pipeline that’s used in production, we recommend duplicating the pipeline and then renaming it to ensure a smooth transition and to prevent any disruptions:

  1. Duplicate the query pipeline that you want to rename.

  2. Rename the duplicated pipeline.

  3. Update all query pipeline references in your configurations, API calls, search interfaces, and scripts to the new pipeline name.

  4. Test the renamed pipeline in the Content Browser (platform-ca | platform-eu | platform-au) to ensure it works correctly.

  5. Once you’ve ensured that the renamed pipeline works as expected, you can delete the original pipeline.

"Description"

The description of a query pipeline can provide additional information about the pipeline’s configuration, and you can add or edit it as needed.

  1. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Identification section, in the Description input, add or edit the description.

  3. Click Save.

"Use case"

Assigning a use case can help you categorize the query pipeline and identify its purpose. This is useful when your Coveo organization has many query pipelines that serve different purposes.

  1. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Identification section, in the Use case dropdown menu, select the desired value. Available values are:

    • Ecommerce

    • Service & Support

    • Workplace

    • Website

  3. Click Save.

EXAMPLE

In your Coveo organization, you have the following query pipelines:

  • Insight-Panel-Pipeline, that serves your support agent portal.

  • Barca-Commerce, that serves your Coveo-powered commerce interface.

  • Barca-Intranet, that serves your intranet’s search interface.

To help Coveo administrators better manage and understand the purpose of each query pipeline, you categorize your query pipelines as follows:

Query pipeline name Use case

Insight-Panel-Pipeline

Service & Support

Barca-Commerce

Ecommerce

Barca-Intranet

Workplace

"Project"

The Project field is a dropdown menu that lets you associate the query pipeline with a project. This is useful when you have a specific business scenario and you want to link the query pipeline to a project as one of its resources.

  1. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Identification section, in the Project dropdown menu, select the desired project or click Create a project to create a new one.

  3. Click Save.

"Condition" section

Once a query pipeline has been created, you can manage the query pipeline’s associated query pipeline conditions as needed.

  1. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Configuration tab, under Condition, you can select a condition in the dropdown menu or create a new one. The query pipeline will apply to queries meeting this condition.

  3. Click Save.

"Interface URL" section

The Interface URL section lets you enter the URL of the search interfaces that use the query pipeline. This is useful to quickly view and access the web pages for which search traffic is routed to the query pipeline.

  1. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Interface URL section, enter the URLs of the search interfaces using the query pipeline.

  3. 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. Access the Configuration tab of the query pipeline you want to manage.

  2. In the Configuration tab, in the upper-right corner, click dots and then click Manage access.

  3. 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 side of the panel, click Groups or API Keys to switch lists.

  4. In the Access Management panel, click Save.

  5. Back in the Configuration tab, click Save.

Required privileges

The following table indicates the privileges required to view or edit the query pipelines page. Learn more about the Privilege reference or how to manage privileges.

Action Service - Domain Required access level

View query pipeline basic configuration

Organization - Organization
Search - Query pipelines

View

Edit query pipeline basic configuration

Organization - Organization

View

Search - Query pipelines

Edit