Personalização e extensão de fragmentos de conteúdo

Um fragmento de conteúdo estende um ativo padrão; consulte:

• Criação e gerenciamento de fragmentos de conteúdo e Criação de página com fragmentos de conteúdo para obter mais informações sobre fragmentos de conteúdo.

• Gerenciamento de ativos e Personalização e extensão de ativos para obter mais informações sobre ativos padrão.

Arquitetura

A base partes componentes de um fragmento de conteúdo são:

• A Fragmento de conteúdo,
• constituído por um ou mais Elemento do conteúdo s,
• e que podem ter um ou mais Variação de conteúdo s

Dependendo do tipo de fragmento, modelos ou modelos também são usados:

• Modelos de fragmentos do conteúdo:

  • Usado para definir fragmentos de conteúdo que contêm conteúdo estruturado.
  • Os modelos de fragmento de conteúdo definem a estrutura de um fragmento de conteúdo quando ele é criado.
  • Um fragmento faz referência ao modelo; portanto, as alterações no modelo podem/afetarão qualquer fragmento dependente.
  • Os modelos são compostos de tipos de dados.
  • As funções para adicionar novas variações etc. precisam atualizar o fragmento de acordo.
  ATENÇÃO

  Qualquer alteração em um modelo de fragmento de conteúdo existente pode afetar fragmentos dependentes; isso pode levar a propriedades órfãs nesses fragmentos.

• Modelos de fragmentos do conteúdo:

  • Usado para definir fragmentos de conteúdo simples.
  • Os modelos definem a estrutura (básica, somente texto) de um fragmento de conteúdo quando ele é criado.
  • O modelo é copiado para o fragmento quando é criado; portanto, outras alterações no modelo não serão refletidas nos fragmentos existentes.
  • As funções para adicionar novas variações etc. precisam atualizar o fragmento de acordo.
  • Modelos de fragmento de conteúdo operar de maneira diferente da de outros mecanismos de modelos dentro do ecossistema AEM (por exemplo, modelos de página, etc.). Por conseguinte, devem ser consideradas separadamente.
  • Quando baseado em um modelo, o tipo MIME do conteúdo é gerenciado no conteúdo real; isso significa que cada elemento e variação pode ter um tipo MIME diferente.

Integração com o Assets

O Gerenciamento de fragmentos de conteúdo (CFM) faz parte do AEM Assets como:

• Fragmentos de conteúdo são ativos.
• Eles usam a funcionalidade existente do Assets.
• Eles são totalmente integrados ao Assets (consoles de administração etc.).

Mapeamento de fragmentos de conteúdo estruturado para ativos

Fragmentos de conteúdo com conteúdo estruturado (ou seja, com base em um modelo de fragmento de conteúdo) são mapeados para um único ativo:

• Todo o conteúdo é armazenado no jcr:content/data nó do ativo:

  • Os dados do elemento são armazenados no subnó principal:

    jcr:content/data/master

  • As variações são armazenadas em um subnó que carrega o nome da variação: por exemplo, jcr:content/data/myvariation

  • Os dados de cada elemento são armazenados no respectivo subnó como uma propriedade com o nome do elemento: por exemplo, o conteúdo do elemento text é armazenado como propriedade text em jcr:content/data/master

• Os metadados e o conteúdo associado são armazenados abaixo jcr:content/metadata
  Exceto o título e a descrição, que não são considerados metadados tradicionais e armazenados em
  jcr:content

Mapeamento de fragmentos de conteúdo simples para ativos

Fragmentos de conteúdo simples (com base em um modelo) são mapeados para um composto que consiste em um ativo principal e (opcional) subativos:

• Todas as informações não relacionadas ao conteúdo de um fragmento (como título, descrição, metadados, estrutura) são gerenciadas exclusivamente no ativo principal.

• O conteúdo do primeiro elemento de um fragmento é mapeado para a representação original do ativo principal.

  • As variações (se houver alguma) do primeiro elemento são mapeadas para outras representações do ativo principal.

