Configurare l’ambiente di sviluppo locale per AEM Forms

Quando imposti e configuri un’ ​ Adobe Experience Manager Forms as a ​ Cloud Service ambiente, puoi configurare ambienti di sviluppo, staging e produzione su cloud. Inoltre, puoi anche impostare e configurare un ambiente di sviluppo locale.

Puoi utilizzare l’ambiente di sviluppo locale per eseguire le seguenti azioni senza effettuare l’accesso all’ambiente di sviluppo cloud:

• Creare moduli e risorse correlate (temi, modelli, azioni di invio personalizzate e altro ancora)
• Conversione di PDF forms in Forms adattivo
• Creare applicazioni da generare Comunicazioni con i clienti su richiesta o in modalità batch.

Dopo che un modulo adattivo o le risorse correlate sono pronti nell’istanza di sviluppo locale o in un’applicazione da generare [Comunicazioni con i clienti] è pronto, è possibile esportare l’applicazione Adaptive Form o Customer Communications dall’ambiente di sviluppo locale a un ambiente di Cloud Service per ulteriori test o per passare agli ambienti di produzione.

Puoi anche sviluppare e testare il codice personalizzato, come componenti personalizzati e il servizio di preriempimento, nell’ambiente di sviluppo locale. Quando il codice personalizzato è testato e pronto, puoi utilizzare l’archivio Git dell’ambiente di sviluppo del Cloud Service per distribuire il codice personalizzato.

Per impostare un nuovo ambiente di sviluppo locale e utilizzarlo per lo sviluppo di per le attività, eseguire le azioni seguenti nell'ordine elencato:

• Configurare gli strumenti di sviluppo

• Configurare le istanze di authoring e pubblicazione locali

• Aggiungere l’archivio Forms alle istanze di sviluppo locali e configurare gli utenti

• Imposta ambiente di sviluppo locale per microservizi

• Configurare un progetto di sviluppo

• Configurare gli strumenti locali di Dispatcher

Prerequisiti

Per configurare un ambiente di sviluppo locale è necessario il software seguente. Scarica questi elementi prima di iniziare a configurare l’ambiente di sviluppo locale:

Scarica la versione più recente del software da Software Distribution

Per scaricare la versione più recente dell’SDK per Adobe Experience Manager as a Cloud Service, l’archivio delle funzioni di Experience Manager Forms (componente aggiuntivo AEM Forms), le risorse di riferimento per i moduli o Forms Designer da Distribuzione di software:

1. Accedi a https://experience.adobe.com/#/downloads con il tuo Adobe ID

   NOTA

   Per scaricare l’SDK as a Cloud Service per l’AEM, è necessario effettuare il provisioning della tua organizzazione Adobe affinché l’AEM as a Cloud Service possa eseguirne il download.

2. Accedi a AEM as a Cloud Service scheda.

3. Ordina per data di pubblicazione in ordine decrescente.

4. Fai clic sull’SDK di Adobe Experience Manager as a Cloud Service più recente, sull’archivio delle funzioni di Experience Manager Forms (componente aggiuntivo AEM Forms), sulle risorse di riferimento per i moduli o su Forms Designer.

5. Rivedere e accettare il contratto di licenza. Seleziona il pulsante Scarica.

Impostare gli strumenti di sviluppo per i progetti AEM

Il progetto Adobe Experience Manager Forms è una base di codice personalizzata. Contiene codice, configurazioni e contenuti distribuiti tramite Cloud Manager per Adobe Experience Manager as a Cloud Service. Il Progetto AEM Archetipo Maven fornisce la struttura della linea di base per il progetto.

Configura i seguenti strumenti di sviluppo da utilizzare per Adobe Experience Manager progetto per lo sviluppo:

• Java™
• Git
• Node.js (npm)
• Maven

Per istruzioni dettagliate sulla configurazione degli strumenti di sviluppo precedentemente menzionati, consulta Configurare gli strumenti di sviluppo.

Configurare l’ambiente Experience Manager locale per lo sviluppo

L’SDK di Cloud Service fornisce un file QuickStart. Esegue una versione locale di Experience Manager. È possibile eseguire localmente le istanze Author o Publish.

