Comprendre la structure d'un schéma schema-structure

La structure de base d’un schéma est décrite ci-dessous.

Schémas de données data-schema

Pour un <srcschema>, la structure est la suivante :

<srcSchema>
    <enumeration>
        ...          //definition of enumerations
    </enumeration>

    <element>         //definition of the root <element>    (mandatory)

        <compute-string/>  //definition of a compute-string
        <dbindex>
            ...        //definition of indexes
        </dbindex>
        <key>
            ...        //definition of keys
        </key>
        <sysFilter>
            ...           //definition of filters
        </sysFilter>
        <attribute>
            ...             //definition of fields
        </attribute>

            <element>           //definition of sub-<element>
                  <attribute>           //(collection, links or XML)
                  ...                         //and additional fields
                  </attribute>
                ...
            </element>

    </element>

        <methods>                 //definition of SOAP methods
            <method>
                ...
            </method>
            ...
    </methods>

</srcSchema>

Le document XML d'un schéma de données doit contenir l'élément racine <srcschema> avec les attributs name et namespace pour renseigner respectivement le nom du schéma et son espace de noms.

<srcSchema name="schema_name" namespace="namespace">
...
</srcSchema>

Pour illustrer la structure d'un schéma de données, nous partirons du contenu XML suivant :

<recipient email="John.doe@aol.com" created="2009/03/12" gender="1">
  <location city="London"/>
</recipient>

Avec son schéma de données correspondant :

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="email"/>
    <attribute name="created"/>
    <attribute name="gender"/>
    <element name="location">
      <attribute name="city"/>
   </element>
  </element>
</srcSchema>

Description description

Le point d’entrée du schéma est son élément principal. Il est facilement identifiable car son nom est identique à celui du schéma et il doit être enfant de l'élément racine. C'est à partir de cet élément que commence la description du contenu.

Dans notre exemple, l'élément principal est représenté par la ligne :

<element name="recipient">

Les éléments <attribute> et <element> qui suivent l'élément principal permettent de définir l'emplacement et le nom des éléments de données dans la structure XML.

Soit dans notre schéma d'exemple :

<attribute name="email"/>
<attribute name="created"/>
<attribute name="gender"/>
<element name="location">
  <attribute name="city"/>
</element>

Les règles suivantes s’appliquent :

Types de données data-types

Le type de données est renseigné à partir de l'attribut type sur les éléments <attribute> et <element>.

Une liste complète est disponible dans la description de l'<attribute>élément et de l’<element>élément.

Lorsque cet attribut n’est pas renseigné, string est le type de données par défaut, sauf si l’élément contient des éléments enfants. Si tel est le cas, il est utilisé uniquement pour structurer les éléments de manière hiérarchique (élément <location> dans notre exemple).

Les types de données supportés dans un schéma sont les suivants :

Notre schéma d'exemple complété avec les types :

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="email" type="string" length="80"/>
    <attribute name="created" type="datetime"/>
    <attribute name="gender" type="byte"/>
    <element name="location">
      <attribute name="city" type="string" length="50"/>
   </element>
  </element>
</srcSchema>

Correspondance des types de données Adobe Campaign/SGBD mapping-the-types-of-adobe-campaign-dbms-data

Le tableau suivant répertorie les correspondances des types de données générés par Adobe Campaign pour les différents systèmes de gestion de base de données.

Propriétés properties

Les éléments <elements> et <attributes> du schéma de données peuvent être enrichis de diverses propriétés. Vous pouvez remplir un libellé afin de décrire l’élément actif.

Les libellés et les descriptions labels-and-descriptions

Les valeurs par défaut default-values

Utilisez la propriété default pour définir une expression qui renvoie une valeur par défaut lors de la création du contenu.

La valeur doit être une expression conforme au langage XPath. Pour plus d’informations, consultez la section Référencer avec XPath.

Exemple:

Pour lier une valeur par défaut à un champ, vous pouvez utiliser le champ <default> ou <sqldefault>.

<default> : vous permet de préremplir le champ avec une valeur par défaut lors de la création d’entités. La valeur ne sera pas une valeur SQL par défaut.

<sqldefault> : vous permet d'avoir une valeur ajoutée lors de la création d'un champ. Cette valeur s'affiche sous forme de résultat SQL. Lors de la mise à jour d'un schéma, seuls les nouveaux enregistrements seront affectés par cette valeur.

Énumérations enumerations

