Criar um esquema usando o Schema Editor
A interface de usuário do Adobe Experience Platform permite criar e gerenciar esquemas do Experience Data Model (XDM) em uma tela visual interativa chamada de Schema Editor. Este tutorial aborda como criar um esquema usando o Schema Editor.
Para fins de demonstração, as etapas deste tutorial envolvem a criação de um schema de exemplo que descreve os membros de um programa de fidelidade do cliente. Embora você possa usar essas etapas para criar um esquema diferente para suas próprias finalidades, é recomendável que você siga primeiro juntamente com a criação do esquema de exemplo para conhecer os recursos do Schema Editor.
Introdução
Este tutorial requer uma compreensão funcional dos vários aspectos do Adobe Experience Platform envolvidos na criação do esquema. Antes de iniciar este tutorial, revise a documentação dos seguintes conceitos:
- Experience Data Model (XDM): a estrutura padronizada pela qual o Platform organiza os dados de experiência do cliente.
- Noções básicas sobre a composição de esquema: uma visão geral dos esquemas XDM e seus blocos de construção, incluindo classes, grupos de campos de esquema, tipos de dados e campos individuais.
- Real-Time Customer Profile: Fornece um perfil de consumidor unificado em tempo real com base em dados agregados de várias fontes.
Abra o espaço de trabalho Esquemas browse
O espaço de trabalho Esquemas da interface do usuário Platform fornece uma visualização do Schema Library, permitindo que você visualize e gerencie os esquemas disponíveis para sua organização. O espaço de trabalho também inclui o Schema Editor, a tela na qual você pode compor um esquema através deste tutorial.
Depois de fazer logon em Experience Platform, selecione Esquemas na navegação à esquerda para abrir o espaço de trabalho Esquemas. A guia Procurar exibe uma lista de esquemas (uma representação do Schema Library) para que você possa exibi-los e personalizá-los. A lista inclui o nome, o tipo, a classe e o comportamento (registro ou série temporal) em que o esquema se baseia, bem como a data e a hora em que o esquema foi modificado pela última vez.
Consulte o manual sobre exploração de recursos XDM existentes na interface para obter mais informações.
Criar e nomear um esquema create
Para começar a compor um esquema, selecione Criar esquema no canto superior direito do espaço de trabalho Esquemas.
O fluxo de trabalho Criar esquema é exibido. Em seguida, escolha uma classe base para o esquema. Você pode escolher entre as classes principais do Perfil Individual XDM e do XDM ExperienceEvent ou Outras se essas classes não atenderem aos seus objetivos. A opção de classes Other permite criar uma nova classe ou escolher entre outras classes pré-existentes.
Consulte a documentação do Perfil individual XDM e do XDM ExperienceEvent para obter mais informações sobre essas classes. Para os fins deste tutorial, selecione Perfil Individual XDM seguido de Próximo.
Após selecionar uma classe, a seção Nome e revisão é exibida. Nesta seção, você fornece um nome e uma descrição para identificar o esquema. Há várias considerações importantes a serem feitas ao decidir sobre um nome para o esquema:
- Os nomes do esquema devem ser curtos e descritivos para que o esquema possa ser facilmente encontrado posteriormente.
- Os nomes do esquema devem ser exclusivos, o que significa que também devem ser específicos o suficiente para não serem reutilizados no futuro. Por exemplo, se sua organização tivesse programas de fidelidade separados para marcas diferentes, seria interessante nomear seu esquema como "Membros da fidelidade da marca A" para facilitar a distinção de outros esquemas relacionados à fidelidade que você poderia definir posteriormente.
- Também é possível usar a descrição do schema para fornecer informações contextuais adicionais sobre o schema.
Este tutorial compõe um esquema para assimilar dados relacionados aos membros de um programa de fidelidade e, portanto, o esquema é nomeado como "Loyalty Members".
A estrutura base do esquema (fornecida pela classe) é mostrada na tela para que você revise e verifique a classe selecionada e a estrutura do esquema.
Insira um Nome para exibição do esquema amigável no campo de texto. Em seguida, insira uma descrição adequada para ajudar a identificar seu esquema. Quando tiver revisado a estrutura do esquema e estiver satisfeito com as configurações, selecione Concluir para criar o esquema.
O Schema Editor aparece. Esta é a tela sobre a qual você irá compor seu esquema. O esquema autointitulado é criado automaticamente na seção Estrutura da tela quando você chega ao editor, juntamente com os campos padrão incluídos na classe base selecionada. A classe atribuída para o esquema também está listada em Classe na seção Composição.
Adicionar um grupo de campos field-group
Agora é possível começar a adicionar campos ao esquema adicionando grupos de campos. Um grupo de campos é um grupo de um ou mais campos que geralmente são usados juntos para descrever um conceito específico. Este tutorial usa grupos de campos para descrever os membros do programa de fidelidade e capturar informações importantes, como nome, aniversário, número de telefone, endereço e muito mais.
Para adicionar um grupo de campos, selecione Adicionar na subseção Grupos de campos.
Uma nova caixa de diálogo é exibida, exibindo uma lista de grupos de campos disponíveis. Cada grupo de campos destina-se apenas ao uso com uma classe específica, portanto, a caixa de diálogo lista apenas grupos de campos compatíveis com a classe selecionada (nesse caso, a classe XDM Individual Profile). Se você estiver usando uma classe XDM padrão, a lista de grupos de campos será classificada de forma inteligente com base na popularidade do uso.
Você pode selecionar um dos filtros no painel esquerdo para restringir a lista de grupos de campos padrão a setores específicos, como varejo, serviços financeiros e área de saúde.
Selecionar um grupo de campos na lista faz com que ele apareça no painel direito. Você pode selecionar vários grupos de campos, se desejar, adicionando cada um à lista no painel direito antes de confirmar. Além disso, um ícone é exibido no lado direito do grupo de campos selecionado no momento, o que permite visualizar a estrutura dos campos fornecidos.
Ao visualizar um grupo de campos, uma descrição detalhada do esquema do grupo de campos é fornecida no painel direito. Você também pode navegar pelos campos do grupo de campos na tela fornecida. À medida que você seleciona campos diferentes, o painel direito é atualizado para mostrar detalhes sobre o campo em questão. Selecione Voltar quando tiver terminado de visualizar para retornar à caixa de diálogo de seleção do grupo de campos.
Para este tutorial, selecione o grupo de campos Detalhes demográficos e selecione Adicionar grupo de campos.
A tela do esquema será exibida novamente. A seção Grupos de campos agora lista "Detalhes Demográficos" e a seção Estrutura inclui os campos contribuídos pelo grupo de campos. Você pode selecionar o nome do grupo de campos na seção Grupos de campos para realçar os campos específicos que ele fornece na tela.
Este grupo de campos contribui com vários campos sob o nome de nível superior person com o tipo de dados "Pessoa". Esse grupo de campos descreve informações sobre um indivíduo, incluindo nome, data de nascimento e sexo.
Observe que o campo name tem um tipo de dados de "Nome completo", o que significa que ele também descreve um conceito comum e contém subcampos relacionados ao nome, como nome, sobrenome, título de cortesia e sufixo.
Selecione os diferentes campos na tela para revelar quaisquer campos adicionais com que eles contribuam para a estrutura do esquema.
Adicionar mais grupos de campos field-group-2
Agora é possível repetir as mesmas etapas para adicionar outro grupo de campos. Ao exibir a caixa de diálogo Adicionar grupo de campos desta vez, observe que o grupo de campos "Detalhes Demográficos" foi esmaecido e a caixa de seleção ao lado dele não pode ser selecionada. Isso impede a duplicação acidental de grupos de campos que você já incluiu no esquema atual.
Para este tutorial, selecione os grupos de campos padrão Detalhes de contato pessoal e Detalhes de fidelidade da lista, em seguida, selecione Adicionar grupos de campos para adicioná-los ao esquema.
A tela será exibida novamente com os grupos de campos adicionados listados em Grupos de campos na seção Composição e seus campos compostos adicionados à estrutura do esquema.
Definir um grupo de campos personalizado define-field-group
O esquema Membros de Fidelidade deve capturar dados relacionados aos membros de um programa de fidelidade, e o grupo de campos padrão Detalhes de Fidelidade adicionado ao esquema fornece a maioria desses dados, incluindo o tipo de programa, pontos, data de adesão e muito mais.
No entanto, pode haver um cenário em que você deseje incluir campos personalizados adicionais não cobertos por grupos de campos padrão para atingir seus casos de uso. No caso de adicionar campos de fidelidade personalizados, você tem duas opções:
- Crie um novo grupo de campos personalizado para capturar esses campos. Este é o método que será abordado neste tutorial.
- Estenda o grupo de campos padrão Detalhes de fidelidade com campos personalizados. Isso faz com que Detalhes de fidelidade sejam convertidos em um grupo de campos personalizado, e o grupo de campos padrão original não estará mais disponível. Consulte o guia de interface do usuário Esquemas para obter mais informações sobre como adicionar campos personalizados à estrutura de grupos de campos padrão.
Para criar um novo grupo de campos, selecione Adicionar na subseção Grupos de campos como antes, mas desta vez selecione Criar novo grupo de campos próximo à parte superior da caixa de diálogo exibida. Em seguida, você será solicitado a fornecer um nome de exibição e uma descrição para o novo grupo de campos. Para este tutorial, nomeie o novo grupo de campos "Custom Loyalty Details" e selecione Adicionar grupos de campos.
"Custom Loyalty Details" agora deve aparecer em Grupos de campos no lado esquerdo da tela, mas ainda não há campos associados a ele e, portanto, nenhum campo novo aparece em Estrutura.
Adicionar campos ao grupo de campos field-group-fields
Agora que você criou o grupo de campos "Custom Loyalty Details", é hora de definir os campos nos quais o grupo de campos contribuirá para o esquema.
Para começar, selecione o ícone de adição (+) ao lado do nome do esquema na tela.
Um espaço reservado para "Campo sem título" é exibido na tela e o painel direito é atualizado para revelar as opções de configuração do campo.
Nesse cenário, o esquema precisa ter um campo do tipo objeto que descreva detalhadamente o nível de fidelidade atual da pessoa. Usando os controles no painel direito, comece criando um campo loyaltyTier com o tipo "Objeto" que será usado para manter seus campos relacionados.
Em Atribuir a, você deve selecionar um grupo de campos ao qual atribuir o campo. Lembre-se de que todos os campos de esquema pertencem a uma classe ou a um grupo de campos e, como esse esquema usa uma classe padrão, sua única opção é selecionar um grupo de campos. Comece a digitar o nome "Custom Loyalty Details" e selecione o grupo de campos na lista.
Quando terminar, selecione Aplicar.
As alterações são aplicadas e o objeto loyaltyTier recém-criado é exibido. Como esse é um campo personalizado, ele é aninhado automaticamente em um objeto com namespace à ID de locatário da sua organização, precedido por um sublinhado (_tenantId neste exemplo).
Selecione o ícone de mais (+) ao lado do objeto loyaltyTier para começar a adicionar subcampos. Um novo espaço reservado de campo é exibido e a seção Propriedades do campo está visível no lado direito da tela.
Cada campo requer as seguintes informações:
- Nome do Campo: O nome do campo, de preferência escrito em camelCase. Não são permitidos caracteres de espaço. Esse é o nome usado para fazer referência ao campo no código e em outros aplicativos downstream.
- Exemplo: fidelizlevel
- Nome para Exibição: O nome do campo, escrito em letra maiúscula. Esse é o nome que será exibido na tela ao visualizar ou editar o esquema.
- Exemplo: Nível de fidelidade
- Tipo: o tipo de dados do campo. Isso inclui tipos escalares básicos e quaisquer tipos de dados definidos em Schema Registry. Exemplos: Cadeia de caracteres, Inteiro, Booleano, Pessoa, Endereço, Número de telefone, etc.
- Descrição: Uma descrição opcional do campo deve ser incluída com no máximo 200 caracteres.
O primeiro campo para o objeto loyaltyTier será uma cadeia de caracteres chamada id, representando a ID da camada atual do membro de fidelidade. A ID da camada será exclusiva para cada membro do programa de fidelidade, já que essa empresa define diferentes limites de ponto da camada de fidelidade para cada cliente com base em diferentes fatores. Defina o novo tipo de campo como "Cadeia de caracteres" e a seção Propriedades do campo será preenchida com várias opções para aplicar restrições, incluindo valor padrão, formato e comprimento máximo. Consulte a documentação sobre práticas recomendadas para campos de validação de dados para saber mais.
Como id será uma cadeia de caracteres de forma livre gerada aleatoriamente, nenhuma outra restrição será necessária. Selecione Aplicar para aplicar as alterações.
Adicionar mais campos ao grupo de campos field-group-fields-2
Agora que você adicionou o campo id, é possível adicionar outros campos para capturar informações do nível de fidelidade, como:
- Limite de ponto atual (número inteiro): o número mínimo de pontos de fidelidade que o membro deve manter para permanecer na camada atual.
- Limite de próximo ponto de camada (número inteiro): o número de pontos de fidelidade que o membro deve acumular para se formar no próximo nível.
- Data de efetivação (data-hora): a data em que o membro do programa de fidelidade ingressou nessa camada.
Para adicionar cada campo ao esquema, selecione o ícone de adição (+) ao lado do objeto loyalty e preencha as informações necessárias.
Quando concluído, o objeto loyaltyTier conterá campos para id, currentThreshold, nextThreshold e effectiveDate.
Adicionar um campo de enumeração ao grupo de campos enum
Ao definir campos no Schema Editor, há algumas opções adicionais que você pode aplicar aos tipos de campos básicos para fornecer restrições adicionais sobre os dados que o campo pode conter. Os casos de uso para essas restrições são explicados na tabela a seguir:
Para este tutorial, o objeto loyaltyTier no esquema requer um novo campo enum que descreve a classe de camada, onde o valor só pode ser uma das quatro opções possíveis. Para adicionar este campo ao esquema, selecione o ícone de adição (+) ao lado do objeto loyaltyTier e preencha os campos obrigatórios para Nome do campo e Nome de exibição. Para Type, selecione "String".
Caixas de seleção adicionais são exibidas para o campo depois que seu tipo é selecionado, incluindo caixas de seleção para Matriz, Enumeração e Valores Sugeridos, Identidade e Relacionamento.
Marque a caixa de seleção Enumerar & Valores Sugeridos e selecione Enumerar. Aqui você pode inserir o Valor (em camelCase) e o Nome para Exibição (um nome opcional e legível em Title Case) para cada classe de camada de fidelidade aceitável.
Quando tiver concluído todas as propriedades de campo, selecione Aplicar para adicionar o campo tierClass ao objeto loyaltyTier.
Converter um objeto de vários campos em um tipo de dados datatype
O objeto loyaltyTier agora contém vários campos e representa uma estrutura de dados comum que pode ser útil em outros esquemas. O Schema Editor permite aplicar prontamente objetos de vários campos reutilizáveis convertendo a estrutura desses objetos em tipos de dados.
Os tipos de dados permitem o uso consistente de estruturas de vários campos e fornecem mais flexibilidade do que um grupo de campos, pois podem ser usados em qualquer lugar em um esquema. Isso é feito definindo o valor Type do campo como aquele de qualquer tipo de dados definido em Schema Registry.
Para converter o objeto loyaltyTier em um tipo de dados, selecione o campo loyaltyTier na tela e selecione Converter em novo tipo de dados no lado direito do editor em Propriedades do campo.
Uma notificação é exibida, confirmando que o objeto foi convertido com êxito. Na tela você pode ver que o campo loyaltyTier agora tem um ícone de link, e o painel direito indica que ele tem um tipo de dados de "Loyalty Tier".
Em um esquema futuro, agora você pode atribuir um campo como um tipo "Loyalty Tier" e ele incluirá automaticamente campos para ID, classe de camada, limites de ponto e data de efetivação.
Pesquisar e filtrar campos de esquema
Seu esquema agora contém vários grupos de campos além dos campos fornecidos por sua classe base. Ao trabalhar com esquemas maiores, você pode marcar as caixas de seleção ao lado dos nomes dos grupos de campos no painel esquerdo para filtrar os campos exibidos somente para aqueles fornecidos pelos grupos de campos em que você está interessado.
Se estiver procurando um campo específico no esquema, também poderá usar a barra de pesquisa para filtrar os campos exibidos por nome, independentemente do grupo de campos em que são fornecidos.
Definir um campo de esquema como um campo de identidade identity-field
A estrutura de dados padrão fornecida pelos esquemas pode ser aproveitada para identificar dados pertencentes ao mesmo indivíduo em várias fontes, permitindo vários casos de uso downstream, como segmentação, relatórios, análise de ciência de dados e muito mais. Para compilar dados com base em identidades individuais, os campos de chave devem ser marcados como campos de Identidade dentro de esquemas aplicáveis.
O Experience Platform facilita a identificação de um campo de identidade através do uso de uma caixa de seleção Identidade no Schema Editor. No entanto, você deve determinar qual campo é o melhor candidato a ser usado como identidade, com base na natureza dos dados.
Por exemplo, pode haver milhares de membros do programa de fidelidade pertencentes ao mesmo nível de fidelidade e vários que podem compartilhar o mesmo endereço físico. Nesse cenário, no entanto, no momento da inscrição, cada membro do programa de fidelidade fornece seu endereço de email pessoal. Como os endereços de email pessoais geralmente são gerenciados por uma pessoa, o campo personalEmail.address (fornecido pelo grupo de campos Detalhes de Contato Pessoal) é um bom candidato para um campo de identidade.
identityMap para conter informações de identidade.identityMap, lembre-se de que ele substituirá qualquer identidade principal adicionada diretamente ao esquema. Consulte a seção sobre identityMap no guia de composição de esquema para obter mais informações.Selecione o campo personalEmail.address na tela e a caixa de seleção Identidade aparecerá em Propriedades do campo. Marque a caixa e a opção para definir isso como a Identidade principal será exibida. Selecione esta caixa também.
Em seguida, você deve fornecer um Namespace de identidade da lista de namespaces predefinidos na lista suspensa. Como este campo é o endereço de email do cliente, selecione "Email" na lista suspensa. Selecione Aplicar para confirmar as atualizações do campo personalEmail.address.
Depois de aplicar a alteração, o ícone de personalEmail.address mostra um símbolo de impressão digital, indicando que agora ele é um campo de identidade. O campo também está listado no painel esquerdo em Identidades.
Agora, todos os dados assimilados no campo personalEmail.address serão usados para ajudar a identificar esse indivíduo e unir uma única visualização desse cliente. Para saber mais sobre como trabalhar com identidades em Experience Platform, reveja a documentação de Identity Service.
Habilitar o esquema para uso em Real-Time Customer Profile profile
O Real-Time Customer Profile aproveita os dados de identidade em Experience Platform para fornecer uma visão holística de cada cliente individual. O serviço cria perfis robustos de 360° dos atributos do cliente, bem como contas com carimbo de data e hora de cada interação que os clientes tiveram em qualquer sistema integrado ao Experience Platform.
Para que um esquema seja habilitado para uso com Real-Time Customer Profile, ele deve ter uma identidade primária definida. Você receberá uma mensagem de erro se tentar ativar um esquema sem definir primeiro uma identidade primária.
Para habilitar o esquema "Membros de Fidelidade" para uso em Profile, comece selecionando o título do esquema na tela.
No lado direito do editor, são mostradas informações sobre o esquema, incluindo o nome para exibição, a descrição e o tipo. Além dessas informações, há um botão de alternância Perfil.
Selecione Perfil e um popover será exibido, pedindo sua confirmação de que você deseja habilitar o esquema para Profile.
Selecione Habilitar para confirmar sua escolha. Você pode selecionar a opção de alternância Perfil novamente para desabilitar o esquema, se desejar, mas uma vez que o esquema tenha sido salvo enquanto Profile estiver habilitado, ele não poderá mais ser desabilitado.
Mais ações more
No Editor de esquemas, você também pode realizar ações rápidas para copiar a estrutura JSON do esquema ou excluir o esquema. Selecione Mais na parte superior do modo de exibição para exibir um menu suspenso com ações rápidas.
Excluir um esquema delete-a-schema
Um esquema pode ser excluído da interface do Editor de Esquemas por meio das ações Mais e também dos detalhes do esquema na guia Procurar. Há determinadas condições que impedem a exclusão de um esquema. Um esquema não pode ser excluído se:
- O esquema é ativado para o Perfil.
- O esquema é ativado para o Perfil e tem conjuntos de dados associados.
- O esquema tem conjuntos de dados associados, mas não está habilitado para o Perfil.
Copiar estrutura JSON copy-json-structure
Selecione Copiar estrutura JSON para gerar uma carga de exportação para qualquer esquema na Biblioteca de Esquemas. Essa ação copia a estrutura JSON para a área de transferência. Seu JSON exportado pode ser usado para importar o esquema e quaisquer recursos relacionados para uma sandbox ou organização diferente. Isso torna simples e eficiente o compartilhamento e a reutilização de esquemas entre diferentes ambientes.
Próximas etapas e recursos adicionais
Agora que terminou de compor o esquema, você pode ver o esquema completo na tela. Selecione Salvar e o esquema será salvo no Schema Library, tornando-o acessível pelo Schema Registry.
Seu novo esquema agora pode ser usado para assimilar dados no Platform. Lembre-se de que, uma vez que o esquema tenha sido usado para assimilar dados, somente alterações aditivas poderão ser feitas. Consulte as noções básicas da composição de esquema para obter mais informações sobre o controle de versão de esquema.
Agora você pode seguir o tutorial em definição de uma relação de esquema na interface para adicionar um novo campo de relação ao esquema "Membros de Fidelidade".
O esquema "Membros de fidelidade" também está disponível para ser visualizado e gerenciado usando a API Schema Registry. Para começar a trabalhar com a API, comece lendo o Schema Registry API guia do desenvolvedor.
Recursos de vídeo
O vídeo a seguir mostra como criar um esquema simples na interface do usuário do Platform.
O vídeo a seguir tem como objetivo reforçar sua compreensão de trabalhar com grupos de campo e classes.
Apêndice
As seções a seguir fornecem informações adicionais sobre o uso do Schema Editor.
Criar uma nova classe create-new-class
O Experience Platform fornece a flexibilidade para definir um esquema com base em uma classe que é exclusiva de sua organização. Para saber como criar uma nova classe, consulte o manual sobre criação e edição de classes na interface.
Alterar a classe de um esquema change-class
Você pode alterar a classe de um esquema em qualquer momento durante o processo de composição inicial, antes que o esquema tenha sido salvo.
Para saber como alterar a classe de um esquema, consulte o manual sobre gerenciamento de esquemas na interface.