Best practice per l’utilizzo dei moduli adattivi best-practices-for-working-with-adaptive-forms

Utilizzare Apache Maven aem-project-archetype per creare e gestire la struttura per il progetto AEM. Crea la struttura e i modelli consigliati per il progetto AEM. Inoltre, fornisce sistemi di automazione della build e di controllo delle modifiche per facilitare la gestione del progetto.

• Utilizza il comando maven archetype:generate per generare la struttura iniziale.
• Utilizza il comando maven eclipse:eclipse per generare i file di progetto dell’eclissi e importare il progetto nell’eclissi.

Lo strumento FileVault o VLT consente di mappare il contenuto di un'istanza CRX o AEM sul file system. Fornisce operazioni di gestione del controllo delle modifiche, come il check-in e il check-out del contenuto del progetto AEM. Consulta Come utilizzare lo strumento VLT.

Se utilizzi un ambiente di sviluppo integrato con Eclipse, puoi utilizzare gli strumenti per sviluppatori AEM per integrare perfettamente Eclipse IDE con le istanze AEM per creare applicazioni AEM. Per informazioni dettagliate, consulta Strumenti per sviluppatori AEM per Eclipse.

Non memorizzare alcun contenuto e non apportare modifiche nella cartella /libs. Crea sovrapposizioni nelle cartelle /app per estendere o sovrascrivere le funzionalità predefinite.

Quando crei pacchetti per spostare il contenuto, assicurati che i percorsi dei filtri dei pacchetti siano corretti e che siano menzionati solo i percorsi richiesti.

Non memorizzare alcun contenuto e non apportare modifiche nella cartella /libs. Crea sovrapposizioni nelle cartelle /app per estendere o sovrascrivere le funzionalità predefinite.

Definire le dipendenze corrette per i pacchetti in modo da forzare un ordine/sequenza di installazione predeterminato.

Non creare nodi referenziabili in /libs o /apps.

Un modello di modulo adattivo è una pagina AEM specializzata che definisce la struttura e le informazioni intestazione-piè di pagina di un modulo adattivo. Un modello presenta layout, stili e struttura di base preconfigurati per un modulo adattivo. AEM Forms fornisce modelli e componenti pronti all’uso che puoi utilizzare per la creazione di moduli adattivi. Tuttavia, puoi creare modelli e componenti personalizzati in base alle tue esigenze. Si consiglia di raccogliere i requisiti per i modelli e i componenti aggiuntivi necessari nei moduli adattivi. Per informazioni dettagliate, consulta Personalizzazione di moduli e componenti adattivi.

Si consiglia di caricare i pacchetti del modulo utilizzando l’interfaccia utente di Form Manager invece dell’interfaccia utente di CRX Package Manager, in quanto il caricamento dei pacchetti tramite CRX Package Manager può talvolta causare anomalie.

AEM Forms consente di creare moduli adattivi basati sui seguenti modelli di moduli. I modelli di modulo fungono da interfaccia per lo scambio di dati tra un modulo e un sistema AEM e forniscono una struttura basata su XML per il flusso di dati all’interno e all’esterno di un modulo adattivo. Inoltre, i modelli di modulo impongono regole e vincoli ai moduli adattivi sotto forma di vincoli di schema e XFA.

