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

NOTA

Para fines de demostración, los pasos de este tutorial implican la creación de un esquema de ejemplo que describa los miembros de un programa de fidelidad de 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 de Schema Editor.

Si prefiere componer un esquema utilizando la API Schema Registry en su lugar, comience leyendo 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 una comprensión práctica de los distintos aspectos de Adobe Experience Platform implicados en la creación de esquemas. Antes de comenzar este tutorial, consulte la documentación de los siguientes conceptos:

  • Experience Data Model (XDM): El marco estandarizado mediante el cual se Platform organizan los datos de experiencia del cliente.
    • Aspectos básicos de la composición del esquema: Una descripción general de los esquemas XDM y sus componentes básicos, incluidas las clases, los grupos de campos de esquema, los tipos de datos y los campos individuales.
  • Real-time Customer Profile: Proporciona un perfil de cliente unificado y en tiempo real basado en datos agregados de varias fuentes.

Abra el espacio de trabajo Esquemas

El espacio de trabajo Esquemas en la interfaz de usuario Platform proporciona una visualización del Schema Library, lo que le permite ver y administrar los esquemas disponibles para su organización. El espacio de trabajo también incluye el Schema Editor, el 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 el panel de navegación izquierdo para abrir el espacio de trabajo Esquemas. La pestaña Browse muestra una lista de esquemas (una representación del Schema Library) que puede ver 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 de la última modificación del esquema.

Consulte la guía Exploración de los 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 Create schema en la esquina superior derecha del espacio de trabajo schemas. Aparece un menú desplegable que le ofrece la opción de elegir entre las clases principales XDM Individual Profile y XDM ExperienceEvent. Si estas clases no se adaptan a sus necesidades, también puede seleccionar Browse para elegir entre otras clases disponibles o crear una nueva clase.

Para los fines de este tutorial, seleccione XDM Individual Profile.

Dado que elige una clase XDM estándar en la que se basa el esquema, aparece el cuadro de diálogo Add field group, que le permite empezar a añadir campos inmediatamente al esquema. Por ahora, seleccione Cancelar para salir del cuadro de diálogo.

Aparece el Schema Editor. Este es el lienzo sobre el que compondrá el esquema. Se crea automáticamente un esquema sin título en la sección Structure 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 enumera en Clase en la sección 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 mucha precaución. Los grupos de campos solo son compatibles con ciertas clases y, por lo tanto, al cambiar la clase se restablecerá el lienzo y los campos que haya agregado.

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

Hay que tener en cuenta varias consideraciones importantes a la hora de decidir un nombre para el esquema:

  • Los nombres de esquema deben ser cortos y descriptivos para que el esquema se pueda encontrar fácilmente más adelante.
  • Los nombres de esquema 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 fidelidad separados para diferentes marcas, sería aconsejable nombrar al esquema "Miembros de fidelidad de marca A" para que sea más fácil distinguir de otros esquemas relacionados con la fidelidad que podría 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 compone un esquema para introducir datos relacionados con los miembros de un programa de fidelidad y, por lo tanto, el esquema se denomina "Miembros de fidelidad".

Agregar un grupo de campos

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

Para agregar un grupo de campos, seleccione Add en la subsección Field groups.

Aparece un nuevo cuadro de diálogo que muestra una lista de los grupos de campos disponibles. Cada grupo de campos solo está diseñado para utilizarse con una clase específica, por lo que el cuadro de diálogo solo enumera los grupos de campos compatibles con la clase seleccionada (en este caso, la clase XDM Individual Profile ). Si utiliza una clase XDM estándar, la lista de grupos de campos se ordenará de forma inteligente según la popularidad de uso.

Si se selecciona un grupo de campos de la lista, este aparecerá en el carril derecho. Si lo desea, puede seleccionar varios grupos de campos, agregándolos a la lista en el carril derecho antes de confirmarlos. Además, aparece un icono en el lado derecho del grupo de campos seleccionado que permite obtener una vista previa de la estructura de los campos que proporciona.

Al obtener una vista previa de un grupo de campos, se proporciona una descripción detallada del esquema del grupo de campos en el carril derecho. También puede navegar por los campos del grupo de campos en el lienzo proporcionado. A medida que selecciona diferentes campos, el carril derecho se actualiza para mostrar detalles sobre el campo en cuestión. Seleccione Back cuando haya terminado de obtener una vista previa para volver al cuadro de diálogo de selección del grupo de campos.

Para este tutorial, seleccione el grupo de campos Demographic Details y, a continuación, seleccione Add field group.

