Fragmentos de experiência

Noções básicas

Um Fragmento de experiência é um grupo de um ou mais componentes, incluindo conteúdo e layout que podem ser referenciados nas páginas.

Um fragmento de experiência principal e/ou variante usa:

• sling:resourceType : /libs/cq/experience-fragments/components/xfpage

Uma vez que não existe /libs/cq/experience-fragments/components/xfpage/xfpage.html reverte para

• sling:resourceSuperType : wcm/foundation/components/page

A representação HTML simples

Usar o .plain. no URL, você poderá acessar a representação de HTML simples.

Isso está disponível por meio do navegador, mas seu objetivo principal é permitir que outros aplicativos (por exemplo, aplicativos Web de terceiros, implementações personalizadas de publicações de conteúdo para dispositivos móveis) acessem o conteúdo do Fragmento de experiência diretamente, usando apenas o URL.

A representação de HTML simples adiciona o protocolo, o host e o caminho de contexto aos caminhos que são:

• do tipo: src, hrefou action

• ou terminam com: -srcou -href

Por exemplo:

.../brooklyn-coat/master.plain.html

O seletor de representação simples usa um transformador em vez de scripts adicionais; a variável Sling Rewriter é usado como transformador. Isso é configurado em

• /libs/experience-fragments/config/rewriter/experiencefragments

Configuração da geração de representação de HTML

A representação de HTML é gerada usando os Pipelines de reescrita do Sling. O pipeline é definido em /libs/experience-fragments/config/rewriter/experiencefragments. O Transformador de HTML suporta as seguintes opções:

• allowedCssClasses
  • Uma expressão RegEx que corresponde às classes CSS que devem ser deixadas na representação final.
  • Isso é útil se o cliente quiser eliminar algumas classes CSS específicas
• allowedTags
  • Uma lista de tags HTML a serem permitidas na representação final.
  • Por padrão, as seguintes tags são permitidas (nenhuma configuração é necessária): html, head, title, body, img, p, span, ul, li, a, b, i, em, strong, h1, h2, h3, h4, h5, h6, br, noscript, div, link e script

É recomendável configurar a reescrita usando uma sobreposição. Consulte Sobreposições

Variações sociais

As variantes sociais podem ser publicadas em redes sociais (texto e imagem). No Adobe Experience Manager (AEM), essas variantes sociais podem conter componentes; por exemplo, componentes de texto, componentes de imagem.

A imagem e o texto da publicação social podem ser obtidos de qualquer tipo de recurso de imagem ou de texto em qualquer nível de profundidade (no bloco de construção ou no contêiner de layout).

As variações sociais também permitem a criação de blocos e os consideram ao realizar ações sociais (no ambiente de publicação).

Para publicar o texto e a imagem corretos na rede social, algumas convenções precisam ser respeitadas se você estiver desenvolvendo seus próprios componentes personalizados.

Para isso, as seguintes propriedades devem ser usadas:

• Para extrair a imagem

  • fileReference
  • fileName

• Para extrair o texto

  • text

Os componentes que não usam essa convenção não serão considerados.

Modelos para fragmentos de experiência

Ao desenvolver um novo modelo para Fragmentos de experiência, você pode seguir as práticas padrão para um modelo editável.

Para criar um modelo de fragmento de experiência detectado pelo Criar fragmento de experiência , você deve seguir um destes conjuntos de regras:

1. Ambos:

   1. O tipo de recurso do template (o nó inicial) deve herdar de:

      cq/experience-fragments/components/xfpage

   2. E o nome do template deve começar com:

      experience-fragments
      Isso permite que os usuários criem fragmentos de experiência em /content/experience-fragments como o cq:allowedTemplates A propriedade desta pasta inclui todos os modelos com nomes que começam com experience-fragment. Os clientes podem atualizar essa propriedade para incluir seu próprio esquema de nomenclatura ou locais do modelo.

2. Modelos permitidos O pode ser configurado no console Fragmentos de experiência.

Componentes para fragmentos de experiência

Desenvolvimento de componentes para uso com/nos Fragmentos de experiência, siga as práticas padrão.

A única configuração adicional é garantir que os componentes estejam permitido no modelo, isso é obtido com a Política de conteúdo.

O provedor de regravação do link do fragmento de experiência - HTML

No AEM, é possível criar Fragmentos de experiência. Um fragmento de experiência:

• consiste em um grupo de componentes juntamente com um layout,
• O pode existir independentemente de uma página AEM.

Um dos casos de uso para esses grupos é para incorporar conteúdo em pontos de contato de terceiros, como o Adobe Target.

Reescrita de link padrão

Usar o Exportar para o Target você pode:

• criar um fragmento de experiência,
• adicionar componentes a ele,
• e, em seguida, exporte-a como uma Oferta do Adobe Target, no Formato HTML ou JSON.

Esse recurso pode ser ativado em uma instância de autor do AEM. Ele requer uma configuração válida do Adobe Target e configurações para o Externalizador de links.

O Externalizador de links é usado para determinar os URLs corretos necessários ao criar a versão do HTML da oferta do Target, que é então enviada para o Adobe Target. Isso é necessário, pois o Adobe Target exige que todos os links dentro da Oferta de HTML do Target possam ser acessados publicamente. Isso significa que todos os recursos aos quais os links fazem referência e o próprio Fragmento de experiência devem ser publicados antes de serem usados.

Por padrão, quando você constrói uma Oferta de HTML do Target, uma solicitação é enviada para um seletor de Sling personalizado no AEM. Esse seletor é chamado de .nocloudconfigs.html. Como o nome indica, ele cria uma renderização de HTML simples de um Fragmento de experiência, mas não inclui configurações de nuvem (que seriam informações supérfluas).

Depois de gerar a página HTML, o pipeline de reescrita do Sling faz modificações na saída:

1. A variável html, head, e body Os elementos são substituídos por div elementos. A variável meta, noscript e title elementos são removidos (são elementos secundários do original) head elemento, e não são considerados quando este é substituído pelo elemento div elemento).

   Isso é feito para garantir que a Oferta do HTML Target possa ser incluída nas Atividades do Target.

2. O AEM modifica todos os links internos presentes no HTML, para que eles apontem para um recurso publicado.

   Para determinar os links a serem modificados, o AEM segue esse padrão para atributos de elementos HTML:

   1. src atributos
   2. href atributos
   3. *-src atributos (como data-src, custom-src e assim por diante)
   4. *-href atributos (como data-href, custom-href, img-hrefe assim por diante)
   OBSERVAÇÃO

   Normalmente, os links internos no HTML são links relativos, mas pode haver casos em que os componentes personalizados fornecem URLs completos no HTML. Por padrão, o AEM ignora esses URLs completos e não faz modificações.

   Os links nesses atributos são executados pelo Externalizador de links AEM publishLink() para recriar o URL como se ele estivesse em uma instância publicada e, como tal, disponibilizado publicamente.

Ao usar uma implementação pronta para uso, o processo descrito acima deve ser suficiente para gerar a oferta do Target a partir do fragmento de experiência e, em seguida, exportá-la para o Adobe Target. No entanto, há alguns casos de uso que não são considerados nesse processo; eles incluem:

• Mapeamento do Sling disponível somente na instância de publicação
• Redirecionamentos do Dispatcher

Nesses casos de uso, o AEM fornece a interface do provedor de reescrita de links.

Interface do provedor de reescrita de links

Para casos mais complicados, não abrangidos pelo padrão, o AEM oferece a interface do provedor Link Rewriter. Este é um ConsumerType que pode ser implementada nos seus pacotes, como um serviço. Ele ignora as modificações que o AEM executa nos links internos de uma oferta de HTML, conforme renderizado a partir de um Fragmento de experiência. Essa interface permite personalizar o processo de reescrita de links de HTML internos para alinhar-se às suas necessidades comerciais.

Exemplos de casos de uso para implementar essa interface como um serviço incluem:

• Os Mapeamentos do Sling são ativados nas instâncias de publicação, mas não na instância do autor
• Um dispatcher ou tecnologia semelhante é usada para redirecionar URLs internamente
• Há sling:alias mechanisms em vigor para os recursos

A Interface Do Provedor De Regravação De Link ( ExperienceFragmentLinkRewriterProvider) é a seguinte:

public interface ExperienceFragmentLinkRewriterProvider {

    String rewriteLink(String link, String tag, String attribute);

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Como usar a interface do provedor de reescrita de links

Para usar a interface, primeiro é necessário criar um pacote contendo um novo componente de serviço que implemente a interface do Provedor de reescrita de link.

Esse serviço é usado para conectar a regravação da Exportação do fragmento de experiência para o Target para ter acesso aos vários links.

Por exemplo, ComponentService:

import com.adobe.cq.xf.ExperienceFragmentLinkRewriterProvider;
import com.adobe.cq.xf.ExperienceFragmentVariation;
import org.osgi.service.component.annotations.Service;
import org.osgi.service.component.annotations.Component;

@Component
@Service
public class GeneralLinkRewriter implements ExperienceFragmentLinkRewriterProvider {

    @Override
    public String rewriteLink(String link, String tag, String attribute) {
        return null;
    }

