Show Menu
TÓPICOS×

Crie um schema usando a variável Schema Editor

A interface do usuário do Adobe Experience Platform permite criar e gerenciar schemas Experience Data Model (XDM) em uma tela visual interativa chamada de Schema Editor. Este tutorial aborda como criar um schema usando o Schema Editor.
Para fins de demonstração, as etapas neste 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 schema diferente para os seus propósitos, recomenda-se que você siga as etapas para criar o schema de exemplo e aprender os recursos do Schema Editor.
Se você preferir compor um schema usando a Schema Registry API, leia o guia Schema Registry do desenvolvedor antes de tentar o tutorial sobre como criar um schema usando a API .

Introdução

Este tutorial requer um entendimento prático dos vários aspectos do Adobe Experience Platform envolvidos na criação de schemas. Antes de iniciar este tutorial, reveja a documentação para obter os seguintes conceitos:

Procurar schemas existentes na área de trabalho de Schemas

A área de trabalho de Schemas na Platform interface do usuário fornece uma visualização do Schema Library, permitindo que você visualização gerenciar os schemas disponíveis para sua organização. A área de trabalho também inclui a tela Schema Editor, na qual você pode compor um schema em todo este tutorial.
Depois de fazer logon Experience Platform, selecione Schemas na navegação à esquerda para abrir a área de trabalho de Schemas . A guia Procurar exibe uma lista de schemas (uma representação do Schema Library) que você pode visualização e personalizar. A lista inclui o nome, o tipo, a classe e o comportamento (registro ou série de tempo) em que o schema se baseia, bem como a data e a hora em que o schema foi modificado pela última vez.
Selecione o ícone de filtro ao lado da barra de pesquisa para usar os recursos de filtragem para todos os recursos no registro, incluindo classes, mixins e tipos de dados. Você também pode filtrar com base em se os recursos são de propriedade do Adobe ou de sua organização e se foram habilitados para uso em Real-time Customer Profile.

Criar e nomear um schema

Para começar a compor um schema, selecione Criar schema no canto superior direito da área de trabalho dos Schemas . Um menu suspenso é exibido, dando a você a opção de escolher entre as classes principais Perfil XDM Individual e XDM ExperienceEvent . Se essas classes não se adequarem aos seus propósitos, você também poderá selecionar Procurar para escolher entre outras classes disponíveis ou criar uma nova classe .
Para os fins deste tutorial, selecione Perfil individual XDM.
O Schema Editor é exibido. Esta é a tela sobre a qual você irá compor seu schema. Como você escolheu uma classe XDM padrão para basear o schema, um schema sem título é criado automaticamente na seção Estrutura da tela quando você chega ao editor, juntamente com os campos padrão incluídos em todos os schemas com base nessa classe. A classe atribuída ao schema também está listada em Classe na seção Composição .
Você pode alterar a classe de um schema em qualquer ponto durante o processo de composição inicial antes que o schema seja salvo, mas isso deve ser feito com extrema cautela. Misturas são compatíveis somente com certas classes, e, portanto, alterar a classe redefinirá a tela de desenho e quaisquer campos adicionados.
Use os campos no lado direito do editor para fornecer um nome de exibição e uma descrição opcional para o schema. Depois que um nome é inserido, a tela é atualizada para refletir o novo nome do schema.
Há várias considerações importantes a serem feitas ao decidir um nome para o seu schema:
  • Os nomes de schemas devem ser curtos e descritivos para que o schema possa ser facilmente encontrado posteriormente.
  • Os nomes dos schemas devem ser exclusivos, o que significa que também devem ser específicos o suficiente para que não sejam reutilizados no futuro. Por exemplo, se sua organização tivesse programas de fidelidade separados para diferentes marcas, seria aconselhável nomear seu schema como "Membros de fidelidade da Marca A" para facilitar a distinção entre outros schemas relacionados à fidelidade que você possa definir posteriormente.
  • Você também pode usar a descrição do schema para fornecer quaisquer informações contextuais adicionais relacionadas ao schema.
Este tutorial compõe um schema para assimilar dados relacionados aos membros de um programa de fidelidade e, portanto, o schema é denominado "Membros de fidelidade".

Adicionar uma mistura

