Définition des champs XDM dans l’interface utilisateur
L’ Schema Editor de l’interface utilisateur de Adobe Experience Platform vous permet de définir vos propres champs dans les classes XDM (Experience Data Model) personnalisées et les groupes de champs de schéma. Ce guide décrit les étapes de définition des champs XDM dans l’interface utilisateur, y compris les options de configuration disponibles pour chaque type de champ.
Conditions préalables
Ce guide nécessite une compréhension pratique du système XDM. Reportez-vous à la présentation XDM pour une présentation du rôle de XDM dans l’écosystème Experience Platform et aux principes de base de la composition des schémas pour apprendre comment les classes et les groupes de champs contribuent aux champs des schémas XDM.
Bien que ce guide ne soit pas obligatoire, il est recommandé de suivre également le tutoriel sur la composition d’un schéma dans l’interface utilisateur pour vous familiariser avec les différentes fonctionnalités de Schema Editor.
Sélectionner une ressource à laquelle ajouter des champs select-resource
Pour définir de nouveaux champs XDM dans l’interface utilisateur, vous devez d’abord ouvrir un schéma dans le Schema Editor. En fonction des schémas actuellement disponibles dans Schema Library, vous pouvez choisir de créer un nouveau schéma ou de sélectionner un schéma existant à modifier.
Une fois que vous avez ouvert l’élément Schema Editor, les commandes permettant d’ajouter des champs s’affichent dans la zone de travail. Ces commandes s’affichent en regard du nom du schéma, ainsi que des champs de type objet qui ont été définis sous la classe ou le groupe de champs sélectionné.
Pour ajouter un nouveau champ à la ressource, sélectionnez l’icône plus (+) en regard du nom du schéma dans la zone de travail ou en regard du champ de type objet sous lequel vous souhaitez définir le champ.
Selon que vous ajoutez directement un champ à un schéma ou à sa classe constituante et à ses groupes de champs, les étapes requises pour ajouter le champ varient. Le reste de ce document se concentre sur la configuration des propriétés d’un champ, quel que soit l’endroit où ce champ apparaît dans le schéma. Pour plus d’informations sur les différentes manières d’ajouter des champs à un schéma, reportez-vous aux sections suivantes du guide de l’interface utilisateur des schémas :
Définition des propriétés d’un champ define
Après avoir sélectionné l’icône plus (+) , un espace réservé Champ sans titre s’affiche dans la zone de travail.
Dans le rail de droite sous Propriétés du champ, vous pouvez configurer les détails du nouveau champ. Les informations suivantes sont requises pour chaque champ :
Nom descriptif et unique du champ. Notez que le nom du champ ne peut pas être modifié une fois le schéma enregistré. Cette valeur est utilisée pour identifier et référencer le champ dans le code et dans d’autres applications en aval
Le nom doit idéalement être écrit en CamelCase. Il peut contenir des caractères alphanumériques, des tirets ou des traits de soulignement, mais ne peut pas commencer par un trait de soulignement.
- Correct :
fieldName - Acceptable :
field_name2,Field-Name,field-name_3 - Incorrect :
_fieldName
Remarque : Si vous sélectionnez le type de données Map , la propriété Type de valeur Map s’affiche.
Vous pouvez également sélectionner Recherche de type avancé pour rechercher et filtrer les types de données existants et localiser plus facilement le type souhaité.
Pour en savoir plus sur les propriétés de champ spécifiques au type, consultez la présentation de la définition des champs.
Vous pouvez également choisir de fournir une description et des notes pour chaque champ. Utilisez le champ Description pour ajouter du contexte et décrire la fonctionnalité du type de données de carte. Cela contribue à la maintenabilité et à la lisibilité de la mise en oeuvre. Vous pouvez également ajouter des notes pour compléter la description initiale. Cela devrait offrir des informations plus granulaires et spécifiques pour aider les développeurs à comprendre, gérer et utiliser efficacement la carte dans le contexte du code base. |
Une fois que vous avez terminé de configurer le champ, sélectionnez Apply.
Le canevas se met à jour pour afficher le champ nouvellement ajouté, situé dans un espace de noms d’objet associé à votre identifiant de tenant unique (illustré par _tenantId dans l’exemple ci-dessous). Tous les champs personnalisés ajoutés à un schéma sont automatiquement placés dans cet espace de noms afin d’éviter tout conflit avec d’autres champs provenant de classes et de groupes de champs fournis par l’Adobe. Le rail de droite répertorie désormais le chemin d’accès du champ en plus de ses autres propriétés.
Vous pouvez continuer à suivre les étapes ci-dessus pour ajouter d’autres champs au schéma. Une fois le schéma enregistré, sa classe de base et ses groupes de champs sont également enregistrés si des modifications leur ont été apportées.
Propriétés de champ spécifiques à un type type-specific-properties
Lors de la définition d’un nouveau champ, d’autres options de configuration peuvent s’afficher dans le rail de droite en fonction du type que vous avez choisi pour le champ. Le tableau suivant décrit ces propriétés de champ supplémentaires, ainsi que leurs types compatibles :
Remarque : tous les types de données de mappage créés par le biais de l’API qui ne sont pas de type Chaîne ou Entier sont affichés sous la forme d’un type de données 'Complex'. Vous ne pouvez pas créer de types de données 'Complex' via l’interface utilisateur.
Les valeurs par défaut ne sont pas enregistrées dans le jeu de données au moment de l’ingestion, car elles peuvent changer au fil du temps. Les valeurs par défaut définies dans le schéma sont déduites par les services et applications Platform en aval lorsqu’ils lisent les données du jeu de données. Par exemple, lors de l’interrogation des données à l’aide de Query Service, si l’attribut a une valeur NULL, mais que la valeur par défaut est
5 au niveau du schéma, il est prévu que Query Service renvoie 5 au lieu de NULL. Notez que ce comportement n’est actuellement pas uniforme pour tous les services AEP.Effectuez une sélection dans une liste de formats prédéfinis pour les chaînes auxquelles la valeur doit se conformer. Les formats disponibles sont les suivants :
Types de champ spéciaux special
Le rail de droite comporte plusieurs cases à cocher pour la désignation des rôles spéciaux pour le champ sélectionné. Les cas d’utilisation de certaines de ces options impliquent des considérations importantes concernant votre stratégie de modélisation des données et la manière dont vous envisagez d’utiliser les services Platform en aval.
Pour en savoir plus sur ces types spéciaux, consultez la documentation suivante :
- Carte
- Obligatoire
- Tableau
- Enum
- Identité (Disponible uniquement pour les champs de chaîne)
- Relationship (Disponible uniquement pour les champs de chaîne)
Bien que techniquement non un type de champ spécial, il est également recommandé de consulter le guide sur la définition des champs de type objet pour en savoir plus sur la définition de sous-champs imbriqués dans vos structures de schéma.
Étapes suivantes
Ce guide fournit un aperçu de la définition des champs XDM dans l’interface utilisateur. N’oubliez pas que les champs ne peuvent être ajoutés qu’aux schémas par l’utilisation de classes et de groupes de champs. Pour en savoir plus sur la gestion de ces ressources dans l’interface utilisateur, consultez les guides sur la création et la modification des classes et des groupes de champs.
Pour plus d’informations sur les fonctionnalités de l’espace de travail Schémas, consultez la présentation des schémas de l’espace de travail.