Crear un esquema con el Schema Editor

La interfaz de usuario de Adobe Experience Platform le permite crear y administrar esquemas Experience Data Model (XDM) en un lienzo visual interactivo denominado Schema Editor. Este tutorial explica cómo crear un esquema con el Schema Editor.

NOTA

Para demostraciones, los pasos de este tutorial incluyen la creación de un esquema de ejemplo que describe a los miembros de un programa de lealtad del cliente. Aunque puede utilizar estos pasos para crear un esquema diferente para sus propios fines, se recomienda que primero siga con la creación del esquema de ejemplo para conocer las capacidades del Schema Editor.

Si prefiere componer un esquema con la API Schema Registry en su lugar, lea la Schema Registry guía para desarrolladores antes de intentar el tutorial sobre la creación de un esquema con la API.

Primeros pasos

Este tutorial requiere un conocimiento práctico de los diversos aspectos de Adobe Experience Platform relacionados con la creación de esquemas. Antes de comenzar este tutorial, consulte la documentación de los siguientes conceptos:

Abra el espacio de trabajo Esquemas

El espacio de trabajo Esquemas de la Platform interfaz de usuario proporciona una visualización del Schema Library, lo que le permite administrar en vista los esquemas disponibles para su organización. El espacio de trabajo también incluye el Schema Editor lienzo en el que puede componer un esquema a lo largo de este tutorial.

Después de iniciar sesión en Experience Platform, seleccione Esquemas en la navegación izquierda para abrir el espacio de trabajo Esquemas. La ficha Examinar muestra una lista de esquemas (una representación de Schema Library) que puede vista y personalizar. La lista incluye el nombre, el tipo, la clase y el comportamiento (registro o serie temporal) en los que se basa el esquema, así como la fecha y la hora en que se modificó el esquema por última vez.

Consulte la guía sobre exploración de recursos XDM existentes en la interfaz de usuario para obtener más información.

Crear y asignar un nombre a un esquema

Para empezar a componer un esquema, seleccione Crear esquema en la esquina superior derecha del espacio de trabajo Esquemas. Aparece un menú desplegable que le ofrece la opción de elegir entre las clases principales Perfil individual XDM y EventoExperienciaXDM. Si estas clases no se ajustan a sus necesidades, también puede seleccionar Examinar para elegir entre otras clases disponibles o crear una nueva clase.

Para los fines de este tutorial, seleccione Perfil individual XDM.

Aparece el Schema Editor. Este es el lienzo sobre el cual compondrás tu esquema. Como eligió una clase XDM estándar en la que basar el esquema, se crea automáticamente un esquema sin título en la sección Estructura del lienzo al llegar al editor, junto con los campos estándar incluidos en todos los esquemas basados en esa clase. La clase asignada para el esquema también se encuentra en la sección Clase de Composición.

NOTA

Puede cambiar la clase de un esquema en cualquier momento durante el proceso de composición inicial antes de guardar el esquema, pero esto debe hacerse con extrema precaución. Las mezclas solo son compatibles con determinadas clases y, por lo tanto, si se cambia la clase, se restablecerán el lienzo y los campos que se hayan agregado.

Utilice los campos del lado derecho del editor para proporcionar un nombre para mostrar y una descripción opcional del esquema. Una vez introducido un nombre, el lienzo se actualiza para reflejar el nuevo nombre del esquema.

A la hora de decidir un nombre para el esquema, hay que tener en cuenta varias consideraciones importantes:

  • Los nombres de los esquemas deben ser cortos y descriptivos para que el esquema pueda encontrarse más adelante.
  • Los nombres de los esquemas deben ser únicos, lo que significa que también deben ser lo suficientemente específicos como para que no se vuelvan a utilizar en el futuro. Por ejemplo: si su organización tiene programas de lealtad separados para diferentes marcas, sería aconsejable nombrar a su esquema "Miembros de lealtad de la marca A" para que sea más fácil distinguir de otros esquemas relacionados con la lealtad que pueda definir más adelante.
  • También puede utilizar la descripción del esquema para proporcionar cualquier información contextual adicional relacionada con el esquema.