Agora você pode começar a adicionar campos ao seu schema adicionando mixins. Uma combinação é um grupo de um ou mais campos que são frequentemente usados em conjunto para descrever um conceito específico. Este tutorial usa mixins para descrever os membros do programa de fidelidade e capturar informações-chave como nome, aniversário, número de telefone, endereço e muito mais.
Para adicionar uma mistura, selecione Adicionar na subseção Misturas .
Uma nova caixa de diálogo é exibida, exibindo uma lista de combinações disponíveis. Cada mistura é destinada somente para uso com uma classe específica, portanto, a caixa de diálogo somente lista combinações compatíveis com a classe selecionada (neste caso, a XDM Individual Profile classe). Se você estiver usando uma classe XDM padrão, a lista de combinações será classificada de forma inteligente com base na popularidade de uso.
Selecionar uma mistura na lista faz com que ela apareça no painel direito. Se desejar, você pode selecionar várias combinações, adicionando cada uma à lista no painel direito antes de confirmar. Além disso, um ícone é exibido no lado direito do mixin atualmente selecionado, permitindo que você pré-visualização a estrutura dos campos fornecidos.
Ao visualizar uma mistura, uma descrição detalhada do schema da mistura é fornecida no painel direito. Também é possível navegar pelos campos do mixin 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 terminar de visualizar para retornar à caixa de diálogo de seleção de mixin.
Para este tutorial, selecione a combinação de detalhes da pessoa do Perfil e, em seguida, selecione Adicionar mistura .
A tela do schema é exibida novamente. A seção Misturas agora lista "detalhesda pessoa doPerfil" e a seção Estrutura inclui os campos contribuídos pela mistura. Você pode selecionar o nome da mistura na seção Misturas para realçar os campos específicos que ela fornece dentro da tela.
Esse mixin contribui com vários campos sob o nome de nível superior person com o tipo de dados "Pessoa". Este grupo de campos descreve informações sobre um indivíduo, incluindo nome, data de nascimento e sexo.
Lembre-se de que os campos podem usar tipos escalares (como string, integer, array ou data), bem como qualquer tipo de dados (um grupo de campos que representa um conceito comum) definido dentro do Schema Registry.
Observe que o name campo tem um tipo de dados de "Nomecompleto", o que significa que 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 que contribuem para a estrutura do schema.

Adicionar outra mistura

Agora você pode repetir as mesmas etapas para adicionar outra mixin. Ao visualização da caixa de diálogo Adicionar mixagem desta vez, observe que a mistura "Detalhesda pessoa doPerfil" foi esmaecida e a caixa de seleção ao lado dela não pode ser selecionada. Isso evita que você duplique acidentalmente misturas que já foram incluídas no schema atual.
Para este tutorial, selecione a combinação "Profile personal details" na caixa de diálogo e, em seguida, selecione Adicionar mistura para adicioná-la ao schema.
Depois de adicionada, a tela de desenho reaparece. "Detalhespessoais doPerfil" agora está listado em Mixins na seção Composição , e campos para endereço residencial, telefone celular e muito mais foram adicionados em Estrutura .
Semelhante ao name campo, os campos que você acabou de adicionar representam os conceitos de vários campos. Por exemplo, homeAddress tem um tipo de dados de "Endereçopostal" e mobilePhone tem um tipo de dados de "Númerodetelefone". Você pode selecionar cada um desses campos para expandi-los e ver os campos adicionais incluídos no tipo de dados.

Definir uma nova mistura

O schema "Membrosdefidelidade" destina-se a capturar dados relacionados aos membros de um programa de fidelidade, para que sejam necessários alguns campos específicos relacionados à fidelidade. Não há combinações padrão disponíveis que contenham os campos necessários, portanto, será necessário definir uma nova mistura.
Desta vez, ao abrir a caixa de diálogo Adicionar mistura , selecione Criar nova mistura . Você será solicitado a fornecer um Nome de exibição e uma Descrição para sua combinação.
Assim como com os nomes de classe, o nome da mistura deve ser curto e simples, descrevendo o que a mistura contribuirá para o schema. Eles também são únicos, portanto, você não poderá reutilizar o nome e deve, portanto, garantir que seja suficientemente específico.
Para este tutorial, nomeie a nova combinação como "DetalhesdaFidelidade".
Selecione Adicionar mixin para retornar ao Schema Editor. "Detalhesdafidelidade" agora deve aparecer em Mixins no lado esquerdo da tela, mas não há campos associados a ela ainda e, portanto, nenhum campo novo aparece em Estrutura .

Adicionar campos ao mixin

