Create and manage in-product experiences

This is for:

System Administrator Developer

Coveo In-Product Experience (IPX) is a lightweight and feature-rich Coveo search interface that you can quickly add to any of your websites and software-as-a-service (SaaS) applications.

The compact search interface is customizable and provides users with access to relevant content directly from your web pages.

IPX Demo

An IPX search interface automatically records Coveo Usage Analytics (Coveo UA) events. This lets you enhance the relevance of search results in your IPX search interfaces using Coveo Machine Learning (Coveo ML). Usage analytics events also let you generate reports to gain insight on how users are interacting with your IPX interfaces.

Typically, website users access the IPX search interface via a button on the web page. But you can configure your IPX interface so that it appears in a custom element on your website. Both the IPX button and IPX search interface are customizable.

Deploy an IPX interface (Overview)

To successfully deploy an IPX interface, you must meet the following minimum requirements and configuration.

Requirements

A Coveo organization with at least one source (preferably a source with content that’s accessible to everyone).

Important

You can configure your IPX search interface to either use the same generic search token to authenticate all users, or a distinct search token for each authenticated user in your IPX search interface.

A generic search token is meant to grant access to publicly available content only. This means that IPX users will only have access to indexed content that’s accessible to everyone, while indexed content that’s secured via a repository’s permissions system won’t appear in search results in IPX.

However, you can use a distinct search token for each user if some or all of your indexed content is secured via a repository’s permissions system. This means that each authenticated user sees only the secured content that they’re allowed to access.

For more information, see Configure search token authentication.

IPX configuration

  1. Create your IPX interface.

  2. Configure query pipelines and machine learning models for your IPX interface.

  3. Add your IPX interface to your website.

Create an IPX interface

You can create a next-gen IPX search interface using one of the following methods:

Note

The next-gen IPX search interface is Coveo’s latest IPX solution, and it leverages Coveo’s Headless and Atomic libraries.

The previous version of the IPX search interface, which was based on the Coveo JavaScript Search Framework, is now referred to as the legacy IPX interface. Coveo supports existing legacy IPX interfaces, but you can no longer create new IPX search interfaces using the legacy configuration. However, you can still edit an existing legacy IPX interface. Legacy IPX interface configurations appear with a Legacy Editor badge on the In-Product Experiences (platform-ca | platform-eu | platform-au) page.

Legacy Editor badge

Create an IPX interface from scratch

Create and customize a new IPX search interface using the IPX builder. You can decide whether or not to automatically create the query pipelines and Coveo ML models for your IPX configuration.

  1. On the In-Product Experiences (platform-ca | platform-eu | platform-au) page, click Add in-product experience.

  2. Enter a descriptive Name for your IPX configuration.

    Important

    The name that you choose for your IPX configuration will also be used as the search hub value for your IPX interface. The search hub value is the identifier for your IPX interface that’s used for query pipeline routing, usage analytics reporting, and enabling Coveo Machine Learning features. The IPX name and search hub value can’t be modified once the IPX configuration is created.

  3. The Include basic query pipelines and ML models option is selected by default. Coveo recommends that you use two query pipelines for your IPX search interface (see Recommended pipeline configuration). This option automatically creates the two query pipelines, and the minimum recommended Coveo ML models for each pipeline, which you would otherwise have to create and configure manually.

    Specifically, when this option is selected, the following query pipelines and Coveo ML models are automatically created for your IPX configuration.

    • A search query pipeline with associated Automatic Relevance Tuning (ART) and Query Suggestion (QS) models. This query pipeline is used to process user queries from your IPX search interface to enhance the relevance of search results.

    • A recommendation query pipeline with an associated Content Recommendation (CR) model. This query pipeline is used solely for the CR model to provide relevant suggestions in the recommendation interface of your IPX search interface.

    Note

    The query pipelines and ML models are created using default settings, but you can modify the configurations as required. See Automatic query pipeline configuration for details on the automatically created query pipelines and Coveo ML models.

  4. Click Add. The IPX builder opens.

    Note

    You may be required to log in to the builder using the credentials you used to log in to the Coveo Administration Console.

  5. Customize your IPX interface.

Tip

If you have the Enterprise edition, group this IPX interface and your other implementation resources together in a project. See Manage projects.

