Manage groups and campaigns

This is for:

Developer System Administrator

The Groups & Campaigns tab of a query pipeline configuration allows members with the required privileges to create sets of query pipeline result ranking rules that apply for specific contexts, audiences, or periods of time.

This query pipeline feature lets you create sets of result ranking rules within the same pipeline, allowing you to create less query pipelines for managing different search and browsing contexts.

Using the Groups and Campaigns tab of a query pipeline configuration, you can either create time-based groups of query pipeline rules, or permanent groups, which last as long as they’re on an active state.

Example

In the query pipeline towards which your Coveo-powered commerce portal traffic is directed, you configure a time-based group of rules to enforce your ACME monitors promotion.

During this one-week promotion, you offer discounts on ACME monitors.

Therefore, you create a groups and campaigns configuration in your pipeline that contains result ranking rules to promote ACME-branded monitors.

This configuration applies only for the duration of the promotion.

Common use cases

Management of large numbers of rules

When your implementation contains several result ranking rules, you should consider creating groups that contain subsets of these result ranking rules.

Example

In your Coveo-powered pet supplies commerce portal, all customer queries are directed to the commerce query pipeline. This query pipeline contains featured result and ranking expression rules that are triggered when the query dog food is performed.

These rules promote different items depending on the user’s country. For example, when the user is Canadian, you promote dog food products available in Canada and when the user is American, you promote dog food products available in the United States.

Since you’re selling different dog food products depending on the user’s country, you create two different groups of query pipeline rules. The rules contained in each group will apply conditionally to the user’s country.

Planning and preparing for time-sensitive rule enforcement

When a query pipeline contains result ranking rules aimed at promoting certain items for a determined period of time, you should consider creating time-based groups.

Example

In your Coveo-powered commerce portal, you want to promote all items made by the ACME brand for 24 hours for the upcoming Black Friday event.

To make sure that this promotion only lasts for the Black Friday event, you create a time-based group that contains all result ranking rules that aim at promoting ACME products. You then set the start and end date as desired.

Add a group

user interface of the Groups and Campaigns feature

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline in which you want to add a group, and then click Edit components in the Action bar.

  2. On the page that opens, select the Groups & Campaigns tab, and then, in the upper-right corner, click Add a group of rules.

  3. On the Add a group of rules subpage that appears, in the Name input, enter a name for the group or campaign you’re creating.

  4. Under Condition, you can optionally select a query pipeline condition in the dropdown menu or create a new one.

    Tip
    Leading practice

    If many of your result ranking rules share a common condition (e.g., context[userRole] is administrator), we recommend that you gather these rules into a single group and use the common condition as the group condition. Doing so allows you to simplify the conditions of the result ranking rules in your group, improving understandability.

  5. In the Activation section, select Activate your group for a specific period of time or Activate group manually depending on whether you want your group of rules to be time-based or permanent.

  6. Depending on your selection in the previous step, fill the available options (see Specific Period of Time Options and Manual Group Option).

  7. Under Description, optionally enter information that will help you manage the group in the future.

  8. Click Add Group.

Edit a group

user interface for editing Groups and Campaigns

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline in which you want to edit a group, and then click Edit components in the Action bar.

  2. On the page that opens, select the Groups & Campaigns tab.

  3. In the Groups & Campaigns tab, click the group you want to edit, and then click Edit in the Action bar.

  4. On the Add a group of rules subpage that appears, in the Name input, enter a name for the group or campaign you’re creating.

  5. Under Condition, you can optionally select a query pipeline condition in the dropdown menu or create a new one.

    Tip
    Leading practice

    If many of your result ranking rules share a common condition (e.g., context[userRole] is administrator), we recommend that you gather these rules into a single group and use the common condition as the group condition. Doing so allows you to simplify the conditions of the result ranking rules in your group, improving understandability.

  6. In the Activation section, select Activate your group for a specific period of time or Activate group manually depending on whether you want your group of rules to be time-based or permanent.

  7. Depending on your selection in the previous step, fill the available options (see Specific Period of Time Options and Manual Group Option).

  8. Under Description, optionally enter information that will help you manage the group in the future.

  9. Click Save Group.

