Show Menu
SUJETS×

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

L’interface utilisateur de Adobe Experience Platform vous permet de créer et de gérer Experience Data Model (XDM) des schémas dans une trame visuelle interactive appelée le Schema Editor. Ce didacticiel explique comment créer un schéma à l’aide du Schema Editor.
À des fins de démonstration, les étapes de ce didacticiel impliquent la création d’un exemple de schéma décrivant les membres d’un programme de fidélité de la clientèle. Bien que vous puissiez utiliser ces étapes pour créer un schéma différent à vos propres fins, il est recommandé de commencer par créer l’exemple de schéma pour découvrir les fonctionnalités du Schema Editor.
If you prefer to compose a schema using the Schema Registry API instead, start by reading the Schema Registry developer guide before attempting the tutorial on creating a schema using the API .

Prise en main

Ce tutoriel exige une compréhension pratique des différents aspects de Adobe Experience Platform impliqués dans la création de schémas. Avant de commencer ce tutoriel, veuillez consulter la documentation relative aux concepts suivants :

Browse existing schemas in the Schemas workspace

L’espace de travail Schémas de l’ Platform interface utilisateur fournit une visualisation du Schema Libraryrapport, ce qui vous permet de gérer les schémas disponibles pour votre entreprise par vue. The workspace also includes the Schema Editor, the canvas on which you can compose a schema throughout this tutorial.
Après vous être connecté Experience Platform, sélectionnez Schémas dans le volet de navigation de gauche pour ouvrir l'espace de travail Schémas . L’onglet Parcourir affiche une liste de schémas (une représentation du Schema Library) que vous pouvez vue et personnaliser. 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.
Sélectionnez l’icône de filtre en regard de la barre de recherche pour utiliser les fonctionnalités de filtrage pour toutes les ressources du registre, y compris les classes, les mixins et les types de données. Vous pouvez également filtrer les ressources selon qu’elles appartiennent à un Adobe ou à votre organisation et si elles ont été activées pour être utilisées dans Real-time Customer Profile.

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

To begin composing a schema, select Create schema in the top-right corner of the Schemas workspace. Un menu déroulant s'affiche, vous permettant de choisir entre les classes de base XDM Individuel Profil et XDM ExperienceEvent. Si ces classes ne répondent pas à vos besoins, vous pouvez également sélectionner Parcourir pour choisir parmi d'autres classes disponibles ou créer une nouvelle classe .
Pour les besoins de ce didacticiel, sélectionnez Profil ​XDM individuel.
Le Schema Editor apparaît. C’est le canevas sur lequel vous allez composer votre schéma. Puisque vous avez choisi une classe XDM standard pour baser le schéma, un schéma sans titre est automatiquement créé dans la section Structure du canevas lorsque vous arrivez dans l'éditeur, avec les champs standard inclus dans tous les schémas en fonction de cette classe. La classe assignée pour le schéma est également répertoriée sous Classe dans la section Composition .
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, modifier la classe réinitialise le canevas et les champs que vous avez ajoutés.
Utilisez les champs situés à droite de l’éditeur pour fournir un nom d’affichage et une description facultative du schéma. 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 :
  • Les noms des schémas doivent être courts et descriptifs afin que le schéma puisse être facilement trouvé plus tard.
  • 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 également utiliser la description du schéma pour fournir toute information contextuelle supplémentaire concernant le schéma.
Ce didacticiel compose un schéma d’assimilation de données relatives aux membres d’un programme de fidélité. Par conséquent, le schéma est nommé "Membres de fidélité".