• Os elementos adicionais (se existirem) são mapeados para os subativos do ativo principal.

  • O conteúdo principal desses elementos adicionais é mapeado para a representação original do respectivo subativo.
  • Outras variações (se aplicável) de quaisquer elementos adicionais são mapeadas para outras representações do respectivo subativo.

Localização do ativo

Assim como com os ativos padrão, um fragmento de conteúdo é mantido em:

/content/dam

Permissões de ativos

Para obter mais detalhes, consulte Fragmento do conteúdo - excluir considerações.

Integração de recursos

• O recurso de Gerenciamento de fragmento de conteúdo (CFM) se baseia no núcleo de ativos, mas deve ser o mais independente possível dele.
• O CFM fornece suas próprias implementações para itens nas exibições de cartão/coluna/lista; elas se conectam às implementações de renderização de conteúdo existentes do Assets.
• Vários componentes do Assets foram estendidos para atender a fragmentos de conteúdo.

Uso de fragmentos de conteúdo em páginas

Os fragmentos de conteúdo podem ser referenciados a partir de páginas AEM, como qualquer outro tipo de ativo. O AEM fornece a Fragmento do conteúdo componente principal - a componente que permite incluir fragmentos de conteúdo nas páginas. Você também pode estender, isso Fragmento do conteúdo componente principal.

• O componente usa o fragmentPath para fazer referência ao fragmento de conteúdo real. A variável fragmentPath A propriedade é tratada da mesma forma que as propriedades semelhantes de outros tipos de ativos; por exemplo, quando o fragmento de conteúdo é movido para outro local.

• O componente permite selecionar a variação a ser exibida.

• Além disso, um intervalo de parágrafos pode ser selecionado para restringir a saída; por exemplo, isso pode ser usado para saída de várias colunas.

• O componente permite conteúdo intermediário:

  • Aqui, o componente permite colocar outros ativos (imagens etc.) entre os parágrafos do fragmento referenciado.

  • Para conteúdo intermediário, é necessário:

    • esteja ciente da possibilidade de referências instáveis; o conteúdo intermediário (adicionado ao criar uma página) não tem relação fixa com o parágrafo ao lado do qual está posicionado, inserindo um novo parágrafo (no editor de fragmento de conteúdo) antes que a posição do conteúdo intermediário possa perder a posição relativa
    • considere os parâmetros adicionais (como variação e filtros de parágrafo) para evitar falsos positivos nos resultados da pesquisa

Configuração usando o console OSGi

A implementação de back-end de fragmentos de conteúdo é responsável, por exemplo, por tornar as instâncias de um fragmento usadas em uma página pesquisável ou por gerenciar conteúdo de mídia mista. Esta implementação precisa saber quais componentes são usados para renderizar fragmentos e como a renderização é parametrizada.

Os parâmetros para isso podem ser configurados na variável Console da Web, para o pacote OSGi Configuração do componente de fragmento de conteúdo.

• Tipos de recursos
  Uma lista de
  sling:resourceTypes O pode ser fornecido para definir componentes usados para renderizar fragmentos de conteúdo e onde o processamento em segundo plano deve ser aplicado.

• Propriedades de referência
  Uma lista de propriedades pode ser configurada para especificar onde a referência ao fragmento é armazenada para o respectivo componente.

Ainda há algumas diretrizes que você deve seguir para garantir que seu componente seja compatível com o processamento em segundo plano do fragmento de conteúdo:

• O nome da propriedade onde os elementos a serem renderizados são definidos deve ser element ou elementNames.

• O nome da propriedade onde a variação a ser renderizada é definida deve ser variation ou variationName.

• Se a saída de vários elementos for suportada (usando elementNames para especificar vários elementos), o modo de exibição real é definido pela propriedade displayMode:

  • Se o valor for singleText (e há apenas um elemento configurado), então o elemento é renderizado como um texto com conteúdo intermediário, suporte de layout etc. Esse é o padrão para fragmentos em que apenas um único elemento é renderizado.
  • Caso contrário, uma abordagem muito mais simples será usada (pode ser chamada de "exibição de formulário"), em que nenhum conteúdo intermediário é compatível e o conteúdo do fragmento é renderizado "como está".

