Upplevelsefragment experience-fragments

Grunderna the-basics

An Experience Fragment är en grupp med en eller flera komponenter, inklusive innehåll och layout, som kan refereras till på sidor.

En Experience Fragment Master, eller Variant, eller båda, använder:

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

För det finns ingen /libs/cq/experience-fragments/components/xfpage/xfpage.html, återgår till

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

The Plain HTML Rendition the-plain-html-rendition

Använda .plain. -väljaren i URL-adressen kan du komma åt den vanliga HTML-återgivningen.

Den här återgivningen är tillgänglig från webbläsaren. Dess främsta syfte är dock att tillåta andra program (till exempel webbprogram från tredje part, anpassade mobilimplementeringar) att komma åt innehållet i Experience Fragment direkt, med enbart URL:en.

Den enkla HTML-renderingen lägger till protokoll, värd och kontextsökväg till sökvägar som är:

  • av typen: src, href, eller action

  • eller avsluta med: -src, eller -href

Till exempel:

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

NOTE
Länkar refererar alltid till publiceringsinstansen. De är avsedda att användas av tredje part, så länken anropas alltid från publiceringsinstansen, inte författarinstansen.
Mer information finns på Extern URL.

Rendering HTML

Väljaren för ren återgivning använder en transformator i stället för ytterligare skript. The Sling Rewriter används som transformator. Den här transformatorn är konfigurerad på följande sätt:

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

Konfigurera generering av HTML-återgivning configuring-html-rendition-generation

Återgivningen av HTML genereras med Sling Rewriter-pipelines. Rörledningen definieras på /libs/experience-fragments/config/rewriter/experiencefragments. Transformatorn HTML stöder följande alternativ:

  • allowedCssClasses

    • Ett RegEx-uttryck som matchar CSS-klasserna som ska lämnas i den slutliga återgivningen.
    • Det här alternativet är användbart om kunden vill ta bort vissa specifika CSS-klasser
  • allowedTags

    • En lista över HTML-taggar som ska tillåtas i den slutliga återgivningen.
    • Som standard är följande taggar tillåtna (ingen konfiguration behövs): html, head, title, body, img, p, span, ul, li, a, b, i, em, strong, h1, h2, h3, h4, h5, h6, br, noscript, div, link och script

Adobe rekommenderar att omskrivaren konfigureras med en övertäckning. Se Övertäckningar i AEM as a Cloud Service.

Mallar för Experience Fragments templates-for-experience-fragments

CAUTION
Endast redigerbara mallar stöds för Experience Fragments.
Upplevelsefragment kan bara användas på sidor som är baserade på redigerbara mallar.

När du utvecklar en ny mall för Experience Fragments kan du följa standardmetoderna för en redigerbar mall.

Skapa en Experience Fragment-mall som identifieras av Skapa upplevelsefragment måste du följa någon av dessa regeluppsättningar:

  1. Båda:

    1. Mallens resurstyp (den inledande noden) måste ärva från:

      cq/experience-fragments/components/xfpage

    2. Och mallens namn måste börja med:

      experience-fragments
      Med det här mönstret kan användare skapa upplevelsefragment i /content/experience-fragments som cq:allowedTemplates -egenskapen i den här mappen innehåller alla mallar som har namn som börjar med experience-fragment. Kunder kan uppdatera den här egenskapen så att den omfattar sina egna namngivningsscheman eller mallplatser.

  2. Tillåtna mallar kan konfigureras i Experience Fragments-konsolen.

Komponenter för Experience Fragments components-for-experience-fragments

Utveckla komponenter för användning med/i Experience Fragments följer standardrutiner.

Den enda extra konfigurationen är att säkerställa att komponenterna tillåts i mallen. Detta uppnås med innehållspolicyn.

I AEM kan ni skapa Experience Fragments. An Experience Fragment:

  • består av en grupp komponenter tillsammans med en layout,
  • kan finnas oberoende av en AEM.

