Community

Product DocsMenu

Creating and Using a Jive Mapping File

By default, the Jive connector uses the default mapping file ([CES_Path]\Bin\Coveo.CES.CustomCrawler.Jive.Mappings.xml). When you want to customize how the connector maps Jive metadata to index fields, you can create a custom mapping file.

Note: The Jive connector uses the standard mapping file schema (see Standard Mapping File Schema) to configure what metadata from your original Jive documents are associated with fields for the documents in the Coveo index.

The first section of the mapping file, CommonMappings, defines fields that will apply to every document. 

<?xml version="1.0" encoding="utf-8" ?>
<Mappings>
  <Version>1</Version>
  <CommonMapping>
    <Fields>
      <Field name="sysauthor">%[author.displayName]</Field>
      <!-- Jive system fields -->
      <Field name="syscstag">%[tags]</Field>
      <Field name="syscstaggroup">%[categories]</Field>
      <Field name="syscsplace">%[coveo.places.titles]</Field>
      <Field name="syscsplacetype">%[coveo.places.types]</Field>
    </Fields>
  </CommonMapping>

Example: The mapping <Field name="sysauthor">%[author.displayName]</Field> instructs the connector to copy the value of the author.displayName Jive metadata and paste it in the sysauthor Coveo index field for each indexed document.

The following sections of the Jive mapping file define fields for different types of Jive documents (file, space, direct message...).

Example: The fields for a Jive person type of documents are given in the following mapping file excerpt. 

<Mapping type="person">
  <Title>%[displayName]</Title>
  <Body> %[displayName] %[emails(work).value] %[jive.profile(Title).value]</Body>
  <Fields>
    <Field name="UserProfile_FirstName">%[name.givenName]</Field>
    <Field name="UserProfile_LastName">%[name.familyName]</Field>
    <Field name="UserProfile_AccountName">%[jive.username]</Field>
    <Field name="UserProfile_Title">%[jive.profile(Title).value]</Field>
    <Field name="UserProfile_AboutMe">%[jive.profile(Biography).value]</Field>
    <Field name="UserProfile_PictureURL">%[thumbnailUrl]</Field>
    <Field name="UserProfile_WorkEmail">%[emails(work).value]</Field>
    <Field name="UserProfile_WorkPhone">%[phoneNumbers(work).value]</Field>
    <Field name="mobile">%[phoneNumbers(mobile).value]</Field>
    <Field name="syslocation">%[location]</Field>
    <Field name="sysfiletype">csuser</Field>
    <!-- Jive system fields -->
    <Field name="syscsitemtype">User</Field>
  </Fields>
</Mapping>

Note: The built-in mapping file includes only the standard Jive metadata, none of your Jive custom or business metadata. The connector however retrieves all metadata. If you create and assign to your Jive source a field set that includes field names that exactly match metadata names, they will be mapped automatically (see Adding or Modifying Custom Fields). It is therefore recommended to extend your Jive source field set to include matching fields for all useful metadata (see Modifying the Field Set Used by a Source).

To create and use a custom mapping file

  1. Using an administrator account, connect to the Coveo Master server.

  2. Using a text editor:

    1. Create an XML file respecting the mapping file schema.

      Tip: You can use a copy of the default mapping file as a starting point.

    2. Save the file using a name of your choice in the [Index_Path]\Config folder.

      Example: C:\CES7\Config\MyJiveMapping.xml

  3. Instruct the connector to use this mapping file for a given source by adding the path of the mapping file to the Mapping File source parameter (see Configuring and Indexing a Jive Source).

People who viewed this topic also viewed