Definición de campos XDM en la IU
Schema Editor en la interfaz de usuario de Adobe Experience Platform le permite definir sus propios campos dentro de clases personalizadas de modelo de datos de experiencia (XDM) y 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 descripción general de XDM para ver una introducción al papel de XDM en el ecosistema de Experience Platform y los conceptos básicos de la composición de esquemas para conocer cómo las clases y los grupos de campos aportan campos a los esquemas XDM.
Aunque no es necesario para esta guía, se recomienda que también siga el tutorial sobre maquetar un esquema en la interfaz de usuario para familiarizarse con las diversas funcionalidades de Schema Editor.
Seleccione un recurso al que añadir campos select-resource
Para definir nuevos campos XDM en la interfaz de usuario, primero debe abrir un esquema dentro de Schema Editor. Según los esquemas que estén disponibles actualmente en Schema Library, puede elegir crear un nuevo esquema o seleccionar un esquema existente para editar.
Una vez que tenga Schema Editor abierto, los controles para agregar campos aparecerán 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.
Para agregar un nuevo campo al recurso, seleccione el icono 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.
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 icono más (+), aparece un marcador de posición Campo sin título en el lienzo.
En el carril derecho bajo Propiedades del campo, puede configurar los detalles del nuevo campo. Se requiere la siguiente información para cada 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 usa para identificar y hacer referencia al campo en el código y en otras aplicaciones de flujo descendente
Idealmente, el nombre debería escribirse en camelCase. Puede contener caracteres alfanuméricos, guiones o guiones bajos, pero no puede comenzar con un guion bajo.
- Correcto:
fieldName - Aceptable:
field_name2,Field-Name,field-name_3 - Incorrecto:
_fieldName
Nota: si selecciona el tipo de datos Map, aparecerá la propiedad Map value type.
También puede seleccionar Búsqueda de tipo avanzada para buscar y filtrar los tipos de datos existentes y encontrar el tipo deseado con mayor facilidad.
Para obtener más información acerca de propiedades de campo específicas del tipo, consulte la descripción general de definir campos.
También puede proporcionar una descripción y notas para cada campo. Utilice el campo Descripción para agregar 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. |
Una vez que haya terminado de configurar el campo, seleccione Aplicar.
El lienzo se actualiza para mostrar el campo recién agregado, ubicado dentro de un objeto que tiene un espacio de nombres con respecto a 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.
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.
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 que elija para el campo. En la tabla siguiente se describen estas propiedades de campo adicionales junto con sus tipos compatibles:
Nota: todos los tipos de datos de asignación creados mediante la API que no sean de tipo String ni Integer se muestran como un tipo de datos 'Complex'. No puede crear tipos de datos 'Complex' a través de la interfaz de usuario.
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 consulta devuelva 5 en lugar de NULL. Tenga en cuenta que este comportamiento no es uniforme actualmente en todos los servicios de AEP.Seleccione de una lista de formatos predefinidos para cadenas con los que debe ajustarse el valor. Los formatos disponibles incluyen:
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 de definición de campos de tipo de objeto para obtener más información sobre la definición de subcampos anidados si sus 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 la creación y edición de clases y grupos de campos.
Para obtener más información sobre las capacidades del área de trabajo Esquemas, consulte la descripción general del área de trabajo Esquemas.