Como modelar seu conteúdo

Nesta parte da jornada do desenvolvedor do AEM Headless, você pode aprender a modelar sua estrutura de conteúdo. Em seguida, estabeleça essa estrutura no Adobe Experience Manager (AEM) usando modelos de fragmentos de conteúdo e fragmentos de conteúdo, para a reutilização em outros canais.

A história até agora

No início, a seção Saiba mais sobre o desenvolvimento do CMS Headless abordou a entrega de conteúdo headless e por que ela deve ser usada. Em seguida, a Introdução ao AEM Headless descreveu o AEM Headless no contexto de seu próprio projeto.

No documento anterior da jornada do AEM Headless, Caminho para a sua primeira experiência utilizando o AEM Headless, você aprendeu as etapas necessárias para implementar seu primeiro projeto. Após ler esse documento, você deve:

• Entender considerações importantes de planejamento para criar seu conteúdo
• Entender as etapas para implementar o método headless dependendo dos requisitos do seu nível de integração.
• Organizar as ferramentas e configurações necessárias do AEM.
• Conhecer as práticas recomendadas para simplificar a sua jornada headless, manter a eficiência na geração de conteúdo e garantir que o conteúdo seja entregue rapidamente.

Este artigo se baseia nesses fundamentos para que você entenda como preparar seu próprio projeto do AEM Headless.

Objetivo

• Público-alvo: iniciante
• Objetivo: aprender a modelar sua estrutura de conteúdo e estabelecer essa estrutura usando modelos de fragmentos de conteúdo e fragmentos de conteúdo do AEM:
  • Conheça conceitos e terminologias relacionados à modelagem de dados/conteúdo.
  • Saiba por que a modelagem de conteúdo é necessária para a entrega de conteúdo headless.
  • Saiba como estabelecer essa estrutura utilizando modelos de fragmentos de conteúdo do AEM (e criar conteúdo com fragmentos de conteúdo).
  • Saiba como modelar seu conteúdo através de princípios com amostras básicas.

Modelagem de conteúdo

O mundo é grande e complexo.

Talvez sim, talvez não. O fato é que há um mundo grande e complicado de informações, e a modelagem de dados é usada para definir uma representação simplificada de uma parcela muito pequena disso, usando apenas as informações específicas que são necessárias para um determinado propósito.

Por exemplo:

Existem muitas escolas, mas todas têm muitas coisas em comum:

• Um local
• Um diretor
• Muitos professores
• Muitos membros não docentes
• Muitos alunos
• Muitos ex-professores
• Muitos ex-alunos
• Muitas salas de aula
• Uma grande quantidade de livros
• Uma grande quantidade de equipamentos
• Muitas atividades extracurriculares
• e assim por diante…

Mesmo num exemplo tão pequeno, a lista pode parecer interminável. Mas se você quiser apenas que seu aplicativo execute uma tarefa simples, precisará limitar as informações ao essencial.

Por exemplo, para realizar a publicidade de eventos especiais para todas as escolas da área, as seguintes informações são necessárias:

• Nome da escola
• Local da escola
• Diretor
• Tipo de evento
• Data do evento
• Professor organizador do evento

Conceitos

O que você deseja descrever é chamado de Entidades, basicamente as “coisas” sobre as quais queremos armazenar informações.

As informações que queremos armazenar sobre elas são os Atributos (propriedades), como Nome e Qualificações para os professores.

Há várias Relações entre as entidades. Por exemplo, geralmente uma escola tem apenas um diretor e muitos professores (e geralmente o diretor também é professor).

O processo de análise e definição dessas informações, junto com as relações entre elas, é chamado de Modelagem de conteúdo.

Básico

Frequentemente, é necessário começar elaborando um Esquema conceitual que descreve as entidades e suas relações. Geralmente, é um esquema de alto nível (conceitual).

Depois que isso estiver estável, você pode traduzir os modelos em um Esquema lógico que descreve as entidades, juntamente com os atributos, e as relações. Nesse nível, você deve examinar as definições cuidadosamente para eliminar a duplicação e otimizar o design.