Enumération ouverte free-enumeration

La propriété userEnum permet de définir une énumération ouverte pour stocker et afficher les valeurs renseignées dans ce champ.

La syntaxe est la suivante :

userEnum="name of enumeration"

Une liste déroulante énumère la liste de ces valeurs à partir du formulaire de saisie :

Énumération fixe set-enumeration

La propriété enum permet de définir une énumération fixe utilisée lorsque la liste des valeurs possibles est connue à l'avance.

L'attribut enum fait référence à la définition d'une classe d'énumération renseignée dans le schéma en dehors de l'élément principal.

Les énumérations permettent à l'utilisateur de sélectionner une valeur dans une liste déroulante au lieu de saisir cette valeur dans une zone de saisie classique :

Exemple de déclaration d'énumération dans le schéma de données :

<enumeration name="gender" basetype="byte" default="0">
  <value name="unknown" label="Not specified" value="0"/>
  <value name="male" label="male" value="1"/>
  <value name="female" label="female" value="2"/>
</enumeration>

Une énumération est déclarée en dehors de l'élément principal à partir de l'élément <enumeration>.

Les propriétés de l'énumération sont :

Les valeurs de l'énumération sont déclarées dans l'élément <value> avec les attributs suivants :

Enumération dbenum dbenum-enumeration

* La propriété dbenum permet de définir une énumération dont les propriétés sont semblables à celles de la propriété enum.

En revanche, l'attribut name ne stocke pas de valeur en interne, mais un code, ce qui permet d'étendre les tables concernées sans avoir à modifier leur schéma.

Cette énumération est utilisée par exemple, pour spécifier la nature des opérations.

Exemple example

Notre schéma d'exemple complété avec les propriétés :

<srcSchema name="recipient" namespace="cus">
  <enumeration name="gender" basetype="byte">
    <value name="unknown" label="Not specified" value="0"/>
    <value name="male" label="male" value="1"/>
    <value name="female" label="female" value="2"/>
  </enumeration>

  <element name="recipient">
    <attribute name="email" type="string" length="80" label="Email" desc="Email of recipient"/>
    <attribute name="created" type="datetime" label="Date of creation" default="GetDate()"/>
    <attribute name="gender" type="byte" label="gender" enum="gender"/>
    <element name="location" label="Location">
      <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
   </element>
  </element>
</srcSchema>

des collections. collections

Une collection est une liste d'éléments de même nom et de même niveau hiérarchique.

L'attribut unbound avec la valeur "true" permet de renseigner un élément de collection.

Exemple  : définition de l'élément de collection <group> dans le schéma.

<element name="group" unbound="true" label="List of groups">
  <attribute name="label" type="string" label="Label"/>
</element>

Avec la projection du contenu XML :

<group label="Group1"/>
<group label="Group2"/>

Référencer avec XPath referencing-with-xpath

Le langage XPath est utilisé dans Adobe Campaign pour référencer un élément ou un attribut appartenant à un schéma de données.

XPath est une syntaxe permettant la localisation d’un nœud dans l’arbre d’un document XML.

Les éléments sont désignés par leur nom, les attributs sont désignés par leur nom précédé d'un caractère "@".

Exemple:

Il est aussi possible de définir des expressions complexes, telles que les opérations arithmétiques :

Des fonctions de haut niveau ont été ajoutées aux expressions afin d'enrichir les possibilités offertes par ce langage.

La liste des fonctions disponibles est accessible à partir de n'importe quel éditeur d'expressions dans la console cliente Adobe Campaign :

Exemple:

Construire une chaîne via la compute string building-a-string-via-the-compute-string

Compute string est une expression XPath utilisée pour construire une chaîne représentant un enregistrement dans une table associée au schéma. Compute string est principalement utilisée dans l’interface graphique pour afficher le libellé d’un enregistrement sélectionné.

La chaîne Compute string est définie via l'élément <compute-string> sous l'élément principal du schéma de données. Un attribut expr contient une expression XPath pour calculer l’affichage.

Exemple  : compute string de la table des destinataires.

<srcSchema name="recipient" namespace="nms">
  <element name="recipient">
    <compute-string expr="@lastName + ' ' + @firstName +' (' + @email + ')' "/>
    ...
  </element>
</srcSchema>

Résultat de la chaîne calculée sur un destinataire : Dupont René (rene.dupont@aol.com)

En savoir plus

Pour en savoir plus, consultez les liens suivants :