Guida introduttiva a Edge Delivery Services per moduli AEM utilizzando l’editor universale
Edge Delivery Services per AEM Forms combina la distribuzione web ad alte prestazioni con l’authoring WYSIWYG nell’editor universale. Questa guida descrive come creare, personalizzare e pubblicare moduli rapidi da caricare.
Che cosa imparerai
Alla fine di questo tutorial sarai in grado di:
- Configurare un archivio GitHub con il blocco di moduli adattivi
- Creare un sito AEM integrato con Edge Delivery Services
- Creare e pubblicare moduli con l’editor universale
- Configurare l’ambiente di sviluppo locale
Scegliere il percorso
Seleziona l’approccio più adatto al tuo scenario:
Figura: guida visiva per aiutarti a scegliere il percorso di implementazione corretto
Prerequisiti
Per garantire un’esperienza fluida e di successo con Edge Delivery Services per AEM Forms utilizzando l’editor universale, rivedi e conferma i seguenti prerequisiti prima di procedere:
Requisiti di accesso
- Account GitHub: per creare nuovi archivi è necessario disporre di un account GitHub con autorizzazioni. Questo è essenziale per gestire il codice di origine del progetto e collaborare con il team.
- Accesso all’authoring di AEM as a Cloud Service: assicurati di disporre dell’accesso a livello di authoring al tuo ambiente AEM as a Cloud Service. Questo accesso è necessario per creare, modificare e pubblicare i moduli.
Requisiti tecnici
- Familiarità con Git: acquisisci dimistechezza nell’eseguire operazioni Git di base quali la clonazione degli archivi, l’impegno delle modifiche e l’invio degli aggiornamenti. Queste competenze sono fondamentali per il controllo delle origini e la collaborazione nel progetto.
- Conoscenze delle tecnologie web: è consigliabile essere in grado di consiglia di utilizzare HTML, CSS e JavaScript. Queste tecnologie sono alla base della personalizzazione dei moduli e della risoluzione dei problemi.
- Node.js (versione 16 o successiva): Node.js è necessario per lo sviluppo locale e per l’esecuzione di strumenti di creazione. Assicurati che nel sistema sia installata la versione 16 o successiva.
- Gestione pacchetti (npm o yarn): per gestire le dipendenze e gli script del progetto sarà necessario npm (Gestione pacchetti nodi) o yarn.
Esperienza pregressa consigliata
- Concetti di AEM Sites: una conoscenza di base di AEM Sites, inclusa la struttura del sito e l’authoring dei contenuti, ti aiuterà a navigare e integrare i moduli in modo efficace.
- Principi di progettazione di moduli: se hai familiarità con le best practice per la progettazione di moduli, quali usabilità, accessibilità e convalida dei dati, potrai creare moduli efficaci e di facile utilizzo.
- Esperienza con editor WYSIWYG: se hai esperienza con gli editor WYSIWYG (What You See Is What You Get) potrai sfruttare meglio le funzionalità di authoring visivo dell’editor universale.
Percorso A: creare un nuovo progetto con moduli
Consigliato per: nuovi progetti, iniziative pilota o di prova di concetto
Sfrutta i moduli standard di AEM per accelerare la configurazione del progetto. Questo standard offre un modello pronto all’uso che integra perfettamente il blocco di moduli adattivi, consentendo di creare e implementare rapidamente i moduli all’interno del sito AEM.
Panoramica
Per avviare correttamente il nuovo progetto con moduli integrati:
- Crea un archivio GitHub utilizzando il modello standard di moduli AEM.
- Configura la sincronizzazione del codice AEM per automatizzare la sincronizzazione dei contenuti tra AEM e l’archivio.
- Configura la connessione tra il progetto GitHub e l’ambiente AEM.
- Stabilire e pubblicare un nuovo sito AEM.
- Aggiungi e gestisci i moduli tramite l’editor universale.
Le sezioni seguenti ti guideranno nei dettagli di ogni passaggio, garantendo un’esperienza di configurazione del progetto fluida ed efficiente.
-
Accedi al modello standard di moduli AEM
Figura: archivio standard di moduli AEM con blocco di moduli adattivi preconfigurato -
Creare l’archivio
- Fai clic su Utilizza questo modello > Crea un nuovo archivio
Figura: utilizzo del modello per creare un nuovo archivio -
Configurare le impostazioni dell’archivio
- Proprietario: seleziona l’account GitHub o l’organizzazione
- Nome archivio: scegli un nome descrittivo (ad esempio,
my-forms-project
) - Visibilità: seleziona Pubblico (consigliato per Edge Delivery Services)
- Fai clic su Crea archivio
Figura: configurazione del nuovo archivio con visibilità pubblica
Convalida: conferma di disporre di un nuovo archivio GitHub basato sul modello standard di moduli AEM.
La sincronizzazione del codice AEM sincronizza automaticamente le modifiche apportate al contenuto tra l’ambiente di authoring AEM e l’archivio GitHub.
-
Installare l’app GitHub
-
Configurare le autorizzazioni di accesso
- Seleziona Seleziona solo archivi
- Scegli il nuovo archivio creato
- Fai clic su Salva
Figura: installazione di sincronizzazione del codice AEM con autorizzazioni specifiche per l’archivio
Punti di controllo: la sincronizzazione del codice AEM è ora installata e ha accesso al tuo archivio.
Il file fstab.yaml
connette l’archivio GitHub all’ambiente di authoring AEM per la sincronizzazione del contenuto.
-
Passa al tuo archivio
- Passa all’archivio GitHub appena creato
- Dovresti visualizzare i file standard dei moduli AEM
-
Creare il file fstab.yaml
- Fai clic su Aggiungi file > Crea nuovo file nella directory principale
- Denominare il file
fstab.yaml
Figura: creazione del file di configurazione fstab.yaml -
Aggiungere i dettagli della connessione AEM
Copia e incolla la seguente configurazione, sostituendo i segnaposto:
code language-yaml mountpoints: /: url: https://<aem-author>/bin/franklin.delivery/<owner>/<repository>/main type: "markup" suffix: ".html"
Sostituisci:
<aem-author>
: URL di authoring di AEM as a Cloud Service (ad esempio,author-p12345-e67890.adobeaemcloud.com
)<owner>
: nome utente o organizzazione GitHub<repository>
: nome dell’archivio
Esempio:
code language-yaml mountpoints: /: https://author-p12345-e67890.adobeaemcloud.com/bin/franklin.delivery/mycompany/my-forms-project/main
Figura: configurazione del punto di montaggio per l’integrazione di AEM -
Impegna la configurazione
- Aggiungi un messaggio di impegno: “Aggiungi configurazione integrazione di AEM”
- Fai clic su Impegna nuovo file
Figura: impegno della configurazione fstab.yaml
Convalida: conferma la connessione tra l’archivio GitHub e AEM.
note note |
---|
NOTE |
Problemi di creazione? Consulta Risoluzione dei problemi di creazione di GitHub. |
-
Accedi alla console AEM Sites
- Accedi all’istanza di authoring di AEM as a Cloud Service
- Passa a Sites
Figura: accesso alla console AEM Sites -
Inizia la creazione del sito
- Fai clic su Crea > Sito da modello.
Figura: creazione di un nuovo sito da modello -
Seleziona il modello di Edge Delivery Services
- Scegli il modello Sito di Edge Delivery Services
- Fai clic su Avanti
Figura: selezione del modello per siti di Edge Delivery Servicesnote note NOTE Modello non disponibile? Se non visualizzi il modello di Edge Delivery Services: - Fai clic su Importa per caricare il modello
- Scaricare modelli dalle versioni GitHub
-
Configurare il sito
Immetti le seguenti informazioni:
table 0-row-3 1-row-3 2-row-3 3-row-3 Campo Valore Esempio Titolo del sito Nome descrittivo per il sito “Il mio progetto di moduli” Nome del sito Nome dell’URL descrittivo “my-forms-project” URL GitHub L’URL dell’archivio https://github.com/mycompany/my-forms-project
Figura: configurazione del nuovo sito AEM con l’integrazione GitHub -
Completare la creazione del sito
- Rivedi le impostazioni
- Fai clic su Crea.
Figura: conferma creazione sitoCompletato correttamente Il sito AEM ora è stato creato e connesso a GitHub.
-
Apri nell’editor universale
- Nella console Sites, individua il nuovo sito
- Seleziona la pagina
index
- Fai clic su Modifica
Figura: apertura del sito per la modificaL’editor universale si apre in una nuova scheda, che fornisce funzionalità di authoring WYSIWYG.
Figura: il sito aperto nell’editor universale per la modifica in WYSIWYG
Convalida: conferma che il sito AEM sia pronto per l’authoring del modulo.
La pubblicazione rende il tuo sito disponibile su Edge Delivery Services per l’accesso globale.
-
Pubblicazione rapida dalla console Sites
- Torna alla console AEM Sites
- Seleziona le pagine del sito (o seleziona tutto con Ctrl+A)
- Fai clic su Pubblicazione rapida
Figura: selezione delle pagine per la pubblicazione rapida -
Conferma pubblicazione
- Nella finestra di dialogo di conferma, fai clic su Pubblica
Figura: conferma dell’azione di pubblicazioneAlternativa: puoi anche pubblicare direttamente dell’editor universale utilizzando il pulsante Pubblica.
Figura: pubblicazione diretta dall’editor universale -
Accedi al tuo sito attivo
Il tuo sito è ora attivo all’indirizzo:
code language-none https://<branch>--<repo>--<owner>.aem.page/content/<site-name>/
Spiegazione struttura URL:
<branch>
: ramo GitHub (in generemain
)<repo>
: nome dell’archivio<owner>
: nome utente o organizzazione GitHub<site-name>
: nome del sito AEM
Esempio:
code language-none https://main--my-forms-project--mycompany.aem.page/content/my-forms-project/
Convalida: conferma che il sito sia attivo su Edge Delivery Services.
note tip |
---|
TIP |
Pattern dell’URL: |
|
Avanti: crea il primo modulo
Percorso B: aggiungere moduli a un progetto esistente
Ideale per: siti AEM esistente con Edge Delivery Services
Se disponi già di un progetto AEM che utilizza Edge Delivery Services, puoi aggiungere funzionalità dei moduli integrando il blocco di moduli adattivi.
Prerequisiti per il percorso B
Per procedere con l’integrazione dei moduli nel progetto AEM esistente, assicurati di soddisfare i seguenti prerequisiti:
- Possiedi un progetto AEM esistente creato con XWalk standard di AEM.
- Hai configurato un ambiente di sviluppo locale
- Possiedi l’accesso a Git nell’archivio del progetti, che ti consente di clonare, modificare e inviare le modifiche in base alle esigenze.
La guida seguente fornisce un approccio strutturato per aggiungere funzionalità di modulo al progetto esistente. Ogni fase è progettata per garantire un’integrazione diretta e funzionalità ottimale nell’ambiente di editor universale.
Panoramica
Completerai i seguenti passaggi di alto livello:
- Copia i file del blocco moduli adattivi nel progetto.
- Aggiorna la configurazione del progetto per riconoscere e supportare i componenti del modulo.
- Imposta le regole ESLint per adattarle ai nuovi file e modelli di codifica.
- Crea il progetto e impegna le modifiche nell’archivio.
-
Passa al progetto locale
code language-bash cd /path/to/your/aem-project
-
Scarica i file richiesti dai moduli standard di AEM
Copia questi file dall’archivio di moduli standard di AEM:
table 0-row-3 1-row-3 2-row-3 3-row-3 Origine Destinazione Scopo blocks/form/
blocks/form/
Funzionalità modulo core scripts/form-editor-support.js
scripts/form-editor-support.js
Integrazione editor universale scripts/form-editor-support.css
scripts/form-editor-support.css
Stile dell’editor -
Aggiornare il supporto dell’editor
- Sostituisci il file
/scripts/editor-support.js
con quello editor-support.js dello standard di moduli di AEM
- Sostituisci il file
Convalida: conferma che i file del blocco del modulo siano presenti nel progetto.
-
Aggiornare il modello della sezione
Apri
/models/_section.json
e aggiungi i componenti del modulo ai filtri:code language-json { "filters": [ { "id": "section", "components": [ "text", "image", "button", "form", "embed-adaptive-form" ] } ] }
Come funziona: abilita i componenti del modulo nel selettore di componenti dell’editor universale.
Convalida: conferma i componenti del modulo che vengono visualizzati nell’editor universale.
Perché questo passaggio: impedisce gli errori di stampa da file specifici del modulo e configura le regole di convalida appropriate.
-
Aggiornare .eslintignore
Aggiungi queste righe a
/.eslintignore
:code language-bash # Form block rule engine files blocks/form/rules/formula/* blocks/form/rules/model/* blocks/form/rules/functions.js scripts/editor-support.js scripts/editor-support-rte.js
-
Aggiornare .eslintrc.js
Aggiungi queste regole all’oggetto
rules
in/.eslintrc.js
:code language-javascript { "rules": { // Existing rules... // Form component cell limits 'xwalk/max-cells': ['error', { '*': 4, // default limit form: 15, wizard: 12, 'form-button': 7, 'checkbox-group': 20, checkbox: 19, 'date-input': 21, 'drop-down': 19, email: 22, 'file-input': 20, 'form-fragment': 15, 'form-image': 7, 'multiline-input': 23, 'number-input': 22, panel: 17, 'radio-group': 20, 'form-reset-button': 7, 'form-submit-button': 7, 'telephone-input': 20, 'text-input': 23, accordion: 14, modal: 11, rating: 18, password: 20, tnc: 12 }], // Disable this rule for forms 'xwalk/no-orphan-collapsible-fields': 'off' } }
Convalida: conferma che ESLint funzioni con i componenti del modulo.
-
Installare le dipendenze e generare
code language-bash # Install any new dependencies npm install # Build component definitions npm run build:json
Come funziona:
- Aggiorna
component-definition.json
con i componenti del modulo - Genera
component-models.json
con i modelli del modulo - Crea
component-filters.json
con regole di filtro
- Aggiorna
-
Verifica dei file generati
Verifica che questi file nella directory principale del progetto contengano oggetti correlati a un modulo:
component-definition.json
component-models.json
component-filters.json
-
Impegnare e inviare delle modifiche
code language-bash git add . git commit -m "Add Adaptive Forms Block integration" git push origin main
Convalida: conferma che il progetto includa funzionalità del modulo.
Avanti: crea il primo modulo
Creare il primo modulo
Chi deve seguire questa sezione:
Questa sezione è pertinente per gli utenti che seguono il Percorso A (nuovo progetto) o il Percorso B (progetto esistente).
Con il progetto ora predisposto per la creazione di moduli, puoi creare il primo modulo utilizzando l’ambiente di authoring WYSIWYG intuitivo dell’editor universale. I passaggi seguenti forniscono un approccio strutturato alla progettazione, configurazione e pubblicazione di un modulo all’interno del sito AEM.
Panoramica
Il processo di creazione di un modulo nell’editor universale consiste in diverse fasi chiave:
-
Inserire il blocco del modulo adattivo
Inizia aggiungendo il blocco di modulo adattivo alla pagina scelta. -
Aggiungere componenti del modulo
Compilare il modulo inserendo componenti quali campi di testo, pulsanti e altri elementi di input. -
Configurare le proprietà del componente
Regola le impostazioni e le proprietà di ciascun componente in base ai requisiti del modulo. -
Anteprima e test del modulo
Utilizza la funzionalità di anteprima per convalidare l’aspetto e il comportamento del modulo prima della pubblicazione. -
Pubblicare la pagina aggiornata
Una volta completata l’operazione, pubblica la pagina per rendere il modulo disponibile agli utenti finali.
Le sezioni seguenti ti guideranno nel dettaglio attraverso tutti questi passaggi, per garantire un’esperienza di creazione del modulo fluida ed efficace.
-
Apri il modulo nell’editor universale
- Passa alla console Sites in AEM
- Seleziona la pagina in cui desideri aggiungere un modulo (ad esempio,
index
) - Fai clic su Modifica
La pagina viene aperta nell’editor universale per la modifica in WYSIWYG.
-
Aggiungere il componente del modulo adattivo
- Apri il pannello Struttura contenuto (barra laterale a sinistra)
- Passa a una sezione in cui desideri aggiungere il modulo
- Fai clic sull’icona Aggiungi (+)
- Seleziona Modulo adattivo dall’elenco dei componenti
Seleziona
Figura: aggiunta di un blocco di modulo adattivo alla pagina
Convalida: conferma di disporre di un contenitore di modulo vuoto.
-
Passa al blocco modulo
- Nella struttura contenuto, individua la sezione Modulo adattivo appena aggiunta
Figura: blocco modulo adattivo nella struttura contenuto -
Aggiungere i componenti del modulo
Puoi aggiungere i componenti in due modi:
Metodo A: fai clic per aggiungere
- Fai clic sull’icona Aggiungi (+) nella sezione del modulo
- Seleziona i componenti dall’elenco Componenti del modulo adattivo.
Metodo B: trascinamento
- Trascina i componenti direttamente dal pannello dei componenti al modulo
Figura: aggiunta di componenti al moduloComponenti consigliati per iniziare
- Input di testo (per nome, e-mail)
- Area di testo (per messaggi)
- Pulsante Invia
-
Configurare le proprietà del componente
-
Seleziona un componente del modulo
-
Utilizza il pannello Proprietà (barra laterale a destra) per configurare:
- Etichette e segnaposto
- Regole di convalida
- Impostazioni di campo obbligatorie
Figura: configurazione delle proprietà del componente -
-
Anteprima del modulo
Il modulo avrà un aspetto simile a questo:
Figura: modulo di esempio creato con l’editor universale
Convalida: conferma che il modulo sia pronto per la pubblicazione.
note important |
---|
IMPORTANT |
Ricordati di pubblicare la pagina dopo aver apportato le modifiche per visualizzare gli aggiornamenti nel browser. |
-
Pubblicare dall’editor universale
- Fai clic sul pulsante Pubblica nell’editor universale
Figura: pubblicazione del modulo dall’editor universale -
Confermare la pubblicazione
- Nella finestra di dialogo di conferma, fai clic su Pubblica
Figura: conferma dell’azione di pubblicazioneVisualizzerai un messaggio di avvenuta conferma della pubblicazione.
Figura: conferma pubblicazione avvenuta correttamente -
Visualizzare il modulo attivo
Il modulo è ora attivo all’indirizzo:
code language-none https://<branch>--<repo>--<owner>.aem.live/content/<site-name>/
URL di esempio:
code language-none https://main--my-forms-project--mycompany.aem.live/content/my-forms-project/
Figura: hai pubblicato la pagina del modulo in Edge Delivery Services
Congratulazioni. Il modulo è ora attivo e pronto per raccogliere gli invii.
Passaggi successivi
Ora che possiedi un modulo funzionante, puoi:
- Personalizzare lo stile modificando i file CSS e JavaScript
- Aggiungere funzioni di modulo avanzate come regole di convalida e logica condizionale
- Configurare lo sviluppo locale per un’iterazione più rapida
- Creare moduli autonomi per casi d’uso specifici
Configurare l’ambiente di sviluppo locale
Ideale per: sviluppatori che desiderano personalizzare lo stile e il comportamento dei moduli
Un ambiente di sviluppo locale consente di apportare modifiche e di visualizzarle immediatamente senza passare attraverso il ciclo di pubblicazione.
-
Installare AEM CLI
AEM CLI semplifica le attività di sviluppo locale:
code language-bash npm install -g @adobe/aem-cli
-
Clonare l’archivio
code language-bash git clone https://github.com/<owner>/<repo> cd <repo>
Sostituisci
<owner>
e<repo>
con i tuoi dettagli GitHub effettivi. -
Avviare il server di sviluppo locale
code language-bash aem up
Verrà avviato un server locale con funzionalità di hot-reloading.
-
Eseguire le personalizzazioni
- Modifica i file nella directory
blocks/form/
per lo stile e il comportamento dei moduli - Modifica
form.css
per lo stile - Aggiorna
form.js
per il comportamento
Visualizza le modifiche immediatamente nel browser all’indirizzo
http://localhost:3000
- Modifica i file nella directory
-
Implementare le modifiche
code language-bash git add . git commit -m "Custom form styling" git push origin main
Le modifiche saranno disponibili all’indirizzo:
- Anteprima:
https://<branch>--<repo>--<owner>.aem.page/content/<site-name>
- Produzione:
https://<branch>--<repo>--<owner>.aem.live/content/<site-name>
- Anteprima:
Risoluzione di problemi
Problemi comuni e soluzioni
Problema: errori di creazione o di linting
Soluzione 1: gestire gli errori di linting
Se si verificano errori di linting:
-
Apri
package.json
nella directory principale del progetto -
Trova lo script
lint
:code language-json "scripts": { "lint": "npm run lint:js && npm run lint:css" }
-
Disabilita temporaneamente il linter:
code language-json "scripts": { "lint": "echo 'skipping linting for now'" }
-
impegna e invia le modifiche
Soluzione 2: errori di percorso del modulo
Se visualizzi “Impossibile risolvere il percorso al modulo '/scripts/lib-franklin.js'”:
-
Passa a
blocks/form/form.js
-
Aggiorna l’istruzione di importazione:
code language-javascript // Change this: import { ... } from '/scripts/lib-franklin.js'; // To this: import { ... } from '/scripts/aem.js';
Problema: gli invii del modulo non funzionano
Soluzioni:
- Assicurati di disporre di un componente pulsante Invia
- Verifica la configurazione dell’URL di azione del modulo
- Verifica le regole di convalida del modulo
- Testa prima in modalità anteprima
Problema: problemi di stile
Soluzioni:
- Verifica i percorsi del file CSS in
blocks/form/
- Cancella la cache del browser
- Verifica la sintassi CSS
- Testa nell’ambiente di sviluppo locale
Problema: i componenti del modulo non vengono visualizzati nell’editor universale
Soluzioni:
- Verifica che la sincronizzazione del codice AEM sia installata e in esecuzione
- Verifica che
fstab.yaml
disponga dell’URL di authoring AEM corretto - Assicurati che l’istanza di AEM disponga dell’accesso anticipato abilitato
- Conferma che
component-definition.json
includa i componenti del modulo
Problema: modifiche non visibili dopo la pubblicazione
Soluzioni:
- Attendi l’aggiornamento della cache CDN
- Controlla la cache del browser (prova la modalità in incognito/privata)
- Verifica che sia utilizzato il formato URL corretto