Explorar recursos de esquema na interface do

No Adobe Experience Platform, todos os recursos de esquema do Experience Data Model (XDM) são armazenados no Schema Library, incluindo os recursos padrão fornecidos pelo Adobe e os recursos personalizados definidos pela sua organização. Na interface do usuário do Experience Platform, você pode exibir a estrutura e os campos de qualquer esquema, classe, grupo de campos ou tipo de dados existente no Schema Library. Isso é especialmente útil ao planejar e se preparar para a assimilação de dados, pois a interface do usuário fornece informações sobre os tipos de dados e casos de uso esperados de cada campo fornecido por esses recursos XDM.

Este tutorial aborda as etapas para explorar esquemas, classes, grupos de campos e tipos de dados existentes na interface do Experience Platform.

Pesquisar um recurso de esquema lookup

Na interface do usuário do Experience Platform, selecione Schemas na navegação à esquerda. O espaço de trabalho Schemas fornece uma guia Browse para explorar todos os esquemas da organização, juntamente com guias dedicadas adicionais para explorar Classes, Field groups, Data types e Relationships respectivamente.

O ícone de filtro ( ) revela controles no painel esquerdo para restringir os resultados listados. Os filtros de recursos estão disponíveis para esquemas e relações nas guias Browse e Relationships, respectivamente. Na guia Field groups, use os filtros descritos em Filtragem e metadados do grupo de campos para restringir a lista por marcas de setor e classe compatíveis.

Na guia Browse do espaço de trabalho Schemas, você pode filtrar o inventário de esquemas. Use a opção Included in Profile para mostrar apenas esquemas que foram habilitados para uso no Perfil de Cliente em Tempo Real. Use o botão Show adhoc schemas para filtrar a lista de esquemas criados com campos com namespace para uso somente por um único conjunto de dados.

Na guia Relationship do espaço de trabalho Schemas, você pode filtrar a lista de relações com base em quatro critérios. Os filtros incluem Source schema, Destination schema, Source class e Destination class. A tabela abaixo fornece uma descrição dos filtros.

Você também pode usar a barra de pesquisa para restringir ainda mais os resultados.

Os recursos exibidos nos resultados da pesquisa são ordenados primeiro por correspondências de título e, em seguida, por correspondências de descrição. Por sua vez, quanto mais palavras corresponderem em uma dessas categorias, maior será o recurso exibido na lista.

Depois de encontrar o recurso que deseja explorar, selecione o nome dele na lista para exibir sua estrutura na tela.

Gerenciar esquemas, classes, grupos de campos e tipos de dados: ações e exclusão xdm-resource-actions

Use esta seção quando precisar gerenciar ou excluir recursos XDM, ou quando uma ação (como excluir) não estiver disponível e você precisar entender o porquê.

Onde encontrar ações (página em linha versus detalhada) where-to-find-actions

Para executar ações como excluir, exportar ou copiar um recurso, use um dos seguintes pontos de entrada:

Nas guias Browse, Classes, Field groups e Data types, as ações de gerenciamento estão disponíveis em dois locais:

Essas ações são consistentes em ambos os pontos de entrada para tipos de recursos compatíveis (esquemas, classes, grupos de campos e tipos de dados).

Ações disponíveis available-actions

Dependendo do tipo de recurso e suas permissões, as seguintes ações podem estar disponíveis:

O seguinte se aplica a diferentes tipos de recursos:

Excluir comportamento delete-behavior

Use a ação Delete quando quiser remover um recurso personalizado que não é mais necessário.

Para excluir um recurso:

O recurso é removido permanentemente da organização após a confirmação.

Se a exclusão não estiver disponível para um recurso, a opção aparecerá desativada com uma dica de ferramenta explicando por que a ação não pode ser executada.

Restrições (conjunto de dados, perfil, RBAC, locatário versus global) delete-constraints

Se uma ação como Delete estiver indisponível ou desabilitada, isso geralmente ocorre devido a uma das seguintes condições:

Essas restrições são refletidas diretamente na interface do usuário do. Quando uma ação não está disponível, ela aparece desativada e inclui uma dica de ferramenta explicando a limitação específica.

Se não for possível excluir um recurso, revise as condições acima para determinar se é necessário atualizar permissões, remover dependências ou ajustar o modelo de dados.