Por exemplo, você precisa de entidades separadas para Head Teacher e Teacher ou simplesmente um atributo adicional no modelo Teacher?

Garantia da integridade de dados

A integridade de dados é necessária para garantir a precisão e a consistência do conteúdo em todo o ciclo de vida. Isso inclui garantir que os autores de conteúdo possam entender facilmente o que armazenar, para que os itens a seguir sejam fundamentais:

• uma estrutura clara
• uma estrutura o mais concisa possível (sem sacrificar a precisão)
• validação de campos individuais
• quando apropriado, restringir o conteúdo de campos específicos ao que é relevante

Eliminação da redundância de dados

A redundância de dados ocorre quando as mesmas informações são armazenadas duas vezes na estrutura de conteúdo. Isso deve ser evitado, pois pode gerar confusão na criação do conteúdo e erros na consulta; sem falar no mau uso do espaço de armazenamento.

Otimização e desempenho

Ao otimizar sua estrutura, você pode melhorar o desempenho, tanto para criação de conteúdo quanto para consultas.

Tudo é um ato de equilíbrio, mas a criação de uma estrutura muito complexa ou com muitos níveis, pode:

• Ser confusa para os autores que geram o conteúdo.

• Afetar bastante o desempenho se a consulta tiver que acessar vários Fragmentos de conteúdo aninhados (referenciados) para recuperar o conteúdo necessário.

Modelagem de conteúdo para AEM headless

A Modelagem de dados é um conjunto de técnicas estabelecidas, frequentemente usadas ao desenvolver bancos de dados de relacionamento. Então o que a Modelagem de conteúdo significa para o AEM Headless?

Por quê?

Para garantir que seu aplicativo possa solicitar e receber o conteúdo necessário do AEM de forma consistente e eficiente, esse conteúdo deve ser estruturado.

Isso significa que o aplicativo sabe antecipadamente a forma de resposta e, portanto, como processá-la. Isso é muito mais fácil do que receber conteúdo de forma livre, que deve ser analisado para determinar o que ele contém e, portanto, como pode ser usado.

Introdução a como?

O AEM usa Fragmentos de conteúdo para fornecer as estruturas necessárias para a entrega headless do conteúdo aos seus aplicativos.

A estrutura do modelo de conteúdo é:

• realizada pela definição do Modelo de fragmento de conteúdo,
• usada como base dos Fragmentos de conteúdo usados para a geração de conteúdo.

As solicitações de conteúdo são feitas usando a API GraphQL do AEM, uma implementação personalizada da API GraphQL padrão. A API GraphQL do AEM permite realizar consultas (complexas) nos Fragmentos de conteúdo; cada uma dessas consultas está de acordo com um tipo de modelo específico.

O conteúdo retornado pode ser usado pelos seus aplicativos.

Criar a estrutura com Modelos de fragmento de conteúdo

Os Modelos de fragmentos de conteúdo fornecem vários mecanismos que permitem definir a estrutura do conteúdo.

Um Modelo de fragmento de conteúdo descreve uma entidade.

Dentro de um modelo:

1. Tipos de dados permitem definir os atributos individuais.
   Por exemplo, defina o campo com o nome de um professor como Texto e seus anos de serviço como Número.
2. Os tipos de dados Referência de conteúdo e Referência de fragmento permitem criar relações com outro conteúdo no AEM.
3. O tipo de dados Referência de fragmento permite que você atinja vários níveis de estrutura aninhando seus Fragmentos de conteúdo (de acordo com o tipo de modelo). Isso é essencial para a modelagem de conteúdo.

Por exemplo:

Tipos de dados

O AEM fornece os seguintes tipos de dados para você modelar o conteúdo:

• Texto em linha única
• Texto multilinha
• Número
• Booleano
• Data e hora
• Lista discriminada
• Tags
• Referência de conteúdo
• Referência de fragmento
• Objeto JSON

Referências e conteúdo aninhado

Dois tipos de dados fornecem referências ao conteúdo fora de um fragmento específico:

• Referência de conteúdo
  Isso fornece uma referência simples a outro conteúdo de qualquer tipo.
  Por exemplo, você pode fazer referência a uma imagem em um local especifico.

• Referência de fragmento
  Isso fornece referências a outros Fragmentos de conteúdo.
  Esse tipo de referência é usado para criar conteúdo aninhado, introduzindo as relações necessárias para modelar o conteúdo.
  O tipo de dados pode ser configurado para permitir que os autores de fragmento:

  • Editem o fragmento referenciado diretamente.
  • Criem um novo fragmento de conteúdo, com base no modelo apropriado

Criar Modelos de fragmentos do conteúdo

No início, é necessário ativar os Modelos de fragmento de conteúdo para o site. Isso é feito no Navegador de configuração; em Ferramentas -> Geral -> Navegador de configuração. Você pode optar por configurar a entrada global ou criar uma nova configuração. Por exemplo:

Em seguida, os Modelos de fragmentos de conteúdo podem ser criados e a estrutura definida. Isso pode ser feito em Ferramentas -> Ativos -> Modelos de fragmento de conteúdo. Por exemplo:

Uso do modelo para criar conteúdo com Fragmentos de conteúdo

Fragmentos de conteúdo são sempre baseados em um Modelo de fragmento de conteúdo. O modelo fornece a estrutura, o fragmento retém o conteúdo.

Seleção do modelo apropriado

A primeira etapa para realmente criar o conteúdo é criar um Fragmento de conteúdo. Isso é feito usando Criar -> Fragmento de conteúdo, na pasta requerida em Ativos -> Arquivos. O assistente o orienta pelas etapas.

Um Fragmento de conteúdo é baseado em um Modelo de fragmento de conteúdo específico, que pode ser selecionado como a primeira etapa do processo de criação.

Criação e edição de conteúdo estruturado

Após a criação do fragmento, é possível abri-lo no Editor de fragmento de conteúdo. Aqui você pode:

• Editar o conteúdo no modo normal ou em tela cheia.
• Formatar o conteúdo como texto completo, texto sem formatação ou markdown.
• Criar e gerenciar variações de seu conteúdo.
• Associar conteúdo.
• Editar os metadados.
• Mostrar a estrutura da árvore.
• Visualizar a representação JSON.

Criação de fragmentos de conteúdo

Após selecionar o modelo apropriado, um fragmento de conteúdo é aberto para edição no editor de fragmento de conteúdo:

Introdução a alguns exemplos

Para ver uma estrutura básica de amostra, consulte Amostra da estrutura do fragmento de conteúdo.

O que vem a seguir

Agora que você aprendeu a modelar a estrutura e criar um conteúdo que é dependente dela, a próxima etapa é Aprender a usar consultas GraphQL para acessar e recuperar conteúdo dos fragmentos de conteúdo. Essa seção introduz e analisa o GraphQL e, em seguida, apresenta algumas consultas de amostra para mostrar como as coisas funcionam na prática.

Recursos adicionais

• Trabalhar com fragmentos de conteúdo - a página introdutória para fragmentos de conteúdo
  • Fragmentos de conteúdo no navegador de configuração - ativar a funcionalidade de fragmento de conteúdo no navegador de configuração
  • Modelos de fragmentos de conteúdo - criação e edição dos modelos de fragmentos de conteúdo
  • Gerenciamento de fragmentos de conteúdo - geração e criação de fragmentos de conteúdo; esta página leva a outras seções detalhadas
• Esquemas GraphQL do AEM - como o GraphQL trabalha com modelos
• Amostra da estrutura do fragmento de conteúdo
• Introdução ao AEM Headless - Uma breve série de tutoriais em vídeo que fornece uma visão geral do uso de recursos do AEM Headless, incluindo a modelagem de conteúdo e o GraphQL
  • Noções básicas sobre a modelagem do GraphQL - Saiba como definir e usar fragmentos de conteúdo no Adobe Experience Manager (AEM) para usar com o GraphQL.

Recursos do Business.Adobe.com