Configurare l’ambiente di sviluppo locale per AEM Forms overview
Quando si imposta e si configura un ambiente Adobe Experience Manager Forms come Cloud Service, vengono impostati gli ambienti di sviluppo, staging e produzione sul 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:
- Crea moduli e risorse correlate (temi, modelli, azioni di invio personalizzate e altro)
- Conversione di moduli PDF in moduli adattivi
- Crea applicazioni per generare comunicazioni con il cliente su richiesta o in modalità batch.
Quando un modulo adattivo o le risorse correlate sono pronti nell'istanza di sviluppo locale o quando è pronta un'applicazione per generare [comunicazioni cliente], è possibile esportare l'applicazione Moduli adattivi o Comunicazioni clienti dall'ambiente di sviluppo locale in 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:
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 software-distribution
Per scaricare la versione più recente di Adobe Experience Manager as a Cloud Service SDK, l'archivio delle funzionalità di Experience Manager Forms (componente aggiuntivo AEM Forms), le risorse di riferimento per i moduli o Forms Designer da Distribuzione software:
-
Accedi a https://experience.adobe.com/#/downloads con il tuo Adobe ID
note note NOTE Per scaricare l'SDK di AEM as a Cloud Service, è necessario aver effettuato il provisioning della tua organizzazione Adobe per AEM as a Cloud Service. -
Passa alla scheda AEM as a Cloud Service.
-
Ordina per data di pubblicazione in ordine decrescente.
-
Fai clic sull’SDK 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.
note note NOTE Per una compatibilità perfetta con l’SDK di Experience Manager Forms, si consiglia di scaricare l’ultima versione dell’archivio delle funzioni di (componente aggiuntivo AEM Forms), le risorse di riferimento dei moduli o Forms Designer Adobe Experience Manager as a Cloud Service. -
Rivedere e accettare il contratto di licenza. Seleziona il pulsante Scarica.
Impostare gli strumenti di sviluppo per i progetti AEM setup-development-tools-for-AEM-projects
Il progetto Adobe Experience Manager Forms è una base di codice personalizzata. Contiene codice, configurazioni e contenuto distribuiti tramite Cloud Manager all'as a Cloud Service Adobe Experience Manager. Il Archetipo Maven progetto AEM fornisce la struttura di base per il progetto.
Configura i seguenti strumenti di sviluppo da utilizzare per il progetto Adobe Experience Manager per lo sviluppo:
Per istruzioni dettagliate sulla configurazione degli strumenti di sviluppo precedentemente menzionati, vedere 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 le istanze Autore o Publish localmente.
Sebbene QuickStart fornisca un'esperienza di sviluppo locale, non tutte le funzionalità sono disponibili nell'as a Cloud Service Adobe Experience Manager. Quindi, verifica sempre le funzionalità e il codice con Adobe Experience Manager as a Cloud Service ambiente di sviluppo prima di spostare le funzionalità nell'area di staging o produzione.
Per installare e configurare l’ambiente di Experience Manager locale, effettua le seguenti operazioni:
- Scarica ed estrai l'SDK Adobe Experience Manager as a Cloud Service
- Configura un'istanza Autore
- Configura un'istanza di Publish
Aggiungere l’archivio Forms alle istanze locali di Author e Publish e configurare utenti specifici di Forms add-forms-archive-configure-users
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 add-forms-archive
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. Installare il pacchetto per creare un modulo adattivo e utilizzare varie altre funzionalità di AEM Forms. Per installare il pacchetto:
-
Scarica ed estrai l'archivio AEM Forms più recente per il tuo sistema operativo da Software Distribution.
-
Passa alla directory crx-quickstart/install. Se la cartella non esiste, creala.
-
Arrestare l'istanza AEM, inserire l'archivio delle funzionalità del componente aggiuntivo AEM Forms,
aem-forms-addon-<version>.far
, nella cartella di installazione. -
Passare alla finestra di comando attiva e premere il comando
Ctrl + C
per riavviare l'SDK.note note NOTE Per riavviare l'SDK, si consiglia di utilizzare il comando 'Ctrl + C'. Il riavvio dell’SDK dell’AEM con metodi alternativi, ad esempio l’arresto dei processi Java, può causare incongruenze nell’ambiente di sviluppo dell’AEM.
Configurare utenti e autorizzazioni configure-users-and-permissions
Crea utenti come Sviluppatore moduli e Professionista moduli e aggiungi questi utenti a gruppi di moduli predefiniti per fornire loro le autorizzazioni necessarie. Nella tabella seguente sono elencati tutti i tipi di utenti e i gruppi predefiniti per ogni tipo di utente di Forms:
Quando non è richiesta l'autenticazione utente per accedere a Adaptive Forms, non assegnare alcun gruppo a tali utenti.
Imposta ambiente di sviluppo locale per documento di record (DoR) docker-microservices
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:
-
Installare e configurare Docker:
-
(Per Microsoft® Windows) Installa Docker Desktop. Configura
Docker Engine
edocker-compose
nel computer. -
(Apple macOS) Installa 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 Docker Compose nel computer.
note note NOTE -
Per Apple macOS, inserire nell'elenco Consentiti cartelle contenenti istanze di 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).
-
-
Crea una cartella, ad esempio aem-sdk, in parallelo alle istanze di authoring e pubblicazione. Ad esempio, C:\aem-sdk.
-
Estrarre il file
aem-forms-addon-<version>.zip\aem-forms-addon-native-<version>.zip
. -
Creare una variabile di ambiente AEM_HOME e puntare all'installazione locale di AEM Author. Ad esempio, C:\aem\author.
-
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.
-
Aprire il prompt dei comandi e passare alla cartella
aem-forms-addon-native-<version>
. -
Assicurati che l’istanza locale di AEM Author sia operativa. Esegui i seguenti comandi per avviare l'SDK:
-
Su Microsoft® Windows
code language-shell sdk.bat start
-
Linux® o Apple macOS
code language-shell % export AEM_HOME=[local AEM Author installation] % ./sdk.sh start
note note NOTE 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. http://localhost:4502/libs/xfaforms/profiles/default.print.pdf?template=crx:///content/dam/formsanddocuments/cheque-request.xdp converte ad esempio il file XDP nel documento PDF.
Configurare un progetto di sviluppo per Forms basato su Archetipo Experience Manager forms-cloud-service-local-development-environment
Utilizza questo progetto per creare Forms adattivo, distribuire aggiornamenti di configurazione, sovrapposizioni, creare componenti per moduli adattivi personalizzati, testare e codice personalizzato nell’SDK Experience Manager Forms locale. Dopo aver eseguito il test in locale, è possibile 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:
Imposta il progetto basato su Archetipo AEM versione 32 o successiva per ottenere e utilizzare i temi Tranquil, Urbane e Ultramarine con AEM Forms as a Cloud Service.
Per impostare il progetto:
-
Clona archivio Git Cloud Manager nell'istanza di sviluppo locale: L'archivio Git di Cloud Manager contiene un progetto AEM predefinito. È basato 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 portare il progetto nell’ambiente di sviluppo locale. Per informazioni dettagliate sull'accesso all'archivio, vedere Accesso agli archivi.
-
Crea un Experience Manager Forms come progetto [Cloud Service]: Crea un Experience Manager Forms come progetto [Cloud Service] basato sull'ultimo archetipo AEM o versione successiva. L'archetipo consente agli sviluppatori di iniziare facilmente a sviluppare per l'as a Cloud Service AEM Forms. Include inoltre alcuni temi e modelli di esempio per aiutarti a iniziare rapidamente.
Aprire il prompt dei comandi ed eseguire il comando seguente per creare un progetto as a Cloud Service Experience Manager Forms.
code language-shell 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"
Modifica
appTitle
,appId
egroupId
nel comando precedente per riflettere l'ambiente. Impostare inoltre il valore di includeFormsenrollment, includeFormscommunications e includeFormsheadless suy
on
a seconda della licenza e dei requisiti. IncludeFormsheadless è obbligatorio per creare Forms adattivo basato su Componenti core.-
Utilizza l'opzione
includeFormsenrollment=y
per includere le configurazioni specifiche di Forms, i temi, i modelli, i Componenti core e le dipendenze necessari per creare Forms adattivo. Se si utilizza Forms Portal, impostare l'opzioneincludeExamples=y
. Aggiunge inoltre al progetto i componenti core di Forms Portal. -
Utilizza l'opzione
includeFormscommunications=y
per includere i componenti core Forms e le dipendenze necessarie per includere la funzionalità Comunicazioni con i clienti.note warning WARNING - Durante la creazione di un progetto di Archetipo con versione 45, la [cartella dei progetti di 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.
-
-
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 Generazione e installazione
-
Distribuisci il codice nell'ambiente AEM Forms as a Cloud Service.
Configurare gli strumenti Dispatcher locali setup-local-dispatcher-tools
Dispatcher è un modulo server web Apache HTTP che fornisce un livello di sicurezza e prestazioni tra il livello CDN e AEM Publish. Dispatcher è parte integrante dell’architettura Experience Manager complessiva e dovrebbe far parte dell’ambiente di sviluppo locale.
Per configurare Dispatcher locale e aggiungere regole specifiche per Forms, effettua le seguenti operazioni:
Configurare il Dispatcher locale setup-local-dispatcher
As a Cloud Service L'SDK di Experience Manager 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 da riga di comando per trasferire i file di configurazione del server web Apache HTTP e di Dispatcher in un formato compatibile e distribuirli in Dispatcher in esecuzione nel contenitore Docker.
La memorizzazione nella cache in Dispatcher consente a AEM Forms di precompilare il Forms adattivo in un client. Migliora la velocità di rendering dei moduli precompilati.
Per istruzioni dettagliate sulla configurazione di Dispatcher, vedere Configurare gli strumenti Dispatcher locali
Aggiungere regole specifiche per Forms a Dispatcher forms-specific-rules-to-dispatcher
Per configurare la cache di Dispatcher per Experience Manager Forms as a Cloud Service, effettua le seguenti operazioni:
-
Apri il progetto AEM e passa a
\src\conf.dispatcher.d\available_farms
-
Crea una copia del file
default.farm
. Esempio:forms.farm
. -
Apri il file
forms.farm
creato per la modifica e sostituisci il seguente codice:code language-json #/ignoreUrlParams { #/0001 { /glob "*" /type "deny" } #/0002 { /glob "q" /type "allow" } #}
con
code language-json /ignoreUrlParams { /0001 { /glob "*" /type "deny" } /0002 { /glob "dataRef" /type "allow" } }
-
Salva e chiudi il file.
-
Passare a
conf.d/enabled_farms
e creare un collegamento simbolico al fileforms.farm
. -
Compila e distribuisci il progetto nell'ambiente as a Cloud Service AEM Forms.
Considerazioni sul caching considerations-about-caching
-
Il caching di Dispatcher consente a AEM Forms di precompilare il Forms adattivo in un client. Migliora la velocità di rendering dei moduli precompilati.
-
Per impostazione predefinita, la memorizzazione nella cache delle funzioni di contenuto protetto è disabilitata. Per abilitare questa funzione, è possibile eseguire le istruzioni fornite nell'articolo Caching di contenuto protetto
-
Dispatcher potrebbe non riuscire ad annullare la validità di alcuni Forms adattivi e dei relativi Forms adattivi. Per risolvere questi problemi, vedere AEM Forms Memorizzazione in cache nella sezione relativa alla risoluzione dei problemi.
-
Memorizzazione in cache di Forms adattivo localizzato:
- Utilizza il formato URL
http://host:port/content/forms/af/<afName>.<locale>.html
per richiedere una versione localizzata di un modulo adattivo invece dihttp://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:
- Utilizza il formato URL
-
Quando si utilizza l'URL Format
http://host:port/content/forms/af/<adaptivefName>.html
e l'opzione Use Browser Locale in Configuration Manager è disabilitata, 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 l'URL Format
http://host:port/content/forms/af/<adaptivefName>.html
e l'opzione Use Browser Locale in Configuration Manager è 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ò causare il caching di [solo della prima istanza di un modulo adattivo]. Per evitare che il problema si verifichi nell'istanza, vedere solo la prima istanza di un modulo adattivo è memorizzata nella cache nella sezione relativa alla 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 adattivi di Forms nell'ambiente di sviluppo as a Cloud Service e locale di AEM Forms
Aggiornare l’ambiente di sviluppo locale upgrade-your-local-development-environment
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 oppure esportato dalle istanze di Experience Manager locali come CRX-Packages.
Come evitare la perdita di contenuti durante l’aggiornamento dell’SDK avoid-content-loss-when-upgrading--SDK
L'aggiornamento dell'SDK comporta la creazione di un nuovo autore e di nuove istanze di Publish, incluso un nuovo archivio (Configura progetto AEM), il che significa che tutte le modifiche apportate a un archivio dell'SDK precedente andranno perse. Per le strategie valide per contribuire alla persistenza dei contenuti tra gli aggiornamenti dell'SDK, vedere 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 backup-and-import-Forms-specific-content-to-new-SDK-environment
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 create-backup-of-your-existing-content
Esegui il backup del Forms adattivo, dei modelli, del modello dati del modulo (FDM), del tema, delle configurazioni e del codice personalizzato. Per creare il backup, è possibile eseguire le operazioni seguenti:
-
Scarica Forms, temi e PDF forms adattivi.
-
Esportare modelli di moduli adattivi.
-
Scarica modelli dati modulo
-
Esporta modelli modificabili, configurazioni cloud e modello di flusso di lavoro. Per esportare tutti gli elementi precedentemente menzionati dall'SDK esistente, crea un pacchetto CRX con i seguenti filtri:
- /conf/ReferenceEditableTemplates
- /conf/global/settings/cloudconfigs
- /conf/global/settings/wcm
- /var/workflow/models
- /conf/global/settings/workflow
-
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 import-the-backup-to-your-new-SDK-environment
Importa Forms adattivo, modelli, modello dati modulo, tema, configurazioni e codice personalizzato nel nuovo ambiente. Per importare il backup, è possibile effettuare le seguenti operazioni:
-
Importa Forms, temi e PDF forms adattivi in nuovi ambienti SDK.
-
Importare modelli di moduli adattivi nel nuovo ambiente SDK.
-
Carica modelli dati modulo nel nuovo ambiente SDK.
-
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 nel nuovo ambiente SDK.
-
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.