Duplicate an IPX configuration

Create a new IPX search interface by duplicating an existing IPX configuration. This is useful when you want to quickly create a new IPX configuration that’s similar to an existing one.

Duplicating an IPX configuration creates a new IPX search interface configuration with the same settings as the original IPX configuration, except for the search hub value and loader script, which are unique to every IPX configuration.

Note

The new IPX configuration doesn’t inherit the version history of the original IPX configuration.

If the IPX configuration that you want to duplicate includes automatically created query pipelines and Coveo ML models, the query pipelines and models are also duplicated with the same settings. For more information, see What gets created when duplicating an IPX.

To duplicate an IPX configuration

  1. On the In-Product Experiences (platform-ca | platform-eu | platform-au) page, click the IPX configuration that you want to duplicate.

  2. In the Action bar, click Duplicate.

  3. Enter a descriptive Name for your IPX configuration.

    Important

    The name that you choose for your IPX configuration will also be used as the search hub value for your IPX interface. The search hub value is the identifier for your IPX interface that’s used for query pipeline routing, usage analytics reporting, and enabling Coveo Machine Learning features. The IPX name and search hub value can’t be modified once the IPX configuration is created.

  4. Click Duplicate. The new IPX configuration is created. Depending on the configuration of the original IPX, the corresponding query pipelines and models may also be created (see What gets created when duplicating an IPX).

  5. If required, edit the configuration of the newly created IPX.

What gets created when duplicating an IPX

This section lists what gets created when duplicating an IPX configuration.

  • A new IPX search interface configuration is created with the same settings in the IPX builder as the original IPX configuration, except for the search hub value and loader script, which are unique to every IPX configuration. For more information see, Access the IPX search hub value and loader script.

  • If the IPX that you choose to duplicate uses automatically created query pipelines and Coveo ML models, new query pipelines and models are automatically created for your new IPX configuration as follows:

    • A new query pipeline is created for each query pipeline that was automatically created for the original IPX configuration. Each query pipeline inherits the same settings and model associations as the original query pipeline, except for the query pipeline condition. The new condition is based on the new IPX configuration name. For more information, see Automatic query pipeline configuration.

    • For each new query pipeline that’s created, if the original query pipeline included an associated model that was automatically created, that model is also duplicated. A new model is created and assigned to the new query pipeline to replace the original model. Each new model inherits the same settings as the original model.

      Notes

      • If the original query pipeline included an association with a model that wasn’t created automatically, the new query pipeline inherits the model association, but that model won’t be duplicated. In this case, that same model is associated with both query pipelines. Only models that were automatically created are duplicated.

      • The query pipelines and models are created using the naming convention detailed in Automatic query pipeline configuration.

Example

You want to duplicate the IPX Workplace IPX configuration that uses the following query pipelines and models:

  • A Search pipeline - IPX Workplace query pipeline that was automatically created, and that has the following model associations:

    • ART model - IPX Workplace (automatically created ART model)

    • QS model - IPX Workplace (automatically created QS model)

    • IPX DNE (manually created DNE model).

  • A Recommendation pipeline - IPX Workplace query pipeline with an associated CR model - IPX Workplace model, which were both automatically created.

Duplicating IPX Workplace, and naming the new IPX configuration New IPX Workplace, results in the following:

  • A new IPX search interface configuration named New IPX Workplace that has the same settings in the IPX builder as the original IPX configuration, except for the search hub value and loader script.

  • New ART model - New IPX Workplace, QS model - New IPX Workplace, and CR model - New IPX Workplace models that inherit the same settings as the original models.

  • A new Search pipeline - New IPX Workplace query pipeline with associated ART model - New IPX Workplace, QS model - New IPX Workplace, and IPX DNE models. The IPX DNE model isn’t duplicated as it wasn’t created automatically, but the new query pipeline maintains the model association of the original query pipeline.

  • A new Recommendation pipeline - New IPX Workplace query pipeline with an associated CR model - New IPX Workplace model.

Customize an IPX interface

This section details how to set up and customize an IPX search interface using the IPX builder.

Tip

The builder maintains a version history of your configuration. A new version is generated every time you save changes in the builder, and you can restore a previous version of your configuration.
Note