Add query pipeline rules to a group

When a group is created, you can add existing result ranking query pipeline rules to your group.

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline that contains the result ranking rules you want to associate with a group, and then click Edit components.

    Note

    The result ranking rules must be in the same query pipeline as the group you want to associate the rule with.

  2. On the page that opens, select the Result Ranking tab.

  3. In the Result Ranking tab, select each checkbox next to the rules that you want to associate with a group, and then click Associate to a group in the Action bar.

  4. In the Associate Rules to a Group panel that opens, in the dropdown menu, select the group with which you want to associate the rules.

  5. Click Save.

user interface for associating rules to a group

Alternatively, you can add a query pipeline rule to a group when creating or editing a result ranking rule.

Edit a query pipeline rule association

When one or more result ranking rules are associated with a group, you can edit their current associations (typically to associate the rules with another group).

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline that contains the result ranking rules for which you want to edit the group associations, and then click Edit components.

  2. On the page that opens, select the Result Ranking tab.

  3. In the Result Ranking tab, select each checkbox next to the rules for which you want to edit the rule association, and then click Associate to a group in the Action bar.

  4. In the Associate Rules to a Group panel that opens, in the dropdown menu, select the group with which you want to associate the rules.

  5. Click Save.

user interface for editing groups associations

Alternatively, you can edit a query pipeline rule association with a group when editing a result ranking rule.

Review information about the group’s creation or last modification

You can verify who created or last modified a given group by inspecting the Details column of the Groups and Campaigns tab. The Details column also indicates the hour and date the group was created or last modified.

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline containing the group for which you want to inspect the information of the Details column, and then click Edit components in the Action bar.

  2. On the page that opens, select the Groups and Campaigns tab.

  3. In the Groups and Campaigns tab, inspect the information of the Details column for the desired group.

Delete a query pipeline rule association

When one or more result ranking rules are associated with a group, you can delete their current associations.

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline that contains the result ranking rules for which you want to delete the group associations, and then click Edit components.

  2. On the page that opens, select the Result Ranking tab.

  3. In the Result Ranking tab, select each checkbox next to the rules for which you want to delete the rule associations, and then click Associate to a group in the Action bar.

  4. In the Associate Rules to a Group panel that opens, click Remove current associations.

  5. Click Remove associations.

user interface for deleting rule associations

Delete a group

Important

Deleting a group also deletes the rules associated with this group. If you don’t want the rules associated with the group to also be deleted, make sure that you dissociate them from the group before deleting the group.

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline for which you want to delete a group, and then click Edit components in the Action bar.

  2. On the page that opens, select the Groups & Campaigns tab.

  3. In the Groups & Campaigns tab, click the rule that you want to delete.

  4. In the Groups & Campaigns tab, click the group that you want to delete.

  5. Click Delete to confirm.

Reference

Specific period of time options

If you selected the Activate your group for a specific period of time radio button when creating your group, you must either select a start date, an end date, or a time frame for which the group of rules will be active.

  1. Select the time period for which the group will be active.

  2. Click Apply.

Note

All time zones default to UTC.

Manual group option

If you selected the Activate group’s rules radio button when creating your group, click Activate group’s rules to activate the group. You can deactivate the group at any time.

Required privileges

By default, members with the required privileges can view and edit elements of the Query Pipelines (platform-ca | platform-eu | platform-au) page.

The following table indicates the required privileges to view or edit groups & campaigns (see Manage privileges and Privilege reference).

Action Service - Domain Required access level

View groups & campaigns

Organization - Organization
Search - Query pipelines

View

Edit groups & campaigns

Organization - Organization

View

Search - Query pipelines

Edit