Créer un schéma à l’aide de l’Schema Editor

L’interface utilisateur d’Adobe Experience Platform vous permet de créer et de gérer des schémas de Experience Data Model (XDM) dans une zone de travail visuelle interactive appelée l’Schema Editor. Ce tutoriel explique comment créer un schéma à l’aide de l’Schema Editor.

À des fins de démonstration, les étapes de ce tutoriel concernent la création d’un exemple de schéma qui décrit les membres d’un programme de fidélité des clients. Vous pouvez utiliser ces étapes pour créer un schéma différent pour vos propres besoins. Cependant, il est recommandé de suivre d’abord la création de l’exemple de schéma pour découvrir les fonctionnalités de l’Schema Editor.

Prise en main

Ce tutoriel demande une bonne compréhension des différents aspects d’Adobe Experience Platform relatifs à la création de schémas. Avant de commencer ce tutoriel, veuillez consulter la documentation relative aux concepts suivants :

Ouvrir l’espace de travail Schemas browse

L’espace de travail Schemas de l’interface utilisateur de Experience Platform permet de visualiser les Schema Library et d’afficher et de gérer les schémas disponibles pour votre organisation. L’espace de travail comprend également l’Schema Editor, la zone de travail sur laquelle vous allez composer un schéma tout au long de ce tutoriel.

Après vous être connecté à Experience Platform, sélectionnez Schemas dans le volet de navigation de gauche pour ouvrir l’espace de travail Schemas. L’onglet Browse affiche une liste des schémas (une représentation de la Schema Library) que vous pouvez afficher 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.

Reportez-vous au guide sur l’exploration des ressources XDM existantes dans l’interface utilisateur pour plus d’informations.

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

Pour commencer à composer un schéma, sélectionnez Create schema dans le coin supérieur droit de l’espace de travail Schemas.

La boîte de dialogue Create a schema s’affiche. Dans cette boîte de dialogue, vous pouvez choisir de créer manuellement un schéma en ajoutant des champs et des groupes de champs, ou de charger un fichier CSV et d’utiliser des algorithmes ML pour générer un schéma. Sélectionnez un workflow de création de schéma dans la boîte de dialogue.

[Beta ​]{class="badge informative"} création manuelle ou assistée par machine learning de schéma manual-or-assisted

Pour découvrir comment utiliser un algorithme ML afin de recommander une structure de schéma basée sur un fichier chargé, consultez le guide de création de schéma assisté par machine learning machine learning. Ce guide de l’interface utilisateur se concentre sur le workflow de création manuelle .

Choisir une classe de base choose-a-class

Le workflow Create schema s’affiche. Choisissez ensuite une classe de base pour le schéma. Vous pouvez choisir entre les classes principales XDM Individual Profile et XDM ExperienceEvent, ou Other si ces classes ne répondent pas à vos besoins. L’option Other des classes vous permet de créer une classe ou de choisir parmi d’autres classes préexistantes.

Pour plus d’informations sur ces classes, consultez la documentation XDM individual profile et XDM ExperienceEvent . Pour les besoins de ce tutoriel, sélectionnez XDM Individual Profile suivi de Next.

Nom et révision name-and-review

Après avoir sélectionné une classe, la section Name and review s’affiche. Dans cette section, vous indiquez un nom et une description pour identifier votre schéma. Plusieurs éléments importants doivent être pris en compte lors du choix d’un nom pour votre schéma :

Ce tutoriel décrit la composition d’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 ».

​La structure de base du schéma (fournie par la classe ) s’affiche dans la zone de travail pour que vous puissiez consulter et vérifier la structure de classe et de schéma sélectionnée.

Saisissez un Schema display name convivial dans le champ de texte. Saisissez ensuite une description appropriée pour vous aider à identifier votre schéma. Une fois que vous avez révisé votre structure de schéma et que vos paramètres vous conviennent, sélectionnez Finish pour créer votre schéma.

Composer le schéma compose-your-schema

L’Schema Editor apparaît. C’est la zone de travail sur laquelle vous allez composer votre schéma. Le schéma doté d’un titre est automatiquement créé dans la section Structure de la zone de travail lorsque vous accédez à l’éditeur, avec les champs standard inclus dans la classe de base que vous avez sélectionnée. La classe affectée pour le schéma est également répertoriée sous Class dans Composition section .

