Dictionnaire de données data-dictionary
Présentation introduction
Un dictionnaire de données permet aux utilisateurs et utilisatrices professionnelles d’avoir des informations provenant de sources de données principales sans connaître les détails techniques de leurs modèles de données sous-jacents. Un dictionnaire de données est composé d'éléments de dictionnaire de données (DDE). Vous utilisez ces éléments de données pour intégrer des données principales sur les lettres comme entrées à utiliser dans la correspondance client.
Un dictionnaire de données est une représentation indépendante des métadonnées qui décrivent les structures des données sous-jacentes et leurs attributs associés. Un dictionnaire de données est créé à l’aide d’un vocabulaire métier. Il peut être mappé à un ou plusieurs modèles de données sous-jacents.
Le dictionnaire de données est composé d'éléments de trois types : simple, composite et de collection. Les DDE simples sont des éléments primitifs tels que des chaînes, des nombres, des dates et des valeurs booléennes qui contiennent des informations telles qu’un nom de ville. Un DDE composite contient d’autres éléments de dictionnaire de données qui peuvent être de type primitif, composite ou de collection. Par exemple, une adresse, qui se compose d’un nom de rue, d’une ville, d’une province, d’un pays et d’un code postal. Une collection est une liste de DDE simples ou composites similaires. Par exemple, un client ou une cliente avec plusieurs emplacements différents ou des adresses de facturation et de livraison différentes.
Correspondence Management utilise des données principales, client ou destinataire stockées conformément à la structure du dictionnaire de données pour créer des correspondances destinées à différents utilisateurs et utilisatrices. Par exemple, un document peut être créé avec des noms conviviaux, tels que « Cher/chère {Prénom} » ou « M. {Nom} ».
En règle générale, les utilisateurs et utilisatrices professionnelles n’ont pas besoin de connaître les représentations de métadonnées telles que le schéma XSD (schéma XML) et les classes Java. Cependant, ils ont le plus souvent besoin de l’accès à ces structures de données et à leurs attributs dans le but de créer des solutions.
Workflow du dictionnaire de données data-dictionary-workflow
- Un auteur ou une autrice crée le dictionnaire de données en chargeant un schéma ou à partir de rien.
- L’auteur crée la lettre et les communications interactives en fonction du dictionnaire de données et associe les éléments de dictionnaire de données dans la lettre et les communications interactives là où cela est nécessaire.
- Il peut télécharger le fichier XML de données d’exemple, qui repose sur le schéma d’un dictionnaire de données. L’auteur peut modifier le fichier XML de données d’exemple, qui peut être associé en tant que données de test au dictionnaire de données. Le même nœud est utilisé pendant l’aperçu de la lettre.
- Durant l’aperçu d’une lettre, un auteur choisit de prévisualiser la lettre avec des données (Aperçu personnalisé). La lettre s’ouvre préremplie avec les données que l’auteur a fournies. Elle s’ouvre dans l’interface de création de correspondance. L’agent qui prévisualise cette lettre peut modifier le contenu, les données, les pièces jointes de la lettre et envoyer la lettre finale. Pour plus d’informations sur la création de lettres, voir Création de correspondance.
Prérequis prerequisite
Installez le package de compatibilité pour afficher l’option Dictionnaires de données sur la page Formulaires.
Création d’un dictionnaire de données createdatadictionary
Utilisez l’Éditeur du dictionnaire de données pour créer un dictionnaire de données ; vous pouvez également charger un fichier de schéma XSD pour créer un dictionnaire de données à partir de cela. Vous pouvez ensuite étendre le dictionnaire de données en ajoutant d’autres informations obligatoires, y compris des champs. Quelle que soit la façon dont le dictionnaire de données a été créé, le propriétaire du processus d’entreprise n’a pas besoin de connaître les systèmes back-end. Le ou la propriétaire du processus d’entreprise n’a besoin de connaître que les objets du domaine et leurs définitions pour leur traitement.
-
Choisissez Formulaires > Dictionnaires de données.
-
Sélectionnez Créer un dictionnaire de données.
-
Dans l’écran de propriétés, ajoutez ce qui suit :
-
Titre : (facultatif) Saisissez le titre pour le dictionnaire de données. Le titre ne doit pas nécessairement être unique et peut contenir des caractères spéciaux et des caractères dans une langue autre que l’anglais. Des lettres et d’autres parties du document sont envoyées avec leur titre (le cas échéant), comme dans les vignettes et les propriétés de la ressource. Les dictionnaires de données sont référencés avec leurs noms et non pas avec leurs titres.
-
Nom : nom unique du dictionnaire de données. Dans le champ Nom, vous pouvez saisir uniquement des caractères, des chiffres et des tirets de langue anglaise. Le champ Nom est automatiquement renseigné en fonction du champ Titre et les caractères spéciaux, les espaces, les chiffres et les caractères non anglais saisis dans le champ Titre sont remplacés par des tirets. Bien que la valeur du champ Titre soit automatiquement copiée dans Nom, vous pouvez la modifier.
-
Description : (facultatif) Description du dictionnaire de données.
-
Balises : (facultatif) Pour créer une balise personnalisée, saisissez la valeur dans le champ de texte et appuyez sur Entrée. Vous pouvez voir votre balise sous le champ de texte des balises. Lorsque vous enregistrez ce texte, les balises nouvellement ajoutées sont également créées.
-
Propriétés étendues : (facultatif) sélectionnez Ajouter un champ pour spécifier des attributs de métadonnées pour votre dictionnaire de données. Dans la colonne Nom de la propriété, saisissez un nom de propriété unique. Dans la colonne Valeur, saisissez une valeur à associer à la propriété.
-
-
(Facultatif) Pour charger une définition de schéma XSD pour votre dictionnaire de données, sélectionnez Charger un schéma XML dans le volet Structure du dictionnaire de données. Recherchez le fichier XSD, sélectionnez-le et cliquez sur Ouvrir. Un dictionnaire de données est créé en fonction du schéma XML chargé. Vous devez ajuster les noms d’affichage et les descriptions des éléments dans le dictionnaire de données. Pour ce faire, sélectionnez les nom des éléments en cliquant dessus et modifiez leur description, leur nom d’affichage, ou d’autres détails dans les champs du panneau de droite.
Pour plus d’informations sur les éléments de dictionnaire de données calculés, consultez la section Eléments de dictionnaire de données calculés.
note note NOTE Vous pouvez ignorer le chargement du fichier de schéma et créer entièrement votre dictionnaire de données à l’aide de l’interface utilisateur. Pour ce faire, ignorez cette étape et passez aux étapes suivantes. -
Sélectionnez Suivant.
-
Dans l’écran Ajouter des propriétés, ajoutez les éléments au dictionnaire de données. Vous pouvez également ajouter/supprimer des éléments et modifier leurs détails si vous avez chargé un schéma pour obtenir une structure de base du dictionnaire de données.
Vous pouvez appuyer sur les trois points à droite d’un élément et ajouter un élément à la structure du dictionnaire de données.
Sélectionnez Élément composite, Élément de collection ou Élément primitif.
- Un DDE composite contient d’autres éléments de dictionnaire de données qui peuvent être de type primitif, composite ou de collection. Par exemple, une adresse, qui se compose d’un nom de rue, d’une ville, d’une province, d’un pays et d’un code postal.
- Les DDE simples sont des éléments tels que des chaînes, des nombres, des dates et des valeurs booléennes qui contiennent des informations telles qu’un nom de ville.
- Une collection est une liste de DDE simples ou composites similaires. Par exemple, un client ou une cliente avec plusieurs emplacements différents ou des adresses de facturation et de livraison différentes.
Voici quelques règles pour créer un dictionnaire de données :
- Seul le type composite est autorisé en tant que DDE de niveau supérieur dans un dictionnaire de données.
- Le nom, le nom de référence et le type d’élément sont des champs obligatoires pour un dictionnaire de données et des DDE.
- Le nom de référence doit être unique.
- Un DDE parent (composite) ne peut pas avoir deux enfants portant le même nom.
- Les énumérations contiennent uniquement des types de chaînes primitifs.
Pour plus d’informations sur les éléments composites, de collection ou primitifs et l’utilisation d’éléments de dictionnaire de données, consultez la section Mapper des éléments du dictionnaire de données avec le schéma XML.
Pour plus d’informations sur les validations dans le dictionnaire de données, consultez la section Validations de l’Éditeur du dictionnaire de données.
-
(Facultatif) Après la sélection d’un élément, vous pouvez ajouter des propriétés dans l’onglet Avancé (attributs). Vous pouvez également sélectionner Ajouter un champ et étendre les propriétés d’un élément de dictionnaire de données.
-
(Facultatif) Vous pouvez supprimer n’importe quel élément en cliquant sur les trois points du côté droit d’un élément et en sélectionnant Supprimer.
note note NOTE La suppression d’un élément composite ou de collection avec des nœuds enfants supprime également ses nœuds enfants. -
(Facultatif) Sélectionnez un élément dans le volet Structure du dictionnaire de données et dans le volet Liste des champs et des variables. Modifiez ou ajoutez les attributs requis associés à l’élément.
-
Sélectionnez Enregistrer.
Créer des copies d’un ou de plusieurs dictionnaires de données create-copies-of-one-or-more-data-dictionary
Pour créer rapidement un ou plusieurs dictionnaires de données avec des propriétés et des éléments similaires aux dictionnaires de données existants, vous pouvez les copier et les coller.
- Sélectionnez le dictionnaire de données approprié dans la liste des dictionnaires de données. L’interface utilisateur affiche l’icône Copier.
- Sélectionnez Copier. L’interface utilisateur affiche l’icône Coller.
- Sélectionnez Coller. La boîte de dialogue Coller s’affiche. Le système attribue automatiquement des noms et des titres aux nouveaux dictionnaires de données.
- Si nécessaire, modifiez le titre et le nom sous lesquels vous souhaitez enregistrer la copie du dictionnaire de données.
- Sélectionnez Coller. La copie du dictionnaire de données est créée. À présent, vous pouvez effectuer les modifications nécessaires dans votre dictionnaire de données nouvellement créé.
Voir les fragments de document ou les documents qui font référence à un élément du dictionnaire de données. see-the-document-fragments-or-documents-that-refer-to-a-data-dictionary-element
Au cours de la modification ou de l’affichage d’un dictionnaire de données, vous pouvez afficher les éléments du dictionnaire de données auxquels il est fait référence, ainsi que les textes, les conditions, les lettres et les communications interactives où ils se trouvent.
-
Procédez de l’une des manières suivantes pour modifier le dictionnaire de données :
- Pointez sur un dictionnaire de données, puis sélectionnez Modifier.
- Sélectionnez un dictionnaire de données, puis sélectionnez Modifier dans l’en-tête.
- Pointez sur un dictionnaire de données, puis sélectionnez Sélectionner. Ensuite, sélectionnez Modifier dans l’en-tête.
Ou sélectionnez un dictionnaire de données pour l’afficher.
-
Dans le dictionnaire de données, sélectionnez un élément simple pour le sélectionner. Les éléments composites et de collection ne comportent pas de références.
Avec les propriétés de base et avancées de l’élément, le contenu prêté s’affiche également.
-
Sélectionnez Contenu prêté.
L’onglet Contenu prêté s’affiche avec les éléments suivants : Textes, Conditions, Lettres et Communications interactives. Chacun de ces en-têtes affiche également le nombre de références à l’élément sélectionné.
-
Sélectionnez un en-tête pour afficher le nom des ressources qui font référence à l’élément.
-
Pour afficher le contenu prêté pour un autre élément, sélectionnez l’élément.
-
Pour afficher une ressource qui fait référence à l’élément, sélectionnez son nom. Le navigateur affiche la ressource, la lettre ou la communication interactive.
Utilisation des données de test working-with-test-data
-
Sur la page Dictionnaires de données, sélectionnez Sélectionner.
-
Sélectionnez un dictionnaire de données dont vous souhaitez télécharger les données de test, puis sélectionnez Télécharger lʼexemple de données XML.
-
Sélectionnez OK dans le message d’alerte. Un fichier XML se télécharge.
-
Ouvrez le fichier XML avec le Bloc-notes ou un autre éditeur XML. Le fichier XML a la même structure que le dictionnaire de données et les chaînes d’espaces réservés dans les éléments. Remplacez les chaînes d’espace réservé par les données avec lesquelles vous souhaitez tester une lettre.
code language-xml <?xml version="1.0" encoding="UTF-8" standalone="no"?> <Company> <Name>string</Name> <Type>string</Type> <HeadOfficeAddress> <Street>string</Street> <City>string</City> <State>string</State> <Zip>string</Zip> </HeadOfficeAddress> <SalesOfficeAddress> <Street>string</Street> <City>string</City> <State>string</State> <Zip>string</Zip> </SalesOfficeAddress> <HeadCount>1.0</HeadCount> <CEO> <PersonName> <FirstName>string</FirstName> <MiddleName>string</MiddleName> <LastName>string</LastName> </PersonName> <DOB>string</DOB> <CurrAddress> <Street>string</Street> <City>string</City> <State>string</State> <Zip>string</Zip> </CurrAddress> <DOJ>14-04-1973</DOJ> <Phone>1.0</Phone> </CEO> </Company>note note NOTE Dans cet exemple, le code XML crée un espacement de trois valeurs pour un élément de collection, mais le nombre de valeurs peut être augmenté ou réduit selon vos besoins. -
Une fois les entrées de données réalisées, vous pouvez utiliser ce fichier XML lorsque vous prévisualisez une lettre avec des données de test.
Vous pouvez ajouter ces données de test avec DD (sélectionnez DD, cliquez sur Charger des données de test et chargez ce fichier XML).
Après cette étape, lorsque vous prévisualiserez une lettre normalement (et non de façon personnalisée), ces données XML seront utilisées dans la lettre. Vous pouvez également sélectionner Personnalisé, puis charger ce fichier XML.
Exemples samples
Les exemples de code suivants illustrent les détails d’implémentation pour le Dictionnaire de données.
Exemple de schéma pouvant être chargé dans le dictionnaire de données sample-schema-that-can-be-uploaded-to-the-data-dictionary
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns="DCT" targetNamespace="DCT" xmlns:xs="https://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="Company">
<xs:complexType>
<xs:sequence>
<xs:element name="Name" type="xs:string"/>
<xs:element name="Type" type="xs:anySimpleType"/>
<xs:element name="HeadOfficeAddress" type="Address"/>
<xs:element name="SalesOfficeAddress" type="Address" minOccurs="0"/>
<xs:element name="HeadCount" type="xs:integer"/>
<xs:element name="CEO" type="Employee"/>
<xs:element name="Workers" type="Employee" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="Employee">
<xs:complexContent>
<xs:extension base="Person">
<xs:sequence>
<xs:element name="CurrAddress" type="Address"/>
<xs:element name="DOJ" type="xs:date"/>
<xs:element name="Phone" type="xs:integer"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Person">
<xs:sequence>
<xs:element name="PersonName" type="Name"/>
<xs:element name="DOB" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Name">
<xs:sequence>
<xs:element name="FirstName" type="xs:string"/>
<xs:element name="MiddleName" type="xs:string"/>
<xs:element name="LastName" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Address">
<xs:sequence>
<xs:element name="Street" type="xs:string"/>
<xs:element name="City" type="xs:string"/>
<xs:element name="State" type="xs:string"/>
<xs:element name="Zip" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Attributs communs associés à un DDE common-attributes-associated-with-a-dde
Le tableau suivant décrit les attributs communs associés à un DDE :
Éléments calculés du dictionnaire de données computedddelements
Un dictionnaire de données peut également inclure des éléments calculés. Un élément calculé de dictionnaire de données est toujours associé à une expression. Cette expression est évaluée pour obtenir la valeur d’un élément de dictionnaire de données au moment de l’exécution. Une valeur de DDE calculée est une fonction d’autres valeurs ou littéraux de DDE. Par défaut, les expressions EL (Expression Language) JSP sont prises en charge. Les expressions EL utilisent les caractères ${ } et les expressions valides peuvent inclure des littéraux, des opérateurs, des variables (références d’élément de dictionnaire de données) et des appels de fonction. Tout en faisant référence à un élément de dictionnaire de données dans l’expression, le nom de référence de DDE est utilisé. Le chemin d’accès est unique pour chaque élément de dictionnaire de données au sein d’un dictionnaire de données.
Un DDE calculé de type PersonfullName peut être associé à une expression de concaténation EL telle que ${PersonFirstName} ${PersonLastName}.
Mappage de type de données entre XSD et le dictionnaire de données data-type-mapping-between-xsd-and-data-dictionary-br
L’exportation d’un schéma XSD nécessite un mappage de données spécifique, détaillé dans le tableau ci-dessous. La colonne DDI indique le type de la valeur DDE disponible dans la DDI.
Téléchargement d’un fichier de données d’exemple d’un dictionnaire de données download-a-sample-data-file-from-a-data-dictionary
Une fois que vous avez créé un dictionnaire de données, vous pouvez le télécharger sous forme d’un fichier de données d’exemple XML pour y effectuer des entrées de texte.
-
Dans la page Dictionnaires de données, sélectionnez Sélectionner, puis sélectionnez un dictionnaire de données.
-
Sélectionnez Télécharger l’exemple de données XML.
-
Sélectionnez OK dans le message d’alerte.
Correspondence Management crée un fichier XML basé sur la structure du dictionnaire de données sélectionné et le télécharge vers votre ordinateur avec le nom <nom-du-dictionnaire-de-données>-SampleData. Vous pouvez désormais modifier ce fichier dans un éditeur XML ou de texte pour créer des entrées de données lors de la création d’une lettre.
Internationalisation des métadonnées internationalization-of-meta-data
Lorsque vous souhaitez envoyer la même lettre dans différentes langues à votre clientèle, vous pouvez localiser le nom, la description et les valeurs d’énumération du dictionnaire de données et des Éléments du dictionnaire de données.
Localisation du dictionnaire de données localize-data-dictionary
-
Sur la page de dictionnaires de données, sélectionnez Sélectionner puis sélectionnez un dictionnaire de données.
-
Sélectionnez Télécharger des données de localisation.
-
Sélectionnez OK dans l’alerte. Correspondence Management télécharge un fichier zip dans votre ordinateur avec pour nom DataDictionary-<DDname>.zip.
-
Le fichier .zip contient un fichier .properties. Ce fichier définit le dictionnaire de données téléchargé. Le contenu du fichier de propriétés est semblable au contenu suivant :
code language-ini #Wed May 20 16:06:23 BST 2015 DataDictionary.EmployeeDD.description= DataDictionary.EmployeeDD.displayName=EmployeeDataDictionary DataDictionaryElement.name.description= DataDictionaryElement.name.displayName=name DataDictionaryElement.person.description= DataDictionaryElement.person.displayName=personLa structure du fichier de propriétés définit une ligne chacune pour la description et le nom d’affichage pour le dictionnaire de données et chaque élément du dictionnaire de données dans le dictionnaire de données. En outre, le fichier de propriétés définit une ligne pour une valeur d’énumération définie pour chaque élément du dictionnaire de données. Comme avec un dictionnaire de données, le fichier de propriétés correspondant peut avoir plusieurs définitions d’éléments de dictionnaire de données. En outre, le fichier peut contenir des définitions pour un ou plusieurs ensembles de valeur d’énumération.
-
Pour mettre à jour le fichier .properties dans une langue différente, mettez à jour le nom d’affichage et les valeurs de description dans le fichier. Créez plus d’instances du fichier pour chaque langue à localiser. Seuls le français, l’allemand, le japonais et l’anglais sont pris en charge.
-
Enregistrez les différents fichiers de propriétés mis à jour avec les noms suivants :
_fr_FR.properties (français)
_de_DE.properties (allemand)
_ja_JA.properties (japonais)
_en_EN.properties (anglais)
-
Archivez le fichier .properties (ou les fichiers si vous avez plusieurs langues) dans un fichier .zip unique.
-
Dans la page du Dictionnaires de données, sélectionnez Plus > Charger les données de localisation et sélectionnez le fichier .zip contenant des fichiers de propriétés localisés.
-
Pour afficher les modifications de localisation, modifiez la langue de votre navigateur.
Validations du dictionnaire de données ddvalidations
L’Éditeur du dictionnaire de données impose les validations suivantes lors de la création ou de la mise à jour d’un dictionnaire de données.
- Seul le type Composite est autorisé en tant qu’élément de niveau supérieur dans la définition du dictionnaire de données.
- Les éléments Composite et Collection ne sont pas autorisés au niveau de la feuille. Seuls les éléments de type primitif (chaîne, date, nombre, booléen) sont autorisés au niveau de la feuille. Cette validation permet de s’assurer qu’il n’existe aucun élément Composite et Collection sans DDE enfant.
- Lors du chargement d’un fichier XSD pour créer un dictionnaire de données, l’Éditeur de dictionnaire de données invite à importer un seul élément de niveau supérieur, s’il en existe plusieurs, afin de créer le dictionnaire de données.
- Le nom est le seul paramètre obligatoire pour un dictionnaire de données.
- Un DDE parent (composite) ne peut pas avoir deux enfants portant le même nom.
- Fait en sorte qu’un DDE soit marqué comme calculé, dans le cas où il ne s’agit pas d’un paramètre obligatoire. Un élément obligatoire ne peut pas être calculé et un élément calculé ne peut pas être obligatoire. Aussi, les éléments Collection et Composite ne peuvent pas être des éléments calculés.
- L’Éditeur de dictionnaire de données fait en sorte qu’un DDE soit marqué comme obligatoire uniquement lorsqu’il n’est pas calculé. Il s’assure également qu’il n’est pas l’élément de collection collectionElement indiquant le type de collection (c’est-à-dire le seul enfant d’un élément de collection).
- Les clés vides ou dupliquées ne sont pas autorisées dans les propriétés étendues d’un dictionnaire de données ou d’un DDE.
- N’utilisez pas les caractères deux-points (:) ou de barre verticale (|) au sein de la clé ou la valeur d’une propriété étendue. Il n’existe aucune validation pour l’utilisation de ces caractères interdits.
Validations appliquées au niveau du dictionnaire de données
- Le nom du dictionnaire de données ne doit pas être nul.
- Le nom du dictionnaire de données ne doit contenir que des caractères alphanumériques.
- La liste des éléments enfants dans le dictionnaire de données ne doit pas être nulle ou vide.
- Le dictionnaire de données ne doit pas contenir plusieurs éléments de dictionnaire de données de niveau supérieur.
- Seul le type Composite est autorisé en tant qu’élément de niveau supérieur dans la définition du dictionnaire de données.
Validations appliquées au niveau de l’élément du dictionnaire de données.
- Aucun nom de DDE ne doit être nul et contenir d’espaces.
- Tous les DDE doivent comporter un type d’élément « not null/non null ».
- Tous les noms de référence de DDE doivent être non nuls.
- Tous les noms de référence de DDE doivent être uniques.
- Tous les noms de référence de DDE doivent uniquement contenir des caractères alphanumériques et le signe « _ ».
- Tous les noms d’affichage de DDE doivent uniquement contenir des caractères alphanumériques et le signe « _ ».
- Les éléments Composite et Collection ne sont pas autorisés au niveau de la feuille. Seuls les éléments de type primitif (chaîne, date, nombre, booléen) sont autorisés au niveau de la feuille. Cette validation permet de s’assurer qu’il n’existe aucun élément Composite et Collection sans DDE enfant.
- Un DDE composite parent ne doit pas comporter deux éléments enfants portant le même nom.
- Le sous-type ENUM est utilisé uniquement pour les éléments String et Number.
- Les éléments Collection et Composite ne peuvent pas être calculés.
- Un DDE ne peut pas être à la fois calculé et obligatoire.
- Les DDE calculés doivent contenir une expression valide.
- Les DDE calculés ne doivent pas comporter de liaison XML.
- Un DDE qui indique le type d’un DDE de collection ne peut être ni calculé ni obligatoire.
- Les DDE du sous-type ENUM ne doivent pas contenir de jeux de valeurs nuls ou vides.
- La liaison XML d’un DDE de collection ne doit pas correspondre à un attribut.
- La syntaxe de liaison XML doit être valide, par exemple, un seul @ apparaît, le caractère @ n’est autorisé que lorsqu’il est suivi d’un nom d’attribut.
Mappage des éléments du dictionnaire de données avec le schéma XML mappingddetoschema
Vous pouvez créer un dictionnaire de données à partir d’un schéma XML ou le créer à l’aide de l’interface utilisateur du dictionnaire de données. Tous les éléments du dictionnaire de données (DDE) d’un dictionnaire de données possèdent un champ de liaison XML pour stocker la liaison du DDE à un élément du schéma XML. La liaison dans chaque DDE dépend du DDE parent.
Les exemples de modèles et de codes indiquant les détails d’implémentation pour le Dictionnaire de données sont détaillés ci-dessous.
Mappage des éléments simples (primitifs) mapping-simple-primitive-elements
Un DDE primitif représente un champ ou un attribut atomique par nature. Les DDE primitifs définis en dehors du cadre d’un type complexe (DDE composite) ou d’un élément répété (DDE de collection) peuvent être stockés à n’importe quel emplacement dans le schéma XML. L’emplacement des données correspondant à un DDE primitif ne dépend pas du mappage de son DDE parent. Les DDE primitifs utilisent les informations de mappage à partir du champ de liaison XML pour déterminer sa valeur et le mappage les traduit par l’un des objets suivants :
- un attribut ;
- un élément ;
- un contexte de texte ;
- rien (un DDE ignoré).
L’exemple suivant illustre un schéma simple.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="https://www.w3.org/2001/XMLSchema">
<xs:element name='age' type='integer'/>
<xs:element name='price' type='decimal'/>
</xs:schema>
Mappage des éléments composites mapping-composite-elements
La liaison n’est pas prise en charge pour les éléments composites. Si la liaison est fournie, elle est ignorée. La liaison de tous les DDE enfants constitutifs de type primitif doit être absolue. L’autorisation du mappage absolu pour les éléments enfants d’un DDE composite offre plus de flexibilité en termes de liaison XPath. Le mappage d’un DDE composite à un élément de type complexe dans le schéma XML limite la portée de la liaison pour ses éléments enfants.
L’exemple suivant illustre le schéma d’une note.
<xs:element name="note">
<xs:complexType>
<xs:sequence>
<xs:element name="to" type="xs:string"/>
<xs:element name="from" type="xs:string"/>
<xs:element name="heading" type="xs:string"/>
<xs:element name="body" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Mappage des éléments de collection mapping-collection-elements
Un élément Collection est uniquement mappé à un autre élément Collection de cardinalité > 1. Les DDE enfants d’un DDE Collection ont des liaisons XML relatives (locales) par rapport à la liaison XML de leur DDE parent. Étant donné que les DDE enfants d’un élément Collection doivent avoir la même cardinalité que celle du DDE parent, la liaison relative est chargée d’assurer la contrainte de cardinalité de sorte que le DDE enfant ne pointe pas vers un élément de schéma XML non répété. Dans l’exemple ci-dessous, la cardinalité de « TokenID » doit être la même que celle de « Tokens », son DDE Collection parent.
Lors du mappage d’un DDE de collection à un élément de schéma XML :
-
La liaison de la DDE correspondant à l’élément Collection doit être le XPath absolu.
-
Ne fournissez aucune liaison pour le DDE représentant le type d’élément Collection. Si une liaison est fournie, elle sera ignorée.
-
La liaison pour tous les DDE enfants d’éléments de collection doit être relative à l’élément de collection parent.
Le schéma XML ci-dessous déclare un élément portant le nom Tokens et doté d’un attribut maxOccurs de type « unbounded » (illimité). Par conséquent, Tokens est un élément Collection.
<?xml version="1.0" encoding="utf-8"?>
<Root>
<Tokens>
<TokenID>string</TokenID>
<TokenText>
<TextHeading>string</TextHeading>
<TextBody>string</TextBody>
</TokenText>
</Tokens>
<Tokens>
<TokenID>string</TokenID>
<TokenText>
<TextHeading>string</TextHeading>
<TextBody>string</TextBody>
</TokenText>
</Tokens>
<Tokens>
<TokenID>string</TokenID>
<TokenText>
<TextHeading>string</TextHeading>
<TextBody>string</TextBody>
</TokenText>
</Tokens>
</Root>
Le fichier Token.xsd associé à cet exemple serait :
<xs:element name="Root">
<xs:complexType>
<xs:sequence>
<xs:element name="Tokens" type="TokenType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="TokenType">
<xs:sequence>
<xs:element name="TokenID" type="xs:string"/>
<xs:element name="TokenText">
<xs:complexType>
<xs:sequence>
<xs:element name="TextHeading" type="xs:string"/>
<xs:element name="TextBody" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>