Benché QuickStart offra un'esperienza di sviluppo locale, non dispone di tutte le funzioni disponibili in Adobe Experience Manager as a Cloud Service. Quindi, testa sempre le funzioni e il codice con Adobe Experience Manager ambiente di sviluppo as a Cloud Service prima di spostare le funzioni nell’ambiente di staging o produzione.

Per installare e configurare l’ambiente di Experience Manager locale, effettua le seguenti operazioni:

• Scarica ed estrai il Adobe Experience Manager SDK AS A CLOUD SERVICE
• Configurare un’istanza di authoring
• Configurare un’istanza Publish

Aggiungere l’archivio Forms alle istanze di authoring e pubblicazione locali e configurare gli utenti specifici di Forms

Per aggiungere un archivio Forms alle istanze di Experience Manager e configurare utenti specifici per i moduli, effettua le seguenti operazioni nell’ordine elencato:

Installa l’archivio delle funzioni più recente dei componenti aggiuntivi di Forms

L’archivio delle funzioni di Adobe Experience Manager Forms as a Cloud Service fornisce strumenti per creare, assegnare stili e ottimizzare Adaptive Forms nell’ambiente di sviluppo locale. Installa il pacchetto per creare un modulo adattivo e utilizza varie altre funzioni di AEM Forms. Per installare il pacchetto:

1. Scarica ed estrai la versione più recente AEM Forms per il sistema operativo da Distribuzione di software.

2. Passa alla directory crx-quickstart/install. Se la cartella non esiste, creala.

3. Arrestare l’istanza di AEM, inserire AEM Forms archivio delle funzioni del componente aggiuntivo, aem-forms-addon-<version>.far, nella cartella di installazione e riavviare l'istanza.

Configurare utenti e autorizzazioni

Creare utenti come sviluppatori di moduli e professionisti dei moduli e aggiungi questi utenti a gruppi di moduli predefiniti per fornire le autorizzazioni necessarie. Nella tabella seguente sono elencati tutti i tipi di utenti e i gruppi predefiniti per ogni tipo di utente di Forms:

Imposta ambiente di sviluppo locale per documento di record (DoR)

AEM Forms as a Cloud Service fornisce un ambiente SDK basato su docker per semplificare lo sviluppo di documenti di record e l’utilizzo di altri microservizi. Consente di configurare manualmente binari e adattamenti specifici della piattaforma. Per impostare l’ambiente:

1. Installare e configurare Docker:

   • (Per Microsoft® Windows) Installazione Docker Desktop. Configura Docker Engine e docker-compose sul tuo computer.

   • (Apple macOS) Installazione Docker Desktop per Mac. Include Docker Engine, il client CLI Docker, Docker Compose, Docker Content Trust, Kubernetes e Credential Helper.

   • (Per Linux®) Installa Docker Engine e Componi Docker sul tuo computer.

   NOTA

   • Per Apple macOS, inserire nell'elenco Consentiti cartelle contenenti istanze AEM Author locali.

   • Docker Desktop per Windows supporta due back-end, Hyper-V
     (legacy) e WSL2 (modern). La condivisione dei file avviene automaticamente
     gestito da Docker tramite WSL2 (modern). Devi
     configurare in modo esplicito la condivisione dei file quando si utilizza Hyper-V (legacy).

2. Crea una cartella, ad esempio aem-sdk, in parallelo alle istanze di authoring e pubblicazione. Ad esempio, C:\aem-sdk.

3. Estrai aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip file.

   

4. Creare una variabile di ambiente AEM_HOME e puntare all'installazione locale di AEM Author. Ad esempio, C:\aem\author.

5. Apri sdk.bat o sdk.sh per la modifica. Impostare AEM_HOME in modo che punti all'installazione di AEM Author locale. Ad esempio, C:\aem\author.

6. Apri il prompt dei comandi e passa alla aem-forms-addon-native-<version> cartella.

7. Assicurati che l’istanza locale di AEM Author sia operativa. Esegui il seguente comando per avviare l'SDK:

   • (su Microsoft® Windows) sdk.bat start
   • (su Linux® o Apple macOS) AEM_HOME=[local AEM Author installation] ./sdk.sh start
   NOTA

   Se hai definito la variabile di ambiente nel file sdk.sh, specificarla nella riga di comando è facoltativo. L’opzione per definire la variabile di ambiente nella riga di comando viene fornita per eseguire il comando senza aggiornare lo script della shell.

   

