Upplevelsefragment experience-fragments

Grunderna the-basics

Ett 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 och/eller Variant använder:

Eftersom det inte finns någon /libs/cq/experience-fragments/components/xfpage/xfpage.html återgår den till

The Plain HTML Rendition the-plain-html-rendition

Du kan använda väljaren .plain. i URL:en för att få åtkomst till renderingen HTML.

Detta är tillgängligt från webbläsaren, men dess primära syfte är 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:

Till exempel:

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

Väljaren för ren återgivning använder en transformator i stället för ytterligare skript. Sling Rewriter används som transformator. Detta är konfigurerat på

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

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

Vi rekommenderar att du konfigurerar omskrivaren med en övertäckning. Se Övertäckningar

Sociala variationer social-variations

Sociala varianter kan publiceras på sociala medier (text och bild). I Adobe Experience Manager (AEM) kan dessa sociala varianter innehålla komponenter, till exempel textkomponenter och bildkomponenter.

Bilden och texten för det sociala inlägget kan hämtas från alla bildresurstyper eller textresurstyper på alla djupnivåer (antingen i byggblocket eller layoutbehållaren).

Sociala variationer möjliggör också byggstenar och tar hänsyn till dem vid sociala åtgärder (i publiceringsmiljön).

För att kunna publicera rätt text och bild i sociala medier måste vissa konventioner respekteras om du utvecklar egna anpassade komponenter.

För detta måste följande egenskaper användas:

Komponenter som inte använder den här konventionen beaktas inte.

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

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

Om du vill skapa en upplevelsefragmentmall som identifieras av guiden Skapa Experience Fragment måste du följa någon av dessa regeluppsättningar:

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

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

Den enda ytterligare konfigurationen är att se till att komponenterna är tillåtna i mallen, vilket uppnås med innehållsprincipen.

Experience Fragment Link Rewriter Provider - HTML the-experience-fragment-link-rewriter-provider-html

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

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.

Omskrivning av standardlänk default-link-rewriting

Med funktionen Exportera till mål kan du:

Den här funktionen kan vara aktiverad på 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. Detta är nödvändigt eftersom Adobe Target kräver att alla länkar i Target HTML-erbjudandet ska vara tillgängliga för allmänheten, vilket innebär att alla resurser som länkreferensen 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 kallas .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 ändrar Sling Rewriter-flödet utdata:

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ändningsområden som inte ingår i den här processen. Exempel:

I sådana fall AEM tillhandahåller länkskrivarens providergränssnitt.

Länk Rewriter-providergränssnitt link-rewriter-provider-interface

För mer komplicerade fall, som inte täcks av standard, erbjuder AEM Länkskrivarleverantörens gränssnitt. Det här är ett ConsumerType-gränssnitt som du kan implementera i dina 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:

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();

}

Så här använder du providergränssnittet Länkskrivare how-to-use-the-link-rewriter-provider-interface

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 för att få tillgång till de olika länkarna.

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

Du måste ange för systemet om länkarna behöver skrivas om när du anropar Exportera till mål för en viss Experience Fragment-variation. Detta gör du genom att implementera metoden:

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 den Experience Fragment-variation som systemet Exportera till mål för närvarande skriver om.

I exemplet ovan vill vi skriva om:

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.

rewriteLink rewritelink

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:

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

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

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

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

När du skapar tjänsten kan du fatta beslut baserat på angivna indata och sedan skriva om länken i enlighet med detta.

Vi vill till exempel ta bort delen /etc.clientlibs i URL:en och lägga till den externa domänen. För att förenkla saker och ting anser vi att vi har tillgång till en resurslösare för din tjänst, som i 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;
}

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 prioritet för olika tjänster. Prioriteringarna anges med hjälp av metoden:

Den här metoden tillåter användning av flera tjänster där metoden shouldRewrite() returnerar true för samma Experience Fragment. Tjänsten som returnerar det högsta antalet från sin getPriority()-metod ä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 metoden shouldRewrite() returnerar 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 metoden shouldRewrite() bara returnerar true för vissa Experience Fragment-variationer. Om du vill vara säker på att SpecificLinkRewriterProvider har valts för att hantera dessa Experience Fragment-variationer måste det returnera ett högre tal i sin getPriority()-metod än GenericLinkRewriterProvider.