Show Menu
TÓPICOS×

Criar um schema usando o Editor de Schemas

O Registro de Schemas fornece uma interface de usuário e uma RESTful API da qual você pode visualização e gerenciar todos os recursos na Biblioteca de Schemas da plataforma Adobe Experience. A Biblioteca de Schemas contém recursos disponibilizados pela Adobe, parceiros da plataforma de experiência e fornecedores cujos aplicativos você usa, bem como recursos que você define e salva no Registro de Schemas.
Este tutorial aborda as etapas para a criação de um schema usando o Editor de Schemas na Plataforma de experiência. Se você preferir compor um schema usando a API do Registro do Schema, comece lendo o guia do desenvolvedor do Registro do Schema antes de tentar que o tutorial crie um schema usando a API .
Este tutorial também inclui etapas para definir uma nova classe que você poderia usar para compor um schema.

Introdução

Este tutorial requer uma compreensão funcional dos vários aspectos da Adobe Experience Platform envolvidos no uso do Editor de Schemas. Antes de iniciar este tutorial, reveja a documentação para obter os seguintes conceitos:
  • Modelo de dados de experiência (XDM) : A estrutura padronizada pela qual a Plataforma organiza os dados de experiência do cliente.
  • Noções básicas da composição do schema: Uma visão geral dos schemas XDM e seus blocos de construção, incluindo classes, misturas, tipos de dados e campos.
  • Perfil do cliente em tempo real: Fornece um perfil unificado e em tempo real para o consumidor, com base em dados agregados de várias fontes.
Este tutorial requer que você tenha acesso à plataforma Experience. Se você não tiver acesso a uma organização IMS na plataforma Experience, fale com o administrador do sistema antes de prosseguir.

Procurar schemas existentes na área de trabalho Schemas

A área de trabalho Schemas na plataforma Experience fornece uma visualização da Biblioteca de Schemas, permitindo que você visualização e gerencie todos os schemas disponíveis para você, bem como componha novos. A área de trabalho também inclui o Editor de Schemas, a tela na qual você irá compor um schema neste tutorial.
Depois de fazer logon na Experience Platform, clique em Schemas na navegação à esquerda e você será levado para a área de trabalho de Schemas. Você verá uma lista de schemas (uma representação da Biblioteca de Schemas) onde poderá visualização, gerenciar e personalizar todos os schemas disponíveis. 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.
Clique no ícone de filtro ao lado da barra Pesquisar para usar os recursos de filtragem para todos os recursos no registro, incluindo classes, mixins e tipos de dados.

Criar e nomear um schema

Para começar a compor um schema, clique em Criar Schema no canto superior direito da área de trabalho dos Schemas.
O Editor de Schemas é exibido. Esta é a tela sobre a qual você irá compor seu schema. Quando você chega ao editor, um "Schema sem título" na seção Estrutura da tela é automaticamente criado para que você comece a personalizar.
No lado direito do editor estão Propriedades do Schema, onde é possível fornecer um nome para o schema (usando o campo Nome de exibição). 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 na biblioteca 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.
  • Como opção, você pode fornecer informações adicionais sobre o schema usando o campo Descrição .
Este tutorial compõe um schema para assimilar dados relacionados aos membros de um programa de fidelidade, portanto, o schema é denominado "Membros de fidelidade".

Atribuir uma classe

No lado esquerdo do editor está a seção Composição . Atualmente, contém duas subseções: Schema e classe .
Agora que o schema tem um nome, é hora de atribuir a classe que o schema implementará. Clique em Atribuir ao lado de Classe .
A caixa de diálogo Atribuir classe é exibida. Esta janela exibe 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 pela Adobe.
Clique no nome da classe para exibir a descrição da classe. Você também pode optar por Pré-visualização da estrutura de classe para ver os campos e os metadados associados à classe.
Este tutorial usa a classe de Perfil individual XDM. Clique no botão de opção ao lado da classe para selecioná-la e clique em Atribuir classe .
A tela reaparece. A seção Classe agora contém a classe selecionada (Perfil individual XDM) e os campos contribuídos pela classe Perfil individual XDM agora são visíveis na seção Estrutura .
Os campos aparecem no formato "fieldName| Tipo de dados". As etapas para definir campos de schema na interface do usuário são fornecidas posteriormente neste tutorial.
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, portanto, alterar a classe redefinirá a tela de desenho e quaisquer campos adicionados.