Para obter fluxos de trabalho adicionais de edição de esquemas na tela, consulte Criar e editar esquemas na interface.

Explorar um recurso XDM na tela explore

Depois de selecionar um recurso, sua estrutura é aberta na tela.

Todos os campos do tipo de objeto que contêm subpropriedades são recolhidos por padrão quando aparecem pela primeira vez na tela. Para mostrar as subpropriedades de qualquer campo, selecione o ícone ao lado do nome.

Indicador padrão de classe e grupo de campos standard-class-and-field-group-indicator

No Editor de esquemas, classes e grupos de campos padrão (gerados por Adobe) são indicados com o ícone de cadeado ( . O cadeado é exibido no painel à esquerda, ao lado do nome da classe ou do grupo de campos, e também ao lado de qualquer campo no diagrama de esquema que faça parte de um recurso gerado pelo sistema.

Consulte a documentação Adicionar campos personalizados a grupos de campos padrão para obter orientação. Não é possível editar uma classe padrão.

Campos gerados pelo sistema system-fields

Alguns nomes de campos recebem um sublinhado como prefixo, por exemplo, _repo e _id. Eles representam espaços reservados para campos que o sistema gerará e atribuirá automaticamente à medida que os dados forem assimilados.

Dessa forma, a maioria desses campos deve ser excluída da estrutura dos dados ao assimilar na Experience Platform. A principal exceção para essa regra é o campo _{TENANT_ID} ​, no qual todos os campos XDM criados em sua organização devem ter o namespace.

Tipos de dados data-types

Para cada campo mostrado na tela, seu tipo de dados correspondente é mostrado ao lado do nome, indicando rapidamente o tipo de dados que o campo espera para assimilação.

Qualquer tipo de dados com colchetes ([]) anexados representa uma matriz desse tipo de dados específico. Por exemplo, um tipo de dados de String[] indica que o campo espera uma matriz de valores de cadeia de caracteres. Um tipo de dados de Payment Item[] indica uma matriz de objetos que estão em conformidade com o tipo de dados Payment Item.

Se um campo de matriz é baseado em um tipo de objeto, você pode selecionar seu ícone na tela para mostrar os atributos esperados para cada item de matriz.

Field properties field-properties

Quando você seleciona o nome de qualquer campo na tela, o painel direito é atualizado para mostrar detalhes sobre esse campo em Field properties. Isso pode incluir uma descrição do caso de uso pretendido do campo, valores padrão, padrões, formatos, se o campo é obrigatório e muito mais. Quando você estiver explorando um grupo de campos, os detalhes relacionados ao rótulo do campo selecionado também podem aparecer aqui; consulte Rótulos na exibição de estrutura.

Se o campo que você está inspecionando for um campo de enumeração, o painel direito também exibirá os valores aceitáveis que o campo espera receber.

Campos de identidade identity

Ao inspecionar esquemas que contêm campos de identidade, esses campos são listados no painel à esquerda na classe ou no grupo de campos que os fornece ao esquema. Selecione o nome do campo de identidade no painel à esquerda para revelar o campo na tela, independentemente da profundidade em que ele está aninhado.

Os campos de identidade são realçados na tela com um ícone de impressão digital ( ). Se você selecionar o nome do campo de identidade, poderá exibir informações adicionais, como o namespace de identidade e se o campo é ou não a identidade principal do esquema.

Campos de relacionamento relationship

Se você estiver inspecionando um esquema que contém um campo de relação, o campo será listado no painel esquerdo em Relationships. Selecione o nome do campo de relacionamento no painel à esquerda para revelar o campo na tela, independentemente da profundidade em que ele está aninhado. Os campos de relacionamento também são destacados exclusivamente na tela, mostrando o nome do esquema de referência ao qual o campo é vinculado. Para organizações com recursos B2B, os nomes de relacionamentos personalizados podem ser escritos e serão exibidos na tela nesses casos.

Para exibir o namespace de identidade da identidade primária do esquema de referência, selecione o campo de relação e, em seguida, Edit relationship na barra lateral Field properties. Os parâmetros da relação são exibidos na caixa de diálogo Edit relationship exibida.

Consulte o tutorial sobre criação de uma relação na interface para obter mais informações sobre o uso de relações em esquemas XDM.

Explorar grupos de campos: uso e metadados explore-field-groups

Navegue até Schemas > Field groups para explorar grupos de campos. Na guia Field groups, recursos adicionais ajudam você a entender onde um grupo de campos é usado em esquemas e o que ele inclui, como compatibilidade, campos obrigatórios (que impõem requisitos de assimilação) e sinais de governança.

Esses recursos ajudam você a avaliar o impacto antes de fazer alterações e identificar grupos de campos relevantes com mais eficiência durante o design do esquema.

Exibir uso de esquema para grupos de campos view-schema-usage-for-field-groups

Na tabela Field groups, selecione um grupo de campos para abrir sua exibição detalhada. A tela é atualizada para exibir a estrutura do grupo de campos, e o painel de propriedades mostra informações adicionais sobre o recurso selecionado.

Esquemas que usam este grupo de campos

No painel de propriedades à direita, a seção Schemas using this field group lista esquemas que atualmente incluem o grupo de campos.

Selecione um nome de esquema para abrir sua visualização de detalhes em uma nova guia e inspecione como o grupo de campos é implementado dentro desse esquema.

Exibir mais e lista completa de esquemas

Se houver mais esquemas do que podem ser exibidos em linha, selecione View more para abrir a caixa de diálogo completa.

A caixa de diálogo Schemas using this field group é exibida, mostrando a lista completa de esquemas que usam o grupo de campos.

Na caixa de diálogo Schemas using this field group, é possível:

Você pode exibir detalhes do esquema, como nome do esquema, classe e outros atributos.

Este fluxo de trabalho destina-se somente a análise e exploração de impacto. Ela não modifica esquemas ou grupos de campos. Para alterar a estrutura do esquema, consulte Criar e editar esquemas na interface.

Metadados e filtragem do grupo de campos field-group-metadata-and-filtering

A guia Field groups fornece ferramentas de filtragem e metadados para ajudar você a localizar e avaliar grupos de campos antes de selecioná-los.

Procurar tabela e filtros

A tabela de inventário do grupo de campos inclui colunas adicionais que expõem metadados diretamente na exibição de lista, como Compatible classes, que indica a quais classes um grupo de campos pode ser aplicado. Os grupos de campos só podem ser adicionados a esquemas que usam uma das classes compatíveis listadas, com base no comportamento dos dados que representam (por exemplo, dados com base em registros ou de séries temporais). A tabela pode exibir All quando o grupo de campos for compatível com todas as classes. Industry tags ajuda a categorizar grupos de campos para descoberta.

Para refinar a lista, selecione o ícone de filtro ( ) para abrir o painel de filtro no painel esquerdo. A imagem a seguir mostra o painel de filtro aberto no painel esquerdo.

No painel de filtros, é possível:

Durante a navegação, selecione uma linha na tabela para atualizar o painel de informações. O painel de informações exibe metadados como classes compatíveis e tags do setor, para que você possa revisar os principais detalhes sem abrir o grupo de campos.

Metadados de detalhes do grupo de campos

Ao abrir um grupo de campos, o painel de propriedades exibe metadados adicionais associados ao recurso.

O painel de propriedades pode exibir os seguintes metadados:

Essas informações ajudam a entender as restrições e os requisitos antes de usar ou modificar o grupo de campos.

Rótulos na visualização de estrutura

Quando um grupo de campos é aberto na tela, é possível exibir as informações do rótulo diretamente na estrutura. Selecione o ícone de configurações ( ) na barra de ferramentas da tela de desenho e habilitar Show labels on tree para exibir indicadores de rótulo em campos da tela de desenho.

Selecione um campo na tela para exibir os detalhes do rótulo no painel Field properties, incluindo rótulos aplicados a esse campo.

Os rótulos são agrupados por categoria (por exemplo, rótulos de identidade e confidenciais) e fornecem visibilidade sobre a governança ou as restrições relacionadas ao acesso aplicadas aos dados.

Esses indicadores são somente para visibilidade e não alteram a estrutura do schema. Para obter mais informações, consulte Gerenciar rótulos de uso de dados para um esquema.

Próximas etapas

Este documento abordou como explorar os recursos XDM existentes na interface do usuário do Experience Platform. Para obter mais informações sobre os diferentes recursos do espaço de trabalho Schemas e Schema Editor, consulte a Schemas visão geral do espaço de trabalho.