Community

Product DocsMenu

About the Oracle UCM Mapping File

The Oracle UCM mapping file is an XML formatted text file used by Coveo Enterprise Search (CES) to map metadata retrieved from an Oracle UCM document to CES fields.

The following mapping file code contains the default mappings used by the Oracle UCM connector.

<?xml version="1.0" encoding="utf-8" ?>
<OracleUCMMapping>
  <Mapping type="Document">
    <Fields>
      <Filename>%[dOriginalName]</Filename>
      <Title>%[dDocTitle]</Title>
      <ClickableUri>%[coveo_url]</ClickableUri>
      <ModifiedDateUtc>%[coveo_lastModifiedDate]</ModifiedDateUtc>
      <CustomFields>
        <CustomField name="sysauthor">%[dDocAuthor]</CustomField>
        <CustomField name="sysconversationsubject">%[coveo_conversation_topic]</CustomField>
        <CustomField name="sysconversationsubjectid">%[coveo_conversation_hash]</CustomField>
      </CustomFields>
    </Fields>
  </Mapping>
  <Mapping type="Discussion">
    <Fields>
      <Filename>%[dOriginalName]</Filename>
      <Title>%[dDocTitle]</Title>
      <ClickableUri>%[coveo_url]</ClickableUri>
      <ModifiedDateUtc>%[coveo_lastModifiedDate]</ModifiedDateUtc>
      <CustomFields>
        <CustomField name="sysauthor">%[dDocAuthor]</CustomField>
      </CustomFields>
    </Fields>
  </Mapping>
  <Mapping type="DiscussionMessage">
    <Fields>
      <Title>%[itemTitle]</Title>
      <Body>%[itemValue]</Body>
      <ClickableUri>%[coveo_url]</ClickableUri>
      <ModifiedDateUtc>%[coveo_lastModifiedDate]</ModifiedDateUtc>
      <CustomFields>
        <CustomField name="sysauthor">%[itemAuthor]</CustomField>
        <CustomField name="sysconversationsubject">%[coveo_conversation_topic]</CustomField>
        <CustomField name="sysconversationsubjectid">%[coveo_conversation_hash]</CustomField>
      </CustomFields>
    </Fields>
  </Mapping>
</OracleUCMMapping>

In the mapping file, a Mapping entry associates a type of document indexed by CES with an Oracle UCM document type. These mappings are then used by the connector as directives to know which metadata from the UCM document must be assigned to which field (such as the Title) of the CES document. By editing this mapping file, it is possible to customize how the CES search results will be displayed to the end-user.

A custom mapping file is only required when you want to modify the default behavior of the Oracle UCM connector.

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. Use the content of the default mapping file as a starting point.

    2. While respecting the format of the mapping file, adapt the content of the mapping file to implement the desired custom mapping.

    3. Save the file under the [Index_Path] folder using a subfolder and a filename of your choice.

      Example: C:\CES7\UCM\Mapping.config

  3. Access the Administration Tool (see Opening the Administration Tool), and then associate the mapping file to the desired Oracle UCM source:

    1. Select Index > Sources and Collections.

    2. In the Collections section, select the collection containing the source to which you want to add the mapping file.

    3. In the Sources section, select the source to which you want to add the mapping file.

    4. In the navigation panel on the left, click General.

    5. In the General page for the Oracle UCM source, for the Mapping File parameter, enter the full path to your custom mapping file.

    6. Click Apply Changes.

People who viewed this topic also viewed