Adicionar uma mistura

Agora que uma classe foi atribuída, a seção Composição contém uma terceira subseção: Misturas .
Agora você pode começar a adicionar campos ao seu schema adicionando mixins. Uma combinação é um grupo de um ou mais campos que descrevem 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, clique em Adicionar na subseção Misturas .
A caixa de diálogo Adicionar mistura é exibida. As misturas só se destinam ao uso com classes específicas, portanto, a lista de misturas mostra somente aquelas compatíveis com a classe selecionada (neste caso, a classe Perfil individual XDM).
Selecionar o botão de opção ao lado de uma combinação lhe dará a opção de Pré-visualização da estrutura de mistura. Selecione a combinação "Detalhes da pessoa do Perfil" e clique em Adicionar combinação .
A tela do schema é exibida novamente. A seção Misturas agora lista a combinação "Detalhes da pessoa do Perfil" e a seção Estrutura inclui os campos contribuídos pela mistura.
Esse mixin contribui com vários campos sob o nome de nível superior "pessoa" 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) como seu tipo de dados, bem como qualquer "tipo de dados" (um grupo de campos que representa um conceito comum) no Registro do Schema.
Observe que o campo "nome" tem um tipo de dados de "Nome da pessoa", o que significa que também descreve um conceito comum e contém subcampos relacionados ao nome, como nome, sobrenome e nome completo.
Clique em diferentes campos na tela para ver 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 mistura desta vez, observe que a mistura "Detalhes da pessoa do Perfil" está esmaecida e o botão de opção ao lado dela não pode ser selecionado. Isso evita que você duplique acidentalmente misturas que já foram incluídas no schema atual.
Agora você pode adicionar a combinação "Detalhes pessoais do Perfil" na caixa de diálogo Adicionar combinação .
Depois de adicionada, a tela de desenho reaparece. Os "Detalhes pessoais do Perfil" agora estão listados em Mixins na seção Composição , e os campos para endereço residencial, telefone celular e muito mais foram adicionados em Estrutura .
Semelhante ao campo "nome", os campos que você acabou de adicionar representam os conceitos de vários campos. Por exemplo, "homeAddress" tem um tipo de dados de "Address" e "mobilePhone" tem um tipo de dados de "Número de telefone". Você pode clicar em cada um desses campos para expandi-los e ver os campos adicionais incluídos no tipo de dados.

Definir uma nova mistura

O schema "Membros de Fidelidade" destina-se a capturar dados relacionados aos membros de um programa de fidelidade, de modo que serão 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 "Detalhes da fidelidade".
Clique em Adicionar mistura para retornar ao editor de schemas. Os "Detalhes de fidelidade" agora devem 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 "Detalhes da Fidelidade", é hora de definir os campos que a combinação contribuirá para o schema.
Para começar, clique no nome da mistura na seção Misturas . Assim que você fizer isso, as Propriedades de combinação aparecerão no lado direito do editor e um botão Adicionar campo aparecerá ao lado do nome do schema em Estrutura .
Clique em Adicionar campo ao lado de "Membros de fidelidade" 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 Registro do Schema em uma área específica acessível apenas à sua Organização IMS. Os campos definidos devem ser sempre adicionados à namespace para evitar colisões com nomes de outras classes padrão, misturas, tipos de dados e campos.
Dentro desse nó com namespaces há um "Novo campo". Este é o começo da mistura "Detalhes da Fidelidade".
Usando Propriedades de campo no lado direito do editor, crie um campo de "fidelidade" com o tipo "Objeto" que será usado para manter seus campos relacionados à fidelidade. Quando terminar, clique em Aplicar .
As alterações são aplicadas e o objeto de "fidelidade" recém-criado é exibido. Clique em Adicionar campo ao lado do objeto para adicionar outros campos relacionados à fidelidade. Um "Novo campo" é exibido e a seção Propriedades do campo é visível no lado direito da tela.
Cada campo requer as seguintes informações:
  • Nome do campo: O nome do campo, escrito em caso de camelo. Exemplo: leyaltyLevel
  • Nome de 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 Registro do Schema. Exemplos: string, integer, 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. (máximo de 200 caracteres)