To edit a legacy IPX interface, see Edit a legacy IPX interface.

From the IPX builder, you can:

Access the IPX builder

The IPX builder lets you customize an IPX search interface configuration. After you create an IPX interface, you can access its configuration settings at any time.

Note

To edit a legacy IPX interface, see Edit a legacy IPX interface.

  1. On the In-Product Experiences (platform-ca | platform-eu | platform-au) page, click the IPX configuration that you want to edit.

  2. Click Edit in the Action bar.

You may be required to log in to the builder using the credentials you used to log in to the Coveo Administration Console.

Live builder preview

The IPX builder includes a live preview that automatically updates based on the configuration options.

Besides showing you how your IPX interface looks, the preview is also fully interactive so you can perform actions such as searches, click search results, and open and close the IPX interface. Use the preview to see your IPX interface customizations and functionality in real time.

IPX preview

Manage result templates

Result templates set how individual query results appear in the search interface based on certain conditions. For example, you can display results for PDFs and web pages differently.

You can:

Result templates are evaluated in the order they appear in the Search results display tab. This means that if a query result meets the conditions found in multiple templates, the first applicable template in the list is used.

Create and edit result templates

  1. In the IPX builder, select the Search results display tab.

  2. Do one of the following:

    • To create a new template, click Add template.

    • Click the result template that you want to edit.

  3. Specify the template settings:

    • Enter a descriptive Name for your template.

    • Under Usage, set the condition(s) for when to use the template:

      1. Click Add condition to add a new condition, or click an existing condition that you want to edit.

      2. In the Select a field dropdown menu, select the desired field (for example, source).

      3. In the Select a condition dropdown menu, select the desired operator (for example, Must match).

      4. In the Values field, specify at least one value (for example, YouTube). Use a comma-separated list to specify multiple values.

      5. Click Done to apply your changes.

    • Under Colored badge, select what’s displayed for the colored badge above the search result:

      1. Select a field to show its data in the badge.

        Badge

      2. Select a color for the badge.

    • Under Additional information, set the information to display below the search result:

      1. Click Add details to add new information, or click the existing information that you want to edit.

      2. Select a field to display the corresponding metadata value.

        Metadata

      3. (Optional) To include a label for the selected field, select the Include label checkbox, and then enter a custom label or keep the default field name.

      4. Click Done to apply your changes.

        Tip

        Change the order in which the information appears by clicking move to drag a details card to its new location in the list.

  4. Click Done to save the result template.

  5. Click Save at the upper-right corner of the builder to save your IPX interface.

Reorder result templates

Result templates are evaluated in the order they appear in the Search results display tab. This means that if a query result meets the conditions found in multiple templates, the first applicable template in the list is used.

Note

The Default template can’t be reordered.

  1. In the IPX builder, select the Search results display tab.

  2. In the Result templates section, click move on a template card to drag it to its new location in the list.

  3. Click Save at the upper-right corner of the builder to save your IPX interface.

Delete a result template

  1. In the IPX builder, select the Search results display tab.

  2. In the Result templates section, click the result template you want to delete.

  3. Click Delete.

  4. Click Delete again to confirm the action.

Enable Quick view

The Quick view feature adds a Quick view button button to each search result. Clicking the button opens a modal window that contains the body of the search result. This lets users preview a search result without leaving the current page.

IPX Quick view result

To enable Quick view

  1. In the IPX builder, select the Search results display tab.

  2. Select the Quick view checkbox.

Manage facets

When facets are enabled, a Filters button appears at the top of the search interface.

IPX facet button

Clicking the Filters button shows the Filters screen where the configured facets appear as filter categories.

IPX facets
Note

By default, an IPX configuration includes the Source, Author, and Item Type facets.

You can:

Enable or disable facets

When facets are enabled, a Filters button appears at the top of the search interface that, when clicked, shows the Filters screen with the configured facets.

IPX facet button
Important

All existing facets will be permanently deleted if you disable facets and then click Save at the upper-right corner of the builder to save your interface.

  1. In the IPX builder, select the Filtering options tab.

  2. To enable or disable all facets, click On or Off respectively in the Facets section.

  3. Click Save at the upper-right corner of the builder to save your interface.

