Show Menu
SUJETS×

Créez un schéma à l’aide de la variable Schema Editor

The Schema Registry provides a user interface and RESTful API from which you can view and manage all resources in the Adobe Experience Platform Schema Library. The Schema Library contains resources made available to you by Adobe, Experience Platform partners, and vendors whose applications you use, as well as resources that you define and save to the Schema Registry.
This tutorial covers the steps for creating a schema using the Schema Editor within Experience Platform. Si vous préférez composer un schéma à l’aide de l’API Schema Registry, veuillez commencer par lire le guide de développement du registre des schémas avant de vous lancer dans le tutoriel sur la création d’un schéma à l’aide de l’API .
Ce tutoriel comprend également des étapes pour définir une nouvelle classe que vous pourrez ensuite utiliser pour composer un schéma.

Prise en main

Ce tutoriel exige une bonne compréhension des différents aspects d’Adobe Experience Platform inhérents à l’utilisation de l’éditeur de schémas. Avant de commencer ce tutoriel, veuillez consulter la documentation relative aux concepts suivants :
Ce tutoriel nécessite d’avoir accès à Experience Platform. If you do not have access to an IMS Organization in Experience Platform, please speak to your system administrator before proceeding.

Exploration des schémas existants dans l’espace de travail des schémas

The Schemas workspace within Experience Platform provides a visualization of the Schema Library, allowing you to view and manage all of the schemas available to you, as well as compose new ones. L’espace de travail comprend également l’éditeur de schémas, le canevas sur lequel vous allez composer un schéma tout au long de ce tutoriel.
After logging into Experience Platform, click Schemas in the left-hand navigation and you will be taken to the Schemas workspace. You will see a list of schemas (a representation of the Schema Library) where you can view, manage, and customize all schemas available to you. La liste comprend le nom, le type, la classe et le comportement (enregistrement ou série chronologique) sur lesquels repose le schéma, ainsi que la date et l’heure de la dernière modification du schéma.
Cliquez sur l’icône de filtrage à côté de la barre de recherche afin d’utiliser les fonctionnalités de filtrage pour toutes les ressources du registre, y compris les classes, les mixins et les types de données.

Création et attribution d’un nom à un schéma

Pour commencer à composer un schéma, cliquez sur Créer un schéma dans le coin supérieur droit de l’espace de travail des schémas.
L’ éditeur de schémas s’affiche. C’est le canevas sur lequel vous allez composer votre schéma. Lorsque vous arrivez dans l’éditeur, un « Schéma sans titre » est automatiquement créé dans la section Structure du canevas pour que vous puissiez commencer à le personnaliser.
Dans la partie droite de l’éditeur se trouvent les propriétés du schéma où vous pouvez donner un nom au schéma (en utilisant le champ Nom d’affichage ). Une fois qu’un nom est saisi, le canevas se met à jour pour tenir compte du nouveau nom du schéma.
Plusieurs éléments importants doivent être pris en compte lors du choix d’un nom pour votre schéma :
  • Le nom d’un schéma doit être court et descriptif afin qu’il puisse être facilement retrouvé par la suite dans la bibliothèque.
  • Le nom d’un schéma doit être unique, ce qui signifie qu’il doit également être suffisamment précis pour ne pas être réutilisé à l’avenir. Par exemple, si votre organisation dispose de programmes de fidélité distincts pour différentes marques, nous vous conseillons de nommer votre schéma « Brand A Loyalty Members » pour faciliter la distinction avec d’autres schémas relatifs à la fidélité que vous pourriez définir ultérieurement.
  • Vous pouvez éventuellement fournir des informations supplémentaires sur le schéma en utilisant le champ Description .
Ce tutoriel compose un schéma pour ingérer les données relatives aux membres d’un programme de fidélité, c’est pourquoi le schéma est nommé « Loyalty Members ».

Attribution d’une classe

