Définir 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 et groupes de champs de schéma du modèle de données d’expérience (XDM) personnalisé. 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 introduction au rôle de XDM dans l’écosystème Experience Platform et aux principes de base de la composition des schémas pour savoir comment les classes et les groupes de champs contribuent aux champs des schémas XDM.

Bien que cela ne soit pas obligatoire pour ce guide, 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 l’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 . Selon les schémas actuellement disponibles dans le Schema Library, vous pouvez choisir de créer un schéma ou sélectionner un schéma existant à modifier.

Une fois le Schema Editor ouvert, 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é.

Éditeur de schémas avec les icônes d’ajout mises en surbrillance.

WARNING
Si vous tentez d’ajouter un champ à un objet fourni par un groupe de champs standard, ce groupe de champs est converti en groupe de champs personnalisés et le groupe de champs d’origine n’est plus disponible. Pour plus d’informations, consultez la section sur l’ajout de champs à des groupes de champs standard dans le guide de l’interface utilisateur des schémas .

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 d’objet sous lequel vous souhaitez définir le champ.

L’éditeur de schémas avec une icône d’ajout mise en surbrillance.

Selon que vous ajoutez directement un champ à un schéma ou à sa classe et à ses groupes de champs constitutifs, 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’emplacement de ce champ dans le schéma. Pour plus d’informations sur les différentes manières dont les champs peuvent être ajoutés à 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.

L’éditeur de schémas avec un nouveau champ sans titre mis en surbrillance.

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 :

Propriété du champ
Description
Nom du champ

Nom unique et descriptif pour le 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 ou des traits de soulignement, mais il peut pas commencer par un trait de soulignement.

  • Correct : fieldName
  • Acceptable : field_name2, fieldName_3
  • Incorrect : _fieldName
Nom d’affichage
Nom d’affichage du champ. Il s’agit du nom qui sera utilisé pour représenter le champ dans la zone de travail de l’éditeur de schémas. Le nom du champ peut être remplacé par le nom d’affichage à l’aide du bouton bascule du nom d’affichage.
Type
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 à champs multiples précédemment définis dans le Schema Registry.
Remarque : si vous sélectionnez le type de données Mappage, la propriété Type de valeur de mappage s’affiche.

Vous pouvez également sélectionner Recherche avancée de type pour rechercher et filtrer les types de données existants et localiser plus facilement le type souhaité.
Mapper le type de valeur
Cette valeur est requise si vous sélectionnez Mapper comme type de données pour le champ. Les valeurs disponibles pour le mappage sont Chaîne et Entier. Sélectionnez une valeur dans la liste déroulante des options disponibles.
Pour en savoir plus sur les propriétés de champ spécifiques à un 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 les fonctionnalités du type de données de mappage. Cela contribue à la facilité de maintenance et à la lisibilité de la mise en œuvre. Vous pouvez également ajouter des notes pour compléter la description initiale. Cela devrait offrir des informations plus granulaires et plus spécifiques pour aider les développeurs à comprendre, à gérer et à utiliser la carte efficacement dans le contexte de la base de code. |

NOTE
Selon le Type que vous avez sélectionné pour le champ, des commandes de configuration supplémentaires peuvent apparaître dans le rail de droite. Pour plus d’informations sur ces commandes, consultez la section sur les propriétés de champ spécifiques à un type.
Le rail de droite fournit également des cases à cocher pour désigner des types de champs spéciaux. Pour plus d’informations, consultez la section sur les types de champs spéciaux.

Une fois le champ configuré, sélectionnez Appliquer.

La section Propriétés du champ de l’éditeur de schémas est mise en surbrillance.

La zone de travail se met à jour pour afficher le champ nouvellement ajouté, situé dans un objet dont l’espace de noms est associé à votre identifiant de client unique (illustré comme _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 au champ en plus de ses autres propriétés.

Un nouveau champ dans le diagramme de schéma et son chemin d’accès correspondant dans la section Propriétés du champ sont mis en surbrillance.

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 y ont été apportées.

NOTE
Toute modification apportée aux groupes de champs ou à la classe d’un schéma est répercutée dans tous les autres schémas qui les utilisent.

Propriétés de champ spécifiques au type type-specific-properties

Lors de la définition d’un nouveau champ, des options de configuration supplémentaires peuvent apparaître dans le rail de droite selon le Type que vous choisissez 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
Mapper le type de valeur
Carte
La propriété Type de valeur de mappage n’apparaît dans l’interface utilisateur que si vous sélectionnez la valeur de mappage dans les options déroulantes Type. Vous pouvez choisir entre les types de valeur Chaîne et Entier pour le mappage.
L’éditeur de schémas avec les champs de type Type et Valeur map mis en surbrillance. {width="100" modal="regular"}
Remarque : tous les types de données de mappage créés par le biais de l’API qui ne sont pas de type String ou Integer s’affichent sous la forme d’un type de données « Complex ». Vous ne pouvez pas créer de types de données « Complexes » via l’interface utilisateur.
Motif
Chaîne
Une expression régulière à laquelle la valeur de ce champ doit se conformer 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 la chaîne doit contenir pour que la valeur soit acceptée lors de l’ingestion.
Longueur maximale
Chaîne
Nombre maximal de caractères que la chaîne doit contenir pour que la valeur soit acceptée lors de l’ingestion.
Valeur minimale
Double
Valeur minimale pour que le doublon soit accepté 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 de Double à 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 maximale exclusive » doit rester vide.
Valeur minimale exclusive
Double
Valeur maximale de Double à accepter lors de l’ingestion. Si la valeur ingérée correspond exactement à celle saisie ici, elle 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 de Double à accepter lors de l’ingestion. Si la valeur ingérée correspond exactement à celle saisie ici, elle est rejetée. Lors de l’utilisation de cette contrainte, la contrainte « Valeur maximale » (non exclusive) doit rester vide.

Types de champs spéciaux special

Le rail de droite propose plusieurs cases à cocher pour désigner 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 avez l’intention d’utiliser les services Platform en aval.

Pour en savoir plus sur ces types spéciaux, consultez la documentation suivante :

Bien que techniquement il ne s’agisse pas d’un type de champ spécial, il est également recommandé de consulter le guide sur la définition de 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 présente 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 aux schémas que par le biais 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 de classes et de groupes de champs.

Pour plus d’informations sur les fonctionnalités de l’espace de travail Schémas, consultez la présentation de l’espace de travail Schémas.

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07