Create and edit facets

  1. In the IPX builder, select the Filtering options tab.

  2. Select the Filtering options tab.

  3. Do one of the following:

    • To create a new facet, click Add facet.

    • Click the facet that you want to edit.

  4. Specify the facet settings:

    • Select the Field to use for the facet (for example, year or documenttype).

    • Enter the Name to display for the facet in the search interface.

    • Depending on the selected field, a Display section may appear. If so, select whether to display the facet options As checkboxes or As links.

  5. Click Done to apply your changes.

  6. Click Save at the upper-right corner of the builder to save your interface.

Reorder facets

  1. In the IPX builder, select the Filtering options tab.

  2. In the Facets section, perform one of the following tasks:

    • To reorder facets and their values based on a user’s query so that the most relevant options appear at the top, select the Use dynamic navigation checkbox.

      Tip
      Tip

      You can enable this option in advance even if you haven’t yet created a DNE model or associated it with your main query pipeline. However, without a properly configured DNE model, this option has no effect.

      To configure a DNE model for use with IPX, see Configure query pipelines and machine learning.

    • To reorder facets manually, clear the Use dynamic navigation checkbox, click move on a Facet card, and then drag and drop the card in the desired order.

  3. Click Save to apply your changes.

Delete a facet

  1. In the IPX builder, select the Filtering options tab.

  2. Click the facet that you want to delete.

  3. Click delete.

  4. Click delete again to confirm.

  5. Click Save at the upper-right corner of the builder to save your interface.

Manage tabs

When enabled, tabs appear at the top of the IPX search interface. Each tab shows a subset of items based on the tab configuration.

IPX tabs
Note

By default, an IPX configuration includes an All tab that can’t be deleted to ensure that all content can be viewed.

You can:

Enable or disable tabs

Important

All existing tabs will be permanently deleted if you disable tabs and then click Save at the upper-right corner of the builder to save your IPX interface.

  1. In the IPX builder, select the Filtering options tab.

  2. To enable or disable all tabs, click On or Off respectively in the Facets section.

    Note

    The All tab can’t be deleted and is provided by default to ensure that all content can be viewed.

  3. Click Save at the upper-right corner of the builder to save your IPX interface.

Create and edit tabs

  1. In the IPX builder, select the Filtering options tab.

  2. Do one of the following:

    • To create a new tab, click Add tab.

    • Click the tab that you want to edit.

  3. Specify the tab settings:

    • In the Label field, enter the name that will be displayed on the tab in the search interface.

    • Under Usage:

      1. Click Add condition to add a new condition for what will appear in the tab.

      2. In the Select a field dropdown menu, select the desired field (for example, source).

      3. In the Select a condition dropdown menu, select the desired operator (for example, Must match).

      4. In the Values field, specify at least one value (for example, YouTube).

        Tip
        Tip

        To specify multiple values, use a comma to separate each value.

      5. Click Done to apply your changes.

  4. Click Done to save the tab.

  5. Click Save at the upper-right corner of the builder to save your IPX interface.

Reorder tabs

Note

The All tab can’t be reordered. It always appears first as it displays all content.

  1. In the IPX builder, select the Filtering options tab.

  2. In the Tabs section, click move on a tab card to drag it to its new location in the list.

  3. Click Save at the upper-right corner of the builder to save your IPX interface.

Delete a tab

  1. In the IPX builder, select the Filtering options tab.

  2. Click the tab that you want to delete.

    Note

    The All tab can’t be deleted.

  3. Click Delete.

  4. Click Delete again to confirm.

  5. Click Save at the upper-right corner of the builder to save your IPX interface.

Set interface colors and text

You can customize the colors and text of your IPX search interface as desired or to match the site or application in which you’ll add the IPX interface.

  1. In the IPX builder, select the Style tab.

  2. Under Theme, select the Primary, Secondary, and Background colors for the search interface.

  3. Under Text:

    • The Font family CSS property sets the prioritized list of supported generic and specific font families for your search interface. By default, the most common fonts are included in the list. The IPX interface will use the first font in the list that’s supported by your website. If required, modify the font family list to match the site or application in which you’ll add the IPX interface.

      Note

      The builder’s live preview won’t display a font if it’s not a font that’s currently available in your web browser.

    • Select the Visited link color for the search interface.

    • For Title, select the color for headings and titles in the search interface.

  4. Click Save at the upper-right corner of the builder to save your IPX interface.

