Frammenti di esperienza experience-fragments

Nozioni di base the-basics

Un frammento esperienza è un gruppo di uno o più componenti, inclusi il contenuto e il layout, a cui è possibile fare riferimento all'interno delle pagine.

Un elemento Principale e/o Variante del frammento esperienza utilizza:

Poiché non è presente alcun /libs/cq/experience-fragments/components/xfpage/xfpage.html, viene ripristinato

Rendering HTML semplice the-plain-html-rendition

Utilizzando il selettore .plain. nell'URL, puoi accedere alla rappresentazione di HTML semplice.

È disponibile dal browser, ma il suo scopo principale è quello di consentire ad altre applicazioni (ad esempio, applicazioni web di terze parti o implementazioni personalizzate per dispositivi mobili) di accedere ai contenuti del frammento esperienza direttamente dall’URL.

La rappresentazione HTML semplice aggiunge il protocollo, l’host e il percorso di contesto ai percorsi seguenti:

Ad esempio:

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

Il selettore di rendering semplice utilizza un trasformatore invece di script aggiuntivi; come trasformatore viene utilizzato il rewriter Sling. È configurato in

Configurazione della generazione della rappresentazione HTML configuring-html-rendition-generation

Il rendering HTML viene generato utilizzando le pipeline del rewriter di Sling. La pipeline è definita in /libs/experience-fragments/config/rewriter/experiencefragments. Il trasformatore HTML supporta le seguenti opzioni:

Si consiglia di configurare il rewriter utilizzando una sovrapposizione. Vedi Sovrapposizioni

Varianti social social-variations

Le varianti social possono essere pubblicate sui social media (testo e immagine). In Adobe Experience Manager (AEM) queste varianti social possono contenere componenti, ad esempio componenti di testo e di immagine.

L’immagine e il testo per il post social possono essere ripresi da qualsiasi tipo di risorsa immagine o tipo di risorsa testo a qualsiasi livello di profondità (nel blocco predefinito o nel contenitore di layout).

Le varianti social consentono anche di creare elementi di base e tenerne conto quando si eseguono azioni social (nell’ambiente di pubblicazione).

Per pubblicare il testo e l’immagine corretti sul social network, è necessario rispettare alcune convenzioni se si sviluppano componenti personalizzati.

A questo scopo, è necessario utilizzare le seguenti proprietà:

I componenti che non utilizzano questa convenzione non vengono presi in considerazione.

Modelli per frammenti esperienza templates-for-experience-fragments

Durante lo sviluppo di un nuovo modello per Frammenti esperienza, puoi seguire le procedure standard per un modello modificabile.

Per creare un modello di frammento esperienza rilevato dalla procedura guidata Crea frammento esperienza, è necessario seguire uno dei seguenti set di regole:

Componenti per frammenti esperienza components-for-experience-fragments

Lo sviluppo di componenti da utilizzare con/in Frammenti di esperienza è conforme alle procedure standard.

L'unica configurazione aggiuntiva consiste nel garantire che i componenti siano consentiti nel modello. A tale scopo, utilizzare Criteri contenuto.

Provider rewriter collegamento frammento esperienza - HTML the-experience-fragment-link-rewriter-provider-html

In AEM hai la possibilità di creare Frammenti esperienza. Un frammento di esperienza:

Uno dei casi d’uso per tali gruppi è l’incorporamento di contenuto in punti di contatto di terze parti, ad esempio Adobe Target.

Riscrittura collegamento predefinita default-link-rewriting

Utilizzando la funzionalità Esporta in Target, è possibile:

Questa funzionalità può essere abilitata in un'istanza Autore di AEM. Richiede una configurazione Adobe Target valida e configurazioni per Link Externalizer.

Link Externalizer viene utilizzato per determinare gli URL corretti necessari durante la creazione della versione HTML dell’offerta Target, che viene quindi inviata ad Adobe Target. Ciò è necessario in quanto Adobe Target richiede che tutti i collegamenti all’interno dell’offerta HTML di Target siano accessibili al pubblico; ciò significa che tutte le risorse a cui fanno riferimento i collegamenti e il frammento di esperienza stesso devono essere pubblicati prima di poter essere utilizzati.

Per impostazione predefinita, quando crei un’offerta Target HTML, viene inviata una richiesta a un selettore Sling personalizzato nell’AEM. Questo selettore si chiama .nocloudconfigs.html. Come suggerisce il nome, viene creato un rendering HTML semplice di un frammento di esperienza, ma non sono incluse le configurazioni cloud (che sarebbero informazioni superflue).

Dopo aver generato la pagina HTML, la pipeline del rewriter di Sling apporta modifiche all’output:

