Sviluppo di un componente personalizzato per AEM Screens

L’esercitazione seguente illustra i passaggi necessari per creare un componente personalizzato per AEM Screens. AEM Screens riutilizza molti modelli di progettazione e tecnologie esistenti di altri prodotti AEM. L'esercitazione evidenzia differenze e considerazioni speciali nello sviluppo per AEM Screens.

Panoramica

Questa esercitazione è destinata agli sviluppatori che hanno familiarità con AEM Screens. In questa esercitazione viene creato un semplice componente "Hello World" per un canale Sequenza in AEM Screens. Una finestra di dialogo consente agli autori di aggiornare il testo visualizzato.

overviwhellow

Prerequisiti

Per completare questa esercitazione, è necessario effettuare le seguenti operazioni:

  1. AEM 6.5 o AEM 6.3 + Ultimi pacchetti di funzioni per schermi

  2. Lettore AEM Screens

  3. Ambiente di sviluppo locale

I passaggi dell'esercitazione e le schermate vengono eseguiti utilizzando CRXDE-Lite. Gli IDE possono essere utilizzati anche per completare l'esercitazione. Ulteriori informazioni sull'utilizzo di un IDE per sviluppare con AEM sono disponibili qui.

Configurazione del progetto

Il codice sorgente di un progetto Screens viene generalmente gestito come progetto Maven multi-modulo. Per accelerare l'esercitazione, un progetto è stato pre-generato utilizzando il AEM Project Archetype 13. Maggiori dettagli sulla creazione di un progetto con Maven AEM Project Archetype sono disponibili qui.

  1. Scaricate e installate i pacchetti seguenti utilizzando CRX package manager:

    Ottieni file

    Ottieni file
    Se si utilizza Eclipse o un altro IDE, è possibile scaricare il pacchetto sorgente riportato di seguito. Distribuite il progetto in un'istanza AEM locale utilizzando il comando Paradiso:

    mvn -PautoInstallPackage clean install

    Start HelloWorld SRC Screens We.Retail Run Project

    Ottieni file

  2. In CRX Package Manager verificare che siano installati i due pacchetti seguenti:

    1. screens-weretail-run.ui.co-0.0.1-SNAPSHOT.zip
    2. screens-weretail-run.ui.apps-0.0.1-SNAPSHOT.zip

    Schermi I.Retail Run I pacchetti Ui.Apps e Ui.Content installati tramite CRX Package Manager

    Schermi I.Retail Run I pacchetti Ui.Apps e Ui.Content installati tramite CRX Package Manager

  3. Il pacchetto screens-weretail-run.ui.apps installa il codice sotto /apps/weretail-run.

    Questo pacchetto contiene il codice responsabile per il rendering dei componenti personalizzati per il progetto. Questo pacchetto include il codice del componente ed eventuali codice JavaScript o CSS necessari. Questo pacchetto include anche screens-weretail-run.core-0.0.1-SNAPSHOT.jar, che contiene qualsiasi codice Java necessario per il progetto.

    NOTA

    In questa esercitazione non viene scritto alcun codice Java. Se è necessaria una logica aziendale più complessa, è possibile creare e distribuire Java back-end utilizzando il pacchetto Java di base.

    Rappresentazione del codice ui.apps nel CRXDE Lite

    Rappresentazione del codice ui.apps nel CRXDE Lite

    Il componente helloworld attualmente è solo un segnaposto. Durante l’esercitazione, verranno aggiunte funzionalità che consentono all’autore di aggiornare il messaggio visualizzato dal componente.

  4. Il pacchetto screens-weretail-run.ui.content installa il codice sotto:

    • /conf/we-retail-run
    • /content/dam/we-retail-run
    • /content/screens/we-retail-run

    Questo pacchetto contiene il contenuto iniziale e la struttura di configurazione necessarie per il progetto. /conf/we-retail-run contiene tutte le configurazioni per il progetto We.Retail Run. /content/dam/we-retail-run include l'avvio di risorse digitali per il progetto. /content/screens/we-retail-run contiene la struttura del contenuto Screens. Il contenuto al di sotto di tutti questi percorsi viene aggiornato principalmente in AEM. Per promuovere la coerenza tra gli ambienti (locale, Dev, Stage, Prod) spesso viene salvata una struttura di contenuto di base nel controllo del codice sorgente.

  5. Andate al progetto AEM Screens > Esecuzione We.Retail:

    Dal menu di avvio AEM > Fare clic sull'icona Schermate. Verificare che il progetto di esecuzione We.Retail sia visibile.

    antipasto a catena

