Communauté

Doc produitsMenu

Plateforme Coveo 7.0 >
Aide à l'administrateur > Connecteurs > Rubriques partagées des connecteurs > Schéma standard d'un fichier de correspondances

Schéma standard d'un fichier de correspondances

Un connecteur de Coveo peut avoir besoin d’un fichier de correspondances pour correctement copier les valeurs des métadonnées de référentiel aux bons champs d’index. Cette rubrique décrit le format du fichier de correspondances standard en fournissant sa définition de schéma XML. Veuillez vous référer à ce schéma afin d'évaluer le contenu possible du fichier et veiller à ce que votre fichier de correspondances soit valide.

Notes :

  • Par défaut, lorsque le nom d’un champ dans le groupe de champs sélectionné pour la source correspond au nom d’une métadonnée du référentiel indexé, la valeur des métadonnées est automatiquement copiée dans le champ, même si elles ne sont pas formellement associées dans un fichier de correspondances.

  • Certains connecteurs ont un fichier de correspondances par défaut qui est disponible dans le dossier [CES_Path]\bin. Le nom du fichier de correspondances est dans cette forme :

    Coveo.CES.CustomCrawlers.[ConnectorName].MappingFile.xml

    Lorsqu’un fichier de correspondances par défaut est disponible, il est conseillé de commencer avec son contenu en utilisant et personnalisant une copie du fichier.

Ce format de fichier de correspondances est utilisé par les connecteurs les plus récemment développés ou mis à jour. Ce fichier de correspondances standard ne contient que les métadonnées des correspondances de champ, et non les autres paramètres de configuration du connecteur. Si nécessaire, un connecteur utilise plutôt un fichier de configuration différent pour les paramètres ne se rapportant pas aux correspondances.

Connecteurs utilisant un fichier de correspondances avec ce schéma :

Le format de la version 1 du fichier de correspondances est spécifié dans la définition de schéma XML (XSD) suivante. 

<?xml version="1.0" encoding="utf-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <!-- definition of possible elements -->
  <xs:element name="Mappings">
    <xs:complexType>
      <xs:sequence>
		<xs:element name="Version" minOccurs="1" maxOccurs ="1" />
        <xs:element name="CommonMapping" type="GenericMapping" minOccurs="0" maxOccurs ="1"/>
        <xs:element name="Mapping" type="SpecificMapping" minOccurs="0" maxOccurs ="unbounded"/>
        <xs:element name="DefaultMapping" type="GenericMapping" minOccurs ="0" maxOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
    <xs:unique name="mappings">
      <xs:selector xpath="Mapping"/>
      <xs:field xpath="@type"/>
    </xs:unique>
  </xs:element>

  <!-- definition of generic (common and default) mapping section -->
  <xs:complexType name="GenericMapping">
    <xs:group ref="MappingElement" />
  </xs:complexType>

  <!-- definition of a specific mapping section -->
  <xs:complexType name ="SpecificMapping">
    <xs:group ref="MappingElement" />
    <xs:attribute name="type" use=" required" />
  </xs:complexType>
  
  <!-- definition of a mapping element.-->
  <xs:group name="MappingElement">
    <xs:all>
      <xs:element name ="Title" minOccurs="0" maxOccurs = "1"/>
      <xs:element name="Body" minOccurs="0" maxOccurs = "1"/>
      <xs:element name="ClickableUri" minOccurs="0" maxOccurs = "1"/>
      <xs:element name="PrintableUri" minOccurs="0" maxOccurs = "1"/>
      <xs:element ref="Fields" minOccurs="0" maxOccurs = "1"/>
    </xs:all>
  </xs:group>

  <!-- definition of fields element -->
  <xs:element name="Fields">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="Field" minOccurs="0" maxOccurs = "unbounded"/>
      </xs:sequence>
    </xs:complexType>
    <xs:unique name="field">
      <xs:selector xpath="Field"/>
      <xs:field xpath="@name"/>
    </xs:unique>
  </xs:element>

  <!-- definition of field element -->
  <xs:element name="Field">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name="name" use="required"/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
</xs:schema>