Fragments d’expérience experience-fragments

Principes élémentaires the-basics

Un fragment d’expérience est un groupe d’un ou plusieurs composants comprenant un contenu et une disposition pouvant être référencés dans les pages.

Un gabarit de fragment d’expérience, ou une variante, ou encore les deux, utilise :

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

En l’absence de /libs/cq/experience-fragments/components/xfpage/xfpage.html, il revient à

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

Rendu HTML brut the-plain-html-rendition

Le sélecteur .plain. de l’URL permet d’accéder au rendu HTML brut.

Ce rendu est disponible à partir du navigateur. Toutefois, son principal objectif consiste à autoriser d’autres applications (des applications web tierces et des implémentations mobiles personnalisées, par exemple) à accéder directement au contenu du fragment d’expérience à l’aide de l’URL uniquement.

Le rendu HTML brut ajoute le protocole, l’hôte et le chemin de contexte aux chemins suivants :

  • sont du type src, href ou action ;

  • se terminent par -src ou -href.

Par exemple :

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

NOTE
Les liens font toujours référence à l’instance de publication. Ils sont destinés à être utilisés par des tiers. Par conséquent, le lien sera toujours appelé à partir de l’instance de publication, et non de l’instance de création.
Pour plus d’informations, voir Externalisation des URL.

Rendu HTML brut

Le sélecteur de rendu brut utilise un transformateur plutôt que des scripts supplémentaires. Le module de réécriture Sling est utilisé comme transformateur. Ce transformateur est configuré comme suit :

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

Configuration de la génération du rendu HTML configuring-html-rendition-generation

Le rendu HTML est généré à l’aide des pipelines de réécriture Sling. Le pipeline est défini au niveau du chemin /libs/experience-fragments/config/rewriter/experiencefragments. Le transformateur HTML prend en charge les options suivantes :

  • allowedCssClasses

    • Une expression RegEx correspondant aux classes CSS qui doivent être conservées dans le rendu final.
    • Cette option est utile si le client ou la cliente souhaite supprimer certaines classes CSS spécifiques
  • allowedTags

    • Une liste des balises HTML autorisées dans le rendu final.
    • Par défaut, les balises suivantes sont autorisées (aucune configuration requise) : html, head, title, body, img, p, span, ul, li, a, b, i, em, strong, h1, h2, h3, h4, h5, h6, br, noscript, div, link et script

Adobe recommande de configurer le module de réécriture à l’aide d’un recouvrement. Consultez la section Recouvrements dans AEM as a Cloud Service.

Modèles de fragments d’expérience templates-for-experience-fragments

CAUTION
Seuls les modèles modifiables sont pris en charge pour les fragments d’expérience.
Les fragments d’expérience ne peuvent être utilisés que sur des pages reposant sur des modèles modifiables.

Lors du développement d’un nouveau modèle pour les fragments d’expérience, vous pouvez suivre les pratiques standard en vigueur pour un modèle modifiable.

Pour créer un modèle de fragment d’expérience détecté par l’assistant Créer un fragment d’expérience, vous devez suivre l’un des ensembles de règles suivants :

  1. Les deux :

    1. Le type de ressource du modèle (le nœud initial) doit hériter de :

      cq/experience-fragments/components/xfpage

    2. Et le nom du modèle doit commencer par :

      experience-fragments
      Ce modèle permet de créer des fragments d’expérience dans /content/experience-fragments, étant donné que la propriété cq:allowedTemplates de ce dossier inclut tous les modèles dont le nom commence par experience-fragment. Les clients peuvent mettre à jour cette propriété afin d’inclure leur propre schéma d’affectation de noms ou emplacement de modèle.

  2. Les modèles autorisés peuvent être configurés dans la console des fragments d’expérience.

Composants des fragments d’expérience components-for-experience-fragments

Le développement de composants à utiliser avec/dans les fragments d’expérience est conforme aux pratiques standard.

La seule configuration supplémentaire consiste à s’assurer que les composants sont autorisés sur le modèle. Cette prise en charge est réalisée à l’aide de la politique de contenu.

Dans AEM, vous avez la possibilité de créer des fragments d’expérience. Un fragment d’expérience :

  • est constitué d’un groupe de composants avec une mise en page ;
  • peut exister indépendamment d’une page AEM.

De tels groupes sont notamment utilisés pour incorporer du contenu dans des points de contact tiers, tels qu’Adobe Target.