Ett av användningsområdena för sådana grupper är att bädda in innehåll i kontaktpunkter från tredje part, som Adobe Target.

Med funktionen Exportera till mål kan du:

  • skapa en upplevelsefragment,
  • lägga till komponenter i den,
  • och sedan exportera det som ett Adobe Target-erbjudande, antingen i HTML-format eller JSON-format.

Den här funktionen kan aktiveras för en författarinstans av AEM. Det kräver en giltig Adobe Target-konfiguration och konfigurationer för länkutökningen.

Länkutjämnaren används för att fastställa rätt URL:er som behövs när du skapar målerbjudandets HTML-version, som sedan skickas till Adobe Target. Denna process är nödvändig eftersom Adobe Target kräver att alla länkar i erbjudandet Target HTML ska vara tillgängliga för allmänheten. Det innebär att alla resurser som länkarna refererar till, och själva Experience Fragment, måste publiceras innan de kan användas.

När du skapar ett Target-erbjudande skickas som standard en begäran till en anpassad Sling-väljare i AEM. Den här väljaren anropas .nocloudconfigs.html. Som namnet antyder skapas en vanlig HTML-återgivning av ett Experience Fragment, men inte molnkonfigurationer (vilket skulle vara överflödig information).

När du har skapat HTML-sidan ändras Sling Rewriter-pipeline till utdata:

  1. The html, headoch body -element ersätts med div -element. The meta, noscriptoch title elementen tas bort (de är underordnade element till originalet) head -element och beaktas inte när de ersätts med div element).

    Detta görs för att se till att HTML Target-erbjudandet kan inkluderas i målaktiviteter.

  2. AEM ändrar alla interna länkar i HTML så att de pekar på en publicerad resurs.

    AEM här mönstret visar attributen för HTML-element för att fastställa vilka länkar som ska ändras:

    1. src attributes
    2. href attributes
    3. *-src attribut (till exempel data-srcoch custom-src)
    4. *-href attribut (till exempel data-href, custom-hrefoch img-href)
    note note
    NOTE
    De interna länkarna i HTML är relativa länkar, men det kan finnas fall när anpassade komponenter tillhandahåller fullständiga URL:er i HTML. Som standard ignorerar AEM dessa fullständigt ifyllda URL:er och gör inga ändringar.

    Länkarna i dessa attribut körs via AEM Link Externalizer publishLink() för att återskapa URL:en som om den fanns på en publicerad instans och som sådan offentligt tillgänglig.

När du använder en körklar implementering bör den process som beskrivs ovan vara tillräcklig för att generera målerbjudandet från Experience Fragment och sedan exportera det till Adobe Target. Det finns dock vissa användningsfall som inte har beaktats i den här processen. Några av dessa fall som inte har något konto för är:

  • Samlingsmappning är bara tillgängligt på publiceringsinstansen
  • Dispatcher-omdirigeringar

I dessa fall tillhandahåller AEM Länkskrivarens providergränssnitt.

För mer komplicerade fall omfattas de inte av standard, AEM har Link Rewriter Provider Interface. Gränssnittet är en ConsumerType som ni kan implementera i era paket som en tjänst. Den åsidosätter de ändringar AEM utför på interna länkar för ett HTML-erbjudande som återges från en Experience Fragment. Med det här gränssnittet kan du anpassa processen att skriva om interna HTML-länkar så att de passar era affärsbehov.

Exempel på användningsområden för implementering av det här gränssnittet som en tjänst är:

  • Samlingsmappningar är aktiverade för publiceringsinstanserna, men inte för författarinstansen
  • En Dispatcher eller liknande teknik används för att omdirigera URL:er internt
  • The sling:alias mechanisms finns på plats för resurser
NOTE
Det här gränssnittet bearbetar bara de interna HTML-länkarna från det genererade Target-erbjudandet.

Länkskrivarens providergränssnitt ( ExperienceFragmentLinkRewriterProvider) är följande:

public interface ExperienceFragmentLinkRewriterProvider {

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

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Om du vill använda gränssnittet måste du först skapa ett paket som innehåller en ny tjänstkomponent som implementerar providergränssnittet för Länkskrivare.

Den här tjänsten används för att ansluta till Experience Fragment Export till Target-omskrivning så att den kan komma åt de olika länkarna.

Till exempel: 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;
    }

}

För att tjänsten ska fungera finns det nu tre metoder som måste implementeras i tjänsten:

  • [shouldRewrite](#shouldrewrite)

  • [rewriteLink](#rewritelink)

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

shouldRewrite shouldrewrite

Ange för systemet om länkarna måste skrivas om när ett anrop görs för Exportera till mål för en viss Experience Fragment-variant. Du kan implementera följande metod:

shouldRewrite(ExperienceFragmentVariation experienceFragment);

Till exempel:

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

Den här metoden tar som parameter emot Experience Fragment-variationen som systemet Exportera till mål skriver om.

I exemplet ovan vill du skriva om:

  • länkar finns i src

  • href endast attribut

  • för ett specifikt Experience Fragment:
    /content/experience-fragment/master

Alla andra Experience Fragments som skickas via systemet Export to Target ignoreras och påverkas inte av ändringar som implementeras i den här tjänsten.

För den Experience Fragment-variation som påverkas av omskrivningsprocessen fortsätter den sedan att låta tjänsten hantera omskrivningen av länken. Varje gång en länk påträffas i det interna HTML anropas följande metod:

rewriteLink(String link, String tag, String attribute)

Som indata tar metoden emot parametrarna:

  • link
    The String återgivning av länken som bearbetas. Den här representationen är vanligtvis en relativ URL som pekar på resursen på författarinstansen.

  • tag
    Namnet på det HTML-element som bearbetas.

  • attribute
    Det exakta attributnamnet.

Om systemet Exportera till mål bearbetar det här elementet kan du definiera CSSInclude as:

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

Anropet till rewriteLink() metoden utförs med följande parametrar:

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

När du skapar tjänsten baseras dina beslut på angivna indata och skriver sedan om länken i enlighet med detta.

Du vill till exempel ta bort /etc.clientlibs del av URL-adressen och lägg till lämplig extern domän. För att förenkla saker och ting bör du tänka på att du har tillgång till en resurslösare för tjänsten, som i rewriteLinkExample2:

NOTE
Mer information om hur du hämtar en resurslösare via en tjänstanvändare finns i 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
Om ovanstående metod returnerar nulllämnar Export to Target-systemet länken som den är, som en relativ länk till en resurs.

Prioriteringar - getPriority priorities-getpriority

Det är inte ovanligt att flera tjänster behövs för olika typer av upplevelsefragment, eller till och med för att ha en allmän tjänst som hanterar externalisering och mappning för alla Experience Fragments. I dessa fall kan konflikter uppstå om vilken tjänst som ska användas, så AEM ger möjlighet att definiera Prioriteringar för olika tjänster. Prioriteringarna anges med hjälp av metoden:

  • getPriority()

Den här metoden tillåter användning av flera tjänster där shouldRewrite() returnerar true för samma Experience Fragment. Tjänsten som returnerar det högsta talet från sin getPriority()-metoden är den tjänst som hanterar Experience Fragment-variationen.

Du kan till exempel ha en GenericLinkRewriterProvider som hanterar den grundläggande mappningen för alla Experience Fragments och när shouldRewrite() metodreturer true för alla Experience Fragment Variations. För flera specifika Experience Fragments kanske du vill ha specialhantering, så i det här fallet kan du ange en SpecificLinkRewriterProvider som shouldRewrite() metoden returnerar bara true för vissa Experience Fragment-variationer. Se till att SpecificLinkRewriterProvider väljs för att hantera dessa Experience Fragment-variationer, måste returneras i getPriority() metod ett högre tal än GenericLinkRewriterProvider.

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