• Nessuno: i moduli adattivi creati con questa opzione non utilizzano alcun modello di modulo. I dati XML generati da tali moduli hanno una struttura piatta con campi e valori corrispondenti.
• Schema XML o JSON: gli schemi XML e JSON rappresentano la struttura in cui i dati vengono prodotti o utilizzati dal sistema back-end dell'organizzazione. È possibile associare uno schema a un modulo adattivo e utilizzarne gli elementi per aggiungere contenuto dinamico al modulo adattivo. Gli elementi dello schema sono disponibili nella scheda Oggetto modello dati del browser dei contenuti per la creazione di moduli adattivi. Puoi trascinare gli elementi dello schema per creare il modulo.
• Modello di modulo XFA: è un modello di modulo ideale se si dispone di investimenti in moduli HTML5 basati su XFA. Fornisce un modo diretto per convertire i moduli basati su XFA in moduli adattivi. Eventuali regole XFA esistenti vengono mantenute nei moduli adattivi associati. I moduli adattivi risultanti supportano i costrutti XFA, ad esempio convalide, eventi, proprietà e modelli.
• Modello dati modulo: è un modello di modulo preferito se desideri integrare i sistemi back-end, come database, servizi Web e profilo utente AEM, per precompilare i moduli adattivi e riscrivere i dati dei moduli inviati nei sistemi back-end. L’editor modello dati modulo consente di definire e configurare entità e servizi in un modello dati modulo da utilizzare per creare moduli adattivi. Per ulteriori informazioni, vedere Integrazione dati AEM Forms.

AEM Forms fornisce modelli di moduli adattivi pronti all’uso che è possibile utilizzare per creare moduli adattivi. Puoi anche creare modelli personalizzati. L’AEM fornisce modelli statici e modificabili.

• I modelli statici sono definiti e configurati dagli sviluppatori.
• I modelli modificabili vengono creati dagli autori mediante l’editor di modelli. L’editor modelli ti consente di definire una struttura di base e il contenuto iniziale in un modello. Qualsiasi modifica nel livello struttura si riflette in tutti i moduli che utilizzano tale modello. Il contenuto iniziale può includere un tema preconfigurato, un servizio di precompilazione, un’azione di invio e così via. Tuttavia, queste impostazioni possono essere modificate per un modulo utilizzando l’editor di moduli. Per ulteriori informazioni, vedere Modelli di modulo adattivo.

Per applicare uno stile a un campo o a un'istanza di pannello specifica, utilizza lo stile in linea. In alternativa, puoi definire una classe in un file CSS e specificare il nome della classe nella proprietà Classe CSS del componente.

Includi una libreria client in un componente per applicare in modo coerente gli stili tra i moduli adattivi o i frammenti che utilizzano tale componente. Per ulteriori informazioni, consulta Creare un componente pagina modulo adattivo.

Applica gli stili definiti in una libreria client per selezionare i moduli adattivi specificando il percorso della libreria client nel campo Percorso file CSS nelle proprietà del contenitore di moduli adattivi.

Per creare una libreria client degli stili, puoi configurare il file CSS personalizzato nella libreria client di base dell’Editor temi o nelle proprietà Contenitore modulo.

I moduli adattivi forniscono layout di pannello, ad esempio reattivi, a schede, fisarmoniche e procedura guidata, per controllare il layout dei componenti del modulo in un pannello. È possibile creare layout di pannello personalizzati e renderli disponibili per l'utilizzo da parte degli autori di moduli. Per ulteriori informazioni, consulta Creazione di componenti di layout personalizzati per moduli adattivi.

Puoi anche personalizzare specifici componenti del modulo adattivo, come campi e layout del pannello.

• Utilizza la funzionalità Sovrapposizione di AEM per modificare una copia di un componente. Si sconsiglia di modificare i componenti predefiniti.
• Per personalizzare il layout dei componenti predefiniti dei moduli adattivi in /libs, crea componenti di layout personalizzati oltre ai layout predefiniti.
• Introdurre interattività personalizzate creando widget o aspetti personalizzati. Si sconsiglia di modificare i componenti predefiniti. Per ulteriori informazioni, vedere Framework aspetto.

Consulta Gestione di informazioni personali per consigli sulla gestione dei dati PII.

Utilizza il browser Oggetti nella barra laterale per accedere rapidamente ai campi in fondo alla gerarchia del modulo. È possibile utilizzare la casella di ricerca per cercare oggetti nel modulo o nella struttura ad albero degli oggetti per spostarsi da un oggetto all'altro.

Per visualizzare e modificare le proprietà di un componente nel browser Componenti nella barra laterale, selezionare il componente e fare clic su . Puoi anche fare doppio clic su un componente per visualizzarne le proprietà nel browser delle proprietà.