La fonction Exporter vers Target vous permet :

  • de créer un fragment d’expérience,
  • d’y ajouter des composants ;
  • de l’exporter ensuite en tant qu’offre Adobe Target, au format HTML ou JSON.

Cette fonction peut être activée sur une instance de création d’AEM. Elle nécessite une configuration Adobe Target valide, ainsi que des configurations pour l’externaliseur de liens.

L’externaliseur de liens sert à déterminer les URL appropriées qui sont nécessaires lors de la création de la version de l’offre Target HTML, qui est ensuite envoyée à Adobe Target. Ce processus est nécessaire, car Adobe Target nécessite que tous les liens de l’offre HTML Target soient accessibles au public. Cela signifie que toutes les ressources auxquelles les liens font référence, ainsi que le fragment d’expérience lui-même, doivent être publiés avant de pouvoir être utilisés.

Par défaut, lorsque vous créez une offre HTML Target, une requête est envoyée à un sélecteur Sling personnalisé dans AEM. Ce sélecteur est appelé .nocloudconfigs.html. Comme son nom l’indique, il crée un rendu HTML brut d’un fragment d’expérience, mais n’inclut pas de configurations cloud (qui seraient des informations superflues).

Une fois la page HTML générée, le pipeline Sling Rewriter est modifié en fonction de la sortie :

  1. Les éléments html, head et body sont remplacés par des éléments div. Les éléments meta, noscript et title sont supprimés (il s’agit d’éléments enfants de l’élément head d’origine et ils ne sont pas pris en compte lorsqu’ils sont remplacés par l’élément div).

    Ce processus permet de s’assurer que l’offre Target HTML peut être incluse dans les activités Target.

  2. AEM modifie les liens internes présents dans le code HTML afin qu’ils pointent vers une ressource publiée.

    Pour identifier les liens à modifier, AEM suit ce modèle pour les attributs d’éléments HTML :

    1. Attributs src
    2. Attributs href
    3. Attributs *-src (par exemple, data-src, et custom-src)
    4. *-hrefAttributs (par exemple, data-href, custom-href, et img-href)
    note note
    NOTE
    Les liens internes du code HTML sont des liens relatifs, mais il peut arriver que des composants personnalisés fournissent des URL complètes dans le code HTML. Par défaut, AEM ignore ces URL complètes et n’effectue aucune modification.

    Les liens de ces attributs sont exécutés via l’externaliseur de liens AEM publishLink() afin de recréer l’URL comme si elle se trouvait sur une instance publiée et, de ce fait, accessible au public.

Lors de l’utilisation d’une implémentation prête à l’emploi, le processus décrit ci-dessus doit être suffisant pour générer l’offre Target à partir du fragment d’expérience, puis l’exporter vers Adobe Target. Toutefois, certains cas d’utilisation ne sont pas pris en compte dans ce processus. Voici quelques-uns de ces cas qui ne sont pas pris en compte :

  • Mappage Sling disponible uniquement sur l’instance de publication
  • Redirections du Dispatcher

Pour ces cas d’utilisation, AEM propose l’interface du fournisseur de réécriture de liens.

Pour les cas plus complexes, non couverts par le paramètre par défaut, AEM propose l’interface du fournisseur de réécriture de liens. Il s’agit d’une interface ConsumerType que vous pouvez implémenter dans vos lots sous la forme d’un service. Elle ignore les modifications qu’AEM effectue sur les liens internes d’une offre HTML telle qu’elle est générée à partir d’un fragment d’expérience. Cette interface vous permet de personnaliser le processus de réécriture des liens HTML internes afin de l’adapter aux besoins de votre entreprise.

Voici quelques exemples d’implémentation de cette interface en tant que service :

  • Les mappages Sling sont activés sur les instances de publication, mais pas sur l’instance de création.
  • Un Dispatcher ou une technologie semblable est utilisé pour rediriger les URL en interne
  • Il existe des sling:alias mechanisms pour les ressources
NOTE
Cette interface traite uniquement les liens HTML internes de l’offre Target générée.

L’interface du fournisseur de réécriture de liens (ExperienceFragmentLinkRewriterProvider) se présente comme suit :

public interface ExperienceFragmentLinkRewriterProvider {

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

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Avant d’utiliser cette interface, vous devez créer un lot contenant un nouveau composant de service qui implémente l’interface du fournisseur de réécriture de liens.

Ce service est utilisé pour se connecter à la réécriture Exporter vers Target du fragment d’expérience afin qu’elle puisse avoir accès aux différents liens.

Par exemple, 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;
    }

}