Dans la partie gauche de l’éditeur se trouve la section Composition . Elle contient actuellement deux sous-sections : Schéma et Classe .
Maintenant que le schéma a un nom, il est temps d’attribuer la classe que le schéma va mettre en œuvre. Cliquez sur Attribuer en regard de Classe .
La boîte de dialogue Attribuer une classe s’affiche. Cette fenêtre affiche une liste de toutes les classes disponibles, y compris celles définies par votre organisation (le propriétaire étant « Client ») ainsi que les classes standard définies par Adobe.
Cliquez sur le nom de la classe pour afficher sa description. Vous pouvez également choisir l’option Prévisualiser la structure de la classe pour voir les champs et les métadonnées associés à la classe.
This tutorial uses the XDM Individual Profile class. Cliquez sur le bouton radio en regard de la classe pour la sélectionner, puis cliquez sur Attribuer une classe .
Le canevas réapparaît. The Class section now contains the class you selected (XDM Individual Profile) and the fields contributed by the XDM Individual Profile class are now visible within the Structure section.
Les champs s’affichent au format « fieldName | Data Type ». Les étapes de définition des champs de schéma dans l’interface utilisateur sont expliquées dans la suite de ce tutoriel.
Vous pouvez modifier la classe d’un schéma à tout moment au cours du processus de composition initial avant que le schéma ne soit enregistré, mais cela doit être fait avec la plus grande prudence. Les mixins ne sont compatibles qu’avec certaines classes. Par conséquent, la modification de la classe réinitialisera le canevas et tous les champs que vous avez ajoutés.

Ajout d’un mixin

Maintenant qu’une classe a été attribuée, la section Composition contient une troisième sous-section : Mixins .
Vous pouvez maintenant commencer à ajouter des champs à votre schéma grâce à l’ajout de mixins. Un mixin est un groupe d’un ou de plusieurs champs qui décrivent un concept particulier. Ce tutoriel utilise des mixins pour décrire les membres du programme de fidélité et recueillir des informations clés telles que le nom, la date d’anniversaire, le numéro de téléphone, l’adresse, etc.
Pour ajouter un mixin, cliquez sur Ajouter dans la sous-section Mixins .
La boîte de dialogue Ajouter un mixin s’affiche. Mixins are only intended for use with specific classes, therefore the list of mixins shows only those compatible with the class you selected (in this case, the XDM Individual Profile class).
En sélectionnant le bouton radio à côté d’un mixin, vous aurez la possibilité de prévisualiser la structure du mixin . Sélectionnez le mixin « Profile Person Details », puis cliquez sur Ajouter un mixin .
Le canevas du schéma réapparaît. The Mixins section now lists the "Profile Person Details" mixin and the Structure section includes the fields contributed by the mixin.
Ce mixin met à disposition plusieurs champs sous le nom de premier niveau « person » avec le type de données « Person ». Ce groupe de champs décrit les informations sur un individu, notamment son nom, sa date de naissance et son genre.
Remember that fields may use scalar types (such as string, integer, array, or date) as their data type, as well as any "data type" (a group of fields representing a common concept) in the Schema Registry.
Notice that the "name" field has a data type of "Person Name", meaning it too describes a common concept and contains name-related sub-fields such as first name, last name, and full name.
Cliquez sur les différents champs dans le canevas pour voir les champs supplémentaires contribuant à la structure du schéma.

Ajout d’un autre mixin

Vous pouvez maintenant répéter les mêmes étapes pour ajouter un autre mixin. When you view the Add Mixin dialog this time, notice that the "Profile Person Details" mixin has been greyed out and the radio button next to it cannot be selected. Cela vous évite de dupliquer accidentellement des mixins que vous avez déjà inclus dans le schéma actuel.
Vous pouvez maintenant ajouter "Profile Personal Details" mixin depuis la boîte de dialogue Ajouter le mixin .
Une fois ajouté, le canevas réapparaît. The "Profile Personal Details" is now listed under Mixins in the Composition section, and fields for home address, mobile phone, and more have been added under Structure .
Similar to the "name" field, the fields you just added represent multi-field concepts. For example, "homeAddress" has a data type of "Address" and "mobilePhone" has a data type of "Phone Number". Vous pouvez cliquer sur chacun de ces champs pour les développer et afficher les champs supplémentaires inclus dans le type de données.

Définition d’un nouveau mixin

