Add/Edit Body Mapping
When Coveo Cloud V2 indexes an item, it also retrieves the item metadata, i.e., values of item fields such as
author, and maps them to a Coveo index field. This makes the item metadata searchable.
The mapping process is similar for the item body, i.e., actual content, which is mapped to the
body Coveo index field whenever possible. The content is indexed, made searchable, and visible from the Content Browser in the Item Properties panel, under the Quick View tab, as well as from the search interface, via the Quick View button (see Item Properties - Panel).
When you index a PDF file, the file body contains all the text visible when you print the PDF.
For standard sources, the indexing pipeline Crawling stage creates a representative body for the item content. This default body is displayed in the Quick View (see Coveo Cloud V2 Indexing Pipeline).
However, Coveo Cloud V2 may not be able to automatically create item bodies to display in the Quick View when there is no standard item content layout, or when the item body is an assembly of values from all or some key records. Records are typically mapped to specific fields. The assembled Quick View may therefore not contain the relevant data or not present it in an appropriate format.
A Jira source issue item consists of a collection of fields defining the issue, such as
Creation date, and
Modification date. The Jira source crawler automatically creates a default body made up of the key fields that is available in the Quick View.
A source indexes a contact database. Each item is one contact consisting in several records such as the contact’s first name, last name, gender, title, email address, phone number, etc. Every item record is mapped to a specific field. There is no standard UI arrangement for all the item records that a user can view, and the database crawler can therefore not create an item body to display in the Quick View.
When you have the required privileges, you can add custom
body mappings and edit Coveo default
body mappings. You can define the desired body with static HTML and metadata placeholders to be replaced with item metadata values. The resulting customized item body is then displayed in the Quick View.
The indexing pipeline handles the
body field in a slightly different way from other fields, since
body is the only field that modifies search results in the free text of an indexed item. This allows you to customize search results and to update the corresponding Quick View. However, this works with fairly simple
body mappings only. To implement a more advanced customization, you must rather leverage indexing pipeline extensions (see Extensions - Page).
body mapping applies at preconversion only, only metadata extracted at the Crawling stage or by a preconversion extension can be mapped (see Coveo Cloud V2 Indexing Pipeline). Metadata extracted at the conversion stage or by a postconversion extension cannot appear in a custom item body.
Add or Edit an Item
To add or edit a
body mapping, follow the regular mapping addition procedure (see Edit the Mappings of a Source: [SourceName]).
In the Apply a Mapping on All/Specific Item Types of a Source: [SourceName] or Edit Mappings Applied on All/Specific Item Types of a Source: [SourceName] panel, take the following into account:
Under Field, select
Under Apply to, select All items (common) or Specific item types depending on whether you want to apply your item
bodymapping to a certain source item type or to all source content, regardless of the item type.
If you selected Specific item types under Apply to, select the item types on which you want to apply the
You have a Web source for your company website. Without body mapping, the Quick View for each page displays the text in the page. Your Contact Us page Quick View is therefore the following:
Contact Us Your comments and questions are always welcome! Phone: 1-800-555-2222 Email: firstname.lastname@example.org
However, you do not want the page text to be displayed in the Quick View. You therefore chose to replace the text with a simple string stating the page title. Your body mapping rule is therefore:
Page Title: %[title]. As a result, when you open the Quick View for item
Contact Us, the following would be displayed:
Page Title: Contact Us
Ensure that your
body mapping works as expected in the content browser (see Quick View Tab).