Ajout d’un mixin

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 sont souvent utilisés ensemble pour décrire 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.
To add a mixin, select Add in the Mixins sub-section.
Une nouvelle boîte de dialogue s’affiche, affichant une liste de mixins disponibles. Chaque mixin n'est destiné qu'à une classe spécifique. Par conséquent, la boîte de dialogue ne liste que les mixins compatibles avec la classe que vous avez sélectionnée (dans ce cas, la XDM Individual Profile classe). Si vous utilisez une classe XDM standard, la liste des mixins sera triée intelligemment en fonction de la popularité de l’utilisation.
Si vous sélectionnez un mixin dans la liste, il apparaît dans le rail de droite. Vous pouvez sélectionner plusieurs mixins si vous le souhaitez, en ajoutant chacun à la liste dans le rail de droite avant de confirmer. En outre, une icône s’affiche sur le côté droit du mixin actuellement sélectionné, ce qui vous permet de prévisualisation de la structure des champs fournis.
Lors de la prévisualisation d'un mixin, une description détaillée du schéma du mixin est fournie dans le rail droit. Vous pouvez également parcourir les champs du mixin dans la trame fournie. Lorsque vous sélectionnez différents champs, le rail de droite se met à jour pour afficher des détails sur le champ en question. Sélectionnez Précédent lorsque vous avez terminé de prévisualiser pour revenir à la boîte de dialogue de sélection de mixin.
Pour ce didacticiel, sélectionnez le mixin des détails de la personne Profil, puis sélectionnez Ajouter le mixin .
Le canevas du schéma réapparaît. The Mixins section now lists "Profile person details" and the Structure section includes the fields contributed by the mixin. Vous pouvez sélectionner le nom du mixin sous la section Mélanges pour mettre en surbrillance les champs spécifiques qu’il contient dans la trame.
This mixin contributes several fields under the top-level name person with the data type "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 well as any data type (a group of fields representing a common concept) defined within the Schema Registry.
Notice that the name field has a data type of "Full name", meaning it too describes a common concept and contains name-related sub-fields such as first name, last name, courtesy title, and suffix.
Sélectionnez les différents champs de la zone de travail pour afficher les champs supplémentaires qui contribuent à 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 checkbox 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.
Pour ce didacticiel, sélectionnez le mixin "Profile personal details" dans la boîte de dialogue, puis sélectionnez Ajouter le mixin pour l’ajouter au schéma.
Une fois ajouté, le canevas réapparaît. "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 "Postal address" and mobilePhone has a data type of "Phone number". Vous pouvez sélectionner 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".
Sélectionnez Ajouter le mixin pour revenir au Schema Editor. "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.
To begin, select the mixin name in the Mixins section. Once you do this, the mixin's properties appear on the right-hand side of the editor and an Add field button appears next to the name of the schema under Structure .
Select 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.
En d’autres termes, les champs que vous ajoutez sont propres à votre organisation et seront enregistrés dans une zone spécifique accessible uniquement à votre organisation Schema Registry dans une zone spécifique. Les champs que vous définissez doivent toujours être ajoutés à votre espace de nommage locataire afin d’éviter les collisions avec des noms provenant d’autres classes standard, mixins, types de données et champs.
Inside that namespaced node is a "New Field". This is the beginning of the "Loyalty Details" mixin.
Using the controls 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. When finished, select Apply .
The changes are applied and the newly created loyalty object appears. Select Add field next to the object to add additional loyalty-related fields. A "New Field" appears and the Field properties section is visible on the right-hand side of the canvas.
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 the Schema Registry. Examples: String, Integer, Boolean, Person, Address, Phone number, etc.
  • Description: Une description facultative du champ doit être incluse, écrite en cas de phrase, avec un maximum de 200 caractères.
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 section 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.

Add more fields to the mixin

Now that you have added the loyaltyId field, you can add additional fields to capture loyalty-related information such as:
  • Points (entier)
  • Membre depuis (date)
Each field is added by selecting Add field on the loyalty object and filling in the required information.
Une fois terminé, l’objet Fidélité contient des champs pour l’identifiant de fidélité, les points et le membre depuis.

ajouter un champ d’énumération au mixin

