Criar e editar esquemas na interface do usuário

Este guia fornece uma visão geral de como criar, editar e gerenciar esquemas do Experience Data Model (XDM) para sua organização na interface do usuário do Adobe Experience Platform.

IMPORTANTE

Os esquemas XDM são extremamente personalizáveis e, portanto, as etapas envolvidas na criação de um esquema podem variar dependendo do tipo de dados que você deseja que o esquema capture. Como resultado, este documento cobre apenas as interações básicas que você pode fazer com esquemas na interface do usuário e exclui etapas relacionadas, como personalização de classes, grupos de campos de esquema, tipos de dados e campos.

Para obter um tour completo do processo de criação do schema, siga as etapas tutorial de criação de schema para criar um schema de exemplo completo e se familiarizar com os vários recursos do Schema Editor.

Pré-requisitos

Este guia requer uma compreensão funcional do Sistema XDM. Consulte a Visão geral do XDM para uma introdução ao papel do XDM no ecossistema do Experience Platform, e noções básicas da composição do schema para obter uma visão geral de como os schemas são construídos.

Criar um novo schema

No Esquemas espaço de trabalho, selecione Criar esquema no canto superior direito. Na lista suspensa exibida, é possível escolher entre Perfil individual XDM e ExperiênciaEvento XDM como a classe base do esquema. Como alternativa, você pode selecionar Procurar para selecionar na lista completa de classes disponíveis, ou criar uma nova classe personalizada em vez disso.

Depois que você selecionar uma classe, a variável Schema Editor for exibida e a estrutura base do esquema (fornecida pela classe ) for mostrada na tela. A partir daqui, você pode usar o painel direito para adicionar um Nome de exibição e Descrição para o schema .

Agora é possível começar a criar a estrutura do schema ao adição de grupos de campos de esquema.

Editar um esquema existente

OBSERVAÇÃO

Depois que um schema é salvo e usado na assimilação de dados, somente alterações aditivas podem ser feitas nele. Consulte a regras de evolução do schema para obter mais informações.

Para editar um esquema existente, selecione o Procurar e selecione o nome do schema que deseja editar.

DICA

Você pode usar os recursos de pesquisa e filtragem do espaço de trabalho para ajudar a encontrar o esquema mais fácil. Consulte o guia sobre exploração de recursos XDM para obter mais informações.

Depois de selecionar um schema, a variável Schema Editor é exibido com a estrutura do esquema mostrada na tela. Agora você pode adicionar grupos de campos ao schema (ou adicionar campos individuais desses grupos), editar nomes de exibição de campoou editar grupos de campos personalizados existentes se o schema empregar algum.

Adicionar grupos de campos a um schema

OBSERVAÇÃO

Esta seção aborda como adicionar grupos de campos existentes a um schema. Para criar um novo grupo de campos personalizado, consulte o guia em criação e edição de grupos de campos em vez disso.

Depois de abrir um schema na Schema Editor, é possível adicionar campos ao schema por meio do uso de grupos de campos. Para iniciar, selecione Adicionar ao lado de Grupos de campos no painel esquerdo.

Uma caixa de diálogo é exibida mostrando uma lista de grupos de campos que você pode selecionar para o esquema. Como os grupos de campos são compatíveis apenas com uma classe, somente os grupos de campos associados à classe selecionada do esquema serão listados. Por padrão, os grupos de campos listados são classificados com base em sua popularidade de uso em sua organização.

Se você conhecer a atividade geral ou a área comercial dos campos que deseja adicionar, selecione uma ou mais categorias verticais do setor no painel à esquerda para filtrar a lista exibida de grupos de campo.

OBSERVAÇÃO

Para obter mais informações sobre as práticas recomendadas para modelagem de dados específica do setor no XDM, consulte a documentação em modelos de dados do setor.

Também é possível usar a barra de pesquisa para ajudar a localizar o grupo de campos desejado. Os grupos de campos cujo nome corresponde ao query são exibidos na parte superior da lista. Em Campos padrão, grupos de campos que contêm campos que descrevem os atributos de dados desejados são exibidos.

Marque a caixa de seleção ao lado do nome do grupo de campos que deseja adicionar ao schema. É possível selecionar vários grupos de campos na lista, com cada grupo de campos selecionado aparecendo no painel direito.

DICA

Para qualquer grupo de campos listado, você pode focalizar ou passar o mouse no ícone de informações () para exibir uma breve descrição do tipo de dados que o grupo de campos captura. Também é possível selecionar o ícone de visualização () para exibir a estrutura dos campos que o grupo de campos fornece antes de decidir adicioná-lo ao schema.

Depois de escolher os grupos de campos, selecione Adicionar grupos de campos para adicioná-los ao schema.

