Definición de campos XDM en la IU

El Schema Editor en la interfaz de usuario de Adobe Experience Platform le permite definir sus propios campos dentro de las clases personalizadas del Modelo de datos de experiencia (XDM) y los grupos de campos de esquema. Esta guía explica los pasos para definir campos XDM en la interfaz de usuario de, incluidas las opciones de configuración disponibles para cada tipo de campo.

Requisitos previos

Esta guía requiere una comprensión práctica del sistema XDM. Consulte la Información general de XDM para obtener una introducción a la función de XDM dentro del ecosistema de Experience Platform, y la conceptos básicos de composición de esquemas para conocer cómo las clases y los grupos de campos contribuyen a los campos en los esquemas XDM.

Aunque no es necesario para esta guía, se recomienda seguir el tutorial en composición de un esquema en la IU para familiarizarse con las diversas capacidades de la Schema Editor.

Seleccione un recurso al que añadir campos select-resource

Para definir nuevos campos XDM en la interfaz de usuario de, primero debe abrir un esquema dentro de la Schema Editor. Dependiendo de los esquemas que estén disponibles actualmente en el Schema Library, puede elegir entre crear un nuevo esquema o seleccione un esquema existente para editarlo.

Una vez que tenga el Schema Editor abierto, los controles para agregar campos aparecen en el lienzo. Estos controles aparecen junto al nombre del esquema, así como cualquier campo de tipo de objeto que se haya definido en la clase o grupo de campos seleccionado.

Editor de esquemas con los iconos de adición resaltados.

WARNING
Si intenta agregar un campo a un objeto proporcionado por un grupo de campos estándar, ese grupo de campos se convertirá en un grupo de campos personalizado y el grupo de campos original dejará de estar disponible. Consulte la sección sobre adición de campos a grupos de campos estándar en la guía de la interfaz de usuario de esquemas para obtener más información.

Para añadir un nuevo campo al recurso, seleccione la más (+) junto al nombre del esquema en el lienzo o junto al campo de tipo de objeto en el que desea definir el campo.

Editor de esquemas con un icono de adición resaltado.

Dependiendo de si agrega un campo directamente a un esquema o a su clase constituyente y a los grupos de campos, los pasos necesarios para agregar el campo variarán. El resto de este documento se centra en cómo configurar las propiedades de un campo independientemente de dónde aparezca en el esquema. Para obtener más información sobre las diferentes formas en que se pueden añadir campos a un esquema, consulte las siguientes secciones en la guía de la IU de esquemas:

Definir las propiedades de un campo define

Después de seleccionar el más (+) icono, un Campo sin título el marcador de posición aparece en el lienzo.

Editor de esquemas con un nuevo campo sin título resaltado.

En el carril derecho debajo de Propiedades del campo, puede configurar los detalles del nuevo campo. Se requiere la siguiente información para cada campo:

Propiedad de campo
Descripción
Nombre de campo

Un nombre único y descriptivo para el campo. Tenga en cuenta que el nombre del campo no se puede cambiar una vez guardado el esquema. Este valor se utiliza para identificar y hacer referencia al campo en el código y en otras aplicaciones posteriores

Idealmente, el nombre debería escribirse en camelCase. Puede contener caracteres alfanuméricos, guiones o guiones bajos, pero puede que no empiece con un guion bajo.

  • Correcto: fieldName
  • Aceptable: field_name2, Field-Name, field-name_3
  • Incorrecto: _fieldName
Nombre para mostrar
Un nombre para mostrar para el campo. Este es el nombre que se utilizará para representar el campo en el lienzo del Editor de esquemas. El nombre del campo se puede cambiar por el nombre para mostrar mediante la variable alternar nombre para mostrar.
Tipo
Tipo de datos que contendrá el campo. En este menú desplegable, puede seleccionar una de las siguientes opciones tipos escalares estándar compatible con XDM o uno de los campos múltiples tipos de datos que se han definido previamente en la Schema Registry.
Nota: Si selecciona el tipo de datos Asignar, Asignar tipo de valor aparece la propiedad.

También puede seleccionar Búsqueda de tipo avanzada para buscar y filtrar tipos de datos existentes y localizar el tipo deseado con mayor facilidad.
Asignar tipo de valor
Este valor es obligatorio si selecciona Mapa como el tipo de datos del campo. Los valores disponibles para el mapa son Cadena y Entero. Seleccione un valor de la lista desplegable de opciones disponibles.
Para obtener más información acerca de propiedades de campo específicas del tipo, consulte la información general sobre la definición de campos.

También puede proporcionar una descripción y notas para cada campo. Utilice el Descripción para añadir contexto y describir la funcionalidad del tipo de datos de asignación. Esto contribuye al mantenimiento y a la legibilidad de la implementación. También puede agregar notas para complementar la descripción inicial. Esto debería ofrecer información más granular y específica para ayudar a los desarrolladores a comprender, mantener y utilizar el mapa de forma eficaz en el contexto de la base de código. |

NOTE
Según la variable Tipo Si ha seleccionado el campo, pueden aparecer controles de configuración adicionales en el carril derecho. Consulte la sección sobre propiedades de campo específicas del tipo para obtener más información sobre estos controles.
El carril derecho también proporciona casillas de verificación para designar tipos de campo especiales. Consulte la sección sobre tipos de campo especiales para obtener más información.

Cuando haya terminado de configurar el campo, seleccione Aplicar.

El Propiedades del campo del Editor de esquemas aparece resaltada.

