Frammenti di esperienza

Ultimo aggiornamento: 2024-02-07

Nozioni di base

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:

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

Poiché non esiste /libs/cq/experience-fragments/components/xfpage/xfpage.html ritorna a

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

Rendering HTML semplice

Utilizzo di .plain. nell’URL, puoi accedere alla rappresentazione 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:

  • del tipo: src, href, o action

  • oppure termina con: -src, o -href

Ad esempio:

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

NOTA

I collegamenti fanno sempre riferimento all’istanza Publish. Vengono utilizzati da terze parti, pertanto il collegamento viene sempre chiamato dall’istanza Publish, non dall’istanza Author.

Per ulteriori informazioni, consulta Esternalizzazione degli URL.

xf-14

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

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

Configurazione della generazione della rappresentazione HTML

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:

  • allowedCssClasses
    • Un’espressione RegEx che corrisponde alle classi CSS che devono essere lasciate nella rappresentazione finale.
    • Questa funzione è utile se il cliente desidera eliminare alcune classi CSS specifiche
  • allowedTags
    • Elenco di tag HTML consentiti nella rappresentazione finale.
    • Per impostazione predefinita sono consentiti i seguenti tag (non è necessaria alcuna configurazione): html, head, title, body, img, p, span, ul, li, a, b, i, em, strong, h1, h2, h3, h4, h5, h6, br, noscript, div, link e script

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

Varianti social

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à:

  • Per estrarre l'immagine

    • fileReference
    • fileName
  • Per estrarre il testo

    • text

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

Modelli per frammenti esperienza

ATTENZIONE

Solo modelli modificabili sono supportate per i frammenti di esperienza.

Quando sviluppi un nuovo modello per Frammenti esperienza, puoi seguire le procedure standard per un’applicazione modello modificabile.

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

  1. Entrambi:

    1. Il tipo di risorsa del modello (nodo iniziale) deve ereditare da:

      cq/experience-fragments/components/xfpage

    2. Il nome del modello deve iniziare con:

      experience-fragments
      Questo consente agli utenti di creare frammenti di esperienza in /content/experience-fragments come cq:allowedTemplates Questa proprietà della cartella include tutti i modelli i cui nomi iniziano con experience-fragment. I clienti possono aggiornare questa proprietà per includere il proprio schema di denominazione o le posizioni dei modelli.

  2. Modelli consentiti può essere configurato nella console Frammenti di esperienza.

Componenti per frammenti esperienza

Sviluppo di componenti per l’utilizzo con/in Frammenti di esperienza, segui le procedure standard.

L’unica configurazione aggiuntiva consiste nel garantire che i componenti siano consentita sul modello, questa operazione viene eseguita con l’Informativa sui contenuti.

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

  • è costituito da un gruppo di componenti con un layout,
  • può esistere indipendentemente da una pagina AEM.

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

Utilizzo di Esporta in Target funzionalità, è possibile:

  • creare un frammento esperienza,
  • aggiungervi componenti,
  • e quindi esportarla come offerta Adobe Target, in formato HTML o JSON.

Questa funzione può essere abilitato 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:

  1. Il html, head, e body gli elementi vengono sostituiti con div elementi. Il meta, noscript e title elementi vengono rimossi (sono elementi figlio dell'originale) head e non vengono considerati quando viene sostituito dall'elemento div elemento ).

    Questo viene fatto per garantire che l’offerta HTML Target possa essere inclusa nelle attività di Target.

  2. L’AEM modifica eventuali collegamenti interni presenti nel HTML in modo che puntino a una risorsa pubblicata.

    Per determinare i collegamenti da modificare, AEM segue questo modello per gli attributi degli elementi HTML:

    1. src attributi
    2. href attributi
    3. *-src attributi (come data-src, custom-src e così via)
    4. *-href attributi (come data-href, custom-href, img-hrefe così via)
    NOTA

    In genere, i collegamenti interni nelle HTML sono collegamenti relativi, ma in alcuni casi i componenti personalizzati forniscono URL completi nelle HTML. Per impostazione predefinita, l’AEM ignora questi URL completi e non apporta modifiche.

    I collegamenti in questi attributi vengono eseguiti tramite AEM Link Externalizer publishLink() per ricreare l’URL come se si trovasse in un’istanza pubblicata e come tale, disponibile al pubblico.

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:

  • Mappatura Sling disponibile solo nell’istanza Publish
  • Reindirizzamenti di Dispatcher

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

NOTA

Questa interfaccia è stata introdotta in AEM 6.5 SP1 (6.5.1.0).

Per i casi più complicati, non coperti dal predefinito, AEM offre l’interfaccia Link Rewriter Provider. Questo è un 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:

  • Le mappature Sling sono abilitate nelle istanze di pubblicazione, ma non nell’istanza di authoring
  • Un dispatcher o una tecnologia simile viene utilizzata per reindirizzare gli URL internamente
  • Ci sono sling:alias mechanisms disponibile per le risorse
NOTA

Questa interfaccia elabora solo i collegamenti HTML interni dall’offerta Target generata.

Interfaccia del provider del rewriter di collegamento ( ExperienceFragmentLinkRewriterProvider) è il seguente:

public interface ExperienceFragmentLinkRewriterProvider {

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

    boolean shouldRewrite(ExperienceFragmentVariation experienceFragment);

    int getPriority();

}

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)

  • [rewriteLink](#rewritelink)

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

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:

  • collegamenti presenti in src

  • href solo attributi

  • per un frammento di esperienza specifico:
    /content/experience-fragment/master

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.

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:

  • link
    Il String rappresentazione del collegamento in fase di elaborazione. In genere si tratta di un URL relativo che punta alla risorsa nell’istanza di authoring.

  • tag
    Nome dell'elemento HTML in fase di elaborazione.

  • attribute
    Il nome esatto dell’attributo.

Ad esempio, se il sistema Export to Target elabora questo elemento, puoi definire CSSInclude come:

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

La chiamata al rewriteLink() viene eseguito 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, desideriamo rimuovere il /etc.clientlibs parte dell’URL e aggiungi il dominio esterno appropriato. Per semplificare le operazioni, considereremo di avere accesso a un Resource Resolver per il servizio, come in rewriteLinkExample2:

NOTA

Per ulteriori informazioni su come ottenere un risolutore risorse tramite un utente del servizio, consulta Utenti di servizi in 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;
}
NOTA

Se il metodo precedente restituisce null, quindi il sistema di esportazione in Target lascia il collegamento così com’è, un collegamento relativo a una risorsa.

Priorità - 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 sorgere conflitti sul servizio da utilizzare, per cui l'AEM fornisce la possibilità di definire Priorità per diversi servizi. Le priorità sono specificate utilizzando il metodo:

  • getPriority()

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

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

In questa pagina