Populate a field with meta tag content

This is for:

Developer System Administrator

Recording metadata with your indexed items in the Coveo Platform is a three-step process:

  1. Extracting a piece of metadata from your content.

  2. Creating a field.

  3. Creating a mapping rule to index the piece of metadata in that field.

A Web source automatically extracts some metadata for you (that is, step 1). Knowing which metadata is automatically extracted can spare you from doing the first step needlessly.

Alternatively, you can set up a web scraping configuration to extract metadata yourself.

Automatically extracted metadata

The HTML content attribute of <meta> tags is extracted when the tag is keyed with one of the following attributes: name, property, itemprop, or http-equiv.

Example

The HTML of a web page contains <meta name="viewport" content="width=device-width, initial-scale=1.0" /> in its <head> section. When the Web source indexes this page, it automatically extracts a viewport metadata whose value is width=device-width, initial-scale=1.0.

Tip

The View and map metadata feature lets you see all the metadata currently extracted from your content, whether indexed (that is, mapped to a field) or not.

View and map metadata feature showing mapped and unmapped metadata | Coveo

Store <meta> tag metadata in a field

If you have the necessary privileges, you can store an automatically extracted <meta> tag metadata with your indexed items as follows:

  1. On the Fields (platform-ca | platform-eu | platform-au) page, click Add field.

  2. In the Add a field panel, provide a field name. For example: description. Specify other field settings as necessary.

  3. On the Sources (platform-ca | platform-eu | platform-au) page, click your source, and then click Mappings in the Action bar.

  4. On the Common tab of the Edit mappings subpage, click Add mapping at the top right.

  5. In the Add a common mapping modal:

    1. Under Field, select the field you created earlier.

    2. Under Rules, enter the mapping rule to apply. For example: %[description]. See the Mapping rule syntax reference to learn how to write mapping rules.

    3. Click Add mapping.

  6. In the Edit mappings subpage, click Save and rebuild source. Coveo launches a source rebuild to apply your changes. Alternatively, click Save to keep your changes without rebuilding. This is useful when you want to make more mapping changes before the rebuild.

  7. Inspect a few items in the Content Browser to make sure that the field is properly populated.

What’s next?

Use your field in an Atomic search interface as follows:

  • Add your field to the fieldsToInclude property of the atomic-search-interface component.

  • Use your field in a atomic-field-condition component. For example, you can create a condition to display the field value in search results only when the item has a value for that field.

  • Use the type-specific Atomic result component to display your field values in search results (for example, atomic-result-text, atomic-result-number).

Tip

See the code sample of the atomic-result-fields-list interactive example.