Agora que você criou a combinação "DetalhesdaFidelidade", é hora de definir os campos que a combinação contribuirá para o schema.
Para começar, selecione o nome da mistura na seção Misturas . Depois disso, as propriedades do mixin são exibidas no lado direito do editor e um botão de campo ​Adicionar é exibido ao lado do nome do schema em Estrutura .
Selecione Adicionar campo ao lado de "Loyalty Members" para criar um novo nó na estrutura. Esse nó (chamado "_locatárioId" neste exemplo) representa a ID de locatário da organização IMS, precedida de um sublinhado. A presença da ID do locatário indica que os campos que você está adicionando estão contidos na namespace de sua organização.
Em outras palavras, os campos que você está adicionando são exclusivos à sua organização e serão salvos no Schema Registry em uma área específica acessível apenas à sua organização. Os campos que você definir devem ser sempre adicionados à namespace do locatário para evitar colisões com nomes de outras classes padrão, combinações, tipos de dados e campos.
Dentro desse nó com namespaces há um "Novo campo". Este é o início da mistura "DetalhesdaFidelidade".
Usando os controles no lado direito do editor, crie um loyalty campo com o tipo "Objeto" que será usado para manter seus campos relacionados à fidelidade. Quando terminar, selecione Aplicar .
As alterações são aplicadas e o loyalty objeto recém-criado é exibido. Selecione Adicionar campo ao lado do objeto para adicionar campos adicionais relacionados à fidelidade. Um "Novo campo" é exibido e a seção de propriedades de campo é visível no lado direito da tela.
Cada campo requer as seguintes informações:
  • Nomedo campo: O nome do campo, escrito em caso de camelo. Exemplo: leyaltyLevel
  • Nomede exibição: O nome do campo, escrito em caso de título. Exemplo: Nível de Fidelidade
  • Tipo: O tipo de dados do campo. Isso inclui tipos escalares básicos e quaisquer tipos de dados definidos no Schema Registry. Exemplos: Sequência, Número inteiro, booleano, Pessoa, Endereço, Número de telefone, etc.
  • Descrição: Uma descrição opcional do campo deve ser incluída, escrita em caso de sentença, com um máximo de 200 caracteres.
O primeiro campo do Loyalty objeto será uma string chamada loyaltyId . Ao definir o tipo do novo campo como "String", a seção de propriedades de Campo é preenchida com várias opções para aplicar restrições, incluindo valor ​Padrão, Formato e comprimento ​Máximo.
Diferentes opções de restrição estão disponíveis dependendo do tipo de dados selecionado. Como loyaltyId será um endereço de email, selecione "email" no menu suspenso Formato . Selecione Aplicar para aplicar suas alterações.

Adicionar mais campos ao mixin

Agora que você adicionou o loyaltyId campo, é possível adicionar campos adicionais para capturar informações relacionadas à fidelidade, como:
  • Pontos (número inteiro)
  • Membro desde (data)
Cada campo é adicionado selecionando Adicionar campo no loyalty objeto e preenchendo as informações necessárias.
Quando concluído, o objeto de Fidelidade conterá campos para ID de fidelidade, pontos e membro-a-partir.

Adicionar um campo de enumeração ao mixin

Ao definir campos no campo, Schema Editorhá algumas opções adicionais que podem ser aplicadas a tipos de campos básicos para fornecer restrições adicionais aos dados que o campo pode conter. Os casos de uso para essas restrições são explicados na tabela a seguir:
Restrição
Descrição
Obrigatório
Indica que o campo é obrigatório para a ingestão de dados. Todos os dados carregados em um conjunto de dados com base nesse schema que não contém esse campo falharão após a ingestão.
Matriz
Indica que o campo contém uma matriz de valores, cada um com o tipo de dados especificado. Por exemplo, usar essa restrição em um campo com um tipo de dados de "String" especifica que o campo conterá uma matriz de strings.
Enum
Indica que esse campo deve conter um dos valores de uma lista enumerada de valores possíveis.
Identidade
Indica que este campo é um campo de identidade. Mais informações sobre campos de identidade são fornecidas posteriormente neste tutorial .
Relação
Embora as relações com os schemas possam ser inferidas com o uso do schema da união e Real-time Customer Profile, isso se aplica somente aos schemas que compartilham a mesma classe. A restrição Relacionamento indica que esse campo faz referência à identidade primária de um schema com base em uma classe diferente, o que implica uma relação entre os dois schemas. Consulte o tutorial sobre como definir um relacionamento para obter mais informações.
Para este tutorial, o "loyalty" objeto no schema requer um novo campo enum que descreva o "nível de fidelidade" de um cliente, onde o valor pode ser apenas uma das quatro opções possíveis. Para adicionar esse campo ao schema, selecione Adicionar campo ao lado do loyalty objeto e preencha os campos obrigatórios para Nome ​de campo e Nome de exibição. Para Tipo , selecione "String".
Caixas de seleção adicionais aparecem para o campo depois que seu tipo é selecionado, incluindo caixas de seleção para Matriz , enumeração e Identidade .
Marque a caixa de seleção Enum para abrir a seção Valores ​Enum abaixo. Aqui, você pode inserir o Valor (em camelCase) e o Rótulo (um nome opcional e amigável para o leitor no Título Case) para cada nível de fidelidade aceitável.
Depois de concluir todas as propriedades do campo, selecione Aplicar para adicionar o campo "loyaltyLevel" ao loyalty objeto.