O primeiro campo para o objeto Loyalty será uma string chamada "loyaltyId". Ao definir o tipo do novo campo como "String", a janela Propriedades do 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 para mixagem

Agora que você adicionou o campo "loyaltyId", é possível adicionar campos adicionais para capturar informações relacionadas à fidelidade, como:
  • Pontos (Inteiro)
  • Membro Desde (Data)
Cada campo é adicionado clicando em Adicionar campo no objeto de fidelidade e preenchendo as informações necessárias.
Quando concluído, o objeto Fidelidade conterá campos para: ID de Fidelidade, Pontos e Membro Desde.

Adicionar campo 'enum' para mixagem

Ao definir campos no Editor de Schemas, há 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.
Um exemplo disso seria um campo "Nível de Fidelidade", onde o valor pode ser apenas uma das quatro opções possíveis. Para adicionar esse campo ao schema, clique em Adicionar campo ao lado do objeto "fidelidade" e preencha os campos obrigatórios em Propriedades do campo.
Para Tipo , selecione "String" e você verá caixas de seleção adicionais exibidas para Matriz , enumeração e identidade .
Marque a caixa de seleção Enum para abrir a seção Valores de enumeração 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, clique em Aplicar e o campo "fidelidadeNível" será adicionado ao objeto "fidelidade".
Mais informações sobre restrições adicionais disponíveis:
  • 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, selecionar um tipo de dados de "String" e marcar a caixa de seleção "Array" significa 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 .

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

Depois de adicionar vários campos específicos de fidelidade, o objeto "fidelidade" agora contém uma estrutura de dados comum que pode ser útil em outros schemas.
Quando você sente que uma estrutura de vários campos pode ser reutilizável e gostaria de ter a flexibilidade para usar essa mesma estrutura de dados em outro lugar, o Editor de Schemas possibilita a conversão dessa estrutura em um tipo 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 Tipo de um campo em uma combinação para qualquer tipo de dados definido no registro.
Para converter o objeto "fidelidade" em um tipo de dados, clique no campo "fidelidade" em Estrutura e selecione Converter em novo tipo de dados no lado direito do editor em Propriedades de campo. Um pequeno pop-up verde é exibido confirmando "Objeto convertido em tipo de dados".
Agora, quando você olha em Estrutura , você pode ver que o campo "fidelidade" tem um tipo de dados de "Fidelidade" e os campos têm pequenos ícones de cadeado ao lado deles, indicando que não são mais campos individuais, mas sim parte de uma estrutura de vários campos.
Em um schema futuro, agora é possível atribuir a um campo o Tipo de "Fidelidade" e ele incluirá automaticamente os campos Nível de Fidelidade, Pontos, Desde Membro e ID de Fidelidade.

Definir um campo de schema como um campo de identidade