Este tutorial contiene un esquema para ingestar datos relacionados con los miembros de un programa de lealtad y, por lo tanto, el esquema se denomina "Miembros de lealtad".

Añadir una mezcla

Ahora puede empezar a agregar campos al esquema agregando mezclas. Una mezcla es un grupo de uno o más campos que se utilizan a menudo juntos para describir un concepto en particular. Este tutorial utiliza mezclas para describir los miembros del programa de lealtad y capturar información clave como nombre, cumpleaños, número de teléfono, dirección, etc.

Para agregar una mezcla, seleccione Añadir en la subsección Mezclas.

Aparece un nuevo cuadro de diálogo, que muestra una lista de mezclas disponibles. Cada mezcla está destinada únicamente a utilizarse con una clase específica, por lo que el cuadro de diálogo sólo lista mezclas compatibles con la clase seleccionada (en este caso, la clase XDM Individual Profile). Si utiliza una clase XDM estándar, la lista de mezclas se ordenará de forma inteligente en función de la popularidad del uso.

La selección de una mezcla de la lista hace que aparezca en el carril derecho. Puede seleccionar varias mezclas si lo desea, agregando cada una a la lista en el carril derecho antes de confirmar. Además, aparece un icono en el lado derecho de la mezcla seleccionada que le permite realizar una previsualización de la estructura de los campos que proporciona.

Al previsualizar una mezcla, se proporciona una descripción detallada del esquema de la mezcla en el carril derecho. También puede navegar por los campos de la mezcla en el lienzo proporcionado. Al seleccionar campos diferentes, se actualiza el carril correcto para mostrar detalles sobre el campo en cuestión. Seleccione Atrás cuando termine de obtener una vista previa para volver al cuadro de diálogo de selección de mezcla.

Para este tutorial, seleccione la mezcla Detalles demográficos y, a continuación, seleccione Añadir mezcla.

El lienzo del esquema vuelve a aparecer. La sección Mezclas ahora lista "Detalles demográficos" y la sección Estructura incluye los campos que aporta la mezcla. Puede seleccionar el nombre de la mezcla en la sección Mezclas para resaltar los campos específicos que proporciona dentro del lienzo.

Esta combinación aporta varios campos bajo el nombre de nivel superior person con el tipo de datos "Persona". Este grupo de campos describe información sobre un individuo, incluido el nombre, la fecha de nacimiento y el sexo.

NOTA

Recuerde que los campos pueden utilizar tipos escalares (como cadena, entero, matriz o fecha), así como cualquier tipo de datos (un grupo de campos que representa un concepto común) definido dentro de Schema Registry.

Observe que el campo name tiene un tipo de datos de "Nombre de la persona", lo que significa que también describe un concepto común y contiene subcampos relacionados con los nombres, como nombre, apellidos, título de cortesía y sufijo.

Seleccione los diferentes campos dentro del lienzo para mostrar los campos adicionales que contribuyen a la estructura de esquema.

Añadir otra mezcla

Ahora puede repetir los mismos pasos para agregar otra mezcla. Cuando vista el cuadro de diálogo Añadir mezcla esta vez, tenga en cuenta que la mezcla "Detalles demográficos" se ha atenuado y que la casilla de verificación situada junto a él no se puede seleccionar. Esto evita que usted duplique accidentalmente las mezclas que ya ha incluido en el esquema actual.

Para este tutorial, seleccione la mezcla "Personal Contact Details" en el cuadro de diálogo y, a continuación, seleccione Añadir mezcla para agregarla al esquema.

Una vez agregado, el lienzo vuelve a aparecer. "Detalles de contacto personal" ahora se encuentra en Mezclas en la sección Composición, y se han agregado campos para dirección doméstica, teléfono móvil y más en Estructura.

