Edit Source Extensions

An indexing pipeline extension (IPE) is an optional Coveo Cloud indexing pipeline pre-conversion or post-conversion stage consisting of a Python script that you can apply to one or more sources to customize the way source items are included in your Coveo Cloud organization (see Indexing Pipeline Extension Overview).

[Administrators and content managers](Built-In Groups can add or modify existing indexing pipeline extensions to an organization (see Adding and Managing Extensions and ). As a member of one of these groups, you can then apply an extension to a source using this Edit Source Extensions panel (see Applying an Extension to a Source).

You must have the privilege to edit extensions (i.e., the Edit access level on the Extensions domain) to copy an extension script (see Extensions Domain).

An extension can be Common, applying to all item types of a source, or Specific, applying only to specified item types, in which case you must first define the item types available in your source (see Source Item Types).

You have a YouTube source that includes videos and playlists. If your indexing pipeline extension applies to both video and playlist items, it is a common extension. However, if it applies to playlists only, it is a specific extension.

“Common” Tab

The Common tab displays extensions that apply to all source item types.

Access the “Common” Tab

  1. If not already done, log in to the Coveo Cloud platform as a member of a group with the required privileges to manage sources in the target Coveo Cloud organization.

  2. In the main menu on the left, under Content, select Sources.

  3. On the Sources page, click the source for which you want to manage mappings.

  4. In the Action bar, click More, and then Manage extensions.

Reference

The information you can review in this tab is:

  • Name column: extension name

  • Stage column: stage at which the extension applies, i.e., pre-conversion or post-conversion

  • Version column: If you specified an extension versionId to apply in the JSON tab, this version ID is displayed (see Adding and Managing Extensions).

“Specific” Tab

The Specific tab displays extensions that apply only to certain source item types.

Access the “Specific” Tab

  1. If not already done, log in to the Coveo Cloud platform as a member of a group with the required privileges to manage sources in the target Coveo Cloud organization.

  2. In the main menu on the left, under Content, select Sources.

  3. On the Sources page, click the source for which you want to manage mappings.

  4. In the Action bar, click More, and then select Manage extensions.

  5. In the Add/Edit Source Extensions: [SourceName] panel, select the Specific tab.

Reference

The information you can review in this tab is:

  • Left pane

    • Item type column: item type names (see Source Item Types).

      Click an item to display the associated item-type-specific extensions in the right pane.

  • Right pane

    • Name column: extension name

    • Stage column : stage at which the extension applies, i.e., pre-conversion or post-conversion

    • Version column: If you specified an extension versionId to apply in the JSON tab, this version ID is displayed (see Adding and Managing Extensions).

“JSON” Tab

The JSON tab shows the source indexing pipeline extension properties in JSON format. Any modification made in the Common and Specific tabs automatically updates the JSON accordingly, and vice versa. You can review this raw source configuration for troubleshooting purposes, but you can also modify the configuration to take advantage of more advanced features not available through the user interface (see Use Cases Requiring to Modify the Source Extension JSON Configuration).

The content displayed in the JSON tab is similar to that in the Pre-conversion extensions and Post-conversion extension tabs of the Edit a Source JSON Configuration: [SourceName] panel (see Edit a Source JSON Configuration).

Since the JSON tab is so similar to the Edit a Source JSON Configuration: [SourceName] panel, the following instructions apply to both:

Access the “JSON” Tab

  1. If not already done, log in to the Coveo Cloud organization as a member of a group with the required privileges to manage sources in the target Coveo Cloud organization.

  2. In the main menu on the left, under Content, select Sources.

  3. On the Sources page, click the source for which you want to manage mappings.

  4. In the Action bar, click More, and then select Manage extensions.

  5. In the Add/Edit Source Extensions: [SourceName] panel, select the JSON tab.

Manage Source Extensions

The following sections describe individual source extension management actions, but there are often used in a specific sequence (see Applying an Extension to a Source).

Add an Item Type

Adding an item type in the panel allows you to apply an extension only to items of this specific type, rather than to all source item types (see Source Item Types).

  1. In the Add/Edit Source Extensions: [SourceName] panel, click the Add drop-down menu, and then select Item type.

  2. In the Add an Item Type dialog, enter the Item type name, and then click Add (see Source Item Types).

  3. Back in the Add/Edit Source Extensions: [SourceName] panel:

    • Clicking Save defers the source rebuild operation, which is necessary to apply changes. Since a source with several millions of items may take weeks to rebuild, choosing the Save option when possible prevents stressing the Coveo Cloud and system server resources. It is therefore recommended to click Save when you plan on making additional changes in the short term, and then to click Save and Rebuild once you are ready to update your source.

    • Item types with no associated extensions are deleted when you save your changes.

  4. If you clicked Save, back on the Sources page, under the source Status column, click Start required rebuild when you are ready or wait for the next scheduled source rebuild to make the changes effective.

Apply an Extension

The following procedure allows you to apply an existing indexing pipeline extension to your source that was previously created in your organization (see Adding and Managing Extensions).

  1. In the Add/Edit Source Extensions: [SourceName] panel, click the Add drop-down menu, and then select Extension.

  2. In the Apply an Existing Extension on Source Items dialog:

    1. Under Stage, select Pre-conversion or Post-conversion to determine at which stage of the indexing pipeline the extension should apply (see Coveo Cloud V2 Indexing Pipeline).

    2. Under Apply to, click All items (common) or Specific item types to determine to which items the extension should apply.

    3. (If you selected Specific item types) Select the items types to which the extension should apply.

    4. Under Extension, click the drop-down menu to select an existing extension to apply to you source (see Adding and Managing Extensions).

    5. In the Condition(s) to apply box, optionally enter conditions to control to which items the extension should apply and therefore optimize indexing pipeline performances (see Indexing Pipeline Extension Condition Syntax Reference).

      Enter %[syssite] == "mycompanyblog.com" AND NOT %[author] == "John Smith" to limit the extension application to mycompanyblog.com, and to exclude articles whose author is John Smith.

    6. Click Apply extension.

  3. In the Add/Edit Source Extensions: [SourceName] panel:

    • If you are done applying and editing extensions, click Save and Rebuild.

      OR

    • If you want to apply or edit other extensions, click Save.

    Clicking Save defers the source rebuild operation, which is necessary to apply changes. Since a source with several millions of items may take weeks to rebuild, choosing the Save option when possible prevents stressing the Coveo Cloud and system server resources. It is therefore recommended to click Save when you plan on making additional changes in the short term, and then to click Save and Rebuild once you are ready to update your source.

  4. If you clicked Save, back on the Sources page, under the source Status column, click Start required rebuild when you are ready or wait for the next scheduled source rebuild to make the changes effective.

Edit an Item Type Name

  1. In the Edit Source Extensions: [SourceName] panel, in the Specific tab, double-click the item type that you want to modify (see Access the “Specific” Tab).

    OR

    Click the item type you want to modify, and then click Edit in the Action bar.

  2. In the Edit an Extension: [ItemTypeName] dialog, edit the item type name, and then click Save.

  3. Back in the Edit Source Extensions: [SourceName] panel:

    • If you are done adding and editing items and extensions, click Save and Rebuild.

      OR

    • If you want to add or edit other items and extensions, click Save.

    Clicking Save defers the source rebuild operation, which is necessary to apply changes. Since a source with several millions of items may take weeks to rebuild, choosing the Save option when possible prevents stressing the Coveo Cloud and system server resources. It is therefore recommended to click Save when you plan on making additional changes in the short term, and then to click Save and Rebuild once you are ready to update your source.

  4. If you clicked Save, back on the Sources page, under the source Status column, click Start required rebuild when you are ready or wait for the next scheduled source rebuild to make the changes effective.

Edit an Extension

  1. In the Edit an Extension: [ItemTypeName] panel, access the “Common” tab or the “Specific” tab.

  2. In the Common or Specific tab, double-click the extension that you want to modify.

    OR

    Click the extension you want to modify, and then click Edit in the Action bar.

  3. In the Edit an Extension: [ItemTypeName] dialog, edit the extension, and then click Save.

  4. Back in the Add/Edit Source Extensions: [SourceName] panel:

    • If you are done applying and editing extensions, click Save and Rebuild.

      OR

    • If you want to apply or edit other extensions, click Save.

    Clicking Save defers the source rebuild operation, which is necessary to apply changes. Since a source with several millions of items may take weeks to rebuild, choosing the Save option when possible prevents stressing the Coveo Cloud and system server resources. It is therefore recommended to click Save when you plan on making additional changes in the short term, and then to click Save and Rebuild once you are ready to update your source.

  5. If you clicked Save, back on the Sources page, under the source Status column, click Start required rebuild when you are ready or wait for the next scheduled source rebuild to make the changes effective.

Move an Extension

  1. In the Edit an Extension: [ItemTypeName] panel, access the “Common” tab or the “Specific” tab.

  2. In the Common or the Specific tab, drag and drop extensions using the Move icon (Icon-Drag2) to rearrange them in the desired execution order. This allows you to set up extensions based on the result of a previously executed extension.

Search an Item Type or Extension

  1. In the Edit an Extension: [ItemTypeName] panel, access the “Common” tab or the “Specific” tab.

  2. In the Common or the Specific tab, on the right end of the Action bar, click the Filter box.

  3. Enter the item name, stage, or version that you want to find.

    The filter automatically applies itself as you type.

Delete an Item Type or Extension

  1. In the Edit an Extension: [ItemTypeName] panel, access the “Common” tab or the “Specific” tab.

  2. In the Common or the Specific tab, click the item type or extension you want to delete, and then in the Action bar, click Delete .

Rebuild Source to Take Account of Extension Changes

In the Add/Edit Source Extensions: [SourceName] panel, click Save and Rebuild to apply your changes.