Ajouter un groupe de champs field-group

Vous pouvez maintenant commencer à ajouter des champs à votre schéma grâce à l’ajout de groupes de schémas. Un groupe de champs est un groupe d’un ou de plusieurs champs souvent utilisés conjointement pour décrire un concept particulier. Ce tutoriel utilise des groupes de champs 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 groupe de champs, sélectionnez Add dans la sous-section Field groups.

Une nouvelle boîte de dialogue apparait. Elle présente la liste des groupes de champs disponibles. Chaque groupe de champs est uniquement destiné à une utilisation avec une classe spécifique. Par conséquent, la boîte de dialogue ne répertorie que les groupes de champs compatibles avec la classe que vous avez sélectionnée (dans ce cas, la classe XDM Individual Profile). Si vous utilisez une classe XDM standard, la liste des groupes de champs sera triée intelligemment en fonction de la popularité de l’utilisation.

Vous pouvez utiliser l’un des filtres dans le rail de gauche pour limiter la liste des groupes de champs standard à des secteurs comme la vente au détail, les services financiers et les services de santé.

Lorsqu’un groupe de champs est sélectionné dans la liste, il s’affiche dans le rail de droite. Si vous le souhaitez, vous pouvez sélectionner plusieurs groupes de champs en les ajoutant chacun à la liste dans le rail de droite avant de confirmer la sélection. En outre, l’icône qui s’affiche sur le côté droit du groupe de champs sélectionné vous permet de prévisualiser la structure des champs qu’il présente.

Lors de la prévisualisation d’un groupe de champs, une description détaillée du schéma du groupe de champs est fournie dans le rail droit. Vous pouvez également parcourir les champs du groupe de champs dans la zone de travail. Lorsque vous sélectionnez différents champs, le rail de droite se met à jour pour afficher les détails du champ en question. Sélectionnez Back lorsque vous avez terminé la prévisualisation pour revenir à la boîte de dialogue de sélection du groupe de champs.

Pour ce tutoriel, sélectionnez le groupe de champs Demographic Details, puis sélectionnez Add field group.

La zone de travail du schéma réapparaît. La section Field groups répertorie désormais « Demographic Details » et la section Structure inclut les champs fournis par le groupe de champs. Vous pouvez sélectionner le nom du groupe de champs sous la section Field groups pour mettre en surbrillance les champs spécifiques qu’il fournit dans la zone de travail.

NOTE