Converter um objeto de vários campos em um tipo de dados

O loyalty objeto agora contém vários campos específicos de fidelidade e representa uma estrutura de dados comum que pode ser útil em outros schemas. 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 proporcionam mais flexibilidade do que uma combinação, pois podem ser usados em qualquer lugar dentro de um schema. Isso é feito configurando o valor Tipo do campo para o valor de qualquer tipo de dados definido no Schema Registry.
Para converter o loyalty objeto em um tipo de dados, selecione o loyalty campo em Estrutura e, em seguida, selecione Converter em novo tipo de dados no lado direito do editor em Propriedades de campo. Uma janela verde é exibida, confirmando que o objeto foi convertido com êxito.
Agora, quando você olha em Estrutura , você pode ver que o loyalty campo tem um tipo de dados "Loyalty" e que os campos têm pequenos ícones de bloqueio ao seu lado, indicando que eles não são mais campos individuais, mas sim parte de um tipo de dados de vários campos.
Em um schema futuro, agora é possível atribuir um campo ao Tipo de "Loyalty" e ele incluirá automaticamente campos para ID, nível de fidelidade, membro desde e pontos.

Pesquisar e filtrar campos de schema

Seu schema agora contém várias combinações além dos campos fornecidos por sua classe base. Ao trabalhar com schemas maiores, você pode marcar as caixas de seleção ao lado dos nomes de mixagem no painel esquerdo para filtrar os campos exibidos somente para os campos fornecidos pelas combinações que você está interessado.
Se você estiver procurando um campo específico no seu schema, também poderá usar a barra de pesquisa para filtrar os campos exibidos pelo nome, independentemente da combinação em que eles são fornecidos.

Definir um campo de schema como um campo de identidade

A estrutura de dados padrão que os schemas fornecem 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 unir dados com base em identidades individuais, os campos principais devem ser marcados como campos de identidade nos schemas aplicáveis.
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 usar como uma identidade, com base na natureza de seus dados.
Por exemplo, pode haver milhares de membros do programa de fidelidade pertencentes ao mesmo "nível de fidelidade", mas cada membro do programa de fidelidade tem um único loyaltyId (que neste caso é o endereço de email do membro individual). O fato de que loyaltyId é um identificador exclusivo para cada membro faz dele um bom candidato para um campo de identidade, ao contrário do que loyaltyLevel é feito.
As etapas descritas abaixo abordam como adicionar um descritor de identidade a um campo de schema existente. Como alternativa à definição de campos de identidade na estrutura do próprio schema, também é possível usar um identityMap campo para conter informações de identidade.
Se você planeja usar identityMap , lembre-se de que isso substituirá qualquer identidade primária adicionada ao schema diretamente. Consulte a seção sobre identityMap as noções básicas do guia de composição do schema para obter mais informações.
Na seção Estrutura do editor, selecione o loyaltyId campo e a caixa de seleção Identidade aparecerá em Propriedades ​de campo. Marque a caixa e a opção para definir isso como a identidade ​Principal será exibida. Selecione essa caixa também.
Cada schema pode conter apenas um campo de identidade principal. Depois que um campo de schema for definido como a identidade primária, você receberá uma mensagem de erro se tentar definir outro campo de identidade no schema como principal.
Em seguida, você deve fornecer uma namespace de identidade da lista de namespaces predefinidas na lista suspensa. Como loyaltyId é o endereço de email do cliente, selecione "Email" na lista suspensa. Selecione Aplicar para confirmar as atualizações do loyaltyId campo.
Para obter uma lista de namespaces padrão e suas definições, consulte a Identity Service documentação .
Depois de aplicar a alteração, o ícone para loyaltyId mostra um símbolo de impressão digital, indicando que agora é um campo de identidade. Além disso, a Loyalty Details mistura no painel esquerdo lista o campo de identidade abaixo dele, permitindo que você determine facilmente qual mistura em um schema fornece os campos de identidade do schema.
Agora, todos os dados ingeridos no loyaltyId campo serão usados para ajudar a identificar esse indivíduo e unir uma única visualização do cliente. Para saber mais sobre como trabalhar com identidades no, consulte a documentação do Experience Platform​Identity Service Identity Servicevisão geral .

Ative o schema para uso em Real-time Customer Profile