El lienzo se actualiza para mostrar el campo recién agregado, ubicado dentro de un objeto que tiene un espacio de nombres con su ID de inquilino único (mostrado como _tenantId en el ejemplo siguiente). Todos los campos personalizados que se agregan a un esquema se colocan automáticamente dentro de este espacio de nombres para evitar conflictos con otros campos de clases y grupos de campos proporcionados por el Adobe. El carril derecho ahora enumera la ruta del campo además de sus otras propiedades.

Un nuevo campo en el diagrama de esquema y su ruta correspondiente en la variable Propiedades del campo La sección está resaltada.

Puede seguir siguiendo los pasos anteriores para agregar más campos al esquema. Una vez guardado el esquema, su clase base y los grupos de campos también se guardan si se han realizado cambios en ellos.

NOTE
Cualquier cambio que realice en los grupos de campos o en la clase de un esquema se reflejará en todos los demás esquemas que los utilicen.

Propiedades de campo específicas del tipo type-specific-properties

Al definir un nuevo campo, pueden aparecer opciones de configuración adicionales en el carril derecho, según el Tipo elija para el campo. En la tabla siguiente se describen estas propiedades de campo adicionales junto con sus tipos compatibles:

Propiedad de campo
Tipos compatibles
Descripción
Asignar tipo de valor
Mapa
El Asignar tipo de valor La propiedad solo aparece en la interfaz de usuario si selecciona el valor Asignar de la Tipo opciones desplegables. Puede seleccionar entre los tipos de valor Cadena y Entero para el Mapa.
Editor de esquemas con los campos Tipo y Tipo de valor de asignación resaltados. {width="100" modal="regular"}
Nota: Todos los tipos de datos de asignación creados a través de la API que no sean de tipo cadena ni entero se muestran como 'Complejo' tipo de datos. No puede crear 'Complejo' a través de la interfaz de usuario.
Valor predeterminado
Cadena, Doble, Largo, Entero, Corto, Byte, Booleano
Un valor predeterminado que se asigna a este campo si no se proporciona ningún otro valor durante la ingesta. Este valor debe cumplir con el tipo seleccionado en el campo.

Los valores predeterminados no se guardan en el conjunto de datos en el momento de la ingesta, ya que pueden cambiar con el tiempo. Los servicios y aplicaciones de Platform secundarios infieren los valores predeterminados establecidos en el esquema cuando leen los datos del conjunto de datos. Por ejemplo, al consultar los datos mediante el servicio de consulta, si el atributo tiene un valor NULL, pero el valor predeterminado está establecido en 5 en el nivel de esquema, se espera que el servicio de consultas devuelva lo siguiente 5 en lugar de NULL. Tenga en cuenta que este comportamiento no es uniforme actualmente en todos los servicios de AEP.
Patrón
Cadena
A expresión regular que el valor de este campo debe cumplir para que se acepte durante la ingesta.
Formato
Cadena

Seleccione de una lista de formatos predefinidos para cadenas con los que debe ajustarse el valor. Los formatos disponibles incluyen:

Longitud mínima
Cadena
Número mínimo de caracteres que debe contener la cadena para que el valor se acepte durante la ingesta.
Longitud máxima
Cadena
Número máximo de caracteres que debe contener la cadena para que el valor se acepte durante la ingesta.
Valor mínimo
Doble
El valor mínimo de Double que se aceptará durante la ingesta. Si el valor introducido coincide exactamente con el introducido aquí, se acepta el valor. Cuando se utiliza esta restricción, la variable "Valor mínimo exclusivoLa restricción " debe dejarse en blanco.
Valor máximo
Doble
El valor máximo de Double que se aceptará durante la ingesta. Si el valor introducido coincide exactamente con el introducido aquí, se acepta el valor. Cuando se utiliza esta restricción, la variable "Valor máximo exclusivoLa restricción " debe dejarse en blanco.
Valor mínimo exclusivo
Doble
El valor máximo de Double que se aceptará durante la ingesta. Si el valor introducido coincide exactamente con el introducido aquí, se rechaza el valor. Cuando se utiliza esta restricción, la variable "Valor mínimoLa restricción " (no exclusiva) debe dejarse en blanco.
Valor máximo exclusivo
Doble
El valor máximo de Double que se aceptará durante la ingesta. Si el valor introducido coincide exactamente con el introducido aquí, se rechaza el valor. Cuando se utiliza esta restricción, la variable "Valor máximoLa restricción " (no exclusiva) debe dejarse en blanco.

Tipos de campo especiales special

El carril derecho proporciona varias casillas de verificación para designar funciones especiales para el campo seleccionado. Los casos de uso de algunas de estas opciones implican consideraciones importantes sobre su estrategia de modelado de datos y cómo desea utilizar los servicios de Platform secundarios.

Para obtener más información sobre estos tipos especiales, consulte la siguiente documentación:

Aunque técnicamente no es un tipo de campo especial, también se recomienda que visite la guía en definición de campos de tipo de objeto para obtener más información sobre la definición de subcampos anidados si las estructuras de esquema.

Pasos siguientes

Esta guía proporciona información general sobre cómo definir campos XDM en la interfaz de usuario. Recuerde que los campos solo se pueden agregar a esquemas mediante el uso de clases y grupos de campos. Para obtener más información sobre cómo administrar estos recursos en la interfaz de usuario, consulte las guías sobre creación y edición clases y grupos de campos.

Para obtener más información sobre las capacidades de Esquemas Workspace, consulte la Esquemas información general de workspace.

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