Cree un esquema con la variable Schema Editor
La interfaz de usuario de Adobe Experience Platform le permite crear y administrar Experience Data Model (XDM) en un lienzo visual interactivo denominado Schema Editor. Este tutorial explica cómo crear un esquema con la variable Schema Editor.
Para fines de demostración, los pasos de este tutorial implican la creación de un esquema de ejemplo que describe a los miembros de un programa de lealtad de clientes. Aunque puede utilizar estos pasos para crear un esquema diferente para sus propios fines, se recomienda que siga primero junto con la creación del esquema de ejemplo para conocer las capacidades del Schema Editor.
Introducción
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, revise la documentación para los siguientes conceptos:
- Experience Data Model (XDM): El marco estandarizado mediante el cual Platform organiza los datos de experiencia del cliente.
- Conceptos básicos de composición de esquemas: Información general sobre los esquemas XDM y sus componentes básicos, incluidas clases, grupos de campos de esquema, tipos de datos y campos individuales.
- Real-Time Customer Profile: Proporciona un perfil de consumidor unificado y en tiempo real basado en los datos agregados de varias fuentes.
Abra el Esquemas workspace browse
El Esquemas workspace en Platform La interfaz de usuario de proporciona una visualización de Schema Library, lo que le permite ver y administrar los esquemas disponibles para su organización. El espacio de trabajo también incluye 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 la navegación izquierda para abrir Esquemas workspace. El Examinar pestaña muestra una lista de esquemas (una representación de la variable Schema Library) para que usted las vea y las personalice. 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.
Consulte la guía de exploración de recursos XDM existentes en la IU para obtener más información.
Creación y asignación de nombres a un esquema create
Para empezar a maquetar un esquema, seleccione Crear esquema en la esquina superior derecha de la Esquemas workspace.
El Crear esquema flujo de trabajo aparece. A continuación, elija una clase base para el esquema. Puede elegir entre las clases principales de Perfil individual de XDM y ExperienceEvent de XDM, o Otros si estas clases no se adaptan a sus propósitos. El Otros La opción de clases permite crear una nueva clase o elija entre otras clases preexistentes.
Consulte la Perfil individual de XDM y ExperienceEvent de XDM para obtener más información sobre estas clases. Para los fines de este tutorial, seleccione Perfil individual de XDM seguido de Siguiente.
Después de seleccionar una clase, la variable Nombre y revisión aparece la sección. En esta sección, proporcione un nombre y una descripción para identificar el esquema. Hay varias consideraciones importantes que se deben tener en cuenta al decidir un nombre para el esquema:
- Los nombres de los esquemas deben ser cortos y descriptivos para que el esquema se pueda encontrar fácilmente más adelante.
- Los nombres de los esquemas deben ser únicos, lo que significa que también deben ser lo suficientemente específicos para que no se reutilicen en el futuro. Por ejemplo, si su organización tiene programas de fidelización independientes para diferentes marcas, sería aconsejable nombrar el esquema "Miembros fieles de marca A" para que sea fácil distinguirlo 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 sobre 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 "Loyalty Members".
La estructura base del esquema (proporcionada por la clase ) se muestra en el lienzo para que revise y compruebe la clase y la estructura de esquema seleccionadas.
Introduce un amigo de los humanos Nombre para mostrar del esquema en el campo de texto. A continuación, introduzca una descripción adecuada para ayudar a identificar el esquema. Cuando haya revisado la estructura de esquema y esté satisfecho con la configuración, seleccione Finalizar para crear el esquema.
El Schema Editor aparece. Este es el lienzo sobre el que compondrá el esquema. El esquema con título propio se crea automáticamente en la variable Estructura del lienzo cuando llegue al editor, junto con los campos estándar incluidos en la clase base que seleccionó. La clase asignada para el esquema también se enumera en Clase in Composición sección.
Adición de un grupo de campos field-group
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 a los miembros del programa de fidelidad y capturar información clave como el nombre, el cumpleaños, el número de teléfono, la dirección, etc.
Para añadir un grupo de campos, seleccione Añadir en el Grupos de campos subsección.
Aparece un nuevo cuadro de diálogo que muestra una lista de grupos de campos disponibles. Cada grupo de campos está diseñado para utilizarse únicamente con una clase específica; por lo tanto, el cuadro de diálogo solo enumera los grupos de campos compatibles con la clase seleccionada (en este caso, la variable XDM Individual Profile class). Si utiliza una clase XDM estándar, la lista de grupos de campos se ordenará de forma inteligente en función de la popularidad del uso.
Puede seleccionar uno de los filtros en el carril izquierdo para reducir la lista de grupos de campos estándar a específicos industrias como venta minorista, servicios financieros y atención sanitaria.
Al seleccionar un grupo de campos de la lista, aparece en el carril derecho. Si lo desea, puede seleccionar varios grupos de campos y añadir cada uno a la lista en el carril derecho antes de confirmar. Además, aparece un icono en el lado derecho del grupo de campos seleccionado actualmente que le permite previsualizar 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. Seleccionar Atrás cuando haya terminado de previsualizar para volver al cuadro de diálogo de selección de grupos de campos.
Para este tutorial, seleccione la Datos demográficos grupo de campos y seleccione Agregar grupo de campos.
El lienzo del esquema vuelve a aparecer. El Grupos de campos La sección ahora enumera "Datos demográficos" y el Estructura incluye los campos aportados por el grupo de campos. Puede seleccionar el nombre del grupo de campos en la variable Grupos de campos para resaltar los campos específicos que proporciona dentro del lienzo.
Este grupo de campos 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.
Observe que la variable name tiene un tipo de datos de "Nombre completo", lo que significa que también describe un concepto común y contiene subcampos relacionados con el nombre, como nombre, apellidos, título de cortesía y sufijo.
Seleccione los diferentes campos dentro del lienzo para mostrar cualquier campo adicional que contribuyan a la estructura del esquema.
Añadir más grupos de campos field-group-2
Ahora puede repetir los mismos pasos para agregar otro grupo de campos. Cuando vea la Agregar grupo de campos esta vez, observe que la opción "Datos demográficos" el grupo de campos se ha atenuado y la casilla de verificación situada junto a él no se puede seleccionar. Esto evita que duplique accidentalmente grupos de campos que ya ha incluido en el esquema actual.
Para este tutorial, seleccione los grupos de campos estándar Datos personales de contacto y Detalles de fidelización en la lista, seleccione Adición de grupos de campos para añadirlos al esquema.
El lienzo vuelve a aparecer con los grupos de campos añadidos enumerados en Grupos de campos en el Composición y sus campos compuestos añadidos a la estructura del esquema.
Definir un grupo de campos personalizados define-field-group
El Miembros socio El esquema está diseñado para capturar datos relacionados con los miembros de un programa de fidelidad y el estándar de Detalles de fidelización el grupo de campos que ha agregado al esquema proporciona la mayoría de estos elementos, incluido el tipo de programa, los puntos, la fecha de unión, etc.
Sin embargo, puede haber un escenario en el que desee incluir campos personalizados adicionales no cubiertos por grupos de campos estándar para lograr sus casos de uso. En el caso de agregar campos de lealtad personalizados, tiene dos opciones:
- Cree un nuevo grupo de campos personalizados para capturar estos campos. Este es el método que se explica en este tutorial.
- Ampliación del estándar Detalles de fidelización grupo de campos con campos personalizados. Esto causa Detalles de fidelización para convertirlo en un grupo de campos personalizados y el grupo de campos estándar original ya no estará disponible. Consulte la Esquemas Guía de la IU para obtener más información sobre agregar campos personalizados a la estructura de grupos de campos estándar.
Para crear un nuevo grupo de campos, seleccione Añadir en el Grupos de campos subsección como antes, pero esta vez seleccione Crear nuevo grupo de campos cerca de la parte superior del cuadro de diálogo que aparece. A continuación, se le pedirá que proporcione un nombre para mostrar y una descripción para el nuevo grupo de campos. Para este tutorial, asigne un nombre al nuevo grupo de campos "Custom Loyalty Details", y luego seleccione Adición de grupos de campos.
"Custom Loyalty Details" debería aparecer ahora en Grupos de campos a la izquierda 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 field-group-fields
Ahora que ha creado el "Custom Loyalty Details" grupo de campos, es hora de definir los campos que el grupo de campos contribuirá al esquema.
Para empezar, seleccione la más (+) junto al nombre del esquema en el lienzo.
Un "Campo sin títuloEl marcador de posición " aparece en el lienzo y el carril derecho se actualiza para mostrar las opciones de configuración del campo.
En esta situación, el esquema debe tener un campo de tipo de objeto que describa en detalle el nivel de lealtad actual de la persona. Con los controles del carril derecho, empiece a crear un loyaltyTier campo con tipo "Objeto" que se utilizará para guardar los campos relacionados.
En Asignar a, debe seleccionar un grupo de campos al que asignar el campo. Recuerde que todos los campos de esquema pertenecen a una clase o a un grupo de campos y, como este esquema utiliza una clase estándar, la única opción es seleccionar un grupo de campos. Empiece a escribir el nombre "Custom Loyalty Details" y, a continuación, seleccione el grupo de campos de la lista.
Cuando termine, seleccione Aplicar.
Los cambios se aplican y el recién creado loyaltyTier aparece el objeto. Como es un campo personalizado, se anida automáticamente dentro de un espacio de nombres de objeto al ID de inquilino de su organización, precedido de un guion bajo (_tenantId en este ejemplo).
Seleccione el más (+) junto al icono loyaltyTier para empezar a añadir subcampos. Aparece un nuevo marcador de posición de campo y la variable Propiedades del campo Esta sección es visible en el lado derecho del lienzo.
Cada campo requiere la siguiente información:
- Nombre de campo: El nombre del campo, preferiblemente escrito en camelCase. No se permiten caracteres de espacio. Es el nombre que se utiliza para hacer referencia al campo en el código y en otras aplicaciones de flujo descendente.
- Ejemplo: loyaltyLevel
- Nombre para mostrar: El nombre del campo, escrito en mayúsculas o minúsculas. Este es el nombre que se mostrará en el lienzo al ver o editar el esquema.
- Ejemplo: Nivel de fidelización
- Tipo: El tipo de datos del campo. Esto incluye tipos escalares básicos y cualquier tipo de datos definido en la variable 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 con un máximo de 200 caracteres.
El primer campo de la variable loyaltyTier el objeto será una cadena llamada id, que representa el ID del nivel actual del miembro socio. El ID de nivel será único para cada miembro socio, ya que esta empresa establece diferentes umbrales de punto de nivel de fidelidad para cada cliente en función de diferentes factores. Establezca el tipo del nuevo campo en "Cadena", y el Propiedades del campo La sección se rellena con varias opciones para aplicar restricciones, incluidos el valor predeterminado, el formato y la longitud máxima. Consulte la documentación sobre prácticas recomendadas para los campos de validación de datos para obtener más información.
Desde id será una cadena de forma libre generada aleatoriamente, no son necesarias más restricciones. Seleccionar Aplicar para aplicar los cambios.
Agregar más campos al grupo de campos field-group-fields-2
Ahora que ha agregado la variable id , puede añadir campos adicionales para capturar información del nivel de fidelidad, como:
- Umbral de punto actual (entero): el número mínimo de puntos de lealtad que debe mantener el miembro para permanecer en el nivel actual.
- Umbral de punto de nivel siguiente (entero): número de puntos de lealtad que debe acumular el miembro para pasar al siguiente nivel.
- Fecha en Vigor (fecha-hora): La fecha en la que el miembro socio se unió a este nivel.
Para añadir cada campo al esquema, seleccione la más (+) junto al icono loyalty y rellene la información necesaria.
Cuando finalice, la variable loyaltyTier el objeto contendrá campos para id, currentThreshold, nextThreshold, y effectiveDate.
Agregar un campo de enumeración al grupo de campos enum
Al definir campos en Schema EditorSin embargo, hay algunas opciones adicionales que puede aplicar a tipos de campo básicos para proporcionar más restricciones en los datos que puede contener el campo. Los casos de uso de estas restricciones se explican en la siguiente tabla:
Para este tutorial, la variable loyaltyTier El objeto del esquema requiere un nuevo campo de enumeración que describe la clase de nivel, donde el valor solo puede ser una de las cuatro opciones posibles. Para añadir este campo al esquema, seleccione la más (+) junto al icono loyaltyTier y rellene los campos obligatorios de Nombre de campo y Nombre para mostrar. Para Tipo, seleccione "Cadena".
Aparecerán casillas de verificación adicionales para el campo después de seleccionar su tipo, incluidas las casillas de verificación para Matriz, Enumeración y valores sugeridos, Identidad, y Relación.
Seleccione el Enumeración y valores sugeridos y, a continuación, seleccione Enumeración. Aquí puede introducir la variable Valor (en camelCase) y Nombre para mostrar (un nombre opcional fácil de leer en el caso del título) para cada clase de nivel de fidelidad aceptable.
Cuando haya completado todas las propiedades del campo, seleccione Aplicar para añadir el tierClass a la loyaltyTier objeto.
Conversión de un objeto de varios campos en un tipo de datos datatype
El loyaltyTier ahora contiene varios campos 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 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 porque se pueden utilizar en cualquier lugar dentro de un esquema. Esto se hace estableciendo el Tipo valor igual al de cualquier tipo de datos definido en la variable Schema Registry.
Para convertir la variable loyaltyTier objeto a un tipo de datos, seleccione el loyaltyTier en el lienzo y seleccione Convertir a nuevo tipo de datos en el lado derecho del editor, debajo de Propiedades del campo.
Aparece una notificación que confirma que el objeto se ha convertido correctamente. En el lienzo ahora puede ver que la variable loyaltyTier El campo ahora tiene un icono de vínculo y el carril derecho indica que tiene un tipo de datos de "Loyalty Tier".
En un esquema futuro, ahora puede asignar un campo como "Loyalty Tier" y automáticamente incluiría campos de ID, clase de nivel, umbrales de punto y fecha de entrada en vigor.
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 en los que esté interesado.
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 del grupo de campos en el que se proporcionen.
Definir un campo de esquema como campo de identidad identity-field
La estructura de datos estándar que proporcionan los esquemas se puede aprovechar para identificar datos que pertenecen a la misma persona en varias fuentes, lo que permite varios casos de uso descendentes, como segmentación, creación de informes, análisis de ciencia de datos y más. Para unir datos basados en identidades individuales, los campos clave deben marcarse como Identidad campos dentro de esquemas aplicables.
Experience Platform facilita la denotación de un campo de identidad mediante el uso de una variable Identidad casilla de verificación en la Schema Editor. Sin embargo, debe determinar qué campo es el mejor candidato para utilizar como identidad, según la naturaleza de los datos.
Por ejemplo, puede haber miles de miembros del programa de fidelidad que pertenecen al mismo nivel de fidelidad y varios que comparten la misma dirección física. Sin embargo, en esta situación, al inscribirse, cada miembro del programa de fidelidad proporciona su dirección de correo electrónico personal. Dado que las direcciones de correo electrónico personales suelen ser administradas por una persona, el campo personalEmail.address (proporcionado por el Datos personales de contacto grupo de campos) es un buen candidato para un campo de identidad.
identityMap para contener información de identidad en su lugar.identityMap, tenga en cuenta que anulará cualquier identidad principal que agregue directamente al esquema. Consulte la sección sobre identityMap en el guía de conceptos básicos de composición de esquemas para obtener más información.Seleccione el personalEmail.address en el lienzo y la variable Identidad La casilla de verificación aparece bajo Propiedades del campo. Marque la casilla y la opción para establecerlo como. Identidad principal aparece. Seleccione también esta casilla.
A continuación, debe proporcionar un Área de nombres de identidad de la lista de áreas de nombres predefinidas en el menú desplegable. Dado que este campo es la dirección de correo electrónico del cliente, seleccione "Correo electrónico" en el menú desplegable. Seleccionar Aplicar para confirmar las actualizaciones de personalEmail.address field.
Después de aplicar el cambio, el icono de personalEmail.address muestra un símbolo de huella digital que indica que ahora es un campo de identidad. El campo también aparece en el carril izquierdo debajo de Identidades.
Ahora, todos los datos introducidos en el personalEmail.address Este campo se utilizará 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, revise la Identity Service documentación.
Habilitar el esquema para utilizarlo en Real-Time Customer Profile profile
Real-Time Customer Profile aprovecha los datos de identidad en Experience Platform para proporcionar una vista integral 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 habilitar un esquema 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 socio" para utilizarlo en Profile, comience por seleccionar el título del esquema en el lienzo.
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 Perfil botón de alternancia.
Seleccionar Perfil y aparece una ventana emergente, en la que se le solicita que confirme que desea habilitar el esquema para Profile.
Seleccionar Activar para confirmar su elección. Puede seleccionar el Perfil vuelva a activarlo para desactivar el esquema si lo desea, pero una vez guardado el esquema mientras Profile está activada, ya no se puede desactivar.
Más acciones more
En el Editor de esquemas también puede realizar acciones rápidas para copiar la estructura JSON del esquema o eliminarlo. Seleccionar Más en la parte superior de la vista para mostrar una lista desplegable con acciones rápidas.
Eliminación de un esquema delete-a-schema
Se puede eliminar un esquema en la interfaz de usuario desde el Editor de esquemas utilizando Más y también desde los detalles de esquema en la Examinar pestaña. Existen ciertas condiciones que impiden que se elimine un esquema. Un esquema no se puede eliminar si:
- El esquema está habilitado para el perfil.
- El esquema está habilitado para el perfil y tiene conjuntos de datos asociados.
- El esquema tiene conjuntos de datos asociados, pero no está habilitado para el perfil.
Copiar estructura de JSON copy-json-structure
Seleccionar Copiar estructura de JSON para generar una carga útil de exportación para cualquier esquema de la biblioteca de esquemas. Esta acción copia la estructura JSON en el portapapeles. El JSON exportado se puede utilizar para importar el esquema y cualquier recurso relacionado en una zona protegida u organización diferente. Esto hace que compartir y reutilizar esquemas entre diferentes entornos sea sencillo y eficaz.
Pasos siguientes y recursos adicionales
Ahora que ha terminado de maquetar el esquema, puede ver el esquema completo en el lienzo. Seleccionar Guardar y el esquema se guardará en el Schema Library, haciéndolo accesible mediante el Schema Registry.
El nuevo esquema ahora se puede utilizar para introducir datos en Platform. Recuerde que una vez que se ha utilizado el esquema para la ingesta de datos, solo se pueden realizar cambios adicionales. Consulte la conceptos básicos de composición de esquemas para obtener más información sobre las 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 socio".
El esquema "Miembros socio" también está disponible para su visualización y administración mediante el Schema Registry API. Para empezar a trabajar con la API, comience leyendo el Schema Registry API guía para desarrolladores.
Recursos de vídeo
El siguiente vídeo muestra cómo crear un esquema simple en la variable Platform IU.
El siguiente vídeo tiene como objetivo reforzar su comprensión del trabajo con grupos y clases de campo.
Apéndice
En las secciones siguientes se proporciona información adicional sobre el uso de Schema Editor.
Crear una nueva clase create-new-class
Experience Platform proporciona la flexibilidad para definir un esquema basado en una clase única para su organización. Para aprender a crear una nueva clase, consulte la guía de crear y editar clases en la interfaz de usuario.
Cambiar la clase de un esquema change-class
Puede cambiar la clase de un esquema en cualquier momento durante el proceso inicial de maquetación antes de guardar el esquema.
Para obtener información sobre cómo cambiar la clase de un esquema, consulte la guía de administración de esquemas en la IU.