El lienzo del esquema vuelve a aparecer. La sección Field groups ahora enumera "Demographic Details" y la sección Structure incluye los campos aportados por el grupo de campos. Puede seleccionar el nombre del grupo de campos en la sección Field groups para resaltar los campos específicos que proporciona dentro del lienzo.

Este grupo de campos contribuye con 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 "Person name", 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 del esquema.

Agregar otro grupo de campos

Ahora puede repetir los mismos pasos para agregar otro grupo de campos. Cuando vea el cuadro de diálogo Agregar grupo de campos esta vez, observe que el grupo de campos "Detalles demográficos" se ha atenuado y la casilla de verificación situada junto a él no se puede seleccionar. Esto evita que se dupliquen accidentalmente los grupos de campos que ya se han incluido en el esquema actual.

Para este tutorial, seleccione el grupo de campos "Personal Contact Details" en el cuadro de diálogo y, a continuación, seleccione Add field group para agregarlo al esquema.

Una vez añadido, el lienzo vuelve a aparecer. "Detalles de contacto personal" ahora aparece en Grupos de campo en la sección Composición, y se han agregado campos para dirección de inicio, teléfono móvil y más en Estructura.

Al igual que el campo name , los campos que acaba de añadir 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 un grupo de campos personalizado

El esquema "Loyalty Members" está diseñado para capturar datos relacionados con los miembros de un programa de fidelidad, por lo que se necesitarán algunos campos específicos relacionados con la fidelidad.

Hay un grupo de campos Detalles de lealtad estándar que puede agregar al esquema para capturar campos comunes relacionados con un programa de fidelidad. Aunque se le recomienda encarecidamente que utilice grupos de campos estándar para representar los conceptos capturados por los esquemas, es posible que la estructura del grupo de campos de lealtad estándar no pueda capturar todos los datos relevantes para su programa de fidelidad en particular. En esta situación, puede definir un nuevo grupo de campos personalizados para capturar estos campos.

Vuelva a abrir el cuadro de diálogo Agregar grupo de campos, pero esta vez seleccione Crear nuevo grupo de campos cerca de la parte superior. A continuación, se le pedirá que proporcione un nombre para mostrar y una descripción para su grupo de campos.

Al igual que con los nombres de clase, el nombre del grupo de campos debe ser corto y sencillo, describiendo lo que el grupo de campos contribuirá al esquema. Estas también son únicas, 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 al nuevo grupo de campos el nombre "Detalles de lealtad".

Seleccione Add field group para volver al Schema Editor. "Detalles de lealtad" debería aparecer ahora en Grupos de campos en el lado izquierdo del lienzo, pero aún no hay campos asociados a él y, por lo tanto, no aparecen campos nuevos en Estructura.

Agregar campos al grupo de campos

Ahora que ha creado el grupo de campos "Detalles de lealtad", ha llegado el momento de definir los campos que el grupo de campos contribuirá al esquema.

Para empezar, seleccione el nombre del grupo de campos en la sección Field groups. Una vez hecho esto, las propiedades del grupo de campos aparecen en el lado derecho del editor y aparece un icono plus (+) junto al nombre del esquema en Structure.

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

En otras palabras, los campos que agregue son únicos para su organización y se guardarán en Schema Registry en un área específica accesible solo para su organización. Los campos que defina siempre deben agregarse al espacio de nombres del inquilino para evitar conflictos con nombres de otras clases estándar, grupos de campos, tipos de datos y campos.

Dentro de ese nodo con espacio de nombres hay un "Nuevo campo". Este es el principio del grupo de campos "Detalles de lealtad".

Con los controles del lado derecho del editor, comience creando un campo loyalty con el tipo "Object" que se utilizará para incluir 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 plus (+) situado junto al objeto para añadir 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 el caso del 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 el Schema Registry. Ejemplos: Cadena, Entero, Booleano, 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 denominada loyaltyId. Al establecer el tipo del nuevo campo en "String", la sección Field properties se rellena con varias opciones para aplicar restricciones, incluidos el valor predeterminado, el formato y la longitud máxima.

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

Agregar más campos al grupo de campos

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 añadir cada campo al esquema, seleccione el icono plus (+) junto al objeto loyalty y rellene la información necesaria.

Cuando se complete, el objeto Lealtad contendrá campos para ID de fidelidad, puntos y desde entonces.

Añadir un campo de enumeración al grupo de campos

Al definir campos en Schema Editor, hay algunas opciones adicionales que puede aplicar a tipos de campo básicos para proporcionar más restricciones 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 necesario para la ingesta de datos. Cualquier dato cargado en un conjunto de datos basado en este esquema que no contenga este campo fallará tras la ingesta.
Matriz Indica que el campo contiene una matriz de valores, cada uno con el tipo de datos especificado. Por ejemplo, el uso de esta restricción en un campo con un tipo de datos de "String" 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 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

