Definir campos XDM na interface do

A variável Schema Editor na interface do usuário do Adobe Experience Platform, é possível definir seus próprios campos nas classes personalizadas do Experience Data Model (XDM) e nos grupos de campos do esquema. Este guia aborda as etapas para definir campos XDM na interface do usuário, incluindo as opções de configuração disponíveis para cada tipo de campo.

Pré-requisitos

Este guia requer uma compreensão funcional do Sistema XDM. Consulte a Visão geral do XDM para obter uma introdução ao papel do XDM no ecossistema de Experience Platform, e a noções básicas da composição do esquema para saber como classes e grupos de campos contribuem com campos para esquemas XDM.

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

Selecionar um recurso ao qual adicionar campos select-resource

Para definir novos campos XDM na interface do usuário do, primeiro abra um esquema na Schema Editor. Dependendo de quais esquemas estão atualmente disponíveis para você no Schema Library, você pode optar por criar um novo esquema ou selecionar um esquema existente para editar.

Depois que você tiver o Schema Editor aberto, os controles para adicionar campos aparecem na tela. Esses controles aparecem ao lado do nome do esquema, bem como quaisquer campos do tipo objeto que tenham sido definidos na classe ou no grupo de campos selecionado.

O Editor de esquemas com os ícones de adição realçados.

WARNING
Se você tentar adicionar um campo a um objeto fornecido por um grupo de campos padrão, esse grupo de campos será convertido em um grupo de campos personalizado e o grupo de campos original não estará mais disponível. Consulte a seção sobre adicionar campos a grupos de campos padrão no guia da interface de schemas para obter mais informações.

Para adicionar um novo campo ao recurso, selecione a variável mais (+) ícone ao lado do nome do esquema na tela ou ao lado do campo do tipo de objeto no qual você deseja definir o campo.

O Editor de esquemas com um ícone de adição realçado.

Dependendo de você estar adicionando um campo diretamente a um esquema ou a sua classe constituinte e grupos de campos, as etapas necessárias para adicionar o campo variam. O restante deste documento se concentra em como configurar as propriedades de um campo, independentemente de onde esse campo aparece no esquema. Para obter mais informações sobre as diferentes maneiras de adicionar campos a um esquema, consulte as seguintes seções no guia da interface do usuário de schemas:

Definir as propriedades de um campo define

Depois de selecionar o mais (+) ícone, um Campo sem título o espaço reservado aparece em na tela.

O Editor de esquemas com um novo campo sem título realçado.

No painel direito, em Propriedades do campo, você poderá configurar os detalhes do novo campo. As seguintes informações são necessárias para cada campo:

Propriedade do campo
Descrição
Nome do campo

Um nome descritivo exclusivo para o campo. Observe que o nome do campo não pode ser alterado depois que o esquema é salvo. Esse valor é usado para identificar e fazer referência ao campo no código e em outros aplicativos downstream

Idealmente, o nome deve ser escrito em camelCase. Ele pode conter caracteres alfanuméricos, traço ou sublinhado, mas não pode comece com um sublinhado.

  • Correto: fieldName
  • Aceitável: field_name2, Field-Name, field-name_3
  • Incorreto: _fieldName
Nome de exibição
Um nome de exibição para o campo. Este é o nome que será usado para representar o campo dentro da tela Editor de esquemas. O nome do campo pode ser alterado para o nome de exibição usando o alternância do nome de exibição.
Tipo
O tipo de dados que o campo conterá. Nesse menu suspenso, é possível selecionar uma das opções tipos escalares padrão compatível com XDM, ou um dos vários campos tipos de dados que tenham sido previamente definidas no Schema Registry.
Observação: Se você selecionar o tipo de dados Mapa, Mapear tipo de valor é exibida.

Também é possível selecionar Pesquisa avançada de tipos para pesquisar e filtrar tipos de dados existentes e localizar o tipo desejado com mais facilidade.
Mapear tipo de valor
Esse valor é necessário se você selecionar Mapa como o tipo de dados do campo. Os valores disponíveis para o mapa são String e Integer. Selecione um valor na lista suspensa de opções disponíveis.
Para saber mais sobre propriedades do campo específico do tipo, consulte a visão geral definir campos.

Você também pode optar por fornecer uma descrição e notas para cada campo. Use o Descrição campo para adicionar contexto e descrever a funcionalidade do tipo de dados do mapa. Isso contribui para a manutenção e a legibilidade da implementação. Você também pode adicionar observações para complementar a descrição inicial. Isso deve oferecer informações mais granulares e específicas para ajudar os desenvolvedores a entender, manter e utilizar o mapa de maneira eficaz no contexto da base de código. |

NOTE
Dependendo do Tipo selecionado para o campo, controles de configuração adicionais podem aparecer no painel direito. Consulte a seção sobre propriedades do campo específico do tipo para obter mais informações sobre esses controles.
O painel direito também fornece caixas de seleção para designar tipos de campo especiais. Consulte a seção sobre tipos de campo especiais para obter mais informações.

Após concluir a configuração do campo, selecione Aplicar.

A variável Propriedades do campo seção do Editor de esquemas é realçada.