Ora puoi utilizzare l’ambiente di sviluppo locale per eseguire il rendering del documento di record. Per eseguire il test, carica un file XDP nel tuo ambiente ed esegui il rendering. Ad esempio: http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp converte il file XDP nel documento PDF.

Configurare un progetto di sviluppo per Forms basato su Archetipo Experience Manager

Utilizza questo progetto per creare Forms adattivo, distribuire aggiornamenti di configurazione, sovrapposizioni, creare componenti per moduli adattivi personalizzati, testare e codice personalizzato in locale Experience Manager Forms SDK Dopo il test locale, puoi distribuire il progetto in Experience Manager Forms ambienti di produzione e non di produzione as a Cloud Service. Quando distribuisci il progetto, vengono distribuite anche le seguenti risorse AEM Forms:

Per impostare il progetto:

1. Clona l’archivio Git di Cloud Manager nell’istanza di sviluppo locale: L’archivio Git di Cloud Manager contiene un progetto AEM predefinito. Si basa su Archetipo AEM. Clona l’archivio Git di Cloud Manager utilizzando la gestione self-service dell’account Git dall’interfaccia utente di Cloud Manager per inserire il progetto nell’ambiente di sviluppo locale. Per informazioni dettagliate sull’accesso all’archivio, consulta Accesso agli archivi.

2. Creare un Experience Manager Forms as a [Cloud Service] progetto: Creare un Experience Manager Forms as a [Cloud Service] progetto basato sui più recenti Archetipo AEM o più tardi. L’archetipo aiuta gli sviluppatori a iniziare facilmente a sviluppare per AEM Forms as a Cloud Service. Include inoltre alcuni temi e modelli di esempio per aiutarti a iniziare rapidamente.

   Apri il prompt dei comandi ed esegui il comando seguente per creare un Experience Manager Forms progetto as a Cloud Service.

   mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate -D archetypeGroupId=com.adobe.aem -D archetypeArtifactId=aem-project-archetype -D archetypeVersion="41" -D appTitle=mysite -D appId=mysite -D groupId=com.mysite -D includeFormsenrollment="y" -D aemVersion="cloud"
   

   Modificare il appTitle, appId, e groupId nel comando precedente per riflettere l’ambiente. Impostare inoltre il valore di includeFormsenrollment, includeFormscommunications e includeFormsheadless su y o n a seconda della licenza e dei requisiti. IncludeFormsheadless è obbligatorio per creare Forms adattivo basato su Componenti core.

   • Utilizza il includeFormsenrollment=y opzione per includere configurazioni, temi, modelli, Componenti core e dipendenze specifiche di Forms necessari per creare Forms adattivo. Se si utilizza Forms Portal, impostare includeExamples=y opzione. Aggiunge inoltre al progetto i componenti core di Forms Portal.

   • Utilizza il includeFormscommunications=y opzione per includere i Componenti core Forms e le dipendenze necessarie per includere la funzionalità di comunicazione con i clienti.

     AVVERTENZA

     • Quando si crea un progetto Archetipo con versione 45, il [Cartella progetto Archetipo AEM]/pom.xml inizialmente imposta la versione dei componenti core forms su 2.0.64. Prima di creare o distribuire il progetto Archetipo, aggiorna la versione dei componenti core forms al 2.0.62.

3. Implementa il progetto nell’ambiente di sviluppo locale. Puoi utilizzare il seguente comando per distribuire nell’ambiente di sviluppo locale

   mvn -PautoInstallPackage clean install

   Per l'elenco completo dei comandi, vedere Creazione e installazione

4. Distribuisci il codice nel tuo AEM Forms ambiente as a Cloud Service.

Configurare gli strumenti locali di Dispatcher

Dispatcher è un modulo server web Apache HTTP che fornisce sicurezza e prestazioni tra il livello di CDN e pubblicazione AEM. Dispatcher è parte integrante dell’architettura Experience Manager complessiva e deve far parte dell’ambiente di sviluppo locale.

Per configurare il Dispatcher locale e quindi aggiungere a esso regole specifiche per Forms, effettua le seguenti operazioni:

Configurare il Dispatcher locale