Creare il componente Hello World

Il componente Hello World è un componente semplice che consente a un utente di inserire un messaggio da visualizzare sullo schermo. Il componente si basa sul modello di componente AEM Screens: https://github.com/Adobe-Marketing-Cloud/aem-screens-component-template.

AEM Screens presenta alcuni vincoli interessanti che non sono necessariamente validi per i componenti WCM Sites tradizionali.

  • La maggior parte dei componenti Screens deve essere eseguita a schermo intero sui dispositivi di digital signage di destinazione
  • La maggior parte dei componenti Screens devono essere incorporati nei canali delle sequenze per generare presentazioni
  • L’authoring dovrebbe consentire la modifica di singoli componenti in un canale di sequenza, per cui il rendering a schermo intero non è più una questione
  1. In CRXDE-Lite http://localhost:4502/crx/de/index.jsp (o IDE) passare a /apps/weretail-run/components/content/helloworld.

    Aggiungete le seguenti proprietà al componente helloworld:

        jcr:title="Hello World"
        sling:resourceSuperType="foundation/components/parbase"
        componentGroup="We.Retail Run - Content"
    

    Proprietà per /apps/weretail-run/components/content/helloworld

    Proprietà per /apps/weretail-run/components/content/helloworld

    Il componente helloworld estende il componente foundation/components/parbase in modo che possa essere utilizzato correttamente all'interno di un canale di sequenza.

  2. Creare un file sotto /apps/weretail-run/components/content/helloworld denominato helloworld.html.

    Compilate il file con le seguenti opzioni:

    <!--/*
    
     /apps/weretail-run/components/content/helloworld/helloworld.html
    
    */-->
    
    <!--/* production: preview authoring mode + unspecified mode (i.e. on publish) */-->
    <sly data-sly-test.production="${wcmmode.preview || wcmmode.disabled}" data-sly-include="production.html" />
    
    <!--/* edit: any other authoring mode, i.e. edit, design, scaffolding, etc. */-->
    <sly data-sly-test="${!production}" data-sly-include="edit.html" />
    

    I componenti Screens richiedono due diversi rendering a seconda della modalità di creazione authoring utilizzata:

    1. Produzione: Modalità Anteprima o Pubblicazione (wcmmode=disabled)
    2. Modifica: utilizzato per tutte le altre modalità di authoring, ad esempio modifica, progettazione, scaffolding, sviluppatore…

    helloworld.htmlfunge da interruttore, verificando quale modalità di authoring è attualmente attiva e reindirizzando l’utente a un altro script HTL. Una convenzione comune utilizzata dai componenti schermate consiste nell'avere uno script edit.html per la modalità Modifica e uno script production.html per la modalità Produzione.

  3. Creare un file sotto /apps/weretail-run/components/content/helloworld denominato production.html.

    Compilate il file con le seguenti opzioni:

    <!--/*
     /apps/weretail-run/components/content/helloworld/production.html
    
    */-->
    
    <div data-duration="${properties.duration}" class="cmp-hello-world">
     <h1 class="cmp-hello-world__message">${properties.message}</h1>
    </div>
    

    Qui di seguito è riportato il markup di produzione per il componente Hello World. È incluso un attributo data-duration poiché il componente viene utilizzato su un canale Sequenza. L'attributo data-duration viene utilizzato dal canale della sequenza per sapere per quanto tempo deve essere visualizzato un elemento della sequenza.

    Il componente riproduce un tag div e h1 con testo. ${properties.message} è una parte dello script HTL che genera il contenuto di una proprietà JCR denominata message. Successivamente viene creata una finestra di dialogo che consente all'utente di immettere un valore per il testo della proprietà message.

    Inoltre, con il componente viene utilizzata la notazione BEM (Modificatore elemento blocco). BEM è una convenzione di codifica CSS che semplifica la creazione di componenti riutilizzabili. BEM è la notazione utilizzata da AEM componenti core. Maggiori informazioni sono disponibili all'indirizzo: https://getbem.com/

  4. Creare un file sotto /apps/weretail-run/components/content/helloworld denominato edit.html.

    Compilate il file con le seguenti opzioni:

    <!--/*
    
     /apps/weretail-run/components/content/helloworld/edit.html
    
    */-->
    
    <!--/* if message populated */-->
    <div
     data-sly-test.message="${properties.message}"
     class="aem-Screens-editWrapper cmp-hello-world">
     <p class="cmp-hello-world__message">${message}</p>
    </div>
    
    <!--/* empty place holder */-->
    <div data-sly-test="${!message}"
         class="aem-Screens-editWrapper cq-placeholder cmp-hello-world"
         data-emptytext="${'Hello World' @ i18n, locale=request.locale}">
    </div>
    

    Sopra è riportata la marcatura di modifica per il componente Hello World. Il primo blocco visualizza una versione di modifica del componente se il messaggio della finestra di dialogo è stato popolato.

    Se non è stato immesso alcun messaggio di dialogo, viene eseguito il rendering del secondo blocco. Le cq-placeholder e data-emptytext eseguono il rendering dell'etichetta Hello World come segnaposto in quel caso. La stringa per l’etichetta può essere internazionalizzata utilizzando i18n per supportare l’authoring in più lingue.

  5. Copia schermata Finestra di dialogo immagine da utilizzare per il componente Hello World.

    È più semplice iniziare da una finestra di dialogo esistente e apportare quindi modifiche.

    1. Copiate la finestra di dialogo da: /libs/screens/core/components/content/image/cq:dialog
    2. Incolla la finestra di dialogo sotto /apps/weretail-run/components/content/helloworld

    copy-image-dialog

  6. Aggiorna Hello World, finestra di dialogo per includere una scheda per il messaggio.

    Aggiornate la finestra di dialogo in modo che corrisponda a quanto segue. La struttura del nodo JCR della finestra di dialogo finale è presentata di seguito in XML:

    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
        jcr:primaryType="nt:unstructured"
        jcr:title="Hello World"
        sling:resourceType="cq/gui/components/authoring/dialog">
        <content
            jcr:primaryType="nt:unstructured"
            sling:resourceType="granite/ui/components/coral/foundation/tabs"
            size="L">
            <items jcr:primaryType="nt:unstructured">
                <message
                    jcr:primaryType="nt:unstructured"
                    jcr:title="Message"
                    sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                    <items jcr:primaryType="nt:unstructured">
                        <column
                            jcr:primaryType="nt:unstructured"
                            sling:resourceType="granite/ui/components/coral/foundation/container">
                            <items jcr:primaryType="nt:unstructured">
                                <message
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
                                    fieldDescription="Message for component to display"
                                    fieldLabel="Message"
                                    name="./message"/>
                            </items>
                        </column>
                    </items>
                </message>
                <sequence
                    jcr:primaryType="nt:unstructured"
                    jcr:title="Sequence"
                    sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                    <items jcr:primaryType="nt:unstructured">
                        <column
                            jcr:primaryType="nt:unstructured"
                            sling:resourceType="granite/ui/components/coral/foundation/container">
                            <items jcr:primaryType="nt:unstructured">
                                <duration
                                    jcr:primaryType="nt:unstructured"
                                    sling:resourceType="granite/ui/components/coral/foundation/form/numberfield"
                                    defaultValue=""
                                    fieldDescription="Amount of time the image will be shown in the sequence, in milliseconds"
                                    fieldLabel="Duration (ms)"
                                    min="0"
                                    name="./duration"/>
                            </items>
                        </column>
                    </items>
                </sequence>
            </items>
        </content>
    </jcr:root>
    

    Il campo di testo del messaggio verrà salvato in una proprietà denominata message e che il campo numerico per la durata verrà salvato in una proprietà denominata duration. A queste due proprietà viene fatto riferimento in /apps/weretail-run/components/content/helloworld/production.html da HTL come ${properties.message} e ${properties.duration}.

    Hello World - finestra di dialogo completata

    Hello World - finestra di dialogo completata

