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 afin de découvrir 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é.

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.

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é Untitled field apparaît dans la zone de travail.

Dans le rail de droite sous Field properties, vous pouvez configurer les détails du nouveau champ. Les informations suivantes sont requises pour chaque champ :

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

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

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 des classes et groupes de champs fournis par Adobe. Le rail de droite répertorie désormais le chemin d’accès au 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 y ont été apportées.

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 en fonction du 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.

Les propriétés telles que la Pattern, la Format et la longueur ou les limites numériques sont appliquées lors de l’ingestion lors de la configuration. Default value est différent : il enregistre les métadonnées du schéma d’information et ne valide ni ne renseigne les données ingérées. Reportez-vous à la ligne Default value ci-dessous et à la remarque qui suit le tableau.

Propriété du champ

Types compatibles

Description

Map value type

Map

La propriété Map value type n’apparaît dans l’interface utilisateur que si vous sélectionnez la valeur Mapper dans les options de la liste déroulante Type . Vous pouvez choisir entre les types de valeur Chaîne et Entier pour le mappage.
{width="100" modal="regular"}
Remarque : tous les types de données de mappage créés via 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 « Complex » via l’interface utilisateur.

Pattern

String

Une expression régulière à laquelle la valeur de ce champ doit se conformer pour être acceptée lors de l’ingestion.

Format

String

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 :

• date-time
• email
• hostname
• ipv4
• ipv6
• uri
• uri-reference
• url-template
• json-pointer

Minimum length

String

Nombre minimum de caractères que la chaîne doit contenir pour que la valeur soit acceptée lors de l’ingestion.

Maximum length

String

Nombre maximal de caractères que la chaîne doit contenir pour que la valeur soit acceptée lors de l’ingestion.

Minimum value

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 « Exclusive minimum value » doit rester vide.

Maximum value

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 « Exclusive maximum value » doit rester vide.

Exclusive minimum value

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 « Minimum value » (non exclusive) doit rester vide.

Exclusive maximum value

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 « Maximum value » (non exclusive) doit rester vide.

Default value

Types scalaires dans l’éditeur de schémas qui prennent en charge les default de schéma JSON (String et Boolean, par exemple)

Métadonnées d’information alignées sur la sémantique Schéma JSON default et stockées dans la définition du schéma. La valeur configurée n’est pas automatiquement appliquée lors de l’ingestion ou des flux de préparation des données. Les champs omis restent absents, sauf s’ils sont explicitement mappés ou transformés dans votre flux de données. Voir définition des champs obligatoires.

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 Experience 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 Schemas, consultez la présentation de l’espace de travail Schemas.