Il Experience Manager L’SDK as a Cloud Service include la versione consigliata degli strumenti di Dispatcher che facilita la configurazione, la convalida e la simulazione locale di Dispatcher. Gli strumenti di Dispatcher sono basati su Docker e forniscono strumenti per riga di comando per trasferire i file di configurazione del server web Apache HTTP e del Dispatcher in un formato compatibile e distribuirli a Dispatcher in esecuzione nel contenitore Docker.

La memorizzazione in cache in Dispatcher consente AEM Forms per precompilare il Forms adattivo su un client. Migliora la velocità di rendering dei moduli precompilati.

Per istruzioni dettagliate sulla configurazione di Dispatcher, vedi Configurare gli strumenti locali di Dispatcher

Aggiungere regole specifiche di Forms a Dispatcher

Per configurare la cache di Dispatcher per Experience Manager Forms as a Cloud Service, effettua le seguenti operazioni:

1. Apri il progetto AEM e passa a \src\conf.dispatcher.d\available_farms

2. Crea una copia di default.farm file. Esempio: forms.farm.

3. Apri il forms.farm file per la modifica e sostituire il seguente codice:

   #/ignoreUrlParams {
   #/0001 { /glob "*" /type "deny" }
   #/0002 { /glob "q" /type "allow" }
   #}
   

   con

   /ignoreUrlParams {
   /0001 { /glob "*" /type "deny" }
   /0002 { /glob "dataRef" /type "allow" }
   }
   

4. Salva e chiudi il file.

5. Vai a conf.d/enabled_farms e creare un collegamento simbolico al forms.farm file.

6. Compila e distribuisci il progetto nel tuo AEM Forms ambiente as a Cloud Service.

Considerazioni sul caching

• Il caching di Dispatcher consente AEM Forms per precompilare il Forms adattivo su un client. Migliora la velocità di rendering dei moduli precompilati.
• Per impostazione predefinita, la memorizzazione nella cache delle funzioni di contenuto protetto è disabilitata. Per attivare la funzione, è possibile eseguire le istruzioni fornite nella Caching di contenuto protetto articolo
• Il Dispatcher può non invalidare alcuni Forms adattivi e i relativi Forms adattivi. Per risolvere questi problemi, vedi AEM Forms Memorizzazione in cache nella sezione risoluzione dei problemi.
• Memorizzazione in cache di Forms adattivo localizzato:
  • Usa formato URL http://host:port/content/forms/af/<afName>.<locale>.html per richiedere una versione localizzata di un modulo adattivo anziché http://host:port/content/forms/af/afName.html?afAcceptLang=<locale>
  • Per impostazione predefinita, l'opzione Impostazioni internazionali browser è disabilitata. Per modificare le impostazioni internazionali del browser:
• Quando si utilizza il formato URL http://host:port/content/forms/af/<adaptivefName>.html, e Use Browser Locale in configuration manager è disabilitato, viene distribuita la versione non localizzata del modulo adattivo. Il linguaggio non localizzato è il linguaggio utilizzato durante lo sviluppo del modulo adattivo. Le impostazioni locali configurate per il browser (impostazioni locali del browser) non vengono considerate e viene distribuita una versione non localizzata del modulo adattivo.
• Quando si utilizza il formato URL http://host:port/content/forms/af/<adaptivefName>.html, e l’opzione Usa impostazioni locali del browser nella gestione della configurazione è abilitata, viene distribuita una versione localizzata del modulo adattivo, se disponibile. La lingua del modulo adattivo localizzato si basa sulle impostazioni locali configurate per il browser (impostazioni locali del browser). Può portare a [memorizzazione nella cache solo della prima istanza di un modulo adattivo]. Per evitare che il problema si verifichi nell’istanza, consulta solo la prima istanza di un modulo adattivo è memorizzata in cache nella sezione risoluzione dei problemi.

L’ambiente di sviluppo locale è pronto.

Abilitare i componenti core dei moduli adattivi in AEM Forms as a Cloud Service e nell’ambiente di sviluppo locale

Abilitando i componenti core Adaptive Forms su AEM Forms as a Cloud Service, puoi iniziare a creare, pubblicare e distribuire componenti core basati su Adaptive Forms e Headless Forms utilizzando le istanze del Cloud Service AEM Forms su più canali. Per utilizzare Headless Adaptive Forms è necessario un ambiente abilitato per i Componenti core Forms adattivi.