Dans l’éditeur de schémas, les classes et les groupes de champs standard (générés par Adobe) sont indiqués par l’icône de cadenas (icône de cadenas . Le cadenas s’affiche dans le rail de gauche à côté du nom de la classe ou du groupe de champs, ainsi qu’à côté de tout champ du diagramme de schéma qui fait partie d’une ressource générée par le système.

Ce groupe de champs fournit plusieurs champs sous le nom de niveau supérieur 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.

Notez que le champ name possède un type de données « Full name », ce qui signifie qu’il décrit lui aussi un concept commun et contient des sous-champs liés au nom, tels que le prénom, le nom de famille, le titre de courtoisie et le suffixe.

Sélectionnez les différents champs dans la zone de travail pour afficher les champs supplémentaires contribuant à la structure du schéma.

Ajouter d’autres groupes de champs field-group-2

Vous pouvez maintenant répéter les mêmes étapes pour ajouter un autre groupe de champs. Lorsque la boîte de dialogue Add field group s’affiche cette fois-ci, vous remarquerez que le groupe de champs « Demographic Details » est grisé et que la case à cocher adjacente ne peut pas être sélectionnée. Cela vous évite de dupliquer accidentellement des groupes de champs que vous avez déjà inclus dans le schéma actuel.

Pour ce tutoriel, sélectionnez les groupes de champs standard Personal Contact Details et Loyalty Details dans la liste, puis sélectionnez Add field groups pour les ajouter au schéma.

La zone de travail réapparaît avec les groupes de champs ajoutés sous Field groups dans la section Composition et leurs champs composites ajoutés à la structure du schéma.

Définir un groupe de champs personnalisé define-field-group

Le schéma Loyalty Members est destiné à capturer des données relatives aux membres d’un programme de fidélité. Le groupe de champs de Loyalty Details standard que vous avez ajouté au schéma fournit la plupart de ces informations, notamment le type de programme, les points, la date d’inscription, etc.

Cependant, il peut arriver que vous souhaitiez inclure d’autres champs personnalisés non couverts par des groupes de champs standard afin d’atteindre vos cas d’utilisation. Dans le cas de l’ajout de champs de fidélité personnalisés, vous disposez de deux options :

Pour créer un groupe de champs, sélectionnez Add dans la sous-section Field groups comme avant, mais cette fois, sélectionnez Create New Field group dans la partie supérieure de la boîte de dialogue qui s’affiche. Vous êtes alors invité à fournir un nom d’affichage et une description pour le nouveau groupe de champs. Pour ce tutoriel, nommez le nouveau groupe de champs « Custom Loyalty Details », puis sélectionnez Add field groups.

« Custom Loyalty Details » devrait maintenant apparaître sous Field groups sur le côté gauche de la zone de travail, mais aucun champ n’y est encore associé et, par conséquent, aucun nouveau champ n’apparaît sous Structure.

Ajouter des champs au groupe de champs field-group-fields

Maintenant que vous avez créé le groupe de champs « Custom Loyalty Details », il est temps de définir les champs que le groupe de champs va ajouter au schéma.

Pour commencer, sélectionnez l’icône plus (+) située à côté du nom du schéma dans la zone de travail.

Un espace réservé « Untitled Field » apparaît dans la zone de travail, et le rail de droite se met à jour pour afficher les options de configuration du champ.

Dans ce scénario, le schéma doit comporter un champ de type objet qui décrit en détail le niveau de fidélité actuel de la personne. À l’aide des commandes du rail de droite, commencez à créer un champ de loyaltyTier de type « Object » qui sera utilisé pour contenir vos champs associés.

Sous Assign to, vous devez sélectionner un groupe de champs auquel affecter le champ. N’oubliez pas que tous les champs de schéma appartiennent à une classe ou à un groupe de champs. Comme ce schéma utilise une classe standard, votre seule option est de sélectionner un groupe de champs. Commencez à saisir le nom « Custom Loyalty Details », puis sélectionnez le groupe de champs dans la liste.

Lorsque vous avez terminé, sélectionnez Apply.

Les modifications sont appliquées et le nouvel objet « loyaltyTier » s’affiche. Puisqu’il s’agit d’un champ personnalisé, il est automatiquement imbriqué dans un espace de noms d’objet associé à l’identifiant du client de votre organisation, précédé d’un trait de soulignement (_tenantId dans cet exemple).

Sélectionnez l’icône plus (+) à côté de l’objet loyaltyTier pour commencer à ajouter des sous-champs. Un espace réservé pour le nouveau champ apparaît et la section Field properties est visible sur le côté droit de la zone de travail.

Chaque champ nécessite les informations suivantes :

Le premier champ de l’objet loyaltyTier sera une chaîne de caractères appelée id, représentant l’ID du niveau actuel du membre du programme de fidélité. L’ID de niveau sera unique pour chaque membre du programme de fidélité, car cette entreprise définit différents seuils de point de niveau de fidélité pour chaque client en fonction de différents facteurs. Définissez le type du nouveau champ sur « String » et la section Field properties se remplit de plusieurs options pour l’application de contraintes, y compris la valeur par défaut, le format et la longueur maximale. Pour en savoir plus, consultez la documentation sur les bonnes pratiques relatives aux champs de validation des données.

Comme id est une chaîne à structure libre générée de manière aléatoire, aucune autre contrainte n’est nécessaire. Sélectionnez Apply pour appliquer vos modifications.

Ajouter des champs supplémentaires au groupe de champs field-group-fields-2

Maintenant que vous avez ajouté le champ id, vous pouvez ajouter des champs supplémentaires pour recueillir des informations relatives à la fidélité, par exemple :

Pour ajouter chaque champ au schéma, sélectionnez l’icône plus (+) à côté de l’objet loyalty et renseignez les informations requises.

Une fois cette étape terminée, l’objet loyaltyTier contiendra des champs pour id, currentThreshold, nextThreshold, et effectiveDate.

Ajouter un champ d’énumération au groupe de champs enum

Lorsque vous définissez des champs dans le Schema Editor, vous pouvez appliquer certaines options supplémentaires aux types de champs de base afin de fournir d’autres contraintes aux données que le champ peut contenir. Les cas d’utilisation de ces contraintes sont expliqués dans le tableau suivant :

Pour ce tutoriel, l’objet loyaltyTier dans le schéma nécessite un nouveau champ d’énumération qui décrit la classe de niveau, où la valeur ne peut être que l’une des quatre options possibles. Pour ajouter ce champ au schéma, sélectionnez l’icône plus (+) à côté de l’objet loyaltyTier et renseignez les champs requis pour Field name et Display name. Par Type, sélectionnez « String ».

D’autres cases à cocher s’affichent pour le champ une fois son type sélectionné, y compris les cases à cocher pour Array, Enum & Suggested Values, Identity et Relationship.

Cochez la case Enum & Suggested Values, puis sélectionnez Enum. Vous pouvez saisir ici les Value (en Camel Case - casse mixte) et Display Name (nom facultatif et facile à lire écrit en Title Case - 1ère lettre des mots en majuscule) pour chaque classe de fidélité acceptable.

Une fois toutes les propriétés de champ renseignées, sélectionnez Apply pour ajouter le champ tierClass à l’objet loyaltyTier.

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

L’objet loyaltyTier contient désormais plusieurs champs et représente une structure de données commune qui peut s’avérer utile dans d’autres schémas. Le Schema Editor vous permet d’appliquer facilement des objets à champs multiples réutilisables 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é qu’un groupe de champs, car elles peuvent être utilisées n’importe où dans un schéma. Pour ce faire, définissez la valeur de Type du champ sur celle de tout type de données défini dans le Schema Registry.

Pour convertir l’objet loyaltyTier en type de données, sélectionnez le champ loyaltyTier dans la zone de travail, puis sélectionnez Convert to new data type sur le côté droit de l’éditeur sous Field properties.

Une notification s’affiche, confirmant que la conversion de l’objet a réussi. Dans la zone de travail, vous pouvez maintenant voir que le champ loyaltyTier comporte désormais une icône de lien et que le rail droit indique qu’il possède un type de données « Loyalty Tier ».

Dans un prochain schéma, vous pourrez désormais attribuer un champ en tant que type « Loyalty Tier », ce qui inclurait automatiquement des champs pour l’ID, la classe de niveau, les seuils de point et la date d’entrée en vigueur.

Rechercher et filtrer des champs de schéma

Votre schéma contient désormais plusieurs groupes de champs en plus des champs fournis par sa classe de base. Lorsque vous utilisez des schémas plus volumineux, vous pouvez cocher les cases situées à côté des noms des groupes de champs dans le rail de gauche pour filtrer les champs affichés uniquement par rapport aux groupes de champs 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 groupe de champs sous lequel ils sont fournis.

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

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, la création de rapports, l’analyse de la science des données, etc. Pour regrouper des données en fonction d’identités individuelles, les champs clés doivent être marqués comme des champs Identity dans les schémas applicables.

Experience Platform permet d’indiquer facilement un champ d’identité grâce à une case à cocher Identity 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.

Par exemple, il peut y avoir des milliers de membres du programme de fidélité appartenant au même niveau de fidélité, et plusieurs d’entre eux peuvent partager la même adresse physique. Dans ce scénario, cependant, chaque membre du programme de fidélité fournit lors de l’inscription son adresse électronique personnelle. Puisque les adresses e-mail personnelles sont généralement gérées par une seule personne, le personalEmail.address de champ (fourni par le groupe de champs Personal Contact Details ) est un bon candidat pour un champ d’identité.

Sélectionnez le champ personalEmail.address dans la zone de travail, et la case à cocher Identity apparaît sous Field properties. Cochez la case et vous aurez la possibilité de la définir comme Primary identity. Cochez également cette case.

Ensuite, vous devez fournir un Identity namespace à partir de la liste des espaces de noms prédéfinis dans la liste déroulante. Puisque ce champ correspond à l’adresse e-mail du client, sélectionnez « Email » dans la liste déroulante. Sélectionnez Apply pour confirmer les mises à jour du champ personalEmail.address .

Après application de la modification, l’icône personalEmail.address affiche un symbole d’empreinte digitale, indiquant qu’il s’agit désormais d’un champ d’identité. Le champ est également répertorié dans le rail de gauche sous Identities.

Désormais, toutes les données ingérées dans le champ personalEmail.address seront utilisées pour aider à identifier cet individu et à établir une vue unique de ce client. Pour en savoir plus sur l’utilisation des identités dans Experience Platform, veuillez consultez la documentation d’Identity Service.

Activer le schéma pour l’utiliser dans Real-Time Customer Profile profile

Real-Time Customer Profile exploite les données d’identité dans Experience Platform afin de fournir une vue holistique de chaque client individuel. Le service crée des profils fiables et complets des attributs des clients, ainsi que des comptes horodatés de chaque interaction des clients dans n’importe quel système intégré à Experience Platform.

Pour qu’un schéma puisse être utilisé avec Real-Time Customer Profile, il doit avoir une identité principale définie. Vous recevrez un message d’erreur si vous tentez d’activer un schéma sans avoir préalablement défini une identité principale.

Pour utiliser le schéma « Membres du programme de fidélité » dans Profile, commencez par sélectionner le titre du schéma dans la zone de travail.

Dans la partie droite de l’éditeur, des informations sur le schéma sont affichées, notamment son nom d’affichage, sa description et son type. En plus de ces informations, vous trouverez également un bouton bascule Profile .

Sélectionnez Profile et une fenêtre contextuelle s’affiche, vous demandant de confirmer que vous souhaitez activer le schéma pour Profile.

Sélectionnez Enable pour confirmer votre choix. Vous pouvez de nouveau sélectionner le bouton (bascule) Profile pour désactiver le schéma si vous le souhaitez, mais une fois que le schéma a été enregistré alors que Profile est activé, il ne peut plus être désactivé.

Actions supplémentaires more

Dans l’éditeur de schémas, vous pouvez également effectuer des actions rapides pour copier la structure JSON du schéma ou supprimer le schéma. Sélectionnez More en haut de la vue pour afficher une liste déroulante avec des actions rapides.

Supprimer un schéma delete-a-schema

Un schéma peut être supprimé de l’interface utilisateur de l’éditeur de schémas à l’aide d’actions More, ainsi que des détails du schéma dans l’onglet Browse . Certaines conditions empêchent la suppression d’un schéma. Un schéma ne peut pas être supprimé si :

Copier la structure JSON copy-json-structure

Sélectionnez Copy JSON structure pour générer une payload d’exportation pour tout schéma de la bibliothèque des schémas. Cette action copie la structure JSON dans le presse-papiers. Le fichier JSON exporté peut ensuite être utilisé pour importer le schéma et les ressources associées dans un autre sandbox ou une autre organisation. Cela rend le partage et la réutilisation des schémas entre différents environnements simples et efficaces.

É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 zone de travail. Sélectionnez Save et le schéma sera enregistré dans le Schema Library, ce qui le rendra accessible par le Schema Registry.

Votre nouveau schéma peut maintenant être utilisé pour ingérer des données dans Experience 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 tutoriel 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 du programme de fidélité ».

Vous pouvez également consulter et gérer le schéma « Membres du programme de fidélité » à l’aide de l’API Schema Registry. Pour commencer à utiliser l’API, consultez d’abord le Schema Registry API guide de développement.

Ressources vidéo

La vidéo suivante montre comment créer un schéma simple dans l’interface utilisateur Experience Platform.

La vidéo suivante est destinée à vous aider à mieux comprendre l’utilisation des groupes et classes de champ.

Annexe

Les sections suivantes apportent des informations supplémentaires sur l’utilisation de Schema Editor.

Création d’une nouvelle classe create-new-class

Experience Platform offre la possibilité de définir un schéma basé sur une classe propre à votre organisation. Pour apprendre à créer une nouvelle classe, consultez le guide sur la création et modification de classes dans l’interface utilisateur.

Modification de la classe d’un schéma change-class

Vous pouvez modifier la classe d’un schéma à tout moment au cours du processus de composition initiale, avant que le schéma ne soit enregistré.

Pour apprendre à modifier la classe d’un schéma, consultez le guide sur la gestion des schémas dans l’interface utilisateur.