Set IPX placement

You can choose to display the IPX search interface using the out-of-the-box IPX button, or in a custom element on your website. Use the Placement section to set how to display the IPX search interface.

  • Out-of-the-box IPX button

    If you use the out-of-the-box IPX button, the IPX search interface opens and closes via a button on the web page where the IPX is added. Both the button and the IPX search interface appear at the bottom-right of the web page. You can customize the button color, label, and icon, but not the placement of the button or the button’s functionality.

  • Custom element on your website

    If you choose to display the IPX search interface in a custom element, the IPX search interface renders and appears in the targeted element on your website. This is done by specifying a CSS selector that targets an existing element on your website, such as a div element, where you want the IPX search interface to appear.

    Important

    • The IPX loader script does not create the element on your web page in which the IPX search interface renders and appears. You must create the element manually. The CSS selector that you specify in the IPX builder settings simply targets the element you created.

    • When adding an IPX interface in a custom element on your site, it’s important to make sure that IPX doesn’t initialize on every page load, but rather only when a specific action is taken, such as a button click.

      When using a custom element, IPX sends a call to the index to retrieve recommendations whenever IPX initializes. This call counts towards the queries per month (QPM) that are allocated to your Coveo organization. Therefore, to avoid using up your QPM limit needlessly, ensure that IPX initializes only when it’s required.

To set your IPX placement

  1. In the IPX builder, select the Style tab.

  2. Under Placement, select whether to use the IPX button or a custom element:

    • To use the IPX button:

      1. Select Open with a button.

      2. Select the Button color.

      3. In the Label field, enter the text what will appear on the button (for example, Search).

      4. Select the Label color.

      5. (Optional) For Button icon, click Upload SVG image to select a custom image to use as the icon in the IPX button when the IPX search interface is closed. By default, a magnifying-glass icon appears.

    • To add the IPX search interface in a custom element:

      1. Select Show in a custom element.

      2. Enter a CSS selector to target the HTML element that you created on your web page where you want your IPX interface to appear.

        Important

        • The IPX loader script does not create the element on your web page in which the IPX search interface renders and appears. You must create the element manually. The CSS selector that you specify in the IPX builder settings simply targets the element you created.

        • When adding an IPX interface in a custom element on your site, it’s important to make sure that IPX doesn’t initialize on every page load, but rather only when a specific action is taken, such as a button click.

          When using a custom element, IPX sends a call to the index to retrieve recommendations whenever IPX initializes. This call counts towards the QPM that are allocated to your Coveo organization. Therefore, to avoid using up your QPM limit needlessly, ensure that IPX initializes only when it’s required.
        Example

        You want the IPX search interface to appear when a user clicks a custom Help button on your website.

        To do this, you create a div element on your website with an ID attribute of sidepanel that opens when a user clicks the Help button.

        To render the IPX search interface in your custom div element, you enter #sidepanel in the IPX builder settings to target the div element on your website.

  3. Click Save at the upper-right corner of the builder to save your IPX interface.

You can add a footer section to the IPX search interface where you can add links and logos.

You can:

Important

All existing footer elements will be permanently deleted if you disable the footer and then click Save at the upper-right corner of the builder to save your IPX interface.

  1. In the IPX builder, select the Style tab.

  2. To enable or disable the footer, click On or Off respectively in the Footer section.

  3. Click Save at the upper-right corner of the builder to save your IPX interface.

The footer can contain up to three text links and logos in any combination. A logo can also contain a link.

  1. In the IPX builder, select the Style tab.

  2. If required, in the Footer section, click On to enable the footer.

    Important

    All existing footer elements will be permanently deleted if you disable the footer and then click Save at the upper-right corner of the builder to save your IPX interface.

  3. Do one of the following:

    • Click Add a link or logo to add a new footer element, and then click Link or Logo.

    • Click the footer element that you want to edit.

  4. Specify the settings:

    • For links:

      1. Enter a Link URL.

      2. Enter the Text to display.

    • For logo:

      1. Click Upload SVG image to select a custom image to add to the footer.

      2. (Optional) Enter a Link URL of the logo.

  5. Click Done to apply your changes.

  6. Click Save at the upper-right corner of the builder to save your IPX interface.

