Criar e editar classes na interface do usuário

No Experience Data Model (XDM), as classes definem os aspectos comportamentais dos dados que um schema conterá (registro ou série de tempo). Além disso, as classes descrevem o menor número de propriedades comuns que todos os esquemas baseados nessa classe precisariam incluir e fornecer uma maneira de vários conjuntos de dados compatíveis serem mesclados.

O Adobe fornece várias classes XDM padrão ("core"), incluindo XDM Individual Profile e XDM ExperienceEvent. Além dessas classes principais, você também pode criar suas próprias classes personalizadas para descrever casos de uso mais específicos da sua organização.

Este documento fornece uma visão geral de como criar, editar e gerenciar classes personalizadas na interface do usuário do Adobe Experience Platform.

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 saber como as classes contribuem com os esquemas XDM.

Embora não seja necessário para este guia, é recomendável seguir também o tutorial em composição de um esquema na interface do usuário para se familiarizar com os vários recursos do Schema Editor.

Criar uma nova classe

No Esquemas espaço de trabalho, selecione Criar esquema, em seguida selecione Procurar na lista suspensa.

Uma caixa de diálogo é exibida e permite selecionar a partir de uma lista de classes disponíveis. Na parte superior da caixa de diálogo, selecione Criar nova classe. Em seguida, você pode fornecer um nome de exibição para a nova classe (um nome curto, descritivo, exclusivo e amigável para a classe), uma descrição e um comportamento para os dados que o schema definirá ("Registro" ou "Série cronológica").

Quando terminar, selecione Atribuir classe.

O Schema Editor for exibido, mostrando um novo schema na tela com base na classe personalizada que você acabou de criar. Como nenhum campo foi adicionado à classe ainda, o schema contém apenas um _id , que representa o identificador exclusivo gerado pelo sistema aplicado automaticamente a todos os recursos no Schema Registry.

IMPORTANTE

Ao criar um schema que implementa uma classe definida pela organização, lembre-se de que os grupos de campos de esquema estão disponíveis para uso somente com classes compatíveis. Como a classe que você definiu é nova, não há grupos de campos compatíveis listados na Adicionar grupo de campos caixa de diálogo. Em vez disso, será necessário criar novos grupos de campos para uso com essa classe. Na próxima vez que você compor um schema que implementa a nova classe, os grupos de campos definidos serão listados e estarão disponíveis para uso.

Agora você pode começar adicionar campos à classe, que será compartilhado por todos os schemas que empregam a classe .

Editar uma classe existente

IMPORTANTE

As classes personalizadas criadas após 30 de abril de 2022 não podem ser editadas diretamente e uma correção está em desenvolvimento no momento. Como solução alternativa, você pode criar um grupo de campos personalizado e reutilize-o para cada schema que usa a classe personalizada que deseja estender. As classes personalizadas criadas antes de 30 de abril de 2022 não são afetadas por essa limitação.

OBSERVAÇÃO

Somente as classes personalizadas definidas pela sua organização podem ser totalmente editadas e personalizadas. Para classes principais definidas por Adobe, somente os nomes de exibição de seus campos podem ser editados no contexto de schemas individuais. Consulte a seção sobre edição de nomes de exibição para campos de esquema para obter detalhes.

Depois que uma classe personalizada é salva e usada na assimilação de dados, somente alterações aditivas podem ser feitas a ela depois. Consulte a regras de evolução do schema para obter mais informações.

Para editar uma classe existente, selecione a Procurar e selecione o nome de um schema que emprega a classe 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.

O Schema Editor for exibida, com a estrutura do esquema mostrada na tela. Agora você pode começar adicionar campos à classe.

Adicionar campos a uma classe

IMPORTANTE

As classes personalizadas criadas após 30 de abril de 2022 não podem ser editadas diretamente e uma correção está em desenvolvimento no momento. Como solução alternativa, você pode criar um grupo de campos personalizado e reutilize-o para cada schema que usa a classe personalizada que deseja estender. As classes personalizadas criadas antes de 30 de abril de 2022 não são afetadas por essa limitação.

Depois de ter um schema que emprega uma classe personalizada aberta no Editor de esquema, você pode começar a adicionar campos à classe . Para adicionar um novo campo, selecione o mais (+) ícone ao lado do nome do schema.

IMPORTANTE

Lembre-se de que quaisquer campos adicionados a uma classe serão usados em todos os esquemas que empregam essa classe. Portanto, você deve considerar cuidadosamente quais campos serão úteis em todos os casos de uso do schema. Se estiver pensando em adicionar um campo que pode ver o uso somente em alguns schemas desta classe, considere adicioná-lo a esses esquemas por criação de um grupo de campos em vez disso.

A Novo campo aparece na tela e o painel direito é atualizado para mostrar controles para configurar as propriedades do campo. Consulte o guia sobre definição de campos na interface do usuário para obter etapas específicas sobre como configurar e adicionar o campo à classe .

Continue a adicionar quantos campos forem necessários à classe. Quando terminar, selecione Salvar para salvar o schema e a classe .

Se você tiver criado esquemas que empregam essa classe anteriormente, os campos recém-adicionados aparecerão automaticamente nesses esquemas.

Alterar a classe de um schema

Você pode alterar a classe do schema em qualquer ponto durante o processo de criação inicial antes que ele seja salvo. Consulte o guia sobre criação e edição de schemas para obter mais informações.

Próximas etapas

Este documento cobriu como criar e editar classes usando a interface do usuário da plataforma. 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 classes usando o Schema Registry API, consulte o guia de endpoint de classes.

Nesta página