Utilizzare le scelte rapide da tastiera per eseguire azioni rapide sui moduli. Consulta Scelte rapide da tastiera di AEM Forms.

L’utilizzo dei componenti di moduli adattivi è consigliato solo nelle pagine di moduli adattivi. I componenti dipendono dalla gerarchia principale. Pertanto, non utilizzarli in una pagina AEM.

Utilizza nomi significativi e univoci per i campi modulo e i componenti per evitare possibili conflitti durante la scrittura delle regole.

Utilizzare l'operatore this per un componente per fare riferimento a se stesso in un'espressione di regola. In questo modo la regola rimane valida anche se il nome del componente cambia. Esempio: field1.valueCommit script: this.value > 10.

Utilizza i nomi dei componenti quando fai riferimento ad altri componenti del modulo. Utilizzare la proprietà value per recuperare il valore di un campo o di un componente. Esempio: field1.value.

Per evitare conflitti, fai riferimento ai componenti per gerarchia univoca relativa. Esempio: parentName.fieldName.

Quando gestisci regole complesse o di uso comune, considera la scrittura di regole business come funzioni in una libreria client separata che puoi specificare e riutilizzare nei moduli adattivi. La libreria client deve essere una libreria indipendente e non deve avere dipendenze esterne, ad eccezione di jQuery e Underscore.js. È inoltre possibile utilizzare la libreria client per applicare la riconvalida lato server dei dati del modulo inviati.

I moduli adattivi forniscono un set di API che è possibile utilizzare per comunicare con ed eseguire azioni sui moduli adattivi. Alcune delle API chiave sono le seguenti. Per ulteriori informazioni, vedere Riferimento API della libreria JavaScript per Forms adattivo.

• guideBridge.reset(): reimposta un modulo.

• guideBridge.submit(): invia un modulo.

• guideBridge.setFocus(somExp, focusOption, runCompletionExp): imposta lo stato attivo su un campo.

• guideBridge.validate(errorList, somExpression, focus): convalida un modulo.

• guideBridge.getDataXML(options): ottiene i dati del modulo come XML.

• guideBridge.resolveNode(somExpression): ottiene un oggetto modulo.

• guideBridge.setProperty(somList, propertyName, valueList): imposta la proprietà di un oggetto modulo.

• Inoltre, puoi utilizzare le seguenti proprietà del campo:

  • field.value per modificare il valore di un campo.
  • field.enabled per abilitare/disabilitare un campo.
  • field.visible per modificare la visibilità di un campo.

Gli autori di moduli adattivi potrebbero dover scrivere codice JavaScript per creare una logica di business in un modulo. JavaScript è potente ed efficace, ma probabilmente potrebbe compromettere le aspettative di sicurezza. Pertanto, devi assicurarti che l’autore del modulo sia un utente fidato e che esistano processi per rivedere e approvare il codice JavaScript prima che un modulo venga messo in produzione. L’amministratore può limitare l’accesso all’editor di regole ai gruppi di utenti in base al loro ruolo o funzione. Consulta Concedere l'accesso all'editor di regole a specifici gruppi di utenti.

È possibile utilizzare le espressioni nelle regole per rendere dinamici i moduli adattivi. Tutte le espressioni sono espressioni JavaScript valide e utilizzano API di modelli di script per moduli adattivi. Queste espressioni restituiscono valori di determinati tipi. Per ulteriori informazioni sulle espressioni e sulle relative best practice, vedere Espressioni modulo adattivo.

L’Adobe consiglia di utilizzare le operazioni sincrone di JavaScript anziché quelle asincrone durante la creazione di regole con l’editor di regole. L'uso di operazioni asincrone è fortemente sconsigliato. Tuttavia, se ti trovi in una situazione in cui le operazioni asincrone sono inevitabili, è essenziale implementare le funzioni di chiusura di JavaScript. In questo modo, puoi proteggere efficacemente da potenziali condizioni di concorrenza, garantendo prestazioni ottimali alle tue implementazioni di regole e mantenendo la stabilità nell’intero processo.