The "Loyalty Members" schema is meant to capture data related to the members of a loyalty program, so it will require some specific loyalty-related fields. Il n’existe pas de mixins standard qui contiennent les champs nécessaires. Vous devrez donc définir un nouveau mixin.
Cette fois, lorsque vous ouvrez la boîte de dialogue Ajouter un mixin , sélectionnez Créer un mixin . Il vous sera alors demandé de fournir un nom d’affichage et une description pour votre mixin.
Comme pour les noms de classe, le nom du mixin doit être court et simple, décrivant ce que le mixin va apporter au schéma. Ces noms sont également uniques. Vous ne pourrez donc pas réutiliser le nom et devrez donc veiller à ce qu’il soit suffisamment spécifique.
For this tutorial, name the new mixin "Loyalty Details".
Cliquez sur Ajouter un mixin pour revenir à l’éditeur de schémas. "Loyalty Details" should now appear under Mixins on the left-side of the canvas, but there are no fields associated with it yet and therefore no new fields appear under Structure .

Ajout de champs au mixin

Now that you have created the "Loyalty Details" mixin, it is time to define the fields that the mixin will contribute to the schema.
Pour commencer, cliquez sur le nom du mixin dans la section Mixins . Une fois que vous avez effectué cette opération, la section Propriétés du mixin apparaît sur le côté droit de l’éditeur et un bouton Ajouter un champ s’affiche à côté du nom du schéma sous Structure .
Click Add Field next to "Loyalty Members" to create a new node in the structure. Ce nœud (appelé « _tenantId » dans cet exemple) représente l’identifiant du client de votre organisation IMS, précédé d’un caractère de soulignement. La présence de l’identifiant du client indique que les champs que vous ajoutez sont contenus dans l’espace de noms de votre organisation.
In other words, the fields you are adding are unique to your organization and are going to be saved in the Schema Registry in a specific area accessible only to your IMS Org. Fields you define must always be added to your namespace to prevent collisions with names from other standard classes, mixins, data types, and fields.
Inside that namespaced node is a "New Field". This is the beginning of the "Loyalty Details" mixin.
Using Field Properties on the right-hand side of the editor, start by creating a "loyalty" field with type "Object" that will be used to hold your loyalty-related fields. Lorsque vous avez terminé, cliquez sur Appliquer .
The changes are applied and the newly created "loyalty" object appears. Cliquez sur Ajouter un champ à côté de l’objet pour ajouter des champs supplémentaires liés à la fidélité. Un « Nouveau champ » apparaît et la section Propriétés du champ est visible sur le côté droit du canevas.
Chaque champ nécessite les informations suivantes :
  • Nomdu champ : ​Le nom du champ, écrit dans le boîtier du chameau. Exemple : loyaltyLevel
  • Nomd'affichage : ​Nom du champ, écrit en cas de titre. Exemple : Loyalty Level
  • Type: ​Type de données du champ. This includes basic scalar types and any data types defined in theSchema Registry. Exemples : string, integer, boolean, Person, Address, Phone Number, etc. (chaîne, entier, booléen, Personne, Adresse, Numéro de téléphone, etc.)
  • Description: ​Une description facultative du champ doit être incluse, écrite en cas de phrase. (200 caractères max.)
The first field for the Loyalty object will be a string called "loyaltyId". When setting the new field's type to "String", the Field Properties window becomes populated with several options for applying constraints, including Default Value , Format , and Maximum Length .
Différentes options de contraintes sont disponibles selon le type de données sélectionné. Since "loyaltyId" will be an email address, select "email" from the Format dropdown menu. Sélectionnez Appliquer pour appliquer vos modifications.

Ajout de champs supplémentaires au mixin

Now that you have added the "loyaltyId" field, you can add additional fields to capture loyalty-related information such as:
  • Points (nombre entier)
  • Member Since (Membre depuis, date)
Chaque champ est ajouté en cliquant sur Ajouter un champ sur l’objet Loyalty et en renseignant les informations requises.
Une fois cette étape terminée, l’objet Loyalty contiendra des champs pour : Loyalty ID, Points, et Member Since.

Ajout d’un champ « enum » au mixin