Creare librerie lato client

Le librerie lato client forniscono un meccanismo per organizzare e gestire i file CSS e JavaScript necessari per un'implementazione AEM.

i componenti AEM Screens vengono sottoposti a rendering in modo diverso in modalità Modifica rispetto alla modalità Anteprima/Produzione. Verranno create due librerie client, una per la modalità di modifica e una per l'anteprima/produzione.

  1. Create una cartella per le librerie lato client per il componente Hello World.

    Sotto /apps/weretail-run/components/content/helloworldcreare una nuova cartella denominata clientlibs.

    2018-04-30_at_1046am

  2. Sotto la cartella clientlibs create un nuovo nodo denominato shared di tipo cq:ClientLibraryFolder.

    2018-04-30_at_1115am

  3. Aggiungete le seguenti proprietà alla libreria client condivisa:

    • allowProxy | Booleano | true

    • categories| Stringa[] | cq.screens.components

    Proprietà per /apps/weretail-run/components/content/helloworld/clientlibs/shared

    Proprietà per /apps/weretail-run/components/content/helloworld/clientlibs/shared

    La proprietà category è una stringa che identifica la libreria client. La categoria cq.screens.component viene utilizzata nelle modalità Modifica e Anteprima/Produzione. Pertanto, qualsiasi CSS/JS definito in sharedclientlib viene caricato in tutte le modalità.

    È consigliabile non esporre mai alcun percorso direttamente alle /app in un ambiente di produzione. La proprietà allowProxy assicura che alla libreria client venga fatto riferimento CSS e JS tramite un prefisso of/etc.clientlibs.

  4. Create un file denominato css.txt sotto la cartella condivisa.

    Compilate il file con le seguenti opzioni:

    #base=css
    
    styles.less
    
  5. Create una cartella denominata css sotto la cartella shared. Aggiungete un file denominato style.less sotto la cartella css. La struttura delle librerie client deve ora essere simile alla seguente:

    2018-04-30_at_3_11pm

    Invece di scrivere CSS direttamente, questa esercitazione utilizza LESS. LESS è un popolare precompilatore CSS che supporta variabili, mixin e funzioni CSS. AEM librerie client supportano in modo nativo la compilazione LESS. Sass o altri precompilatori possono essere utilizzati ma devono essere compilati al di fuori di AEM.

  6. Compilare /apps/weretail-run/components/content/helloworld/clientlibs/shared/css/styles.less con i seguenti elementi:

    /**
        Shared Styles
       /apps/weretail-run/components/content/helloworld/clientlibs/shared/css/styles.less
    
    **/
    
    .cmp-hello-world {
        background-color: #fff;
    
     &__message {
      color: #000;
      font-family: Helvetica;
      text-align:center;
     }
    }
    
  7. Copiate e incollate la cartella della libreria client shared per creare una nuova libreria client denominata production.

    Copiare la libreria client condivisa per creare una nuova libreria client di produzione

    Copiare la libreria client condivisa per creare una nuova libreria client di produzione

  8. Aggiornare la proprietà categories della clientlibrary di produzione affinché sia cq.screens.components.production.

    In questo modo gli stili vengono caricati solo in modalità Anteprima/Produzione.

    Proprietà per /apps/weretail-run/components/content/helloworld/clientlibs/production

    Proprietà per /apps/weretail-run/components/content/helloworld/clientlibs/production

  9. Compilare /apps/weretail-run/components/content/helloworld/clientlibs/production/css/styles.less con i seguenti elementi:

    /**
        Production Styles
       /apps/weretail-run/components/content/helloworld/clientlibs/production/css/styles.less
    
    **/
    .cmp-hello-world {
    
        height: 100%;
        width: 100%;
        position: fixed;
    
     &__message {
    
      position: relative;
      font-size: 5rem;
      top:25%;
     }
    }
    

    Gli stili di cui sopra visualizzeranno il messaggio centrato al centro dello schermo, ma solo in modalità di produzione.