Os Schemas são usados para ingerir dados na plataforma da experiência, e esses dados são usados para identificar indivíduos e unir informações provenientes de várias fontes. Para ajudar nesse processo, os campos principais podem ser marcados como campos "Identidade".
A Plataforma de experiência facilita a identificação de um campo de identidade através do uso de uma caixa de seleção Identidade no Editor de Schemas.
Por exemplo, pode haver milhares de membros do programa de fidelidade pertencentes ao mesmo "nível", mas cada membro do programa de fidelidade tem uma "loyaltyId" exclusiva (que, neste caso, é o endereço de email do membro individual). O fato de "loyaltyId" ser um identificador exclusivo para cada membro faz dele um bom candidato para um campo de identidade, enquanto "level" não é.
Na seção Estrutura do editor, clique no campo "loyaltyId" que você criou e você verá a caixa de seleção Identity aparecer em Propriedades de campo. Marque a caixa e você terá a opção de definir isso como a Identidade ​principal. Marque essa caixa também.
Em seguida, você deve fornecer um Nome de identidade . Existem várias namespaces predefinidas, mas como "loyaltyId" é o endereço de email do membro, selecione "Email" na lista suspensa. Agora você pode clicar em Aplicar para confirmar as atualizações do campo "idelityId".
Agora, todos os dados ingeridos no campo "leyaltyId" serão usados para ajudar a identificar esse indivíduo e unir uma única visualização do cliente.
Depois que um campo de schema for definido como a identidade primária, você receberá uma mensagem de erro se tentar definir outro campo no schema como principal. Cada schema pode conter apenas um campo de identidade principal.
Para saber mais sobre como trabalhar com identidades, consulte a documentação do Serviço de identidade.

Ative o schema para uso no Perfil do cliente em tempo real

O Editor de Schemas fornece a capacidade de habilitar um schema para uso com o Perfil Cliente em tempo real. O Perfil fornece uma visualização holística de cada cliente individual, criando um perfil robusto de 360° dos atributos do cliente, bem como uma conta com carimbo de data e hora de cada interação que o cliente teve em qualquer sistema integrado à plataforma Experience.
Para que um schema seja habilitado para uso com o Perfil de cliente em tempo real, ele deve ter uma identidade primária definida. Você receberá uma mensagem de erro "Missing Primary Identity" (Identidade primária ausente) se tentar habilitar um schema sem primeiro definir uma identidade primária.
Para ativar o schema "Membros da Fidelidade" para uso no Perfil, comece clicando em "Membros da Fidelidade" na seção Estrutura do editor.
No lado direito do editor, em Propriedades do Schema, 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 intitulado Perfil .
Clique em Perfil e um pop-up será exibido, solicitando que você confirme que deseja ativar o schema para Perfil.
Uma vez que um schema tenha sido ativado para Perfil do cliente em tempo real e salvo, ele não poderá ser desativado.

Próximas etapas

Agora que você terminou de compor um schema de "Membros da Fidelidade", você pode ver o schema completo na seção Estrutura do editor. Clique em Salvar e o schema será salvo na Biblioteca de Schemas, tornando-o acessível pelo Registro de Schemas.
Seu novo schema agora pode ser usado para assimilar dados na Plataforma. 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.
O schema "Membros da fidelidade" também está disponível para exibição e gerenciamento usando a API do Registro do Schema. Para começar a trabalhar com a API, leia o guia do desenvolvedor da API do Registro do Schema.

Apêndice

As informações a seguir são complementares ao Tutorial do Editor de Schemas.

Create a new class

A Plataforma de experiência oferece a flexibilidade para definir um schema com base em uma classe exclusiva de sua organização.
Abra a caixa de diálogo Atribuir classe clicando em Atribuir na seção Classe do Editor de Schemas. Na caixa de diálogo, selecione Criar nova classe .
Em seguida, você pode atribuir a 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érie de tempo") 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 mistura . Em vez disso, será necessário selecionar Criar nova mistura e definir uma mistura para uso 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

A qualquer momento durante o processo inicial de composição do schema, antes de o schema ser salvo, é possível alterar a classe na qual o schema se baseia.
Tenha cuidado antes de mudar de classe. Misturas são compatíveis apenas com certas classes, portanto, alterar a classe redefine a tela e remove quaisquer campos adicionados a esse ponto.
Para alterar a classe, clique em Atribuir ao lado de Classe na seção Composição do editor.
Quando a caixa de diálogo Atribuir classe é aberta, você pode escolher uma nova classe na lista disponível. Clique em Atribuir classe e uma nova caixa de diálogo será aberta solicitando que você confirme que deseja atribuir uma nova classe.
Se você confirmar a alteração da classe, a tela será redefinida e todo o progresso da composição será perdido.