Ad esempio, supponiamo che sia necessario recuperare dati da un’API esterna e quindi applicare alcune regole in base a tali dati. Utilizziamo una chiusura per gestire la chiamata API asincrona e ci assicuriamo che le regole vengano applicate dopo il recupero dei dati. Di seguito è riportato un codice di esempio:

     function fetchDataFromAPI(apiEndpoint, callback) {
      // Simulate asynchronous API call with setTimeout
      setTimeout(() => {
        // Assuming the API call is successful, we receive some data
        const data = {
          someValue: 42,
        };
        // Invoke the callback with the fetched data
        callback(data);
      }, 2000); // Simulate a 2-second delay for the API call
    }
    // Rule implementation using Closure
    function ruleImplementation(apiEndpoint) {
      // Using a closure to handle the asynchronous API call and rule application
      // say you have set this value in street field inside address panel
      var streetField = address.street;
      fetchDataFromAPI(apiEndpoint, (data) => {
        streetField.value = data.someValue;
      });
    }
    // Example usage of the rule implementation
    const apiEndpoint = "https://example-api.com/data";
    ruleImplementation(apiEndpoint);

In questo esempio, fetchDataFromAPI simula una chiamata API asincrona utilizzando setTimeout. Una volta recuperati i dati, richiama la funzione di callback fornita, che è la chiusura per gestire la successiva applicazione della regola. La funzione ruleImplementation contiene la logica della regola.

Si consiglia di creare moduli adattivi utilizzando il modello dati del modulo XSD anche quando si converte un XFA in modulo adattivo, se possibile.

Includi solo i campi e i pannelli nei moduli adattivi che acquisiscono informazioni dall’utente. Valuta se mantenere minimo il contenuto statico o utilizza URL per aprirli in una finestra separata.

Anche se ogni modulo è progettato per uno scopo specifico, nella maggior parte dei moduli sono presenti alcuni segmenti comuni. Ad esempio, dati personali, indirizzo, dettagli sull’impiego e così via. Crea frammenti di moduli adattivi per sezioni e elementi modulo comuni e utilizzali in tutti i moduli. È inoltre possibile salvare un pannello in un modulo esistente come frammento. Qualsiasi modifica in un frammento si riflette in tutti i moduli adattivi associati. Promuove l’authoring collaborativo in quanto più autori possono lavorare contemporaneamente su diversi frammenti che compongono un modulo.

• Analogamente ai moduli adattivi, si consiglia di definire nella libreria client tutti gli stili e gli script personalizzati specifici del frammento, utilizzando la finestra di dialogo del contenitore di frammenti. Inoltre, prova a creare frammenti autosufficienti che non dipendono da oggetti esterni.
• Evita l’utilizzo di script per più frammenti. Se è presente un oggetto esterno al frammento a cui si deve fare riferimento, provare a rendere tale oggetto parte del modulo principale. Se l’oggetto deve ancora trovarsi in un altro frammento, fai riferimento a esso con il relativo nome nello script.

Utilizza Salva e riprendi con salvataggio automatico per salvare periodicamente il modulo adattivo e consentire agli utenti di visitarlo nuovamente in un secondo momento per completare il modulo.

Configura i frammenti per caricarli in modo differito. In fase di runtime, il rendering del frammento contrassegnato per il caricamento in modo differito viene eseguito solo quando necessario. Riduce in modo significativo il tempo di caricamento per i moduli di grandi dimensioni. È supportato anche nei frammenti con pannelli ripetibili. Per ulteriori informazioni, vedere Configurare il caricamento lento.

• Non configurare il caricamento lento sui frammenti in un layout di griglia reattiva o nel primo pannello.
• I componenti Allegato file e Termini e condizioni non sono supportati nei frammenti caricati in modo differito.
• Contrassegna un valore in un pannello con caricamento lazy come Usa valore a livello globale se tale valore viene utilizzato in un’altra parte del modulo in modo che sia disponibile per l’uso quando il pannello che lo contiene viene scaricato.
• È consigliabile scrivere regole di visibilità per i frammenti che devono essere visualizzati o nascosti in base a una condizione.