Quando si utilizza un’implementazione standard, il processo descritto sopra deve essere sufficiente per generare l’offerta Target dal frammento di esperienza e quindi esportarla in Adobe Target. Tuttavia, esistono alcuni casi d’uso che non sono presi in considerazione in questo processo, tra cui:

Per questi casi d’uso, AEM fornisce l’interfaccia Link Rewriter Provider.

Collega interfaccia provider rewriter link-rewriter-provider-interface

Per casi più complessi, non coperti dal default, AEM offre l'interfaccia Link Rewriter Provider. Si tratta di un'interfaccia ConsumerType che puoi implementare nei bundle come servizio. Ignora le modifiche che AEM esegue sui collegamenti interni di un’offerta HTML riprodotta da un frammento di esperienza. Questa interfaccia consente di personalizzare la procedura di riscrittura dei collegamenti interni di HTML in base alle esigenze aziendali.

Esempi di casi d’uso per l’implementazione di questa interfaccia come servizio includono:

Interfaccia provider rewriter collegamento ( ExperienceFragmentLinkRewriterProvider):

public interface ExperienceFragmentLinkRewriterProvider {

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

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

Come utilizzare l'interfaccia del provider del rewriter di collegamento how-to-use-the-link-rewriter-provider-interface

Per utilizzare l’interfaccia, devi innanzitutto creare un bundle contenente un nuovo componente del servizio che implementa l’interfaccia Link Rewriter Provider.

Questo servizio viene utilizzato per collegarsi alla riscrittura del file Esportazione frammento di esperienza in Target per accedere ai vari collegamenti.

Ad esempio, 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;
    }

}

Affinché il servizio funzioni, è ora necessario implementare tre metodi all’interno del servizio:

shouldRewrite shouldrewrite

Devi indicare al sistema se è necessario riscrivere i collegamenti quando viene effettuata una chiamata per l’esportazione in Target per una determinata variante del frammento di esperienza. Per farlo, implementa il metodo:

shouldRewrite(ExperienceFragmentVariation experienceFragment);

Ad esempio:

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

Questo metodo riceve come parametro la variante del frammento di esperienza che il sistema di esportazione in Target sta riscrivendo.

Nell’esempio precedente, vorremmo riscrivere:

Qualsiasi altro frammento di esperienza che passa attraverso il sistema di esportazione in Target viene ignorato e non è interessato dalle modifiche implementate in questo Servizio.

rewriteLink rewritelink

Per la variante del frammento di esperienza interessata dal processo di riscrittura, verrà quindi consentito al servizio di gestire la riscrittura del collegamento. Ogni volta che si verifica un collegamento in Internal HTML, viene richiamato il seguente metodo:

rewriteLink(String link, String tag, String attribute)

Come input, il metodo riceve i parametri:

Ad esempio, se il sistema di esportazione in Target sta elaborando questo elemento, è possibile definire CSSInclude come:

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

La chiamata al metodo rewriteLink() viene eseguita utilizzando i seguenti parametri:

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

Quando crei il servizio, puoi prendere decisioni in base all’input fornito, quindi riscrivere il collegamento di conseguenza.

Nel nostro esempio, vogliamo rimuovere la parte /etc.clientlibs dell'URL e aggiungere il dominio esterno appropriato. Per semplificare le operazioni, si considererà di avere accesso a un Resource Resolver per il servizio, come 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à - getPriority priorities-getpriority

Non è raro che siano necessari diversi servizi per soddisfare diversi tipi di frammenti esperienza o persino un servizio generico che gestisca l’esternalizzazione e la mappatura di tutti i frammenti esperienza. In questi casi, potrebbero verificarsi conflitti sul servizio da utilizzare, pertanto l'AEM offre la possibilità di definire Priorità per servizi diversi. Le priorità sono specificate utilizzando il metodo:

Questo metodo consente di utilizzare diversi servizi in cui il metodo shouldRewrite() restituisce true per lo stesso frammento di esperienza. Il servizio che restituisce il numero più alto dal relativo metodo getPriority() è il servizio che gestisce la variante del frammento di esperienza.

Ad esempio, puoi avere un GenericLinkRewriterProvider che gestisce la mappatura di base per tutti i frammenti di esperienza e quando il metodo shouldRewrite() restituisce true per tutte le varianti di frammenti di esperienza. Per diversi frammenti di esperienza specifici, potrebbe essere utile una gestione speciale. In questo caso, puoi fornire SpecificLinkRewriterProvider per il quale il metodo shouldRewrite() restituisce true solo per alcune varianti di frammenti di esperienza. Per assicurarsi che SpecificLinkRewriterProvider sia scelto per gestire tali varianti di frammenti esperienza, deve restituire nel suo metodo getPriority() un numero maggiore di GenericLinkRewriterProvider.