When defining fields in the Schema Editor, there are some additional options that you can apply to basic field types in order to provide further constraints on the data the field can contain. Les cas d’utilisation de ces contraintes sont expliqués dans le tableau suivant :
Contrainte
Description
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, l’utilisation de cette contrainte sur un champ dont le type de données est "String" indique 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 .
Relation
Bien que les relations de schéma puissent être déduites par l'utilisation du schéma et Real-time Customer Profilede l'union, cela ne s'applique qu'aux schémas qui partagent la même classe. La contrainte Relation indique que ce champ fait référence à l'identité Principale d'un schéma en fonction d'une classe différente, ce qui implique une relation entre les deux schémas. See the tutorial on defining a relationship for more information.
Pour ce didacticiel, l’ "loyalty" objet du schéma nécessite un nouveau champ d’énumération qui décrit le "niveau de fidélité" d’un client, où la valeur ne peut être que l’une des quatre options possibles. To add this field to the schema, select Add field beside the loyalty object and fill in the required fields for Field name and Display name . Pour Type , sélectionnez "Chaîne".
D’autres cases à cocher s’affichent pour le champ une fois son type sélectionné, notamment les cases Tableau , Enum et Identité .
Select the Enum checkbox to open the Enum values section below. 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.
Une fois toutes les propriétés de champ remplies, sélectionnez Appliquer pour ajouter le champ "loyaltyLevel" à l’ loyalty objet.

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

L’ loyalty objet contient désormais plusieurs champs spécifiques à la fidélité et représente une structure de données commune qui peut s’avérer utile dans d’autres schémas. Le Schema Editor permet d’appliquer facilement des objets réutilisables à plusieurs champs en convertissant la structure de ces objets en types 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 la valeur Type du champ sur celle de tout type de données défini dans le Schema Registry.
To convert the loyalty object to a data type, select the loyalty field under Structure , then select Convert to new data type on the right-hand side of the editor under Field properties . Une fenêtre contextuelle verte s’affiche, confirmant que l’objet a bien été converti.
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 data type.
In a future schema, you could now assign a field the Type of "Loyalty" and it would automatically include fields for ID, loyalty level, member since, and points.

Rechercher et filtrer les champs de schéma

Votre schéma contient désormais plusieurs mixins en plus des champs fournis par sa classe de base. Lorsque vous travaillez avec des schémas plus volumineux, vous pouvez cocher les cases en regard des noms de mixin dans le rail de gauche pour filtrer les champs affichés uniquement ceux fournis par les mixins qui vous intéressent.
Si vous recherchez un champ spécifique dans votre schéma, vous pouvez également utiliser la barre de recherche pour filtrer les champs affichés par nom, quel que soit le mixin sous lequel ils sont fournis.

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