Al igual que el campo name, los campos que acaba de agregar representan conceptos de varios campos. Por ejemplo, homeAddress tiene un tipo de datos de "dirección postal" y mobilePhone tiene un tipo de datos de "número de teléfono". Puede seleccionar cada uno de estos campos para expandirlos y ver los campos adicionales incluidos en el tipo de datos.

Definir una nueva mezcla

El esquema "Miembros de lealtad" tiene el propósito de capturar datos relacionados con los miembros de un programa de lealtad, por lo que requerirá algunos campos específicos relacionados con la lealtad. No hay mezclas estándar disponibles que contengan los campos necesarios, por lo tanto deberá definir una nueva mezcla.

Esta vez, cuando abra el cuadro de diálogo Añadir mezcla, seleccione Crear nueva mezcla. Luego se le pedirá que proporcione un nombre para mostrar y una descripción para la mezcla.

Al igual que con los nombres de clase, el nombre de la mezcla debe ser corto y simple, describiendo lo que la mezcla contribuirá al esquema. Estos también son únicos, por lo que no podrá reutilizar el nombre y, por lo tanto, debe asegurarse de que sea lo suficientemente específico.

Para este tutorial, asigne un nombre a la nueva combinación "Detalles de lealtad".

Seleccione Añadir mezcla para volver a Schema Editor. "Detalles de lealtad" debe aparecer ahora en Mezclas en el lado izquierdo del lienzo, pero aún no hay campos asociados a él y, por lo tanto, no aparecen nuevos campos en Estructura.

Añadir campos a la mezcla

Ahora que ha creado la mezcla "Detalles de Lealtad", es hora de definir los campos que la mezcla contribuirá al esquema.

Para comenzar, seleccione el nombre de la mezcla en la sección Mezclas. Una vez hecho esto, las propiedades de la mezcla aparecen en la parte derecha del editor y aparece un icono más (+) junto al nombre del esquema en Estructura.

Seleccione el icono más (+) junto a "Loyalty Members" para crear un nuevo nodo en la estructura. Este nodo (denominado _tenantId en este ejemplo) representa la ID de inquilino de la organización de IMS, precedida por un guion bajo. La presencia de la ID de inquilino indica que los campos que está agregando están contenidos en la Área de nombres de su organización.

En otras palabras, los campos que está agregando son exclusivos de su organización y se guardarán en Schema Registry en un área específica a la que solo pueda acceder su organización. Los campos que defina siempre deben agregarse a la Área de nombres del inquilino para evitar conflictos con nombres de otras clases estándar, mezclas, tipos de datos y campos.

Dentro de ese nodo con espacio de nombres hay un "Nuevo campo". Este es el comienzo de la mezcla "Detalles de lealtad".

Con los controles del lado derecho del editor, cree un campo loyalty de inicio con el tipo "Object" que se utilizará para mantener los campos relacionados con la lealtad. Cuando termine, seleccione Aplicar.

Los cambios se aplican y aparece el objeto loyalty recién creado. Seleccione el icono más (+) junto al objeto para agregar campos adicionales relacionados con la lealtad. Aparece un "Nuevo campo" y la sección Propiedades del campo está visible en el lado derecho del lienzo.

Cada campo requiere la siguiente información:

  • Nombre del campo: El nombre del campo, escrito en caso de camello. Ejemplo: loyaltyLevel
  • Nombre para mostrar: el nombre del campo, escrito en el caso del título. Ejemplo: Nivel de fidelidad
  • Tipo: El tipo de datos del campo. Esto incluye tipos escalares básicos y cualquier tipo de datos definido en Schema Registry. Ejemplos: Cadena, Entero, Boolean, Persona, Dirección, Número de teléfono, etc.
  • Descripción: Se debe incluir una descripción opcional del campo, escrita en caso de sentencia, con un máximo de 200 caracteres.

El primer campo del objeto Loyalty será una cadena llamada loyaltyId. Al establecer el tipo del nuevo campo en "String", la sección Propiedades del campo se llena con varias opciones para aplicar restricciones, incluido el valor predeterminado, el formato y la longitud máxima.