Lorsque vous définissez des champs dans l’éditeur de schémas, vous pouvez appliquer certaines options supplémentaires aux types de champs de base afin de limiter davantage les données que le champ peut contenir.
An example of this would be a "Loyalty Level" field, where the value can only be one of four possible options. To add this field to the schema, click Add Field beside the "loyalty" object and fill in the required fields under Field Properties .
Pour Type , sélectionnez « String » et des cases à cocher supplémentaires s’afficheront pour Tableau , Énumération , et Identité .
Cochez la case Énumération pour ouvrir la section Valeurs d’énumération ci-dessous. Ici, vous pouvez saisir la valeur (en Camel Case) et le libellé (nom facultatif et facile à lire écrit en Title Case) pour chaque niveau de fidélité acceptable.
When you have completed all field properties, click Apply and the "loyaltyLevel" field will be added to the "loyalty" object.
Vous trouverez ci-dessous davantage d’informations sur les contraintes supplémentaires disponibles :
  • Obligatoire: ​Indique que le champ est requis pour l’assimilation de données. Toute donnée chargée dans un ensemble de données basé sur ce schéma qui ne contient pas ce champ sera défaillante lors de l’ingestion.
  • Tableau: ​Indique que le champ contient un tableau de valeurs, chacune avec le type de données spécifié. Par exemple, si vous sélectionnez un type de données « String » et que vous cochez la case « Tableau », cela signifie que le champ contiendra un tableau de chaînes.
  • Enum: ​Indique que ce champ doit contenir l’une des valeurs d’une liste énumérée de valeurs possibles.
  • Identité: ​Indique que ce champ est un champ d’identité. Vous trouverez plus d’informations sur les champs d’identité dans la suite de ce tutoriel .

Conversion d’un objet à plusieurs champs en un type de données

After adding several loyalty-specific fields, the "loyalty" object now contains a common data structure that could be useful in other schemas.
Si vous estimez qu’une structure à plusieurs champs peut être réutilisable et que vous souhaitez avoir la possibilité d’utiliser cette même structure de données ailleurs, l’éditeur de schémas vous permet de convertir cette structure en un type de données.
Les types de données permettent l’utilisation cohérente de structures à champs multiples, avec plus de flexibilité que les mixins, car ils peuvent être utilisés n’importe où dans un schéma. Pour ce faire, définissez le type d’un champ dans un mixin par rapport à celui de tout type de données défini dans le registre.
To convert the "loyalty" object to a data type, click on the "loyalty" field under Structure and select Convert to New Data Type on the right-hand-side of the editor under Field Properties . A small green pop-up appears confirming "Object Converted to Data Type".
Now, when you look under Structure , you can see that the "loyalty" field has a data type of "Loyalty" and the fields have small lock icons beside them indicating they are no longer individual fields, but rather part of a multi-field structure.
In a future schema, you could now assign a field the Type of "Loyalty" and it would automatically include Loyalty Level, Points, Member Since, and Loyalty ID fields.

Définition d’un champ de schéma comme champ d’identité

Schemas are used for ingesting data into Experience Platform, and that data is ultimately used to identify individuals and stitch together information coming from multiple sources. To help with this process, key fields can be marked as "Identity" fields.
Experience Platform facilite la désignation d'un champ d'identité grâce à l'utilisation d'une case à cocher Identité dans le Schema Editor.
Par exemple, il peut y avoir des milliers de membres du programme de fidélité appartenant au même « level », mais chaque membre du programme de fidélité a un « loyaltyId » unique (qui, dans ce cas, est l’adresse électronique du membre individuel). Le fait que « loyaltyId » soit un identifiant unique pour chaque membre en fait un bon candidat pour un champ d’identité, contrairement à « level ».
In the Structure section of the editor, click on the "loyaltyId" field that you created and you will see the Identity checkbox appear under Field Properties . Cochez la case et vous aurez la possibilité de la définir comme Identité principale . Cochez également cette case.
Ensuite, vous devez fournir un espace de noms d’identité . There are several pre-defined namespaces, but since the "loyaltyId" is the member's email address, select "Email" from the dropdown list. You can now click Apply to confirm the updates to the "loyaltyId" field.
Now all data ingested into the "loyaltyId" field will be used to help identify that individual and stitch together a single view of that customer.
Une fois qu’un champ du schéma a été défini comme identité principale, vous recevrez un message d’erreur si vous tentez par la suite de définir un autre champ du schéma comme identité principale. Chaque schéma ne peut contenir qu’un seul champ d’identité principal.
Pour en savoir plus sur l’utilisation des identités, consultez la documentation Identity Service .

Enable the schema for use in Real-time Customer Profile