Imposta il valore di Numero di chiamate per richiesta in Apache Sling Main Servlet su un numero abbastanza grande. Consente al server Forms di consentire chiamate aggiuntive. Nella configurazione viene visualizzato il valore predefinito 1500. Il valore, 1500 chiamate, è per altri componenti di Experience Manager come Sites e Assets. Il set di valori predefinito per i moduli adattivi è 20000. Se l'errore too many calls si verifica nei registri o se il rendering del modulo non riesce, prova ad aumentare il valore a un numero elevato per risolvere il problema. Se il numero di chiamate supera i 20000, significa che il modulo è complesso e potrebbe richiedere un po’ di tempo per il rendering nel browser. Questo accade solo la prima volta che il modulo viene caricato, dopo che il modulo è stato memorizzato nella cache e una volta memorizzato nella cache, non vi è alcun impatto significativo sulle prestazioni.

AEM Forms fornisce un servizio di precompilazione per leggere i dati da un file XML di dati predefinito e precompilare i campi di un modulo adattivo con il contenuto del file XML precompilato.

L’XML dei dati di precompilazione deve essere conforme allo schema del modello di modulo associato al modulo adattivo.

Includi afBoundedData e afUnBoundedData sezioni nel file XML di precompilazione per precompilare sia i campi associati che quelli non associati in un modulo adattivo.

Per i moduli adattivi basati sul modello di dati del modulo, AEM Forms fornisce il servizio predefinito Modello dati modulo. Il servizio di precompilazione interroga le origini dati per gli oggetti modello dati nel modulo adattivo e i valori dei campi di precompilazione durante il rendering del modulo.

Puoi anche utilizzare i protocolli file, crx, service o http per precompilare i moduli adattivi.

AEM Forms supporta servizi di precompilazione personalizzati che è possibile collegare come servizio OSGi per precompilare i moduli adattivi.

A seconda del modello di dati del modulo su cui si basa un modulo adattivo, è possibile configurare un modello per DoR come segue:

• Modello di modulo XFA: utilizza il file XDP associato come modello DoR.
• Schema XSD: utilizza il modello XFA associato che utilizza lo stesso schema XML utilizzato dal modulo adattivo.
• Nessuno: usa DoR generato automaticamente.

Configura intestazione, piè di pagina, immagini, colore, font e così via direttamente dalla scheda Documento di record dell’editor di moduli adattivi.

Utilizzare DoRService per generare il DoR a livello di programmazione.

Escludere i campi nascosti dal DoR.

Utilizza il parametro di richiesta afAcceptLang per visualizzare il DoR in un'altra lingua.

Utilizza frammenti di modulo adattivi per elementi comuni a più moduli e localizza frammenti. In questo modo è possibile localizzare un frammento una volta e rifletterlo in tutte le forme in cui viene utilizzato il frammento localizzato.

Eventuali modifiche, come l’aggiunta di un nuovo componente o l’applicazione di uno script in un modulo localizzato, non vengono localizzate automaticamente. Pertanto, è necessario finalizzare un modulo prima di localizzarlo per evitare più cicli di localizzazione.

Utilizzare il parametro di richiesta afAcceptLang per ignorare le impostazioni locali del browser ed eseguire il rendering del modulo nelle impostazioni locali specificate. Ad esempio, il seguente URL viene forzato a eseguire il rendering del modulo nelle impostazioni locali giapponesi, indipendentemente dalle impostazioni locali specificate nell’impostazione del browser:

https://'[server]:[port]'/<contextPath>/<formFolder>/<formName>.html?wcmmode=disabled&afAcceptLang=ja

