Fragmentos de experiência experience-fragments

Noções básicas the-basics

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, ou uma variante, ou ambos, usa:

Como não há /libs/cq/experience-fragments/components/xfpage/xfpage.html, ele é revertido para

A representação HTML simples the-plain-html-rendition

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

Essa representação está disponível no navegador. No entanto, 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:

Por exemplo:

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

O seletor de representação simples usa um transformador em vez de scripts adicionais. O Sling Rewriter é usado como transformador. Esse transformador é configurado da seguinte maneira:

Configuração da geração de representação de HTML configuring-html-rendition-generation

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

Adobe recomenda configurar a reescrita usando uma sobreposição. Consulte Sobreposições no AEM as a Cloud Service.

Modelos para fragmentos de experiência templates-for-experience-fragments

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 assistente Criar Fragmento de Experiência, siga um destes conjuntos de regras:

Componentes para fragmentos de experiência components-for-experience-fragments

O desenvolvimento de componentes para uso com/nos Fragmentos de experiência segue as práticas padrão.

A única configuração adicional é garantir que os componentes sejam permitidos no modelo. Essa permissão é obtida com a Política de conteúdo.

O provedor de reescrita de link do fragmento de experiência - HTML the-experience-fragment-link-rewriter-provider-html

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

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 default-link-rewriting

Com o recurso Exportar para o Target, você pode:

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. Esse processo é necessário, pois a 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. Este seletor é chamado .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 é modificado para a saída:

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. Alguns desses casos que não são considerados para incluem o seguinte:

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

Interface do provedor de reescrita de links link-rewriter-provider-interface

Para casos mais complicados, não cobertos pelo padrão, o AEM oferece a Interface do Provedor de Reescrita de Link. Esta interface é uma interface ConsumerType que você pode implementar em 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:

A Interface do Provedor de Reescrita 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 how-to-use-the-link-rewriter-provider-interface

Para usar a interface, primeiro você deve 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 à regravação da Exportação do fragmento de experiência para o Target, para que ele possa 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 devem ser implementados dentro do serviço:

shouldRewrite shouldrewrite

Indique ao sistema se ele deve regravar os links quando é feita uma chamada para Export to Target em uma determinada variação do Fragmento de experiência. Você pode implementar o seguinte 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á regravando.

No exemplo acima, você deseja reescrever:

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 rewritelink

Para a variação do Fragmento de experiência afetada pelo processo de regravação, ela continua 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:

Por exemplo, se o sistema Exportar para Destino 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 método rewriteLink() é feita usando estes parâmetros:

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

Ao criar o serviço, suas decisões são baseadas na entrada fornecida e, em seguida, reescrevem o link de acordo.

Por exemplo, você deseja remover a parte /etc.clientlibs da URL e adicionar o domínio externo apropriado. Para simplificar, considere que você tenha 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 priorities-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, portanto, o AEM oferece a possibilidade de definir Prioridades para serviços diferentes. As prioridades são especificadas usando o método:

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

Como exemplo, você pode ter um GenericLinkRewriterProvider que manipula o mapeamento básico para todos os Fragmentos de experiência e quando o método shouldRewrite() retorna true para todas as Variações de Fragmento de experiência. Para vários Fragmentos de experiência específicos, talvez você queira manuseio especial; portanto, nesse caso, você pode fornecer um SpecificLinkRewriterProvider para o qual o método shouldRewrite() retorna "true" somente para algumas Variações de Fragmento de experiência. Para garantir que SpecificLinkRewriterProvider seja escolhido para lidar com essas Variações de Fragmento de Experiência, ele deve retornar em seu método getPriority() um número maior que GenericLinkRewriterProvider.