Una terza categoria di clientlibrary: È possibile utilizzare cq.screens.components.edit per aggiungere al componente stili specifici di sola modifica.

Categoria Clientlib Utilizzo
cq.screens.components Stili e script condivisi tra modalità di modifica e produzione
cq.screens.components.edit Stili e script utilizzati solo in modalità di modifica
cq.screens.components.production Stili e script utilizzati solo in modalità di produzione

Creare una pagina di progettazione

AEM Screens utilizza modelli di pagina statici e configurazioni di progettazione per le modifiche globali. Le configurazioni di progettazione vengono spesso utilizzate per configurare i componenti consentiti per Parsys su un canale. Una procedura consigliata consiste nell'archiviare queste configurazioni in un modo specifico per l'app.

Sotto viene creata una pagina di progettazione di esecuzione We.Retail per memorizzare tutte le configurazioni specifiche del progetto We.Retail Run.

  1. In CRXDE-Lite http://localhost:4502/crx/de/index.jsp#/apps/settings/wcm/designs passare a /apps/settings/wcm/designs

  2. Create un nuovo nodo sotto la cartella delle progettazioni, denominato we-retail-run con un tipo di cq:Page.

  3. Sotto la pagina we-retail-run, aggiungere un altro nodo denominato jcr:content di tipo nt:unstructured. Aggiungete le seguenti proprietà al nodo jcr:content:

    Nome Tipo Valore
    jcr:title Stringa Esecuzione We.Retail
    sling:resourceType Stringa wcm/core/components/designer
    cq:doctype Stringa html_5

    Pagina di progettazione in /apps/settings/wcm/designs/we-retail-run

    Pagina di progettazione in /apps/settings/wcm/designs/we-retail-run