Los campos requeridos, 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 solo puede ser una de las cuatro opciones posibles. Para añadir este campo al esquema, seleccione el icono plus (+) junto al objeto loyalty y rellene los campos obligatorios para Field name y Display name. Para Type, seleccione “String”.

Después de seleccionar su tipo, aparecen casillas de verificación adicionales para el campo, incluidas las casillas de verificación Array, Enum e Identity.

Active la casilla Enum para abrir la sección Enum values que aparece a continuación. Aquí puede introducir el Value (en camelCase) y la Label (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 Apply 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 resultar útil en otros esquemas. El Schema Editor permite aplicar fácilmente objetos de varios campos reutilizables convirtiendo 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 un grupo de campos, ya que se pueden utilizar en cualquier lugar dentro de un esquema. Esto se hace 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, al mirar en Structure, 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 parte de un tipo de datos de varios campos.

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

NOTA

También puede crear y editar tipos de datos personalizados de forma independiente 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 varios grupos de campos 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 los grupos de campos en el carril izquierdo para filtrar los campos mostrados únicamente a los proporcionados por los grupos de campos que le interesen.

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

IMPORTANTE

La función de búsqueda tiene en cuenta los filtros de grupo de campos seleccionados al mostrar los campos coincidentes. Si una consulta de búsqueda no muestra los resultados esperados, es posible que tenga que verificar que no está filtrando ningún grupo de campos 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 al mismo individuo en múltiples fuentes, lo que permite varios casos de uso descendente como segmentación, informes, análisis de ciencia de datos, etc. Para unir datos en función de identidades individuales, los campos clave deben marcarse como campos Identity 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 ​Identityen Schema Editor. Sin embargo, debe determinar qué campo es el mejor candidato para utilizarlo como identidad, en función de la naturaleza de los datos.

Por ejemplo, puede haber miles de miembros del programa de fidelidad que pertenezcan al mismo "nivel de fidelidad", pero cada miembro del programa de fidelidad 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 abarcan 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 propio esquema, también puede utilizar un campo identityMap para contener información de identidad en su lugar.

Si planea utilizar identityMap, tenga en cuenta que anulará cualquier identidad principal que agregue al esquema directamente. 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 Structure del editor, seleccione el campo loyaltyId y la casilla Identity aparece en Field properties. Marque la casilla y la opción para establecerla como aparece la Primary identity. Seleccione también este cuadro.

NOTA

Cada esquema puede contener solo un campo de identidad principal. Una vez que se ha establecido un campo de esquema como identidad principal, recibirá un mensaje de error si más tarde intenta establecer otro campo de identidad en el esquema como principal.

A continuación, debe proporcionar un espacio de nombres de identidad de la lista de espacios de nombres predefinidos de la lista desplegable. Dado que loyaltyId es la dirección de correo electrónico del cliente, seleccione "Correo electrónico" en la lista desplegable. Seleccione Apply para confirmar las actualizaciones del campo loyaltyId.

NOTA

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

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

Ahora todos los datos incorporados en el campo loyaltyId se utilizan para ayudar a identificar a ese individuo 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 utilizarlo en Real-time Customer Profile

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

Para que un esquema esté habilitado para utilizarse 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, hay un botón de alternancia Profile.

Seleccione Perfil y aparecerá una ventana emergente para pedirle que confirme que desea habilitar el esquema para Profile.


ADVERTENCIA

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

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

Pasos siguientes y recursos adicionales

Ahora que ha terminado de componer el esquema, puede ver el esquema completo en el lienzo. Seleccione Save y el esquema se guardará en Schema Library, de modo que el Schema Registry pueda acceder a él.

El nuevo esquema ahora se puede usar para introducir datos en Platform. Recuerde que una vez que el esquema se ha utilizado para introducir datos, solo 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 esquemas.

Ahora puede seguir el tutorial sobre la definición de una relación de esquema en la interfaz de usuario 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.

Recursos de vídeo

ADVERTENCIA

La interfaz de usuario Platform que se muestra en los siguientes vídeos no está actualizada. Consulte la documentación anterior para obtener las últimas capturas de pantalla y funciones 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 grupos de campo 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 para definir un esquema basado en una clase que sea única para su organización. Para aprender a 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. Los grupos de campos solo son compatibles con ciertas clases y, por lo tanto, al cambiar la clase se restablecerá el lienzo y los campos que haya agregado.

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

En esta página