Definir enumerações e valores sugeridos na interface enums-and-suggested-values
No Experience Data Model (XDM), um campo de sequência pode receber um conjunto predefinido de valores aceitos ou sugeridos para controlar melhor quais valores são assimilados nesse campo ou como ele se comportará na segmentação.
Enumerações restringem os valores que podem ser assimilados para um campo de cadeia de caracteres para um conjunto predefinido. Se você tentar assimilar dados em um campo enum e o valor não corresponder a nenhum dos definidos em sua configuração, a assimilação será negada.
Ao contrário das enumerações, a opção Valores sugeridos permite indicar um conjunto de valores recomendados para um campo de sequência que não restringe os valores que ele pode assimilar. Em vez disso, os valores sugeridos afetam quais valores predefinidos estão disponíveis na Interface de segmentação ao incluir o campo de sequência como um atributo.
Ao definir um novo campo na interface do usuário do Adobe Experience Platform e definir o tipo como Cadeia de caracteres, você terá a opção de definir um enum ou valores sugeridos para esse campo.
Este documento aborda como definir enumerações e valores sugeridos no espaço de trabalho da interface de Esquemas. Para obter uma visão geral rápida sobre enumerações e valores sugeridos, incluindo como configurá-los na interface do usuário e seus efeitos downstream, assista ao seguinte vídeo:
Definir um enum enum
Selecione Enumerações e Valores Sugeridos e, em seguida, Enumerações. Controles adicionais são exibidos, permitindo especificar as restrições de valor para o enum. Para adicionar uma restrição, selecione Adicionar linha.
Na coluna Valor, você deve fornecer o valor exato ao qual deseja restringir o campo. Opcionalmente, você também pode fornecer um Nome de Exibição amigável para a restrição, o que afeta como o valor será representado na segmentação.
Continue a usar a Linha de adição para adicionar as restrições desejadas e os rótulos opcionais à enumeração, ou selecione o ícone de exclusão (
A tela é atualizada para refletir as alterações. Ao explorar esse esquema no futuro, você pode visualizar e editar as restrições para o campo de enumeração no painel direito.
Definir valores sugeridos suggested-values
Selecione Enumerações e Valores Sugeridos e Valores Sugeridos para exibir controles adicionais. Aqui, selecione Adicionar linha para começar a adicionar os valores sugeridos.
Na coluna Nome para Exibição, forneça um nome amigável para o valor como você deseja que ele seja exibido na interface do usuário de Segmentação. Para adicionar mais valores sugeridos, selecione Adicionar linha novamente e repita o processo conforme necessário. Para remover uma linha adicionada anteriormente, selecione
Quando terminar, selecione Aplicar para aplicar as alterações ao esquema.
Gerenciar valores sugeridos para campos padrão
Alguns campos de componentes XDM padrão contêm seus próprios valores sugeridos, como eventType da classe XDM ExperienceEvent. Embora seja possível criar valores sugeridos adicionais para um campo padrão, não é possível modificar ou remover valores sugeridos que não estejam definidos pela organização. Ao visualizar um campo padrão na interface do usuário do, os valores sugeridos são exibidos, mas são somente leitura.
Para adicionar novos valores sugeridos para um campo padrão, selecione Adicionar linha. Para remover um valor sugerido que foi adicionado anteriormente por sua organização, selecione
Regras de evolução para enumerações e valores sugeridos evolution
Depois que um esquema com um campo de enumeração é usado para assimilar dados na Platform, qualquer alteração adicional feita na definição do esquema deve estar em conformidade com os dados já existentes no sistema. Em geral, as alterações feitas em um campo existente só podem tornar esse campo menos restritivo. Um campo não pode se tornar mais restritivo do que já é.
Quando se trata de enumerações e valores sugeridos, as seguintes regras se aplicam após a assimilação:
- Você PODE adicionar valores sugeridos para campos padrão e personalizados com valores sugeridos existentes.
- Você PODE remover valores sugeridos de campos personalizados com valores sugeridos existentes.
- Você PODE adicionar novos valores de enumeração para um campo de enumeração personalizado existente.
- Você PODE alternar os valores de enumeração de um campo personalizado somente para os valores sugeridos ou convertê-los em uma cadeia de caracteres sem enumeração ou valores sugeridos. Esta opção não pode ser desfeita depois de aplicada.
- Você NÃO PODE remover enumerações ou valores sugeridos de campos padrão.
- Você NÃO PODE adicionar valores de enumeração a um campo sem enumeração existente.
- Você NÃO PODE remover menos do que todos os valores de enumeração existentes para um campo personalizado.
- Você NÃO PODE alternar dos valores sugeridos para uma enumeração.
Mesclar regras para enumerações e valores sugeridos merging
Se vários esquemas usarem o mesmo campo de enumeração com configurações diferentes e esses esquemas forem incluídos em uma união, determinadas regras se aplicam quando se trata de como as diferenças de enumeração são reconciliadas. As regras exatas dependem se os esquemas fazem referência ao mesmo campo padrão (como eventType) ou se estão fazendo referência ao mesmo caminho de campo personalizado em diferentes grupos de campos.
Se fizer referência ao mesmo campo padrão:
- Quaisquer valores adicionais sugeridos são APPENDED na união.
- As atualizações feitas nos valores sugeridos para a mesma chave enum são ATUALIZADAS na união.
Se estiver fazendo referência ao mesmo caminho de campo personalizado em grupos de campos diferentes:
- Quaisquer valores adicionais sugeridos são APPENDED na união.
- Se o mesmo valor adicional sugerido for definido em mais de um esquema, esses valores serão MESCLADOS na união. Em outras palavras, o mesmo valor sugerido não aparecerá duas vezes após a mesclagem.
Limitações da validação
Devido às limitações atuais do sistema, há dois casos em que um enum não é validado pelo sistema durante a assimilação:
- A enumeração está definida em um campo de matriz.
- A enumeração está definida em mais de um nível profundo na hierarquia de esquema.
Próximas etapas
Este guia abordou como definir enumerações e valores sugeridos para campos de sequência na interface do usuário. Para obter informações sobre como gerenciar enumerações e valores sugeridos usando a API do Registro de Esquema, consulte o seguinte tutorial.
Para saber como definir outros tipos de campo XDM no Schema Editor, consulte a visão geral em definindo campos na interface.