Creare un canale di sequenza

Il componente Hello World è destinato all’uso su un canale sequenza. Per testare il componente, viene creato un nuovo canale sequenza.

  1. Dal menu di avvio AEM, andate a Schermi > We.Retail Ru n > e selezionate Canali.

  2. Fare clic sul pulsante Crea

    1. Scegliere Crea entità

    2018-04-30_at_5_18pm

  3. Nella procedura guidata Crea:

  4. Passaggio modello - scegliere Canale sequenza

    1. Passaggio proprietà
    • Scheda di base > Titolo = Canale inattivo
    • Scheda Canale > selezionare Rendi canale online

    canale inattivo

  5. Aprite le proprietà della pagina per il canale inattivo. Aggiornate il campo Progettazione in modo che punti a /apps/settings/wcm/designs/we-retail-run,la pagina di progettazione creata nella sezione precedente.

    Configurazione di progettazione /apps/settings/wcm/designs/we-retail-run

    Configurazione di progettazione che punta a /apps/settings/wcm/designs/we-retail-run

  6. Modificate il canale inattivo appena creato per aprirlo.

  7. Passa alla modalità Progettazione

    1. Fare clic sull'icona chiave inglese in Parsys per configurare i componenti consentiti

    2. Selezionare il gruppo Screens e il gruppo We.Retail Run - Content.

    2018-04-30_at_5_43pm

  8. Passate alla modalità pagina su Modifica. È ora possibile aggiungere il componente Hello World alla pagina e combinarlo con altri componenti per canali di sequenza.

    2018-04-30_at_5_53pm

  9. In CRXDE-Lite http://localhost:4502/crx/de/index.jsp#/apps/settings/wcm/designs/we-retail-run/jcr%3Acontent/sequencechannel/par passare a /apps/settings/wcm/designs/we-retail-run/jcr:content/sequencechannel/par. Notate che la proprietà components ora include group:Screens, group:We.Retail Run - Content.

    Configurazione della progettazione in /apps/settings/wcm/designs/we-retail-run

    Configurazione della progettazione in /apps/settings/wcm/designs/we-retail-run