L’éditeur de schémas permet d’activer un schéma à utiliser avec Real-time Customer Profile . Profile fournit une vue globale de chaque client individuel en établissant un profil solide à 360° des attributs du client ainsi qu’un compte horodaté de chaque interaction que le client a eue avec tout système intégré à Experience Platform.
In order for a schema to be enabled for use with Real-time Customer Profile, it must have a primary identity defined. Vous recevrez un message d’erreur « Missing Primary Identity » (Identité primaire manquante) si vous essayez d’activer un schéma sans avoir défini au préalable une identité principale.
To enable the "Loyalty Members" schema for use in Profile, begin by clicking on "Loyalty Members" in the Structure section of the editor.
Dans la partie droite de l’éditeur, sous Propriétés du schéma , des informations sur le schéma sont affichées, notamment son nom d’affichage, sa description et son type. En plus de ces informations, il y a un bouton de basculement intitulé Profile .
Click Profile and a pop-up appears, asking you to confirm that you wish to enable the schema for Profile.
Once a schema has been enabled for Real-time Customer Profile and saved, it cannot be disabled.

Étapes suivantes et ressources supplémentaires

Now that you have finished composing a "Loyalty Members" schema, you can see the complete schema in the Structure section of the editor. Click Save and the schema will be saved to the Schema Library, making it accessible by the Schema Registry.
Votre nouveau schéma peut désormais être utilisé pour ingérer des données dans Platform. Pour rappel, une fois que le schéma a été utilisé pour ingérer des données, seules des modifications additives peuvent être apportées. Reportez-vous aux principes de base de la composition des schémas pour plus d’informations sur le contrôle de version des schémas.
The "Loyalty Members" schema is also available to be viewed and managed using the Schema Registry API. Pour commencer à utiliser l’API, consultez d’abord le guide de développement de l’API Schema Registry .
L’ Platform interface utilisateur illustrée dans les vidéos suivantes est obsolète. Reportez-vous à la documentation ci-dessus pour obtenir les dernières captures d'écran et fonctionnalités de l'interface utilisateur.
La vidéo suivante montre comment créer un schéma simple dans l’ Platform interface utilisateur.

La vidéo ci-dessous est destinée à vous aider à mieux comprendre comment travailler avec des mixins et des classes.

Annexe

Les informations suivantes viennent compléter le tutoriel de l’éditeur de schémas.

Création d’une nouvelle classe

Experience Platform offre la possibilité de définir un schéma basé sur une classe propre à votre organisation.
Ouvrez la boîte de dialogue Attribuer une classe en cliquant sur Attribuer dans la section Classe de l’éditeur de schémas. Within the dialog, select Create New Class .
You can then give your new class a Display Name (a short, descriptive, unique, and user-friendly name for the class), a Description , and a Behavior ("Record" or "Time Series") for the data the schema will define.
Lors de la création d’un schéma qui met en œuvre une classe définie par votre organisation, n’oubliez pas que les mixins ne peuvent être utilisés qu’avec des classes compatibles. Comme la classe que vous avez définie est nouvelle, aucun mixin compatible n’est répertorié dans la boîte de dialogue Ajouter un mixin . Vous devez plutôt sélectionner Créer un mixin et définir un mixin à utiliser avec cette classe. La prochaine fois que vous composerez un schéma mettant en œuvre la nouvelle classe, le mixin que vous avez défini sera répertorié et pourra être utilisé.

Modification de la classe d’un schéma

À tout moment au cours du processus initial de composition du schéma, avant que le schéma ne soit enregistré, vous pouvez modifier la classe sur laquelle repose le schéma.
Réfléchissez bien avant de modifier la classe. Les mixins ne sont compatibles qu’avec certaines classes. Par conséquent, la modification de la classe réinitialise le canevas et supprime tous les champs que vous avez ajoutés à ce stade.
Pour modifier la classe, cliquez sur Attribuer à côté de Classe dans la section Composition de l’éditeur.
Lorsque la boîte de dialogue Attribuer une classe s’ouvre, vous pouvez sélectionner une nouvelle classe dans la liste disponible. Cliquez sur Attribuer une classe et une nouvelle boîte de dialogue s’ouvre, vous demandant de confirmer que vous souhaitez attribuer une nouvelle classe.
Si vous confirmez la modification de la classe, le canevas sera réinitialisé et toute la progression de la composition sera perdue.