Definir campos XDM na interface do
O Schema Editor na interface do usuário do Adobe Experience Platform permite definir seus próprios campos nas classes personalizadas do Experience Data Model (XDM) e nos grupos de campos de 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 à função do XDM no ecossistema de Experience Platform e as noções básicas da composição de 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 que você também siga o tutorial sobre 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, primeiro abra um esquema no Schema Editor. Dependendo dos esquemas que 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 o Schema Editor estiver aberto, os controles para adicionar campos aparecerão 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.
Para adicionar um novo campo ao recurso, selecione o ícone de adição (+) ao lado do nome do esquema na tela ou ao lado do campo do tipo de objeto no qual você deseja definir o campo.
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 ícone de adição (+), um espaço reservado para Campo sem título aparece na tela.
No painel direito, em Propriedades do campo, você pode configurar os detalhes do novo campo. As seguintes informações são necessárias para cada campo:
Um nome descritivo exclusivo para o campo. Observe que o nome do campo não pode ser alterado depois que o esquema é salvo. Este 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. Ela pode conter caracteres alfanuméricos, traços ou sublinhados, mas não pode começar com um sublinhado.
- Correto:
fieldName - Aceitável:
field_name2,Field-Name,field-name_3 - Incorreto:
_fieldName
Observação: se você selecionar o tipo de dados do mapa, a propriedade Tipo de valor do mapa será exibida.
Você também pode selecionar Pesquisa avançada de tipos para pesquisar e filtrar tipos de dados existentes e localizar o tipo desejado com mais facilidade.
Para saber mais sobre propriedades de campo específicas de tipo, consulte a visão geral de definição de campos.
Você também pode optar por fornecer uma descrição e notas para cada campo. Use o campo Descrição 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. |
Após concluir a configuração do campo, selecione Aplicar.
A tela é atualizada para mostrar o campo recém-adicionado, localizado em um objeto com namespace para sua ID de locatário exclusiva (mostrado 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.
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.
Propriedades de campo específico do tipo type-specific-properties
Ao definir um novo campo, opções de configuração adicionais podem aparecer no painel direito, dependendo do Tipo escolhido para o campo. A tabela a seguir descreve essas propriedades de campo adicionais, juntamente com seus tipos compatíveis:
Observação: todos os tipos de dados de mapa criados por meio da API que não são do tipo Cadeia de Caracteres ou Integer são exibidos como um tipo de dados 'Complexo'. Você não pode criar tipos de dados 'Complexos' por meio da interface do usuário.
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 estiver 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.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:
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:
- Mapa
- Obrigatório
- Matriz 1}
- Enumeração
- Identidade (Disponível somente para campos de cadeia de caracteres)
- Relacionamento (Disponível somente para campos de sequência de caracteres)
Embora tecnicamente não seja um tipo de campo especial, também é recomendável que você visite o guia em definindo campos de tipo de 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, consulte os guias sobre criação e edição de classes e grupos de campos.
Para obter mais informações sobre os recursos do espaço de trabalho Esquemas, consulte a visão geral do espaço de trabalho de .