Pour que le service fonctionne, trois méthodes doivent à présent être implémentées en interne :

  • [shouldRewrite](#shouldrewrite)

  • [rewriteLink](#rewritelink)

    • rewriteLinkExample2
  • [getPriority](#priorities-getpriority)

shouldRewrite shouldrewrite

Indiquez au système s’il doit ou non réécrire les liens lorsqu’un appel est effectué pour Exporter vers Target sur une variante donnée du fragment d’expérience. Vous pouvez implémenter la méthode suivante :

shouldRewrite(ExperienceFragmentVariation experienceFragment);

Par exemple :

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

Cette méthode reçoit, en tant que paramètre, la variante du fragment d’expérience qui est réécrite par le système Exporter vers Target.

Dans l’exemple ci-dessus, vous souhaitez réécrire :

  • Les liens présents dans src

  • Uniquement les attributs href

  • Pour un fragment d’expérience spécifique :
    /content/experience-fragment/master

Les autres fragments d’expérience transitant par le système Exporter vers Target sont ignorés et ne sont pas affectés par les modifications implémentées dans ce service.

S’agissant de la variante du fragment d’expérience concernée par le processus de réécriture, elle se poursuit pour permettre au service de traiter la réécriture du lien. Chaque fois qu’un lien est détecté dans le code HTML interne, la méthode suivante est appelée :

rewriteLink(String link, String tag, String attribute)

En entrée, la méthode reçoit les paramètres suivants :

  • link
    Représentation String du lien en cours de traitement. Cette représentation correspond généralement à une URL relative pointant vers la ressource sur l’instance de création.

  • tag
    Nom de l’élément HTML en cours de traitement.

  • attribute
    Nom exact de l’attribut.

Si, par exemple, le système Exporter vers Target traite cet élément, vous pouvez définir CSSInclude en tant que :

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

L’appel de la méthode rewriteLink() est effectué à l’aide des paramètres suivants :

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

Lorsque vous créez le service, vous pouvez prendre des décisions en fonction de l’entrée indiquée, puis réécrire le lien en conséquence.

Dans notre exemple, nous souhaitons supprimer la partie /etc.clientlibs de l’URL et ajouter le domaine externe approprié. Pour simplifier les choses, nous partons du principe que nous avons accès à un résolveur de ressources pour le service, comme dans rewriteLinkExample2 :

NOTE
Pour plus d’informations sur l’obtention d’un résolveur de ressources par le biais d’un utilisateur des services, voir Utilisateurs des services dans AEM.
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;
}
NOTE
Si la méthode ci-dessus renvoie null, le système Exporter vers Target laisse le lien tel quel, c’est-à-dire un lien relatif vers une ressource.

Priorités - getPriority priorities-getpriority

Il n’est pas rare de devoir utiliser plusieurs services pour traiter différents types de fragments d’expérience, voire de disposer d’un service générique qui gère l’externalisation et le mappage pour tous les fragments d’expérience. Dans ce cas, des conflits peuvent survenir au niveau du service à utiliser. Aussi, AEM permet-il de définir des priorités pour différents services. Les priorités sont spécifiées en utilisant la méthode suivante :

  • getPriority()

Cette méthode permet d’utiliser plusieurs services pour lesquels la méthode shouldRewrite() renvoie la valeur « true » pour le même fragment d’expérience. Le service qui renvoie la valeur la plus élevée à partir de sa méthode getPriority() est celui qui traite la variation du fragment d’expérience.

Par exemple, un GenericLinkRewriterProvider peut gérer le mappage de base pour tous les fragments d’expérience et lorsque la méthode shouldRewrite() renvoie true pour toutes les variations du fragment d’expérience. Pour plusieurs fragments d’expérience spécifiques, une gestion spéciale peut être souhaitable. Dans ce cas, vous pouvez donc fournir un SpecificLinkRewriterProvider pour lequel la méthode shouldRewrite() ne renvoie la valeur « true » que pour certaines variations du fragment d’expérience. Pour s’assurer que SpecificLinkRewriterProvider est choisi pour traiter ces variations du fragment d’expérience, il doit renvoyer dans sa méthode getPriority() un nombre supérieur à GenericLinkRewriterProvider.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab