Adding and Managing Fields

Each Coveo Cloud organization source automatically comes with a set of standard system fields populated from standard metadata (see Understanding Fields). You can also create fields that are filled with the content or metadata of your choice when adding source mappings. All these fields can be used later in a search interface to optimize the global search experience.

In a Coveo Cloud organization, fields are index-wide data containers. Therefore, you should be aware that modifying a given field can impact multiple sources.

Add a New Field

By default, a new Coveo Cloud organization can contain a maximum of 5000 fields. Once the threshold is reached, you cannot create new fields or create sources that would add fields.

Default fields are shared among sources of the same type, so the number of fields in your Coveo Cloud organization increase only when you add new types of sources.

When you already have a YouTube source in your Coveo Cloud organization, adding other YouTube sources does not create new fields.

  1. On the Fields page, at the top right, click Add Field.

    If the Add Field button is grayed and unresponsive, you do not have all of the required privileges to perform this action.

  2. In the Add a Field panel that appears, create a new field (see Add or Edit a Field).

Sort Fields by Type

On the Fields page, in the Action bar, click the Type drop-down menu, and then select the desired value.

Sort Fields by Origin

On the Fields page, in the Action bar, click the Origin drop-down menu, and then select the desired value.

Default fields are required by the Coveo index and apply to all sources, while Other fields are created by a Coveo Cloud platform user or by a source addition (each source comes with a set of standard fields).

Edit an Existing Field

Once a field is created, you can always edit its configuration.

  1. On the Fields page, double-click the desired field.

  2. In the Edit a Field: [FieldName] panel that appears, make the desired changes.

    System field name and type are not editable.

  3. Click Save.

Depending on the changes made in the Advanced Settings section of the Add/Edit a Field [FieldName] panel, you may need to rebuild the sources that use the edited field for your changes to be effective (see String Options). You can trigger this operation on the Sources page.

Delete an Existing Field

You can only delete fields that are Unused in sources.

  1. On the Fields page, in the field list, select the field that you want to delete.

  2. In the Action bar, click Delete.

  3. At the Are you sure? prompt, click Delete.

Review the Activity Regarding Fields

On the Fields page, in the right section of the page header, click the Activity icon (Activity icon) to review events relative to fields.

If the Activity icon is grayed and unresponsive, you do not have the privileges required to perform this action.

Reference

The body of the Fields page is essentially a table listing the fields defined in your Coveo organization.

  • The Name column indicates the field name that was entered when creating the field, or the name of the out-of-the-box and system fields.

    A developer may need a field name when deciding which fields are included in the details of a search result.

  • The Type column indicates the field type.

  • The Origin column indicates whether the field is a default field required by the Coveo index (Default), or a user-defined or standard source field (Other).

  • The Used in Sources column indicates the number of sources in which the field is used.

  • The next three columns indicate the field uses in a search interface:

    • Facet: users can filter their search results by selecting only the desired values for a field (see Using Facets and JavaScript Search Interface Editor).

    • Multi-Value Facet: (when facet field has more than one value for a given item) instructs Coveo Cloud to process each field value independently.

    • Sortable: allows end users to modify the display order of items in the search results based on the field.

The Activity tab provides information such as the duration of an activity, which is useful for long operations.

Required Privileges

The following table indicates the privileges required to view or edit elements of the Fields page and associated panels (see Privilege Management and Privilege Reference).

Action Service - Domain Required access level
View

Content - Fields

Content - Sources

Organization - Activities

View
Edit

Organization - Activities

View

Content - Fields

Content -Sources

Edit