Per istruzioni, consulta Abilitare i componenti core Adaptive Forms nell’ambiente di sviluppo as a Cloud Service e locale di AEM Forms

Aggiornare l’ambiente di sviluppo locale

L’aggiornamento dell’SDK a una nuova versione richiede la sostituzione dell’intero ambiente di sviluppo locale, con conseguente perdita di codice, configurazione e contenuto negli archivi locali. Assicurati che qualsiasi codice, configurazione o contenuto che non deve essere eliminato sia salvato in modo sicuro in Git o esportato dalle istanze di Experience Manager locali come CRX-Packages.

Come evitare la perdita di contenuti durante l’aggiornamento dell’SDK

L’aggiornamento dell’SDK crea efficacemente una nuova istanza di authoring e pubblicazione, incluso un nuovo archivio (Configura progetto AEM), il che significa che tutte le modifiche apportate all’archivio di un SDK precedente andranno perse. Per strategie valide per contribuire alla persistenza dei contenuti tra gli aggiornamenti dell’SDK, consulta Come evitare la perdita di contenuti durante l’aggiornamento dell’SDK per AEM

Backup e importazione di contenuti specifici per Forms in un nuovo ambiente SDK

Per eseguire il backup e spostare le risorse dall’SDK esistente a un nuovo ambiente SDK:

• Crea un backup del contenuto esistente.

• Configurare un nuovo ambiente SDK.

• Importa il backup nel nuovo ambiente SDK.

Creare un backup del contenuto esistente

Esegui il backup del Forms adattivo, dei modelli, del modello dati del modulo, del tema, delle configurazioni e del codice personalizzato. Per creare il backup, è possibile eseguire le operazioni seguenti:

1. Scarica Forms, temi e PDF forms adattivi.

2. Esportare modelli di moduli adattivi.

3. Scarica modelli dati modulo

4. Esporta modelli modificabili, configurazioni cloud e modello di flusso di lavoro. Per esportare tutti gli elementi precedentemente menzionati dall’SDK esistente, crea un’ CRX-Package con i seguenti filtri:

   • /conf/ReferenceEditableTemplates
   • /conf/global/settings/cloudconfigs
   • /conf/global/settings/wcm
   • /var/workflow/models
   • /conf/global/settings/workflow

5. Esporta configurazioni e-mail, invia e precompila il codice delle azioni dal tuo ambiente di sviluppo locale. Per esportare queste impostazioni e configurazione, crea una copia delle cartelle e dei file seguenti nell’ambiente di sviluppo locale:

   • [Archetype Project in Cloud Service Git]/core/src/main/java/com/<program name>/core/service
   • [Archetype Project in Cloud Service Git] /core/src/main/java/com/<program name>/core/servlets/FileAttachmentServlet.java
   • [Archetype Project in Cloud Service Git]/ui.apps/src/main/content/jcr_root/apps/<program name>/config

Importare il backup nel nuovo ambiente SDK

Importa Forms adattivo, modelli, modello dati modulo, tema, configurazioni e codice personalizzato nel nuovo ambiente. Per importare il backup, è possibile effettuare le seguenti operazioni:

1. Importa Forms, temi e PDF forms adattivi per nuovi ambienti SDK.

2. Importare modelli di moduli adattivi nel nuovo ambiente SDK.

3. Carica modelli dati modulo nel nuovo ambiente SDK.

4. Importa modelli modificabili, configurazioni cloud e modello di flusso di lavoro. Per importare nel nuovo ambiente SDK tutti gli elementi precedentemente menzionati, importa il pacchetto CRX contenente tali elementi.

5. Importa le configurazioni e-mail, invia e precompila il codice delle azioni dal tuo ambiente di sviluppo locale. Per importare queste impostazioni e configurazione, inserisci i seguenti file dal vecchio progetto Archetipo al nuovo progetto Archetipo:

   • [Archetype Project in Cloud Service Git]/core/src/main/java/com/<program name>/core/service
   • [Archetype Project in Cloud Service Git] /core/src/main/java/com/<program name>/core/servlets/FileAttachmentServlet.java
   • [Archetype Project in Cloud Service Git]/ui.apps/src/main/content/jcr_root/apps/<program name>/config

Il nuovo ambiente ora dispone di moduli e risorse correlate del vecchio ambiente.