Modello per gestori personalizzati

Se il componente personalizzato utilizza risorse esterne come risorse (immagini, video, font, icone, ecc.), rappresentazioni di risorse specifiche o librerie lato client (css, js, ecc.), queste non vengono aggiunte automaticamente alla configurazione offline, in quanto il bundle solo il codice HTML per impostazione predefinita.

Per consentire di personalizzare e ottimizzare le risorse esatte scaricate nel lettore, offriamo un meccanismo di estensione per i componenti personalizzati per esporre le loro dipendenze alla logica di caching offline in Screens.

La sezione seguente mostra il modello per i gestori di risorse offline personalizzati e i requisiti minimi in pom.xml per quel progetto specifico.

package …;

import javax.annotation.Nonnull;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceUtil;
import org.apache.sling.api.resource.ValueMap;

import com.adobe.cq.screens.visitor.OfflineResourceHandler;

@Service(value = OfflineResourceHandler.class)
@Component(immediate = true)
public class MyCustomHandler extends AbstractResourceHandler {

 @Reference
 private …; // OSGi services injection

 /**
  * The resource types that are handled by the handler.
  * @return the handled resource types
  */
 @Nonnull
 @Override
 public String[] getSupportedResourceTypes() {
     return new String[] { … };
 }

 /**
  * Accept the provided resource, visit and traverse it as needed.
  * @param resource The resource to accept
  */
 @Override
 public void accept(@Nonnull Resource resource) {
     ValueMap properties = ResourceUtil.getValueMap(resource);
     
     /* You can directly add explicit paths for offline caching using the `visit`
        method of the visitor. */
     
     // retrieve a custom property from the component
     String myCustomRenditionUrl = properties.get("myCustomRenditionUrl", String.class);
     // adding that exact asset/rendition/path to the offline manifest
     this.visitor.visit(myCustomRenditionUrl);
     
     
     /* You can delegate handling for dependent resources so they are also added to
        the offline cache using the `accept` method of the visitor. */
     
     // retrieve a referenced dependent resource
     String referencedResourcePath = properties.get("myOtherResource", String.class);
     ResourceResolver resolver = resource.getResourceResolver();
     Resource referencedResource = resolver.getResource(referencedResourcePath);
     // let the handler for that resource handle it
     if (referencedResource != null) {
         this.visitor.accept(referencedResource);
     }
   }
}

Il codice seguente fornisce i requisiti minimi in pom.xml per il progetto specifico:

   <dependencies>
        …
        <!-- Felix annotations -->
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
            <version>1.9.0</version>
            <scope>provided</scope>
        </dependency>

        <!-- Screens core bundle with OfflineResourceHandler/AbstractResourceHandler -->
        <dependency>
            <groupId>com.adobe.cq.screens</groupId>
            <artifactId>com.adobe.cq.screens</artifactId>
            <version>1.5.90</version>
            <scope>provided</scope>
        </dependency>
        …
      </dependencies>

Mettere tutto insieme

Il video seguente mostra il componente finito e come può essere aggiunto a un canale Sequenza. Il canale viene quindi aggiunto alla visualizzazione Posizione e, in ultima istanza, assegnato a un lettore Screens.

Codice finito

Di seguito è riportato il codice finale dell'esercitazione. I screens-weretail-run.ui.apps-0.0.1-SNAPSHOT.zip e screens-weretail-run.ui.content-0.0.1-SNAPSHOT.zip sono i pacchetti AEM compilati. Il SRC-screens-weretail-run-0.0.1.zip è il codice sorgente non compilato che può essere distribuito con Maven.

Ottieni file

Ottieni file

Ottieni file

In questa pagina