O Schema Editor reaparece com os campos fornecidos pelo grupo de campos representados na tela.

Após adicionar um grupo de campos a um schema, você pode optar por remover campos existentes ou adicionar novos campos personalizados para esses grupos, dependendo de suas necessidades.

Remover campos adicionados de grupos de campos

Após adicionar um grupo de campos a um schema, é possível remover os campos que não são necessários.

OBSERVAÇÃO

A remoção de campos de um grupo de campos afeta apenas o schema que está sendo trabalhado e não afeta o próprio grupo de campos. Se você remover campos em um schema, esses campos ainda estarão disponíveis em todos os outros esquemas que empregam o mesmo grupo de campos.

No exemplo a seguir, o grupo de campos padrão Detalhes demográficos foi adicionado a um schema. Para remover um único campo, como taxId, selecione o campo na tela e selecione Remover no painel direito.

Remover campo único

Se houver vários campos que você deseja remover, será possível gerenciar o grupo de campos como um todo. Selecione um campo pertencente ao grupo na tela e selecione Gerenciar campos relacionados no painel direito.

Gerenciar campos relacionados

Uma caixa de diálogo é exibida mostrando a estrutura do grupo de campos em questão. Aqui, você pode usar as caixas de seleção fornecidas para selecionar ou desmarcar os campos necessários. Quando estiver satisfeito, selecione Confirmar.

Selecionar campos do grupo de campos

A tela reaparece somente com os campos selecionados presentes na estrutura do schema.

Campos adicionados

Adicionar campos personalizados a grupos de campos

Após adicionar um grupo de campos a um schema, é possível definir campos adicionais para esse grupo. No entanto, quaisquer campos adicionados a um grupo de campos em um schema também aparecerão em todos os outros esquemas que empregam esse mesmo grupo de campos.

Além disso, se um campo personalizado for adicionado a um grupo de campos padrão, esse grupo de campos será convertido em um grupo de campos personalizado e o grupo de campos padrão original não estará mais disponível.

Se quiser adicionar um campo personalizado a um grupo de campos padrão, consulte seção abaixo para obter instruções específicas. Se estiver adicionando campos a um grupo de campos personalizado, consulte a seção em edição de grupos de campos personalizados no guia da interface do usuário de grupos de campo .

Se você não quiser alterar nenhum grupo de campos existente, poderá criar um novo grupo de campos personalizado para definir campos adicionais.

Adicionar campos individuais a um schema

O Editor de esquema permite adicionar campos individuais diretamente a um esquema se você não quiser adicionar um grupo de campos inteiro para um caso de uso específico. Você pode adicionar campos individuais de grupos de campos padrão ou adicionar seus próprios campos personalizados em vez disso.

IMPORTANTE

Embora o Editor de esquema permita, funcionalmente, adicionar campos individuais diretamente a um esquema, isso não altera o fato de que todos os campos em um esquema XDM devem ser fornecidos por sua classe ou por um grupo de campos compatível com essa classe. Como as seções abaixo explicam, todos os campos individuais ainda são associados a uma classe ou grupo de campos como uma etapa principal quando são adicionados a um esquema.

Adicionar campos padrão

Você pode adicionar campos de grupos de campos padrão diretamente a um schema sem precisar conhecer previamente o grupo de campos correspondente. Para adicionar um campo padrão a um schema, selecione o sinal de mais (+) ícone ao lado do nome do esquema na tela. Um Campo sem título o espaço reservado aparece na estrutura do schema e o painel direito é atualizado para revelar controles para configurar o campo.

Espaço reservado do campo

Em Nome do campo, comece digitando o nome do campo que deseja adicionar. O sistema pesquisa automaticamente campos padrão que correspondem à consulta e os lista em Campos padrão recomendados, incluindo os grupos de campos aos quais eles pertencem.

Campos padrão recomendados

Embora alguns campos padrão compartilhem o mesmo nome, sua estrutura pode variar dependendo do grupo de campos de onde vêm. Se um campo padrão estiver aninhado em um objeto pai na estrutura do grupo de campos, o campo pai também será incluído no esquema se o campo filho for adicionado.

Selecione o ícone de visualização (Ícone Visualizar) ao lado de um campo padrão para visualizar a estrutura de seu grupo de campos e entender melhor como ele pode ser aninhado. Para adicionar o campo padrão ao schema, selecione o ícone de adição (Ícone Plus).

Adicionar campo padrão

A tela é atualizada para mostrar o campo padrão adicionado ao esquema, incluindo quaisquer campos pai nos quais ele está aninhado dentro da estrutura do grupo de campos. O nome do grupo de campos também é listado em Grupos de campos no painel esquerdo. Para adicionar mais campos do mesmo grupo de campos, selecione Gerenciar campos relacionados no painel direito.