The footer area is separated into three distinct areas (left, center, right). Footer elements appear on the left, center, or right footer area based on the order that the elements appear in the Footer section. The top-most element appears in the left footer area and the lowest element appears in the right footer area. You can reorder your footer elements as desired.

  1. In the IPX builder, select the Style tab.

  2. In the Footer section, click move on a footer element card to drag it to its new location in the list.

Enable or disable Smart Snippets

The IPX search interface supports Coveo Machine Learning (Coveo ML) Smart Snippets. Smart Snippets provide users with answers to their queries directly on the results page by displaying a snippet of the most relevant result item. For more information, see About Smart Snippets.

Important

Enabling the Smart Snippets option allows Smart Snippets to appear in your IPX search interface, but only if you have a Smart Snippet model that’s associated with your IPX’s main query pipeline.

You can enable this option in advance even if you haven’t yet created a Smart Snippet model or associated it with your main query pipeline. However, without a properly configured Smart Snippet model, this option has no effect.

To configure a Smart Snippet model for use with IPX, see Configure query pipelines and machine learning.

To enable Smart Snippets

  1. In the IPX builder, select the Settings tab.

  2. Under Results page, select the Smart Snippets option.

Enable Relevance Generative Answering (RGA)

Enabling Relevance Generative Answering (RGA) adds the RGA component to your search interface. This component appears above the search results list.

RGA uses generative AI technology to generate answers for natural language queries. The answers are generated based on your enterprise content and permissions, and are displayed in the search interface along with the search results. See About Relevance Generative Answering (RGA) for more information.

  1. In the IPX builder, select the Settings tab.

  2. Under Results page, select the Relevance Generative Answering box.

  3. Click Save at the upper-right corner of the builder to save your IPX interface.

Note

When enabling RGA, you must also associate an RGA model with your IPX’s main query pipeline.

Access the IPX search hub value and loader script

Your IPX interface configuration includes a dedicated search hub value and loader snippet script.

The search hub value is the identifier for your IPX interface that’s used for query pipeline routing and enabling Coveo Machine Learning features. The search hub value is based on the name of your IPX configuration and can’t be modified.

The loader snippet script is required when adding your IPX interface to websites and applications.

To retrieve the search hub value or loader snippet

  1. In the IPX builder, select the Settings tab.

  2. In the Search hub or Loader snippet section, click copy16px to copy the search hub value or loader script respectively.

Manage version history

The Version history tab lets you view, manage, and restore earlier versions of your IPX search interface configuration. A new version is generated every time you save changes in the builder.

Specifically, it offers the following capabilities:

  • View a summary of your interface versions and changes.

  • View who made the changes and when.

  • View the date that changes were last made to your current interface (identified with the Current label).

  • Restore an interface version.

View interface versions and changes

  1. In the IPX builder, click Version history.

    A timeline displaying the last 10 interface versions is displayed.

    Note

    A new version is generated every time changes to the interface are saved.
    Tip
    Tip

    To view the next 10 versions, click Show more.

  2. To view the changes that apply to a specific version, select it.

    The changes for the selected version appear under Activity in the Version details panel.

  3. (Optional) In the Comment box, enter a description for the selected version.

    Tip
    Tip

    Entering a description will help you to identify this version in the Version history timeline.

    For example:

    timeline comment

Restore an interface version

Important

Restoring a version automatically applies the changes to your live interface.

  1. In the IPX builder, click Version history.

  2. Select the version you want to restore from the timeline.

  3. (Optional) In the Comment box, enter a description for the selected version.

  4. Click Restore this version.

    The restored version is automatically applied to your live interface and displayed in the builder preview.

Edit a legacy IPX interface

This section details how to edit a legacy IPX search interface.

Note

Legacy IPX interface configurations appear with a Legacy Editor badge on the In-Product Experiences (platform-ca | platform-eu | platform-au) page.

Legacy Editor badge