AEM Forms attualmente supporta la localizzazione dei contenuti dei moduli adattivi nelle lingue inglese (en), spagnolo (es), francese (fr), italiano (it), tedesco (de), giapponese (ja), portoghese-brasiliano (pt-BR), cinese (zh-CN), cinese-Taiwan (zh-TW) e coreano (ko-KR). Tuttavia, è possibile aggiungere il supporto per nuove lingue per i moduli adattivi in fase di esecuzione. Per ulteriori informazioni, consulta Supporto di nuove lingue per la localizzazione di moduli adattivi.

Abilita la compressione della libreria client HTML per JavaScript e CSS dalla console Felix.

Memorizza nella cache tutte le librerie client in /etc.clientlibs/fd ed eventuali librerie client personalizzate in AEM Dispatcher per aumentare la reattività e la sicurezza dei moduli pubblicati. Per ulteriori informazioni, vedere Dispatcher.

Non memorizzare nella cache /content/forms/af/ e /content/dam/formsanddocuments/* percorsi. per informazioni dettagliate sulla configurazione della memorizzazione nella cache dei moduli adattivi, vedi memorizzazione nella cache dei moduli adattivi.

Abilita HTML tramite il modulo di compressione del server web. Per ulteriori informazioni, vedere Ottimizzazione delle prestazioni del server AEM Forms.

Aumentare le chiamate per configurazione di richiesta per i moduli di grandi dimensioni. Consulta Ottimizzazione delle prestazioni di moduli complessi e di grandi dimensioni.

Crea pagine di errore personalizzate visualizzate dal gestore degli errori.

Server AEM Forms protetto.

• Utilizzare la modalità di esecuzione nosamplecontent per verificare che non siano presenti contenuti di esempio e utenti di esempio distribuiti nel server di produzione. Vedere Esecuzione di AEM in modalità pronta per la produzione.

Mantenere le dimensioni heap su un minimo di 8 GB. Per altre impostazioni, vedere Ottimizzazione delle prestazioni del server AEM Forms.

Utilizzare le sessioni utente di servizio anziché le sessioni di amministrazione per eseguire attività a livello di servizio. Per ulteriori informazioni, vedere Autenticazione servizio.

Memorizzazione dei dati bozza: se si utilizza la funzione Bozza dei moduli adattivi, è necessario implementare un'interfaccia SPI (Service Provide Interface) personalizzata per memorizzare i dati bozza in un'archiviazione più sicura, ad esempio nel database. Per ulteriori informazioni, vedere Esempio per l'integrazione del componente Bozze e invii con il database.

Memorizzazione dei dati di invio: se si utilizza l'archivio di invio del portale dei moduli, è necessario implementare un SPI personalizzato per memorizzare i dati di invio in un database. Per un esempio di integrazione, vedere Esempio per l'integrazione del componente Bozze e invii con il database.

È inoltre possibile scrivere un'azione di invio personalizzata che memorizzi i dati del modulo e l'allegato in un archivio protetto. Per ulteriori informazioni, vedere Scrittura di un'azione di invio personalizzata per i moduli adattivi.

Lunghezza bozza ID: quando salvi un modulo adattivo come bozza, viene generato un ID bozza per identificare in modo univoco la bozza. Il valore minimo per la lunghezza del campo ID bozza è di 26 caratteri. L'Adobe consiglia di impostare la lunghezza dell'ID bozza su 26 o più caratteri.

Utilizza senza problemi il controllo delle versioni come Git:

• L’isolamento del codice dai contenuti riduce in modo significativo i conflitti Git durante la gestione dei contenuti e promuove un archivio ben organizzato.
• Le funzioni personalizzate sono utili per progetti con più collaboratori che lavorano simultaneamente.

Vantaggi tecnici:

• Le funzioni personalizzate offrono modularità e incapsulamento.
• I moduli possono essere sviluppati, testati e manutenuti in modo indipendente.
• Migliora la riutilizzabilità e la manutenzione del codice.

Processo di sviluppo efficiente:

• La modularità consente agli sviluppatori di concentrarsi su funzionalità specifiche.
• Riduce il carico di lavoro degli sviluppatori riducendo la complessità dell'intera base di codice per un processo di sviluppo più efficiente.