Campo padrão adicionado

Adicionar campos personalizados

Semelhante ao fluxo de trabalho para campos padrão, também é possível adicionar seus próprios campos personalizados diretamente a um esquema.

Para adicionar campos ao nível raiz de um schema, selecione o sinal de mais (+) ícone ao lado do nome do esquema na tela. Um Campo sem título o espaço reservado aparece na estrutura do schema e o painel direito é atualizado para revelar controles para configurar o campo.

Campo personalizado raiz

Comece digitando o nome do campo que deseja adicionar e o sistema inicia automaticamente a pesquisa por campos padrão correspondentes. Para criar um novo campo personalizado, selecione a opção superior anexada com (Novo campo).

Novo campo

Depois de fornecer um nome de exibição e um tipo de dados para o campo, a próxima etapa é atribuir o campo a um recurso XDM pai. Se o esquema usar uma classe personalizada, você pode optar por adicionar o campo à classe atribuída ou grupo de campos em vez disso. No entanto, se o esquema usar uma classe padrão, você só poderá atribuir o campo personalizado a um grupo de campos.

Atribuir o campo a um grupo de campos personalizado

OBSERVAÇÃO

Esta seção aborda apenas como atribuir o campo a um grupo de campos personalizado. Se você quiser estender um grupo de campos padrão com o novo campo personalizado, consulte a seção em adição de campos personalizados a grupos de campos padrão.

Em Atribuir a, selecione Grupo de campos. Se o esquema usar uma classe padrão, essa será a única opção disponível e será selecionada por padrão.

Em seguida, é necessário selecionar um grupo de campos para o novo campo ser associado. Comece digitando o nome do grupo de campos na entrada de texto fornecida. Se você tiver grupos de campos personalizados que correspondam à entrada, eles serão exibidos na lista suspensa. Como alternativa, você pode digitar um nome exclusivo para criar um novo grupo de campos.

Selecionar grupo de campos

AVISO

Se você selecionar um grupo de campos personalizado existente, qualquer outro esquema que use esse grupo de campos também herdará o campo recém-adicionado depois de salvar as alterações. Por isso, selecione somente um grupo de campos existente se desejar esse tipo de propagação. Caso contrário, você deve optar por criar um novo grupo de campos personalizado.

Depois de selecionar o grupo de campos na lista, selecione Aplicar.

Campo Aplicar

O novo campo é adicionado à tela de desenho e é namespacado sob seu ID do locatário para evitar conflitos com campos XDM padrão. O grupo de campos ao qual você associou o novo campo também aparece em Grupos de campos no painel esquerdo.

ID do locatário

OBSERVAÇÃO

O restante dos campos fornecidos pelo grupo de campos personalizado selecionado são removidos do schema por padrão. Para adicionar alguns desses campos ao schema, selecione um campo pertencente ao grupo e selecione Gerenciar campos relacionados no painel direito.

Atribuir o campo a uma classe personalizada

Em Atribuir a, selecione Classe. O campo de entrada abaixo é substituído pelo nome da classe personalizada do esquema atual, indicando que o novo campo será atribuído a essa classe.

O Classe sendo selecionada para a nova atribuição de campo.

Continue configurando o campo conforme desejado e selecione Aplicar quando terminar.

Aplicar sendo selecionado para o novo campo.

O novo campo é adicionado à tela de desenho e é namespacado sob seu ID do locatário para evitar conflitos com campos XDM padrão. Selecionar o nome da classe no painel esquerdo revela o novo campo como parte da estrutura da classe.

O novo campo aplicado à estrutura da classe personalizada, representado na tela.

Adicionar campos personalizados à estrutura de grupos de campos padrão

Se o esquema em que você está trabalhando tiver um campo tipo objeto fornecido por um grupo de campos padrão, você poderá adicionar seus próprios campos personalizados a esse objeto padrão.

AVISO

Todos os campos adicionados a um grupo de campos em um schema também aparecerão em todos os outros esquemas que empregam esse mesmo grupo de campos. Além disso, se um campo personalizado for adicionado a um grupo de campos padrão, esse grupo de campos será convertido em um grupo de campos personalizado e o grupo de campos padrão original não estará mais disponível.

Se tiver participado do beta para esse recurso, você receberá uma caixa de diálogo informando sobre os grupos de campos padrão que você personalizou anteriormente. Depois de selecionar Conhecimento, os recursos listados são convertidos em grupos de campos personalizados.

Caixa de diálogo de confirmação para converter grupos de campos padrão

Para iniciar, selecione o sinal de mais (+) ícone ao lado da raiz do objeto fornecido pelo grupo de campos padrão.

