Fragmentos de experiencias experience-fragments

Conceptos básicos the-basics

Un fragmento de experiencia es un grupo de uno o más componentes, incluido el contenido y el diseño, a los que se puede hacer referencia en las páginas.

Un fragmento de experiencia principal, una variante o ambos utilizan:

Como no hay /libs/cq/experience-fragments/components/xfpage/xfpage.html, vuelve a

Representación HTML sin formato the-plain-html-rendition

Utilizando el selector .plain. en la dirección URL, puede acceder a la representación de HTML sin formato.

Esta representación está disponible en el explorador. Sin embargo, su propósito principal es permitir que otras aplicaciones (por ejemplo, aplicaciones web de terceros o implementaciones móviles personalizadas) accedan al contenido del fragmento de experiencia directamente, únicamente mediante la dirección URL.

La representación de HTML sin formato agrega el protocolo, el host y la ruta de contexto a las rutas que son:

Por ejemplo:

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

El selector de representación sin formato utiliza un transformador en lugar de scripts adicionales. Sling Rewriter se usa como transformador. Este transformador se configura en lo siguiente:

Configuración de la generación de representaciones del HTML configuring-html-rendition-generation

La representación del HTML se genera mediante las canalizaciones de reescritura de Sling. La canalización se ha definido en /libs/experience-fragments/config/rewriter/experiencefragments. El transformador de HTML admite las siguientes opciones:

El Adobe recomienda configurar la reescritura mediante una superposición. Ver Superposiciones en AEM as a Cloud Service.

Plantillas para fragmentos de experiencias templates-for-experience-fragments

Al desarrollar una nueva plantilla para fragmentos de experiencias, puede seguir las prácticas estándar para una plantilla editable.

Para crear una plantilla de fragmento de experiencia detectada por el asistente Crear fragmento de experiencia, debe seguir uno de estos conjuntos de reglas:

Componentes para fragmentos de experiencias components-for-experience-fragments

El desarrollo de componentes para su uso con/en fragmentos de experiencias sigue las prácticas estándar.

La única configuración adicional es garantizar que los componentes estén permitidos en la plantilla. Esta asignación se logra con la Política de contenido.

El proveedor del reescritor de vínculos de fragmentos de experiencias: HTML the-experience-fragment-link-rewriter-provider-html

AEM En el caso de los fragmentos de experiencias, tiene la posibilidad de crear fragmentos de experiencias. Un fragmento de experiencia:

Uno de los casos de uso de estos grupos es para incrustar contenido en puntos de contacto de terceros, como Adobe Target.

Reescritura de vínculos predeterminados default-link-rewriting

Con la función Exportar a destino, puede:

AEM Esta función se puede habilitar en una instancia de autor de. Requiere una configuración de Adobe Target válida y configuraciones para el externalizador de vínculos.

El externalizador de vínculos se utiliza para determinar las direcciones URL correctas necesarias al crear la versión de HTML de la oferta de Target, que luego se envía a Adobe Target. Este proceso es necesario, ya que Adobe Target requiere que se pueda acceder públicamente a todos los vínculos dentro de la oferta de HTML de Target. Significa que cualquier recurso al que hagan referencia los vínculos, y el propio fragmento de experiencia, deben publicarse antes de poder utilizarse.

De forma predeterminada, al crear una oferta de HTML AEM de Target, se envía una solicitud a un selector de Sling personalizado en, que se encuentra en el menú de configuración de la. Este selector se llama .nocloudconfigs.html. Como su nombre indica, crea una representación HTML sin formato de un fragmento de experiencia, pero no incluye configuraciones de nube (lo que sería información superflua).

Después de generar la página de HTML, la canalización de reescritura de Sling se modifica a la salida:

Al utilizar una implementación predeterminada, el proceso descrito anteriormente debe ser suficiente para generar la oferta de Target a partir del fragmento de experiencia y luego exportarla a Adobe Target. Sin embargo, hay algunos casos de uso que no se tienen en cuenta en este proceso. Algunos de estos casos que no se tienen en cuenta son los siguientes:

AEM Para estos casos de uso, proporciona la interfaz del proveedor de reescritura de vínculos de manera de.