Although you can edit an existing legacy IPX interface, you can no longer create a new IPX search interface using the legacy configuration (see Create an IPX interface).
Edit an IPX legacy configuration

  1. On the In-Product Experiences (platform-ca | platform-eu | platform-au) page, click the legacy IPX configuration that you want to edit, and then click Edit in the Action bar.

  2. In the Configuration tab, fill the Basic settings section.

    Note

    The Loader snippet is used to add your IPX interface to a website.

  3. Use the Design tab to:

  4. Use the Content access tab to:

  5. Click Save. Saved changes take effect immediately.

Modify the main button

Note

This procedure must be executed by a developer who knows how to use the Coveo JavaScript Search Framework.

  1. On your IPX’s configuration page, select the Design tab.

  2. In the Main button section, modify the settings as desired, and then click Save.

    Modifying the main button of an IPX interface

Advanced main button modification using CSS

For increased flexibility when embedding your IPX in sites and applications, you can use the following elements in the CSS of your web page to modify the style of the IPX button, the button icon, and the button text.

Note

Modifying the style attributes of the IPX button using the above CSS elements overrides the corresponding settings in the IPX configuration Design tab. For example, if you set the button color in the Design tab, and then specify a different color in the CSS, your IPX interface uses the color specified in the CSS of the corresponding web page.

  • coveo-in-app-widget-loader::part(button): Modifies the style of the IPX button.

  • coveo-in-app-widget-loader::part(button-text): Modifies the style of the text that appears in the IPX button.

  • coveo-in-app-widget-loader::part(button-icon): Modifies the style of the icon that appears in the IPX button.

In the CSS of your web page that includes your IPX interface, add one or more of the above elements within a style tag and specify the attributes as required using standard CSS rules.

Example

You want the IPX button width to adjust to the button text. You add the following style tag to your web page HTML:

<style> coveo-in-app-widget-loader::part(button) { width: inherit; } coveo-in-app-widget-loader::part(button-text) { max-width: unset; } </style>

Deploy IPX in a native component (advanced)

To deploy an IPX interface inside a native component of your website or application instead of attaching it to the default button, you can use the Target selector section.

