Définition des champs XDM dans l’interface utilisateur

La balise 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 de XDM pour une présentation du rôle de XDM dans l’écosystème Experience Platform et les bases de la composition des schémas pour découvrir 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 afin de vous familiariser avec les différentes fonctionnalités de Schema Editor.

Sélectionnez une ressource pour ajouter des champs à

Pour définir de nouveaux champs XDM dans l’interface utilisateur, vous devez d’abord ouvrir un schéma dans Schema Editor. Selon les schémas actuellement disponibles dans la balise Schema Library, vous pouvez choisir de créer un nouveau schéma ou sélectionner un schéma existant à modifier.

Une fois Schema Editor ouvert, utilisez le rail de gauche pour sélectionner la classe ou le groupe de champs pour lequel vous souhaitez définir des champs. Si la ressource est une ressource personnalisée définie par votre organisation, les contrôles permettant d’ajouter ou de modifier 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é.

REMARQUE

Si la classe ou le groupe de champs que vous sélectionnez est une ressource principale fournie par Adobe, il ne peut pas être modifié et les contrôles affichés ci-dessus n’apparaîtront donc pas. Si le schéma auquel vous souhaitez ajouter des champs est basé sur une classe XDM principale et ne contient aucun groupe de champs personnalisé, vous pouvez créer un nouveau groupe de champs à ajouter au schéma à la place.

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.

Définition d’un champ pour une ressource

Après avoir sélectionné l’icône plus (+), un Nouveau champ s’affiche dans la zone de travail, située dans un objet de niveau racine et dont l’espace de noms correspond à votre identifiant de client unique (illustré par _tenantId dans l’exemple ci-dessous). Tous les champs ajoutés à un schéma par le biais de classes personnalisées et de groupes de champs 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.

Dans le rail de droite sous Propriétés du champ, vous pouvez configurer les détails des nouveaux champs. Les informations suivantes sont requises pour chaque champ :

Propriété du champ Description
Nom du champ Nom explicite unique du champ. Notez que le nom du champ ne peut pas être modifié une fois le schéma enregistré.

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
Nom d’affichage Nom convivial du champ.
Type Le type de données que le champ contiendra. Dans ce menu déroulant, vous pouvez sélectionner l’un des types scalaires standard pris en charge par XDM, ou l’un des types de données à plusieurs champs précédemment définis dans la balise Schema Registry.

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é.

Vous pouvez également fournir au champ une description lisible par l’utilisateur facultatif afin de fournir plus de contexte sur le cas d’utilisation prévu du champ.

REMARQUE

Selon le type que vous avez sélectionné pour le champ, d’autres contrôles de configuration peuvent apparaître dans le rail de droite. Pour plus d’informations sur ces contrôles, consultez la section Propriétés de champ spécifiques au type .

Le rail de droite contient également des cases à cocher pour désigner les types de champ spéciaux. Pour plus d’informations, reportez-vous à la section Types de champs spéciaux .

Une fois que vous avez terminé de configurer le champ, sélectionnez Appliquer.

Le canevas se met à jour pour afficher le nom et le type du champ. 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.

REMARQUE

Toutes les modifications que vous apportez aux groupes de champs ou à la classe d’un schéma seront répercutées dans tous les autres schémas qui les utilisent.

Propriétés de champ spécifiques au type

Lors de la définition d'un nouveau champ, d'autres options de configuration peuvent apparaître dans le rail de droite selon le 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 :

Propriété du champ Types compatibles Description
Valeur par défaut Chaîne, Double, Long, Entier, Court, Octet, Booléen Une valeur par défaut qui sera affectée à ce champ si aucune autre valeur n’est fournie pendant l’ingestion. Cette valeur doit être conforme au type sélectionné du champ.
Modèle Chaîne expression régulière à laquelle la valeur de ce champ doit être conforme pour être acceptée lors de l’ingestion.
Format Chaîne 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 :
Longueur minimale Chaîne Nombre minimum de caractères que doit contenir la chaîne pour que la valeur soit acceptée lors de l’ingestion.
Longueur maximale Chaîne Nombre maximal de caractères que doit contenir la chaîne pour que la valeur soit acceptée lors de l’ingestion.
Valeur minimale Double Valeur minimale à accepter lors de l’ingestion. Si la valeur ingérée correspond exactement à celle saisie ici, la valeur est acceptée. Lors de l’utilisation de cette contrainte, la contrainte "Valeur minimale exclusive" doit rester vide.
Valeur maximale Double Valeur maximale que la Double doit être acceptée lors de l’ingestion. Si la valeur ingérée correspond exactement à celle saisie ici, la valeur est acceptée. Lors de l’utilisation de cette contrainte, la contrainte "Valeur maximale exclusive" doit rester vide.
Valeur minimale exclusive Double Valeur maximale que la Double doit être acceptée lors de l’ingestion. Si la valeur ingérée correspond exactement à celle saisie ici, la valeur est rejetée. Lors de l’utilisation de cette contrainte, la contrainte "Valeur minimale" (non exclusive) doit rester vide.
Valeur maximale exclusive Double Valeur maximale que la Double doit être acceptée lors de l’ingestion. Si la valeur ingérée correspond exactement à celle saisie ici, la valeur est rejetée. Lors de l’utilisation de cette contrainte, la contrainte "Maximum value" (non exclusive) doit rester vide.

Types de champ spéciaux

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 :

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.

Sur cette page