Interfaz de proveedor de reescritura de vínculos link-rewriter-provider-interface

AEM Para casos más complicados, no cubiertos por default, ofrece la interfaz del proveedor de reescritura de vínculos. Esta interfaz es una interfaz de ConsumerType que puede implementar en sus paquetes como servicio. AEM Evita las modificaciones que realiza en los vínculos internos de una oferta de HTML que se representan desde un fragmento de experiencia. Esta interfaz le permite personalizar el proceso de reescritura de vínculos internos de HTML para adaptarlos a sus necesidades comerciales.

Algunos ejemplos de casos de uso para implementar esta interfaz como servicio son:

La interfaz del proveedor de reescritura de vínculos ( ExperienceFragmentLinkRewriterProvider) es la siguiente:

public interface ExperienceFragmentLinkRewriterProvider {

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

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Cómo utilizar la interfaz del proveedor de reescritura de vínculos how-to-use-the-link-rewriter-provider-interface

Para utilizar la interfaz, primero debe crear un paquete que contenga un nuevo componente de servicio que implemente la interfaz del proveedor de reescritura de vínculos.

Este servicio se utiliza para conectarse a la reescritura de Exportación de fragmentos de experiencias a Target para que pueda tener acceso a los distintos vínculos.

Por ejemplo, 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 el servicio funcione, ahora hay tres métodos que deben implementarse dentro del servicio:

shouldRewrite shouldrewrite

Indique al sistema si debe reescribir los vínculos cuando se realice una llamada para Exportar a Target en una variación determinada del fragmento de experiencia. Puede implementar el siguiente método:

shouldRewrite(ExperienceFragmentVariation experienceFragment);

Por ejemplo:

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

Este método recibe, como parámetro, la variación del fragmento de experiencia que el sistema Exportar a destino está reescribiendo.

En el ejemplo anterior, desea volver a escribir:

Cualquier otro fragmento de experiencia que pase por el sistema Exportar a destino se ignorará y no se verá afectado por los cambios implementados en este servicio.

rewriteLink rewritelink

Para la variación del fragmento de experiencia afectada por el proceso de reescritura, permite al servicio gestionar la reescritura de vínculos. Cada vez que se encuentra un vínculo en el HTML interno, se invoca el siguiente método:

rewriteLink(String link, String tag, String attribute)

Como entrada, el método recibe los parámetros:

Por ejemplo, si el sistema Exportar a destino está procesando este elemento, puede definir CSSInclude como:

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

La llamada al método rewriteLink() se realiza utilizando estos parámetros:

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

Al crear el servicio, las decisiones se basan en la entrada dada y, a continuación, reescriba el vínculo en consecuencia.

Para el ejemplo, desea eliminar la parte /etc.clientlibs de la dirección URL y agregar el dominio externo correspondiente. Para simplificar las cosas, considere que tiene acceso a un Resource Resolver para su servicio, como en 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

No es raro necesitar varios servicios para atender diferentes tipos de fragmentos de experiencias o incluso tener un servicio genérico que gestione la externalización y la asignación para todos los fragmentos de experiencias. AEM En estos casos, pueden surgir conflictos acerca del servicio que se va a usar, por lo que proporciona la posibilidad de definir Prioridades para diferentes servicios de manera que se puedan definir los mismos. Las prioridades se especifican mediante el método:

Este método permite el uso de varios servicios donde el método shouldRewrite() devuelve true para el mismo fragmento de experiencia. El servicio que devuelve el número más alto de su método getPriority() es el que administra la variación del fragmento de experiencia.

Por ejemplo, puede tener un GenericLinkRewriterProvider que administra la asignación básica de todos los fragmentos de experiencias y cuando el método shouldRewrite() devuelve true para todas las variaciones de fragmentos de experiencias. Para varios fragmentos de experiencias específicos, es posible que desee una administración especial, por lo que en este caso, puede proporcionar un SpecificLinkRewriterProvider para el cual el método shouldRewrite() devuelva el valor "True" solo para algunas variaciones de fragmentos de experiencias. Para asegurarse de que SpecificLinkRewriterProvider se elige para controlar esas variaciones de fragmento de experiencia, debe devolver en su método getPriority() un número mayor que GenericLinkRewriterProvider.