The Target selector section lets you replace the default IPX button by a custom open/close mechanism integrated within your website or application.

  1. On your IPX’s configuration page, select the Design tab.

  2. In the Target selector box, enter a CSS selector to the element that should replace the default IPX button (for example, #myElementId).

  3. Click Save.

    Screen capture of the target selector section in the Coveo Administration Console

Modify the search panel (advanced)

You can use the Interface Editor in the Administration Console to customize the search panel.

  1. On your IPX’s configuration page, select the Design tab.

  2. In the Search Panel section, click Use the interface editor.

    Modifying the search panel of an IPX interface - 1

  3. In the Interface Editor window, select the Code view tab.

  4. Modify the search panel markup configuration as desired, and then click Save.

    Modifying the search panel of an IPX interface - 2

The changes take effect immediately.

Configure content access (advanced)

When embedding your IPX interface in sites and applications, the IPX interface uses the same generic search token to authenticate all users by default. This token is meant to grant access to publicly available content only. You can modify the information to include in the generic search token directly through the Administration Console.

If you would rather use a distinct search token for each authenticated user to provide access only to the secured content they’re allowed to view, you must instead implement advanced search token authentication.

Option 1: Modify the default content access settings

Note

Follow this procedure only if you want to modify the information to include in the search token that gets generated by default for all users of an IPX interface.

If you want each end user to be able to access the secured content they’re allowed to view in your IPX interface, you must instead implement advanced search token authentication.

  1. On the configuration page for your IPX interface, select the Content access tab.

  2. In the Default settings section, modify the settings as desired, and then click Save.

    Modifying the content access settings for an IPX interface

The changes take effect immediately.

Option 2: Implement advanced search token authentication

Implementing advanced search token authentication requires you to add server-side logic to your website or application. Therefore, the actual implementation details will vary from one project to another. This procedure only provides generic guidelines.

Note

This procedure must be executed by a developer who is allowed to modify code in the target website or application.

In summary, you must write server-side code that performs the following actions:

  1. Authenticate the user.

  2. Call a service exposed through Coveo to request a search token for the authenticated user.

    POST https://platform.cloud.coveo.com/rest/search/v2/token HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: Bearer **********-****-****-****-************
    {
  "userIds": [
    {
      "name": "asmith@example.com",
      "provider": "Email Security Provider"
    }
  ]
}

  3. In the snippet for the IPX interface to load, inject the access_token=TOKEN query parameter into the script URL (where TOKEN must be replaced with the actual search token that was generated for the authenticated user).

    <!--  Coveo In-Product Experience -->
<script type="text/javascript" src="https://platform.cloud.coveo.com/rest/organizations/speedbit1a2b34d5e/pages/abc8ccfe-bf50-42e7-a140-475420cbc543/inappwidget/loader?access_token=eyJhbGciOiJIUzI1NiJ9.eyJ2OCI6dHJ1ZSwib3JnYW5pemF0aW9uIjoic3BlZWRiaXQxYTJiMzRkNWUiLCJ1c2VySWRzIjpbeyJwcm92aWRlciI6IkVtYWlsIFNlY3VyaXR5IFByb3ZpZGVyIiwibmFtZSI6ImFzbWl0aEBleGFtcGxlLmNvbSIsInR5cGUiOiJVc2VyIn1dLCJyb2xlcyI6WyJxdWVyeUV4ZWN1dG9yIl0sImV4cCI6MTU3OTgwMzcxNSwiaWF0IjoxNTc5NzE3MzE1fQ.aPFX20a7IdvtKuw89len98fDqMbSo87ER7isSCn-Q90" async ></script>
<!-- End Coveo In-Product Experience -->

  4. Serve the page, including the snippet in its head.

For more information and examples, see Search token authentication.

Pass custom context (advanced)

Note

This procedure must be executed by a developer who knows how to use the Coveo JavaScript Search Framework.

Passing custom context through an IPX interface helps train Coveo ML models to provide more relevant results to users.

To do so:

  1. Ensure that your IPX interface contains a PipelineContext component.

    Note

    A PipelineContext component is included by default in all IPX interfaces created after March 10th, 2020. For older IPX interfaces, you can add a PipelineContext component using the Interface Editor.

  2. Once the CoveoInProduct global variable is available, set the custom context as needed by invoking the setContextValue and/or setContext methods.

Example

You want to collect information from the registered users on the Speedbit Dashboard (that is, their subscription level, age group, and which Speedbit products they already own) to better provide suggestions as to what they may need next.

Assuming you have implemented the getSubscriptionLevel, getAgeGroup, and getOwnedProducts functions to retrieve the target values, you can use them to pass custom context as follows:

<head>
   <!-- ... -->
   <!--  Pass custom context to IPX  -->
   <script>
      // Wait for IPX interface to load...
      window.addEventListener('load', () => {
         CoveoInProduct.setContext({
            "subscriptionLevel": getSubscriptionLevel(),
            "ageGroup": getAgeGroup(),
            "ownedProducts": getOwnedProducts()
         });
      });

      function getSubscriptionLevel() { /* Implementation here... */ }
      function getAgeGroup() { /* Implementation here... */ }
      function getOwnedProducts() { /* Implementation here... */ }

   </script>
   <!-- End pass custom context to IPX -->
   <!-- ... -->
</head>

Delete an IPX

Important

If you delete an IPX configuration for which query pipelines and ML models were automatically created, the corresponding query pipelines, ML models, and conditions will also be deleted. Make sure they’re not used by other search interfaces before deleting the IPX configuration.

Deleting an IPX search interface configuration is irreversible.

  1. Ensure that the loader snippet for the IPX interface you want to delete is no longer included in any page of your website or application. Otherwise, the console will display a 404 error when the browser attempts to load the script.

  2. On the In-Product Experiences (platform-ca | platform-eu | platform-au) page, click the IPX interface you want to delete, and then click Delete in the Action bar.

  3. Click Delete to confirm.

Required privileges

The following table indicates the privileges required to view or edit elements of the In-Product Experiences (platform-ca | platform-eu | platform-au) page and associated panels (see Manage privileges and Privilege reference).

Action Service - Domain Required access level

View In-Product Experiences

Organization - Organization

View

Search - Search pages and IPX

View

Edit and test In-Product Experiences

Organization - Organization

View

Search - Search pages and IPX

Edit

Search - Execute queries

Allowed

Content - Fields

View

What’s next?

Enhance relevance in your IPX by configuring query pipelines and Coveo Machine Learning.