Adding and Managing Fields

Each Coveo 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 mappings for sources. All these fields can be used later in search interfaces 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.

Access the “Fields” Page

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

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

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, in the page header, at the 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 Fields).

Sort Fields by Type

On the Fields page, in the right section of the Action bar, click the Type drop-down menu, and then select one of the following values: All, String, Date, Decimal, Long (32-bit long), or Long 64 (64-bit long) (see Field Types).

Sort Fields by Origin

On the Fields page, in the right section of the Action bar, click the Origin drop-down menu, and then select one of the following values: All, Default, or Other (see Field Origins).

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).

Search Fields

  1. On the Fields page, in the right section of the Action bar, click the Filter field names box.

  2. Enter the field name that you want to find.

    The filter automatically applies as you type.

To further filter your name search results, you may also choose to display only a certain field type or origin (see Sort Fields by Type and Sort Fields by Origin).

Edit an Existing Field

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

  1. On the Fields page, in the list of fields:

    • Click the field that you want to modify, and click Edit.

      Members with the privilege to view sources (i.e., the View access level on the Sources domain) can click View to review the field configuration in read-only mode (Privilege Management and Sources Domain).

      OR

    • Double-click the desired field.

  2. In the Edit a Field: [FieldName] panel that appears, make the desired changes (see Add or Edit Fields).

    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 the changes to be effective (see String Options, Advanced Settings, and Refresh, Rescan and Rebuild). You can trigger this operation on the Sources page (see Refresh, Rescan, or Rebuild Sources).

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.

(When your organization contains more than 50 fields) On the Fields page, at the bottom-right of the table, click the left and right arrow icons, or a page number to navigate through pages.

Set the Number of Fields per Page

(When your organization contains more than 50 fields) On the Fields page, at the bottom-left of the page, select 25, 50, 10 or 100.

By default, the table shows 50 fields per page.

Review the Activity Regarding Fields

On the Fields page, in the right section of the page header, click the Activity icon (ac8-icon-clock) (see Review Events Related to Specific Coveo Cloud Administration Console Resources).

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

Reference

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

  • 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 contained in the details of a search result.

  • Type column indicates the field type (see Field Types).

  • 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) (see Field Origins).

  • 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 (see Field Uses):

    • Facet: users can filter their search results by selecting only the desired values for a field (see Understanding Facets).

    • Multi-Value Facet: (when facet field contains more than one value for a given included item) instructs Coveo Cloud to process each field value independently (see Multi-Value Fields and Understanding Facets).

    • 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 - Privilege Required access level
View

Content - Fields

Content - Sources

Organization - Activities

Organization - Organization

View
Edit

Organization - Activities

Organization - Organization

View

Content - Fields

Content -Sources

Edit