Adicionar campo ao objeto padrão

Uma mensagem de aviso é exibida, solicitando que você confirme se deseja converter o grupo de campos padrão. Selecionar Continuar criando grupo de campos para continuar.

Confirmar conversão de grupo de campos

A tela é exibida novamente com um espaço reservado sem título para o novo campo. Observe que o nome do grupo de campos padrão foi anexado com "(Estendido)" para indicar que foi modificado a partir da versão original. A partir daqui, use os controles no painel direito para definir as propriedades do campo.

Campo adicionado ao objeto padrão

Depois de aplicar as alterações, o novo campo aparece sob o namespace da ID do locatário no objeto padrão. Esse namespace aninhado impede conflitos de nome de campo no próprio grupo de campos para evitar a quebra de alterações em outros esquemas que usam o mesmo grupo de campos.

Campo adicionado ao objeto padrão

Ativar um esquema para o Perfil do cliente em tempo real

Perfil do cliente em tempo real mescla dados de fontes diferentes para criar uma visualização completa de cada cliente individual. Se desejar que os dados capturados por um schema participem neste processo, é necessário habilitar o schema para uso em Profile.

IMPORTANTE

Para habilitar um schema para Profile, deve ter um campo de identidade primário definido. Consulte o guia sobre definição de campos de identidade para obter mais informações.

Para ativar o schema, comece selecionando o nome do schema no painel esquerdo e selecione o Perfil alternar no painel direito.

Um provedor é exibido, avisando que, uma vez que um esquema foi ativado e salvo, ele não poderá ser desativado. Selecionar Habilitar para continuar.

A tela reaparece com a Perfil ativar alternância.

IMPORTANTE

Como o esquema ainda não foi salvo, esse é o ponto de não retorno se você mudar de ideia sobre permitir que o esquema participe do Perfil do cliente em tempo real: depois de salvar um schema ativado, ele não poderá mais ser desativado. Selecione o Perfil alterne novamente para desativar o esquema.

Para concluir o processo, selecione Salvar para salvar o schema .

O esquema agora está ativado para uso no Perfil do cliente em tempo real. Quando a Platform assimila dados em conjuntos de dados com base nesse esquema, esses dados serão incorporados aos dados do Perfil amalgamado.

Editar nomes de exibição para campos de esquema

Depois de atribuir uma classe e adicionar grupos de campos a um esquema, você pode editar os nomes de exibição de qualquer um dos campos do esquema, independentemente desses campos terem sido fornecidos por recursos XDM padrão ou personalizados.

OBSERVAÇÃO

Lembre-se de que os nomes de exibição dos campos que pertencem a classes ou grupos de campos padrão só podem ser editados no contexto de um schema específico. Em outras palavras, alterar o nome de exibição de um campo padrão em um schema não afeta outros esquemas que empregam a mesma classe ou grupo de campos associado.

Depois de fazer alterações nos nomes de exibição dos campos de um esquema, essas alterações são refletidas imediatamente em qualquer conjunto de dados existente com base nesse esquema.

Para editar o nome de exibição de um campo de esquema, selecione o campo na tela. No painel direito, forneça o novo nome em Nome de exibição.

Selecionar Aplicar no painel direito, e a tela é atualizada para mostrar o novo nome de exibição do campo. Selecionar Salvar para aplicar as alterações ao schema.

Alterar a classe de um esquema

Você pode alterar a classe de um schema em qualquer ponto durante o processo de composição inicial antes que o schema tenha sido salvo.

AVISO

A reatribuição da classe para um schema deve ser feita com extremo cuidado. Os grupos de campos são compatíveis apenas com determinadas classes e, portanto, alterar a classe redefinirá a tela 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 Visualizar estrutura da classe para ver os campos e metadados associados à classe. Selecionar Atribuir classe para continuar.

Uma nova caixa de diálogo é aberta, solicitando que você confirme que deseja atribuir uma nova classe. Selecionar Atribuir para confirmar.

Após confirmar a alteração de classe, a tela será redefinida e todo o progresso da composição será perdido.

Próximas etapas

Este documento abordou as noções básicas para a criação e edição de schemas na interface do usuário da plataforma. É altamente recomendável revisar a variável tutorial de criação de schema para obter um fluxo de trabalho abrangente para criar um esquema completo na interface do usuário, incluindo a criação de grupos de campos personalizados e tipos de dados para casos de uso exclusivos.

Para obter mais informações sobre os recursos da Esquemas espaço de trabalho, consulte o Esquemas visão geral do espaço de trabalho.

Para saber como gerenciar schemas no Schema Registry API, consulte o guia do endpoint de schemas.

Nesta página