Hay diferentes opciones de restricción disponibles según el tipo de datos seleccionado. Dado que loyaltyId será una dirección de correo electrónico, seleccione "correo electrónico" en el menú desplegable Formato. Seleccione Aplicar para aplicar los cambios.

Añadir más campos a la mezcla

Ahora que ha agregado el campo loyaltyId, puede agregar campos adicionales para capturar información relacionada con la lealtad como:

  • Puntos (entero)
  • Miembro desde (fecha)

Para agregar cada campo al esquema, seleccione el icono más (+) junto al objeto loyalty y rellene la información requerida.

Una vez completado, el objeto Lealtad contendrá campos para ID de lealtad, puntos y elementos desde los que se obtuvo.

Añadir un campo de enumeración a la mezcla

Al definir campos en Schema Editor, existen algunas opciones adicionales que puede aplicar a los tipos de campo básicos para proporcionar restricciones adicionales en los datos que el campo puede contener. Los casos de uso de estas restricciones se explican en la siguiente tabla:

Restricción Descripción
Requerido Indica que el campo es obligatorio para la ingesta de datos. Cualquier dato cargado en un conjunto de datos basado en este esquema que no contenga este campo fallará durante la ingestión.
Matriz Indica que el campo contiene una matriz de valores, cada uno con el tipo de datos especificado. Por ejemplo, si se utiliza esta restricción en un campo con un tipo de datos "String", se especifica que el campo contendrá una matriz de cadenas.
Enum Indica que este campo debe contener uno de los valores de una lista enumerada de valores posibles.
Identidad Indica que este campo es un campo de identidad. Más información sobre los campos de identidad se proporciona más adelante en este tutorial.
Relación Aunque las relaciones de esquema se pueden inferir mediante el uso del esquema de unión y Real-time Customer Profile, esto solo se aplica a esquemas que comparten la misma clase. La restricción Relationship indica que este campo hace referencia a la identidad principal de un esquema basado en una clase diferente, lo que implica una relación entre los dos esquemas. Consulte el tutorial sobre definición de una relación para obtener más información.
NOTA

Todos los campos obligatorios, de identidad o de relación se muestran en el carril izquierdo, lo que permite localizar estos campos fácilmente independientemente de la complejidad del esquema.

Para este tutorial, el objeto “loyalty” del esquema requiere un nuevo campo de enumeración que describa el “nivel de lealtad” de un cliente, donde el valor sólo puede ser una de las cuatro opciones posibles. Para agregar este campo al esquema, seleccione el icono más (+) junto al objeto loyalty y rellene los campos obligatorios para Nombre del campo y Nombre para mostrar. Para Tipo, seleccione “Cadena”.

Aparecerán casillas de verificación adicionales para el campo después de que se haya seleccionado su tipo, incluidas las casillas de verificación para Array, Enum e Identity.

Seleccione la casilla Enum para abrir la sección Enum values a continuación. Aquí puede introducir el valor (en camelCase) y etiqueta (un nombre opcional y fácil de leer en el caso del título) para cada nivel de lealtad aceptable.

Cuando haya completado todas las propiedades del campo, seleccione Aplicar para agregar el campo "loyaltyLevel" al objeto loyalty.

Conversión de un objeto de varios campos en un tipo de datos

El objeto loyalty ahora contiene varios campos específicos de lealtad y representa una estructura de datos común que podría ser útil en otros esquemas. El Schema Editor permite aplicar fácilmente objetos de varios campos reutilizables mediante la conversión de la estructura de esos objetos en tipos de datos.

Los tipos de datos permiten el uso coherente de estructuras de varios campos y proporcionan más flexibilidad que una mezcla, ya que se pueden utilizar en cualquier lugar dentro de un esquema. Esto se realiza estableciendo el valor Type del campo en el valor de cualquier tipo de datos definido en Schema Registry.

Para convertir el objeto loyalty en un tipo de datos, seleccione el campo loyalty en Estructura y, a continuación, seleccione Convertir en nuevo tipo de datos en el lado derecho del editor en Propiedades del campo. Aparece una ventana emergente verde que confirma que el objeto se ha convertido correctamente.