    @Override
    public boolean shouldRewrite(ExperienceFragmentVariation experienceFragment) {
        return false;
    }

    @Override
    public int getPriority() {
        return 0;
    }

}

Para que o serviço funcione, agora há três métodos que precisam ser implementados dentro dele:

• [shouldRewrite](#shouldrewrite)

• [rewriteLink](#rewritelink)

  • rewriteLinkExample2

• [getPriority](#priorities-getpriority)

shouldRewrite

Você precisa indicar ao sistema se ele precisa regravar os links quando for feita uma chamada para Export to Target em uma determinada variação de Fragmento de experiência. Para fazer isso, implemente o método:

shouldRewrite(ExperienceFragmentVariation experienceFragment);

Por exemplo:

@Override
public boolean shouldRewrite(ExperienceFragmentVariation experienceFragment) {
    return experienceFragment.getPath().equals("/content/experience-fragment/master");
}

Esse método recebe como parâmetro a variação do Fragmento de experiência que o sistema de Exportação para o Target está reescrevendo no momento.

No exemplo acima, gostaríamos de reescrever:

• links presentes em src

• href somente atributos

• para um Fragmento de experiência específico:
  /content/experience-fragment/master

Quaisquer outros Fragmentos de experiência que passam pelo sistema Exportar para o Target são ignorados e não são afetados pelas alterações implementadas neste Serviço.

rewriteLink

Para a variação do Fragmento de experiência afetada pelo processo de regravação, ele continuará a permitir que o serviço lide com a regravação do link. Sempre que um link é encontrado no HTML interno, o seguinte método é chamado:

rewriteLink(String link, String tag, String attribute)

Como entrada, o método recebe os parâmetros:

• link
  A variável String representação do link que está sendo processado. Normalmente, esse é um URL relativo que aponta para o recurso na instância do autor.

• tag
  O nome do elemento HTML que está sendo processado.

• attribute
  O nome exato do atributo.

Por exemplo, se o sistema Exportar para o Target estiver processando esse elemento, você poderá definir CSSInclude como:

<link rel="stylesheet" href="/etc.clientlibs/foundation/clientlibs/main.css" type="text/css">

A chamada para o rewriteLink() é feito usando estes parâmetros:

rewriteLink(link="/etc.clientlibs/foundation/clientlibs/main.css", tag="link", attribute="href" )

Ao criar o serviço, você pode tomar decisões com base na entrada fornecida e, em seguida, reescrever o link de acordo.

Para o nosso exemplo, gostaríamos de remover a variável /etc.clientlibs parte do URL e adicione o domínio externo apropriado. Para simplificar as coisas, consideraremos que temos acesso a um Resource Resolver para o seu serviço, como em rewriteLinkExample2:

private ResourceResolver resolver;

private Externalizer externalizer;

@Override
public String rewriteLink(String link, String tag, String attribute) {

    // get the externalizer service
    externalizer = resolver.adaptTo(Externalizer.class);
    if(externalizer == null) {
        // if there was an error, then we do not modify the link
        return null;
    }

    // remove leading /etc.clientlibs from resource link before externalizing
    link = link.replaceAll("/etc.clientlibs", "");

    // considering that we configured our publish domain, we directly apply the publishLink() method
    link = externalizer.publishLink(resolver, link);

    return link;
}

Prioridades - getPriority

Não é incomum precisar de vários serviços para atender a diferentes tipos de Fragmentos de experiência, ou até mesmo ter um Serviço genérico que lida com a externalização e o mapeamento de todos os Fragmentos de experiência. Nesses casos, podem surgir conflitos sobre qual serviço usar, de modo que o AEM oferece a possibilidade de definir Prioridades para diferentes serviços. As prioridades são especificadas usando o método:

• getPriority()

Este método permite a utilização de vários serviços em que a shouldRewrite() O método retorna verdadeiro para o mesmo Fragmento de experiência. O serviço que retorna o número mais alto de seu getPriority()é o serviço que lida com a variação do fragmento de experiência.

Como exemplo, você pode ter uma GenericLinkRewriterProvider que lida com o mapeamento básico para todos os Fragmentos de experiência e quando a variável shouldRewrite() o método retorna true para todas as variações de fragmento de experiência. Para vários Fragmentos de experiência específicos, você pode desejar um manuseio especial, portanto, nesse caso, você pode fornecer um SpecificLinkRewriterProvider para o qual o shouldRewrite() O método retorna verdadeiro somente para algumas variações de fragmento de experiência. Para garantir que SpecificLinkRewriterProvider for escolhida para lidar com essas variações de fragmento de experiência, ela deve retornar em seu getPriority() método um número maior que GenericLinkRewriterProvider.