La structure de données standard fournie par les schémas peut être exploitée pour identifier les données appartenant à la même personne sur plusieurs sources, ce qui permet d'utiliser divers cas d'utilisation en aval tels que la segmentation, le rapports, l'analyse des données scientifiques, etc. Pour regrouper les données en fonction des identités individuelles, les champs clés doivent être marqués comme champs Identité dans les schémas applicables.
Experience Platform facilite la désignation d'un champ d'identité grâce à l'utilisation d'une case à cocher Identité dans le Schema Editor. Cependant, vous devez déterminer quel champ est le meilleur candidat à utiliser comme identité, en fonction de la nature de vos données.
For example, there may be thousands of loyalty program members belonging to the same "loyalty level", but each member of the loyalty program has a unique loyaltyId (which in this instance is the individual member's email address). The fact that loyaltyId is a unique identifier for each member makes it a good candidate for an identity field, whereas loyaltyLevel is not.
Les étapes décrites ci-dessous expliquent comment ajouter un descripteur d'identité à un champ de schéma existant. Au lieu de définir des champs d'identité dans la structure du schéma lui-même, vous pouvez également utiliser un identityMap champ pour contenir des informations d'identité.
Si vous prévoyez d'utiliser identityMap , gardez à l'esprit qu'il remplacera toute identité Principale que vous ajouterez directement au schéma. Pour plus d'informations, consultez la section sur identityMap les bases du guide de composition de schéma.
Dans la section Structure de l’éditeur, sélectionnez le loyaltyId champ et la case à cocher Identité s’affiche sous Propriétés du champ. Check the box and the option to set this as the Primary identity appears. Sélectionnez également cette zone.
Chaque schéma ne peut contenir qu’un seul champ d’identité principal. Une fois qu'un champ de 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 d'identité dans le schéma comme Principal.
Ensuite, vous devez fournir un espace de nommage ​d'identité à partir de la liste d'espaces de nommage prédéfinis dans la liste déroulante. Puisque loyaltyId est l’adresse électronique du client, sélectionnez "Courriel" dans la liste déroulante. Sélectionnez Appliquer pour confirmer les mises à jour apportées au loyaltyId champ.
Pour une liste des espaces de nommage standard et de leurs définitions, voir la Identity Service documentation .
Après l’application de la modification, l’icône loyaltyId affiche un symbole d’empreinte digitale, indiquant qu’il s’agit désormais d’un champ d’identité. En outre, le Loyalty Details mixin du rail gauche liste le champ d'identité situé en dessous, ce qui vous permet de déterminer facilement quel mixin d'un schéma fournit ce ou ces champs d'identité de schéma.
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. To learn more about working with identities in Experience Platform, please review the Identity Service documentation.

Enable the schema for use in Real-time Customer Profile

Profil client en temps réel utilise les données d'identité Experience Platform pour fournir une vue holistique de chaque client individuel. Le service crée des profils robustes de 360° d'attributs du client ainsi que des comptes horodatés de chaque interaction que les clients ont eue dans 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 si vous tentez d'activer un schéma sans définir au préalable une identité Principale.
To enable the "Loyalty Members" schema for use in Profile, begin by selecting "Loyalty Members" in the Structure section of the editor.
Sur le côté droit de l’éditeur, des informations sur le schéma, y compris son nom d’affichage, sa description et son type, s’affichent. Outre ces informations, il existe un bouton de bascule Profil .
Select Profile and a popover 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.
Sélectionnez Activer pour confirmer votre choix. Vous pouvez sélectionner à nouveau la bascule Profil pour désactiver le schéma si vous le souhaitez, mais une fois que le schéma a été enregistré alors qu'il Profile est activé, il ne peut plus être désactivé.

Étapes suivantes et ressources supplémentaires

Maintenant que vous avez fini de composer le schéma, vous pouvez voir le schéma complet dans la trame. Sélectionnez Enregistrer et le schéma sera enregistré dans le Schema Libraryfichier, ce qui le rendra accessible par Schema Registryle.
Votre nouveau schéma peut désormais être utilisé pour importer 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.
Vous pouvez maintenant suivre le didacticiel sur la définition d’une relation de schéma dans l’interface utilisateur pour ajouter un nouveau champ de relation au schéma "Membres fidèles".
The "Loyalty Members" schema is also available to be viewed and managed using the Schema Registry API. To begin working with the API, start by reading the Schema Registry API developer guide .

Ressources vidéo

L’ Platform interface utilisateur affiché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 sections suivantes fournissent des informations complémentaires sur l'utilisation de la Schema Editorméthode.

Création d’une nouvelle classe

Experience Platform offre la possibilité de définir un schéma basé sur une classe propre à votre organisation.
Dans l’espace de travail Schémas , sélectionnez Créer un schéma , puis sélectionnez Parcourir dans la liste déroulante.
Une boîte de dialogue s'affiche, vous permettant de choisir parmi une liste de classes disponibles. Dans la partie supérieure de la boîte de dialogue, sélectionnez Créer une classe . 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. Since the class you defined is new, there are no compatible mixins listed in the Add mixin dialog. Instead, you will need to select Create new mixin and define a mixin for use with that class. 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

Vous pouvez modifier la classe d'un schéma à tout moment pendant le processus de composition initial avant que le schéma n'ait été enregistré.
Réassigner la classe à un schéma doit être fait avec une extrême prudence. Les mixins ne sont compatibles qu'avec certaines classes. Par conséquent, modifier la classe réinitialise le canevas et les champs que vous avez ajoutés.
Pour réaffecter une classe, sélectionnez Attribuer dans la partie gauche du canevas.
A dialog appears that displays a list of all available classes, including any defined by your organization (the owner being "Customer") as well as standard classes defined by Adobe.
Sélectionnez une classe dans la liste pour afficher sa description sur le côté droit de la boîte de dialogue. You can also select Preview class structure to see the fields and metadata associated with the class. Sélectionnez Affecter une classe pour continuer.
Une nouvelle boîte de dialogue s'ouvre vous demandant de confirmer que vous souhaitez affecter une nouvelle classe. Sélectionnez Attribuer pour confirmer.
Après avoir confirmé le changement de classe, le canevas sera réinitialisé et tous les progrès de la composition seront perdus.