A tela é atualizada para mostrar o campo recém-adicionado, localizado em um objeto com namespace para sua ID de locatário exclusiva (exibido como _tenantId no exemplo abaixo). Todos os campos personalizados adicionados a um esquema são automaticamente colocados dentro desse namespace para evitar conflitos com outros campos de classes e grupos de campos fornecidos pelo Adobe. O painel direito agora lista o caminho do campo, além de suas outras propriedades.

Um novo campo no diagrama de esquema e seu caminho correspondente no Propriedades do campo é realçada.

Você pode continuar seguindo as etapas acima para adicionar mais campos ao esquema. Depois que o esquema for salvo, sua classe base e grupos de campos também serão salvos se alguma alteração tiver sido feita neles.

NOTE
Quaisquer alterações feitas aos grupos de campos ou à classe de um esquema serão refletidas em todos os outros esquemas que as empregam.

Propriedades de campo específico do tipo type-specific-properties

Ao definir um novo campo, opções adicionais de configuração podem aparecer no painel direito, dependendo da Tipo escolha para o campo. A tabela a seguir descreve essas propriedades de campo adicionais, juntamente com seus tipos compatíveis:

Propriedade do campo
Tipos compatíveis
Descrição
Mapear tipo de valor
Mapa
A variável Mapear tipo de valor A propriedade só será exibida na interface do usuário se você selecionar o valor Mapa na Tipo opções suspensas. Você pode selecionar entre os tipos de valor String e Integer para o Mapa.
O Editor de esquemas com os campos Type e Map value type realçados. {width="100" modal="regular"}
Observação: todos os tipos de dados de mapa criados por meio da API que não são do tipo String ou Integer são exibidos como um 'Complexotipo de dados '. Você não pode criar 'ComplexoTipos de dados do por meio da interface do.
Valor padrão
String, Duplo, Longo, Integer, Short, Byte, Booleano
Um valor padrão atribuído a esse campo se nenhum outro valor for fornecido durante a assimilação. Esse valor deve estar em conformidade com o tipo selecionado no campo.

Os valores padrão não são salvos no conjunto de dados no momento da assimilação, pois podem mudar com o tempo. Os valores padrão definidos no esquema são inferidos pelos serviços e aplicativos downstream da Platform quando leem os dados do conjunto de dados. Por exemplo, ao consultar os dados usando o Serviço de consulta, se o atributo tiver um valor NULL, mas o padrão for definido como 5 no nível do esquema, espera-se que o Serviço de consulta retorne 5 em vez de NULL. No momento, esse comportamento não é uniforme em todos os serviços da AEP.
Padrão
String
A expressão regular que o valor desse campo deve estar em conformidade para ser aceito durante a assimilação.
Formato
String

Selecione em uma lista de formatos predefinidos para cadeias de caracteres às quais o valor deve estar em conformidade. Os formatos disponíveis são:

Comprimento mínimo
String
O número mínimo de caracteres que a cadeia de caracteres deve conter para que o valor seja aceito durante a assimilação.
Comprimento máximo
String
O número máximo de caracteres que a cadeia de caracteres deve conter para que o valor seja aceito durante a assimilação.
Valor mínimo
Duplo
O valor mínimo para o Duplo a ser aceito durante a assimilação. Se o valor assimilado corresponder exatamente ao inserido aqui, o valor será aceito. Ao usar essa restrição, a variável "Valor mínimo exclusivoA restrição " deve ser deixada em branco.
Valor máximo
Duplo
O valor máximo para o Duplo a ser aceito durante a assimilação. Se o valor assimilado corresponder exatamente ao inserido aqui, o valor será aceito. Ao usar essa restrição, a variável "Valor máximo exclusivoA restrição " deve ser deixada em branco.
Valor mínimo exclusivo
Duplo
O valor máximo para o Duplo a ser aceito durante a assimilação. Se o valor assimilado corresponder exatamente ao inserido aqui, o valor será rejeitado. Ao usar essa restrição, a variável "Valor mínimoA restrição " (não exclusiva) deve ser deixada em branco.
Valor máximo exclusivo
Duplo
O valor máximo para o Duplo a ser aceito durante a assimilação. Se o valor assimilado corresponder exatamente ao inserido aqui, o valor será rejeitado. Ao usar essa restrição, a variável "Valor máximoA restrição " (não exclusiva) deve ser deixada em branco.

Tipos de campo especial special

O painel direito fornece várias caixas de seleção para designar funções especiais para o campo selecionado. Os casos de uso de algumas dessas opções envolvem considerações importantes sobre sua estratégia de modelagem de dados e como você pretende usar os serviços downstream da plataforma.

Para saber mais sobre esses tipos especiais, consulte a seguinte documentação:

Embora tecnicamente não seja um tipo de campo especial, também é recomendável que você visite o guia em definição de campos do tipo objeto para saber mais sobre como definir subcampos aninhados se suas estruturas de esquema.

Próximas etapas

Este guia forneceu uma visão geral sobre como definir campos XDM na interface do usuário. Lembre-se de que os campos só podem ser adicionados a esquemas por meio do uso de classes e grupos de campos. Para saber mais sobre como gerenciar esses recursos na interface do usuário, consulte os guias sobre criação e edição classes e grupos de campos.

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

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07