• Se o fragmento for renderizado para displayMode == singleText (implícita ou explicitamente) as seguintes propriedades adicionais entram em ação:

  • paragraphScope define se todos os parágrafos ou somente um intervalo de parágrafos devem ser renderizados (valores: all vs. range)

  • se paragraphScope == range em seguida, a propriedade paragraphRange define o intervalo de parágrafos a ser renderizado

Integração com outras estruturas

Os fragmentos de conteúdo podem ser integrados a:

• Traduções

  Os fragmentos de conteúdo são totalmente integrados ao Fluxo de trabalho de tradução do AEM. Em um nível arquitetônico, isso significa:

  • As traduções individuais de um fragmento de conteúdo são fragmentos separados; por exemplo:

    • eles estão localizados em raízes de idioma diferentes:

      /content/dam/<path>/en/<to>/<fragment>

      vs.

      /content/dam/<path>/de/<to>/<fragment>

    • mas compartilham exatamente o mesmo caminho relativo abaixo da raiz de idioma:

      /content/dam/<path>/en/<to>/<fragment>

      vs.

      /content/dam/<path>/de/<to>/<fragment>

  • Além dos caminhos com base em regras, não há mais conexão entre as diferentes versões de idioma de um fragmento de conteúdo; elas são tratadas como dois fragmentos separados, embora a interface forneça os meios para navegar entre as variantes de idioma.

  OBSERVAÇÃO

  O fluxo de trabalho de tradução do AEM funciona com /content:

  • Como os modelos de fragmento de conteúdo residem no /conf, elas não estão incluídas em tais traduções. Você pode internacionalizar as strings da interface do usuário.

  • Os modelos são copiados para criar o fragmento de forma que isso esteja implícito.

• Esquemas de metadados

  • Fragmentos de conteúdo (re)usam o esquemas de metadados, que pode ser definido com ativos padrão.

  • O CFM fornece seu próprio esquema específico:

    /libs/dam/content/schemaeditors/forms/contentfragment

    isso pode ser estendido, se necessário.

  • O respectivo formulário de esquema é integrado ao editor de fragmentos.

A API de gerenciamento de fragmentos de conteúdo — lado do servidor

Você pode usar a API do lado do servidor para acessar os fragmentos de conteúdo; consulte:

com.adobe.cq.dam.cfm

Interfaces principais

As três interfaces a seguir podem servir como pontos de entrada:

• Modelo de fragmento (ModeloFragmento)

  Uso FragmentTemplate.createFragment() para criar um novo fragmento.

  Resource templateOrModelRsc = resourceResolver.getResource("...");
  FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
  ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
  

  Essa interface representa:

  • um modelo de fragmento de conteúdo ou um modelo de fragmento de conteúdo a partir do qual criar um fragmento de conteúdo,
  • e (após a criação) a informação estrutural desse fragmento

  Essas informações podem incluir:

  • Acessar dados básicos (título, descrição)

  • Acesse modelos/modelos para os elementos do fragmento:

    • Listar modelos de elementos
    • Obter informações estruturais de um determinado elemento
    • Acesse o modelo de elemento (consulte ElementTemplate)

  • Acesse modelos para as variações do fragmento:

    • Listar modelos de variação
    • Obter informações estruturais para uma determinada variação
    • Acesse o modelo de variação (consulte VariationTemplate)

  • Obter conteúdo associado inicial

  Interfaces que representam informações importantes:

  • ElementTemplate

    • Obter dados básicos (nome, título)
    • Obter conteúdo do elemento inicial

  • VariationTemplate

    • Obter dados básicos (nome, título, descrição)

