Experience Fragments experience-fragments

Grundlagen the-basics

Ein Experience Fragment ist eine Gruppe aus einer oder mehreren Komponenten (einschließlich Inhalt und Layout), die innerhalb von Seiten referenziert werden können.

Ein primäres Experience Fragment, eine andere Variante oder beides verwendet:

Da es kein /libs/cq/experience-fragments/components/xfpage/xfpage.html gibt, wird auf Folgendes zurückgegriffen

Einfache HTML-Ausgabedarstellung the-plain-html-rendition

Mit dem .plain.-Selektor in der URL können Sie auf die einfache HTML-Ausgabe zugreifen.

Diese Ausgabedarstellung ist über den Browser verfügbar. Sie dient jedoch in erster Linie dazu, anderen Anwendungen (beispielsweise Web-Anwendungen von Drittanbietern oder benutzerdefinierte Mobile-Implementierungen) den direkten Zugriff auf den Inhalt des Experience Fragments zu ermöglichen, und zwar allein über die URL.

Die einfache HTML-Ausgabedarstellung fügt das Protokoll, den Host und den Kontextpfad zu Pfaden hinzu, die:

Zum Beispiel:

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

Die Auswahl für einfache Ausgabedarstellungen verwendet einen Transformator im Gegensatz zu zusätzlichen Skripten. Der Sling Rewriter wird als Transformator verwendet. Dieser Transformer wird wie folgt konfiguriert:

Konfigurieren der HTML-Ausgabegenerierung configuring-html-rendition-generation

Die HTML-Ausgabedarstellung wird mit den Sling Rewriter Pipelines erstellt. Die Pipeline ist unter /libs/experience-fragments/config/rewriter/experiencefragments definiert. Der HTML-Transformer unterstützt die folgenden Optionen:

Adobe empfiehlt, den Rewriter mit einer Überlagerung zu konfigurieren. Siehe Überlagerungen in AEM as a Cloud Service.

Vorlagen für Experience Fragments templates-for-experience-fragments

Beim Entwickeln einer neuen Vorlage für Experience Fragments folgen Sie den Standardverfahren für eine bearbeitbare Vorlage.

Um eine Experience Fragment-Vorlage zu erstellen, die vom Assistenten Erstellen von Experience Fragments erkannt wird, müssen Sie einen dieser Regelsätze verfolgen:

Komponenten für Experience Fragments components-for-experience-fragments

Die Entwicklung von Komponenten für die Verwendung mit/in Experience Fragments erfolgt gemäß den üblichen Verfahren.

Die einzige zusätzliche Konfiguration besteht darin sicherzustellen, dass die Komponenten in der Vorlage zulässig sind. Dieses Zertifikat wird mit der Inhaltsrichtlinie erreicht.

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

In AEM haben Sie die Möglichkeit, Experience Fragments zu erstellen. Ein Experience Fragment:

Einer der Anwendungsfälle für solche Gruppen ist das Einbetten von Inhalten in Touchpoints von Dritten, wie z. B. Adobe Target.

Standardmäßige Link-Umschreibung default-link-rewriting

Mit der Funktion „In Target exportieren“ können Sie:

Diese Funktion kann in einer Autoreninstanz von AEM aktiviert werden. Sie erfordert eine gültige Adobe Target-Konfiguration und Konfigurationen für den Link Externalizer.

Der Link Externalizer wird verwendet, um die richtigen URLs zu ermitteln, die beim Erstellen der HTML-Version des Target-Angebots erforderlich sind, die anschließend an Adobe Target gesendet wird. Dieser Vorgang ist notwendig, da Adobe Target voraussetzt, dass alle Links innerhalb des Target-HTML-Angebots öffentlich zugänglich sind. Das bedeutet, dass alle Ressourcen, auf die die Links verweisen, und das Experience Fragment selbst veröffentlicht werden müssen, bevor sie verwendet werden können.

Wenn Sie ein Target-HTML-Angebot erstellen, wird standardmäßig eine Anfrage an einen benutzerdefinierten Sling-Selektor in AEM gesendet. Dieser Selektor heißt .nocloudconfigs.html. Wie der Name schon sagt, erstellt er ein einfaches HTML-Rendering eines Experience Fragment, enthält jedoch keine Cloud-Konfigurationen (die überflüssige Informationen wären).

Nachdem Sie die HTML-Seite generiert haben, wird die Sling Rewriter-Pipeline an die Ausgabe angepasst:

Bei Verwendung einer vordefinierten Implementierung sollte der oben beschriebene Prozess ausreichen, um das Target-Angebot aus dem Experience Fragment zu generieren und es dann in Adobe Target zu exportieren. Es gibt jedoch einige Anwendungsfälle, die in diesem Prozess nicht berücksichtigt werden. Einige dieser Fälle, die nicht berücksichtigt werden, umfassen Folgendes:

Für diese Anwendungsfälle stellt AEM die Link Rewriter Provider-Schnittstelle bereit.

Link Rewriter Provider-Schnittstelle link-rewriter-provider-interface