Ahora, cuando consulta en Estructura, puede ver que el campo loyalty tiene un tipo de datos "Loyalty" y que los campos tienen iconos de bloqueo pequeños junto a ellos, lo que indica que ya no son campos individuales sino que forman parte de un tipo de datos de varios campos.

En un esquema futuro, ahora se puede asignar un campo como tipo "Loyalty" y se incluirán automáticamente campos para ID, nivel de lealtad, miembro desde y puntos.

NOTA

También puede crear y editar tipos de datos personalizados independientemente de la edición de esquemas. Consulte la guía sobre creación y edición de tipos de datos para obtener más información.

Buscar y filtrar campos de esquema

El esquema ahora contiene varias mezclas además de los campos proporcionados por su clase base. Al trabajar con esquemas más grandes, puede seleccionar las casillas de verificación situadas junto a los nombres de las mezclas en el carril izquierdo para filtrar los campos mostrados únicamente a los proporcionados por las mezclas que le interesen.

Si busca un campo específico en el esquema, también puede utilizar la barra de búsqueda para filtrar los campos mostrados por nombre, independientemente de la mezcla en la que se proporcionen.

IMPORTANTE

La función de búsqueda tiene en cuenta cualquier filtros de mezcla seleccionado al mostrar los campos coincidentes. Si una consulta de búsqueda no muestra los resultados esperados, es posible que tenga que comprobar con doble que no está filtrando ninguna mezcla relevante.

Establecer un campo de esquema como campo de identidad

La estructura de datos estándar que proporcionan los esquemas se puede aprovechar para identificar los datos que pertenecen a la misma persona en múltiples fuentes, permitiendo diversos casos de uso descendente como segmentación, sistema de informes, análisis de la ciencia de datos, etc. Para poder unir datos en función de identidades individuales, los campos clave deben marcarse como campos Identidad dentro de los esquemas aplicables.

Experience Platform facilita la identificación de un campo de identidad mediante el uso de una casilla de verificación ​Identidad en la Schema Editor. Sin embargo, debe determinar qué campo es el mejor candidato para utilizar como identidad, en función de la naturaleza de los datos.

Por ejemplo, puede haber miles de miembros del programa de lealtad que pertenecen al mismo "nivel de lealtad", pero cada miembro del programa de lealtad tiene un loyaltyId único (que en este caso es la dirección de correo electrónico del miembro individual). El hecho de que loyaltyId sea un identificador único para cada miembro lo convierte en un buen candidato para un campo de identidad, mientras que loyaltyLevel no lo es.

IMPORTANTE

Los pasos que se describen a continuación explican cómo agregar un descriptor de identidad a un campo de esquema existente. Como alternativa a definir campos de identidad dentro de la estructura del esquema mismo, también puede utilizar un campo identityMap para contener información de identidad.

Si planea utilizar identityMap, tenga en cuenta que anulará cualquier identidad principal que agregue directamente al esquema. Consulte la sección sobre identityMap en la guía básica de composición de esquema para obtener más información.

En la sección Estructura del editor, seleccione el campo loyaltyId y la casilla Identidad aparece en Propiedades del campo. Marque la casilla y la opción para establecerla como Identidad principal aparece. Seleccione también este cuadro.

NOTA

Cada esquema puede contener sólo un campo de identidad principal. Una vez que un campo de esquema se haya establecido como identidad principal, recibirá un mensaje de error si posteriormente intenta establecer otro campo de identidad en el esquema como principal.

A continuación, debe proporcionar una Área de nombres de identidad desde la lista de Áreas de nombres predefinidas en el menú desplegable. Dado que loyaltyId es la dirección de correo electrónico del cliente, seleccione "Correo electrónico" en la lista desplegable. Seleccione Aplicar para confirmar las actualizaciones en el campo loyaltyId.

NOTA

Para obtener una lista de las Áreas de nombres estándar y sus definiciones, consulte la Identity Service documentación.

Después de aplicar el cambio, el icono para loyaltyId muestra un símbolo de huella digital, que indica que ahora es un campo de identidad.

Ahora, todos los datos ingestados en el campo loyaltyId se utilizarán para identificar a esa persona y unir una sola vista de ese cliente. Para obtener más información sobre cómo trabajar con identidades en Experience Platform, consulte la documentación de Identity Service.

Habilitar el esquema para su uso en Real-time Customer Profile

Real-time Customer Profile aprovecha los datos de identidad Experience Platform para proporcionar una vista holística de cada cliente individual. El servicio crea sólidos perfiles de 360° de atributos del cliente, así como cuentas con marca de hora de cada interacción que los clientes han tenido en cualquier sistema integrado con Experience Platform.

Para que un esquema se pueda habilitar para su uso con Real-time Customer Profile, debe tener una identidad principal definida. Recibirá un mensaje de error si intenta habilitar un esquema sin definir primero una identidad principal.


Para habilitar el esquema "Miembros de lealtad" para su uso en Profile, comience por seleccionar "Loyalty Members" en la sección Estructura del editor.

A la derecha del editor, se muestra información sobre el esquema, incluido su nombre para mostrar, descripción y tipo. Además de esta información, existe un botón de alternancia Perfil.

Seleccione Perfil y aparecerá una ventana emergente, pidiéndole que confirme que desea habilitar el esquema para Profile.


ADVERTENCIA

Una vez que un esquema se ha habilitado para Real-time Customer Profile y guardado, no se puede deshabilitar.

Seleccione Habilitar para confirmar su elección. Puede seleccionar el Perfil de nuevo para deshabilitar el esquema si lo desea, pero una vez guardado el esquema mientras Profile está habilitado, ya no se puede deshabilitar.

Próximos pasos y recursos adicionales

Ahora que ha terminado de componer el esquema, puede ver el esquema completo en el lienzo. Seleccione Guardar y el esquema se guardará en Schema Library, lo que lo hará accesible desde Schema Registry.

El nuevo esquema ahora se puede usar para ingestar datos en Platform. Recuerde que una vez que el esquema se ha utilizado para ingestar datos, sólo se pueden realizar cambios aditivos. Consulte los conceptos básicos de la composición de esquema para obtener más información sobre el control de versiones de esquema.

Ahora puede seguir el tutorial sobre definición de una relación de esquema en la IU para agregar un nuevo campo de relación al esquema "Miembros de lealtad".

El esquema "Miembros de lealtad" también está disponible para su visualización y administración mediante la API Schema Registry. Para empezar a trabajar con la API, lea la Schema Registry API guía para desarrolladores para comenzar a trabajar con ella.

Recursos de vídeo

ADVERTENCIA

La Platform IU que se muestra en los siguientes vídeos no está actualizada. Consulte la documentación anterior para obtener las capturas de pantalla y la funcionalidad más recientes de la interfaz de usuario.

El siguiente vídeo muestra cómo crear un esquema simple en la interfaz de usuario Platform.

El siguiente vídeo pretende reforzar su comprensión del trabajo con mezclas y clases.

Apéndice

Las secciones siguientes proporcionan información adicional sobre el uso de Schema Editor.

Crear una nueva clase

Experience Platform proporciona la flexibilidad necesaria para definir un esquema basado en una clase exclusiva de su organización. Para obtener información sobre cómo crear una nueva clase, consulte la guía sobre creación y edición de clases en la interfaz de usuario.

Cambiar la clase de un esquema

Puede cambiar la clase de un esquema en cualquier momento durante el proceso de composición inicial antes de guardar el esquema.

ADVERTENCIA

La reasignación de la clase para un esquema debe realizarse con extrema precaución. Las mezclas solo son compatibles con determinadas clases y, por lo tanto, si se cambia la clase, se restablecerán el lienzo y los campos que se hayan agregado.

Para obtener información sobre cómo cambiar la clase de un esquema, consulte la guía sobre administración de esquemas en la interfaz de usuario.

En esta página