• Fragmento do conteúdo (FragmentoConteúdo)

  Essa interface permite trabalhar com um fragmento de conteúdo de forma abstrata.

  ATENÇÃO

  É altamente recomendável acessar um fragmento por meio dessa interface. Deve ser evitada a alteração direta da estrutura do conteúdo.

  A interface fornece os meios para:

  • Gerenciar dados básicos (por exemplo, obter nome; obter/definir título/descrição)

  • Acessar metadados

  • Acessar elementos:

    • Listar elementos

    • Obter elementos por nome

    • Criar novos elementos (consulte Avisos)

    • Acessar dados do elemento (consulte ContentElement)

  • Variações de lista definidas para o fragmento

  • Criar novas variações globalmente

  • Gerenciar conteúdo associado:

    • Listar coleções
    • Adicionar coleções
    • Remover coleções

  • Acessar o modelo ou modelo do fragmento

  As interfaces que representam os elementos principais de um fragmento são:

  • Elemento do conteúdo (ElementoConteúdo)

    • Obter dados básicos (nome, título, descrição)

    • Obter/definir conteúdo

    • Acessar variações de um elemento:

      • Variações de lista
      • Obter variações por nome
      • Criar novas variações (consulte Avisos)
      • Remover variações (consulte Avisos)
      • Acessar dados de variação (consulte ContentVariation)

    • Atalho para resolver variações (aplicar alguma lógica de fallback adicional específica de implementação se a variação especificada não estiver disponível para um elemento)

  • Variação de conteúdo (VariaçãoDeConteúdo)

    • Obter dados básicos (nome, título, descrição)
    • Obter/definir conteúdo
    • Sincronização simples, com base nas informações da última modificação

  Todas as três interfaces ( ContentFragment, ContentElement, ContentVariation) estender o Versionable , que adiciona recursos de controle de versão, necessários para fragmentos de conteúdo:

  • Criar nova versão do elemento
  • Listar versões do elemento
  • Obter o conteúdo de uma versão específica do elemento com versão

Adaptação - Uso de adaptTo()

Os seguintes podem ser adaptados:

• ContentFragment pode ser adaptada a:

  • Resource - o recurso Sling subjacente; observe que a atualização do subjacente Resource diretamente, exige a reconstrução do ContentFragment objeto.

  • Asset - o DAM Asset abstração que representa o fragmento de conteúdo; observe que a atualização do Asset diretamente, exige a reconstrução do ContentFragment objeto.

• ContentElement pode ser adaptada a:

  • ElementTemplate - para acessar as informações estruturais do elemento.

• FragmentTemplate pode ser adaptada a:

  • Resource - o Resource determinar o modelo referenciado ou o modelo original que foi copiado;

    • as alterações efetuadas através da Resource não são refletidas automaticamente na variável FragmentTemplate.

• Resource pode ser adaptada a:

  • ContentFragment
  • FragmentTemplate

Avisos

É de notar que:

• A API é implementada para fornecer a funcionalidade compatível com a interface do usuário do.

• A API inteira foi projetada para não manter as alterações automaticamente (a menos que indicado de outra forma no JavaDoc da API). Portanto, sempre é necessário confirmar o resolvedor de recursos da respectiva solicitação (ou o resolvedor que você está usando na verdade).

• Tarefas que podem exigir esforço adicional:

  • Criar/remover novos elementos não atualizará a estrutura de dados de fragmentos simples (com base em um modelo de fragmento).

  • Criar novas variações a partir de ContentElement não atualizará a estrutura de dados (mas criará globalmente a partir de ContentFragment will).

  • A remoção de variações existentes não atualizará a estrutura de dados.

A API de gerenciamento de fragmentos de conteúdo - Lado do cliente

Informações adicionais

Consulte o link a seguir:

• filter.xml

  A variável filter.xml para o gerenciamento de fragmentos de conteúdo é configurado de modo que não se sobreponha ao pacote de conteúdo principal do Assets.

Editar sessões

Uma sessão de edição é iniciada quando o usuário abre um fragmento de conteúdo em uma das páginas do editor. A sessão de edição é concluída quando o usuário deixa o editor selecionando Salvar ou Cancelar.

Requisitos

Os requisitos para controlar uma sessão de edição são:

• A edição de um fragmento de conteúdo, que pode abranger várias visualizações (= páginas de HTML), deve ser atômica.
• A edição também deve ser transacional; no final da sessão de edição, as alterações deverão ser confirmadas (salvas) ou revertidas (canceladas).
• Os casos de borda devem ser tratados corretamente; eles incluem situações como quando o usuário sai da página inserindo um URL manualmente ou usando a navegação global.
• Um salvamento automático periódico (a cada x minutos) deve estar disponível para evitar perda de dados.
• Se um fragmento de conteúdo for editado por dois usuários simultaneamente, eles não deverão substituir as alterações um do outro.

Processos

Os processos envolvidos são:

• Iniciar uma sessão

  • Uma nova versão do fragmento de conteúdo é criada.
  • Salvamento automático iniciado.
  • Os cookies são definidos; eles definem o fragmento editado no momento e uma sessão de edição aberta.

• Finalizando uma sessão

  • Salvamento automático interrompido.

  • Na confirmação:

    • As informações da última modificação são atualizadas.
    • Os cookies são removidos.

  • Na reversão:

    • A versão do fragmento de conteúdo criada quando a sessão de edição foi iniciada é restaurada.
    • Os cookies são removidos.

• Edição

  • Todas as alterações (salvamento automático incluído) são feitas no fragmento de conteúdo ativo - não em uma área separada e protegida.
  • Portanto, essas alterações são refletidas imediatamente nas páginas AEM que fazem referência ao respectivo fragmento de conteúdo

Ações

As ações possíveis são:

• Inserção de uma página

  • Verifique se uma sessão de edição já está presente; verificando o respectivo cookie.

    • Se existir, verifique se a sessão de edição foi iniciada para o fragmento de conteúdo que está sendo editado no momento

      • Se for o fragmento atual, restabeleça a sessão.
      • Caso contrário, tente cancelar a edição do fragmento de conteúdo editado anteriormente e remover os cookies (nenhuma sessão de edição presente posteriormente).

    • Se não houver uma sessão de edição, aguarde a primeira alteração feita pelo usuário (veja abaixo).

  • Verifique se o fragmento de conteúdo já está referenciado em uma página e exiba as informações apropriadas em caso positivo.

• Alteração de conteúdo

  • Sempre que o usuário alterar o conteúdo e não houver nenhuma sessão de edição presente, uma nova sessão de edição será criada (consulte Iniciar uma sessão).

• Sair de uma página

  • Se uma sessão de edição estiver presente e as alterações não forem persistentes, uma caixa de diálogo de confirmação modal será exibida para notificar o usuário sobre conteúdo potencialmente perdido e permitir que ele permaneça na página.

Exemplos

Exemplo: acesso a um fragmento de conteúdo existente

Para isso, você pode adaptar o recurso que representa a API a:

com.adobe.cq.dam.cfm.ContentFragment

Por exemplo:

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
}

Exemplo: Criação de um novo fragmento de conteúdo

Para criar um novo fragmento de conteúdo de forma programática, é necessário usar:

com.adobe.cq.dam.cfm.ContentFragmentManager#create

Por exemplo:

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

Exemplo: Especificação do intervalo de salvamento automático

O intervalo de salvamento automático (medido em segundos) pode ser definido usando o gerenciador de configurações (ConfMgr):

• Nó: <*conf-root*>/settings/dam/cfm/jcr:content

• Nome da Propriedade: autoSaveInterval

• Tipo: Long

• Padrão: 600 (10 minutos); está definido em /libs/settings/dam/cfm/jcr:content

Se você quiser definir um intervalo de salvamento automático de 5 minutos, será necessário definir a propriedade no nó; por exemplo:

• Nó: /conf/global/settings/dam/cfm/jcr:content

• Nome da Propriedade: autoSaveInterval

• Tipo: Long

• Valor: 300 (5 minutos equivale a 300 segundos)

Modelos de fragmentos do conteúdo

Consulte Modelos de fragmentos do conteúdo para obter informações completas.

Componentes para criação de página

Para obter mais informações, consulte

• Componentes principais - Componente do fragmento de conteúdo (recomendado)
• Componentes do fragmento de conteúdo — Componentes para criação de página

Recursos do Business.Adobe.com

Content Insights Automated Onboarding Mobile Forms Theme Editor Customer Experience Management Digital Asset Management