Für kompliziertere Fälle, die nicht vom Standard abgedeckt werden, bietet AEM die Link Rewriter Provider-Schnittstelle. Diese Schnittstelle ist eine ConsumerType-Schnittstelle, die Sie als Service in Ihren Bundles implementieren können. Sie umgeht die Änderungen, die AEM an internen Links eines HTML-Angebots vornimmt, die aus einem Experience Fragment gerendert wurden. Diese Schnittstelle ermöglicht es Ihnen, das Umschreiben interner HTML-Links an Ihre geschäftlichen Anforderungen anzupassen.

Beispiele für Anwendungsfälle für die Implementierung dieser Schnittstelle als Service:

Die Link Rewriter Provider-Schnittstelle (ExperienceFragmentLinkRewriterProvider) lautet wie folgt:

public interface ExperienceFragmentLinkRewriterProvider {

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

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Verwendung der Link Rewriter Provider-Schnittstelle how-to-use-the-link-rewriter-provider-interface

Um die Schnittstelle zu verwenden, müssen Sie zunächst ein Bundle anlegen, das eine neue Service-Komponente enthält, die die Link Rewriter Provider-Schnittstelle implementiert.

Dieser Service wird verwendet, um das Umschreiben beim Exportieren von Experience Fragments nach Target zu ermöglichen, damit es Zugriff auf die verschiedenen Links hat.

Beispiel: 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;
    }

}

Damit der Service funktioniert, müssen jetzt drei Methoden innerhalb des Service implementiert werden:

shouldRewrite shouldrewrite

Geben Sie dem System an, ob es die Links neu schreiben muss, wenn ein Aufruf für Export nach Target auf einer bestimmten Experience Fragment-Variante erfolgt. Sie können die folgende Methode implementieren:

shouldRewrite(ExperienceFragmentVariation experienceFragment);

Zum Beispiel:

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

Diese Methode erhält als Parameter die Experience Fragment-Variante, die das System „In Target exportieren“ umschreibt.

Im obigen Beispiel möchten Sie Folgendes umschreiben:

Alle anderen Experience Fragments, die das System „In Target exportieren“ durchlaufen, werden ignoriert und sind von den in diesem Service implementierten Änderungen nicht betroffen.

rewriteLink rewritelink

Für die Experience Fragment-Variante, die vom Umschreibungsprozess betroffen ist, wird der Dienst dann die Links umschreiben. Bei jedem Auftreten eines Links im internen HTML-Code wird die folgende Methode aufgerufen:

rewriteLink(String link, String tag, String attribute)

Als Eingabe erhält die Methode die folgenden Parameter:

Wenn beispielsweise das System „In Target exportieren“ dieses Element verarbeitet, können Sie CSSInclude wie folgt definieren:

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

Die rewriteLink()-Methode wird mithilfe der folgenden Parameter aufgerufen:

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

Wenn Sie den Dienst erstellen, können Sie Entscheidungen auf der Grundlage der eingegebenen Daten treffen und dann den Link entsprechend umschreiben.

Für das Beispiel möchten Sie den /etc.clientlibs-Teil der URL entfernen und die entsprechende externe Domain hinzufügen. Um die Dinge einfach zu halten, werden wir in Betracht ziehen, dass Sie Zugriff auf einen Ressource Resolver für Ihren Dienst haben, wie in 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;
}

Prioritäten – getPriority priorities-getpriority

Es ist nicht ungewöhnlich, dass mehrere Service für verschiedene Arten von Experience Fragments benötigt werden oder dass sogar ein generischer Service vorhanden ist, der die Externalisierung und Zuordnung aller Experience Fragments übernimmt. In diesen Fällen kann es zu Konflikten darüber kommen, welcher Service verwendet werden soll, sodass AEM die Möglichkeit bietet, Prioritäten für verschiedene Services festzulegen. Die Prioritäten werden nach folgendem Verfahren festgelegt:

Diese Methode ermöglicht die Verwendung mehrerer Services, bei denen die shouldRewrite()-Methode für dasselbe Experience Fragment „true“ zurückgibt. Der Service, der die höchste Zahl aus der getPriority()-Methode zurückgibt, ist der Service, der die Experience Fragment-Variante verarbeitet.

Beispielsweise können Sie einen GenericLinkRewriterProvider-Service verwenden, der die grundlegende Zuordnung für alle Experience Fragments handhabt und wenn die shouldRewrite() Methode für alle Experience-Fragment-Varianten true zurückgibt. Für mehrere spezifische Experience Fragments ist möglicherweise eine besondere Behandlung erforderlich. In diesem Fall können Sie also einen SpecificLinkRewriterProvider-Service bereitstellen, für den die shouldRewrite()-Methode nur für einige Experience Fragment-Varianten „true“ zurückgibt. Um sicherzustellen, dass SpecificLinkRewriterProvider für die Verarbeitung dieser Experience Fragment-Varianten ausgewählt wird, muss in der getPriority()-Methode eine höhere Zahl zurückgegeben werden als für GenericLinkRewriterProvider.