O Real-time Customer Perfil aproveita os dados de identidade Experience Platform para fornecer uma visualização holística de cada cliente individual. O serviço cria perfis robustos, 360°, de atributos do cliente, bem como contas com carimbos de data e hora de cada interação que os clientes tiveram em qualquer sistema integrado com Experience Platform.
Para que um schema 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 schema sem primeiro definir uma identidade primária.
Para ativar o schema "Membros de Fidelidade" para uso em Profile, comece selecionando "Loyalty Members" na seção Estrutura do editor.
No lado direito do editor, são mostradas informações sobre o schema, incluindo seu nome de exibição, descrição e tipo. Além dessas informações, há um botão de alternância de Perfil .
Selecione Perfil e um será exibido, solicitando que você confirme que deseja ativar o schema para Profile.
Depois que um schema é ativado para Real-time Customer Profile e salvo, ele não pode ser desativado.
Selecione Ativar para confirmar sua escolha. Se desejar, você pode selecionar a alternância do Perfil para desativar o schema, mas depois que o schema for salvo enquanto Profile estiver ativado, ele não poderá mais ser desativado.

Próximos passos e recursos adicionais

Agora que você terminou de compor o schema, você pode ver o schema completo na tela. Selecione Salvar e o schema será salvo no Schema Library, tornando-o acessível pelo Schema Registry.
Seu novo schema agora pode ser usado para assimilar dados em Platform. Lembre-se de que, uma vez que o schema tenha sido usado para ingerir dados, somente alterações aditivas poderão ser feitas. Consulte as noções básicas da composição do schema para obter mais informações sobre o controle de versão do schema.
Agora você pode seguir o tutorial sobre como definir uma relação de schema na interface do usuário para adicionar um novo campo de relação ao schema "Membros da fidelidade".
O schema "Membros da fidelidade" também está disponível para exibição e gerenciamento usando a Schema Registry API. Para começar a trabalhar com a API, leia o guia Schema Registry API do desenvolvedor para obter mais informações.

Recursos de vídeo

A Platform interface do usuário exibida nos vídeos a seguir está desatualizada. Consulte a documentação acima para obter as capturas de tela e a funcionalidade mais recentes da interface do usuário.
O vídeo a seguir mostra como criar um schema simples na Platform interface do usuário.

O vídeo a seguir destina-se a reforçar sua compreensão sobre como trabalhar com mixins e classes.

Apêndice

As seções a seguir fornecem informações adicionais sobre o uso do Schema Editor.

Create a new class

Experience Platform fornece a flexibilidade para definir um schema com base em uma classe exclusiva de sua organização.
Na área de trabalho Schemas , selecione Criar schema e, em seguida, selecione Procurar na lista suspensa.
Uma caixa de diálogo é exibida permitindo que você selecione uma lista de classes disponíveis. Na parte superior da caixa de diálogo, selecione Criar nova classe . Em seguida, é possível atribuir à sua nova classe um nome de exibição (um nome curto, descritivo, exclusivo e amigável para a classe), uma Descrição e um comportamento ("Registro" ou "Sériecronológica") para os dados que o schema definirá.
Ao criar um schema que implemente uma classe definida pela sua organização, lembre-se de que as combinações estão disponíveis para uso somente com classes compatíveis. Como a classe definida é nova, não há combinações compatíveis listadas na caixa de diálogo Adicionar mixin . Em vez disso, você precisará selecionar Criar nova combinação e definir uma mistura para usar com essa classe. Na próxima vez que você redigir um schema que implementa a nova classe, a combinação definida será listada e estará disponível para uso.

Alterar a classe de um schema

É possível alterar a classe de um schema em qualquer ponto durante o processo de composição inicial antes que o schema seja salvo.
A reatribuição da classe para um schema deve ser feita com extrema cautela. Misturas são compatíveis somente com certas classes, e, portanto, alterar a classe redefinirá a tela de desenho e quaisquer campos adicionados.
Para reatribuir uma classe, selecione Atribuir no lado esquerdo da tela.
Uma caixa de diálogo é exibida mostrando uma lista de todas as classes disponíveis, incluindo qualquer classe definida por sua organização (o proprietário sendo "Cliente"), bem como as classes padrão definidas pelo Adobe.
Selecione uma classe na lista para exibir sua descrição no lado direito da caixa de diálogo. Você também pode selecionar a estrutura da classe de Pré-visualização para ver os campos e os metadados associados à classe. Selecione Atribuir classe para continuar.
Uma nova caixa de diálogo é aberta solicitando que você confirme que deseja atribuir uma nova classe. Selecione Atribuir para confirmar.
Após confirmar a alteração de classe, a tela será redefinida e todo o progresso da composição será perdido.