Rendering di Forms basato su frammenti

Ultimo aggiornamento: 14 luglio 2024
  • Si applica a:
  • Experience Manager 6.5
  • Argomenti:

Creato per:

  • Sviluppatore

Gli esempi e gli esempi contenuti in questo documento sono solo per AEM Forms in ambiente JEE.

Rendering di Forms basato su frammenti

Il servizio Forms può eseguire il rendering di moduli basati su frammenti creati con Designer. Un frammento è una parte riutilizzabile di un modulo e viene salvato come file XDP separato che può essere inserito in più progettazioni di moduli. Ad esempio, un frammento può includere un blocco di indirizzi o un testo legale.

L’utilizzo di frammenti semplifica e velocizza la creazione e la manutenzione di un gran numero di moduli. Durante la creazione di un modulo, viene inserito un riferimento al frammento richiesto e il frammento viene visualizzato nel modulo. Il riferimento al frammento contiene un sottomodulo che punta al file XDP fisico. Per informazioni sulla creazione di strutture di moduli basate su frammenti, vedere Forms Designer

Un frammento può includere diverse sottomaschere racchiuse in un set di sottomaschere di scelta. I set di sottomaschere di scelta controllano la visualizzazione delle sottomaschere in base al flusso di dati provenienti da una connessione dati. È possibile utilizzare le istruzioni condizionali per determinare quale sottomaschera all'interno della serie viene visualizzata nella maschera consegnata. Ad esempio, ogni sottomaschera di un set può includere informazioni relative a una particolare posizione geografica e la sottomaschera visualizzata può essere determinata in base alla posizione dell'utente.

Un frammento script contiene funzioni o valori JavaScript riutilizzabili che vengono memorizzati separatamente da un particolare oggetto, ad esempio un parser di date o una chiamata a un servizio Web. Questi frammenti includono un singolo oggetto script che viene visualizzato come elemento figlio di variabili nella tavolozza Gerarchia. I frammenti non possono essere creati da script che sono proprietà di altri oggetti, ad esempio script di eventi come validate, calculate o initialize.

Di seguito sono riportati i vantaggi dell’utilizzo dei frammenti:

  • Riutilizzo del contenuto: è possibile utilizzare i frammenti per riutilizzare il contenuto in più progettazioni di moduli. Quando è necessario utilizzare parte dello stesso contenuto in più moduli, l’utilizzo di un frammento è più rapido e semplice rispetto alla copia o alla ricreazione del contenuto. L’utilizzo dei frammenti assicura inoltre che le parti utilizzate di frequente di una progettazione di moduli abbiano contenuto e aspetto coerenti in tutti i moduli di riferimento.
  • Aggiornamenti globali: è possibile utilizzare i frammenti per apportare modifiche globali a più moduli una sola volta, in un unico file. È possibile modificare il contenuto, gli oggetti script, le associazioni di dati, il layout o gli stili di un frammento. Le modifiche verranno applicate a tutti i moduli XDP che fanno riferimento al frammento.
  • Ad esempio, un elemento comune in molti moduli potrebbe essere un blocco di indirizzi che include un oggetto elenco a discesa per il paese. Se è necessario aggiornare i valori dell'oggetto elenco a discesa, è necessario aprire più maschere per apportare le modifiche. Se includi il blocco di indirizzi in un frammento, per apportare le modifiche dovrai aprire un solo file di frammento.
  • Per aggiornare un frammento in un modulo PDF, è necessario salvare nuovamente il modulo in Designer.
  • Creazione di moduli condivisi: è possibile utilizzare i frammenti per condividere la creazione di moduli tra diverse risorse. Gli sviluppatori di moduli con esperienza nello scripting o altre funzioni avanzate di Designer possono sviluppare e condividere frammenti che sfruttano le proprietà di script e dinamiche. I progettisti di moduli possono utilizzare tali frammenti per disporre le progettazioni dei moduli e per garantire che tutte le parti di un modulo abbiano un aspetto e una funzionalità coerenti in più moduli progettati da più persone.

Assemblaggio di una struttura di modulo assemblata mediante frammenti

È possibile assemblare una struttura di modulo da passare al servizio Forms in base a più frammenti. Per assemblare più frammenti, utilizzare il servizio Assembler. Per visualizzare un esempio di utilizzo del servizio Assemble per la creazione di una struttura di modulo utilizzata da altri servizi Forms (il servizio di output), vedere Creazione di documenti PDF tramite frammenti. Invece di utilizzare il servizio di output, puoi eseguire lo stesso flusso di lavoro utilizzando il servizio Forms.

Quando si utilizza il servizio Assembler, si passa una progettazione di modulo che è stata assemblata utilizzando frammenti. La struttura del modulo creata non fa riferimento ad altri frammenti. In questo argomento viene invece illustrato come passare al servizio Forms una struttura di modulo che fa riferimento ad altri frammenti. Tuttavia, la progettazione del modulo non è stata assemblata da Assembler. È stato creato in Designer.

NOTA
Per ulteriori informazioni sul servizio Forms, vedere Riferimento ai servizi per AEM Forms.
NOTA
Per informazioni sulla creazione di un'applicazione basata sul Web per il rendering di moduli basati su frammenti, vedere Creazione di applicazioni Web per il rendering di Forms.

Riepilogo dei passaggi

Per eseguire il rendering di un modulo basato su frammenti, effettuare le seguenti operazioni:

  1. Includi file di progetto.
  2. Crea un oggetto API client di Forms.
  3. Specifica i valori URI.
  4. Eseguire il rendering del modulo.
  5. Scrivere il flusso di dati del modulo nel browser Web client.

Includi file di progetto

Includi i file necessari nel progetto di sviluppo. Se stai creando un’applicazione client utilizzando Java, includi i file JAR necessari. Se utilizzi i servizi web, accertati di includere i file proxy.

Creare un oggetto API client di Forms

Prima di poter eseguire a livello di programmazione un'operazione API client del servizio Forms, è necessario creare un client del servizio Forms.

Specificare valori URI

Per eseguire correttamente il rendering di un modulo basato su frammenti, è necessario assicurarsi che il servizio Forms sia in grado di individuare sia il modulo che i frammenti (i file XDP) a cui fa riferimento il progetto del modulo. Si supponga ad esempio che il modulo sia denominato PO.xdp e che utilizzi due frammenti denominati FooterUS.xdp e FooterCanada.xdp. In questa situazione, il servizio Forms deve essere in grado di individuare tutti e tre i file XDP.

È possibile organizzare un modulo e i relativi frammenti posizionando il modulo in una posizione e i frammenti in un'altra, oppure è possibile posizionare tutti i file XDP nella stessa posizione. Ai fini di questa sezione, supponiamo che tutti i file XDP siano presenti nell’archivio AEM Forms. Per informazioni sul posizionamento dei file XDP nell'archivio di AEM Forms, vedere Scrittura delle risorse.

Quando si esegue il rendering di un modulo basato su frammenti, è necessario fare riferimento solo al modulo stesso e non ai frammenti. Ad esempio, è necessario fare riferimento a PO.xdp e non a FooterUS.xdp o FooterCanada.xdp. Assicurati di posizionare i frammenti in una posizione in cui il servizio Forms possa individuarli.

Rendering del modulo

Un modulo basato su frammenti può essere renderizzato nello stesso modo dei moduli non frammentati. In altre parole, è possibile eseguire il rendering del modulo come PDF, HTML o Guide del modulo (obsoleto). Nell'esempio di questa sezione viene eseguito il rendering di un modulo basato su frammenti come modulo PDF interattivo. (Vedi Rendering dei PDF forms interattivi.)

Scrivere il flusso di dati del modulo nel browser Web client

Quando il servizio Forms esegue il rendering di un modulo, restituisce un flusso di dati del modulo che è necessario scrivere nel browser Web client. Quando viene scritto nel browser Web client, il modulo è visibile all'utente.

Consulta anche

Eseguire il rendering di moduli basati su frammenti utilizzando l’API Java

Eseguire il rendering di moduli basati su frammenti utilizzando l’API del servizio web

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Guida introduttiva all’API di servizio Forms

Rendering dei PDF forms interattivi

Creazione di applicazioni Web per il rendering di Forms

Eseguire il rendering di moduli basati su frammenti utilizzando l’API Java

Eseguire il rendering di un modulo basato su frammenti utilizzando l’API Forms (Java):

  1. Includi file di progetto

    Includi i file JAR client, ad esempio adobe-forms-client.jar, nel percorso di classe del progetto Java.

  2. Creare un oggetto API client di Forms

    • Creare un oggetto ServiceClientFactory contenente le proprietà di connessione.
    • Creare un oggetto FormsServiceClient utilizzando il relativo costruttore e passando l'oggetto ServiceClientFactory.

  3. Specificare i valori URI

    • Creare un oggetto URLSpec che memorizza i valori URI utilizzando il relativo costruttore.
    • Richiama il metodo setApplicationWebRoot dell'oggetto URLSpec e passa un valore stringa che rappresenta la radice web dell'applicazione.
    • Richiama il metodo setContentRootURI dell'oggetto URLSpec e passa un valore stringa che specifica il valore URI della radice del contenuto. Assicurati che la progettazione del modulo e i frammenti siano nell’URI della directory principale del contenuto. In caso contrario, il servizio Forms genera un'eccezione. Per fare riferimento all'archivio, specificare repository://.
    • Richiama il metodo setTargetURL dell'oggetto URLSpec e passa un valore stringa che specifica il valore dell'URL di destinazione in cui vengono inviati i dati del modulo. Se definisci l’URL di destinazione nella progettazione del modulo, puoi trasmettere una stringa vuota. È inoltre possibile specificare l'URL a cui viene inviato un modulo per eseguire i calcoli.

  4. Rendering del modulo

    Richiama il metodo renderPDFForm dell'oggetto FormsServiceClient e passa i seguenti valori:

    • Valore stringa che specifica il nome della struttura del modulo, inclusa l'estensione del nome file. Se si fa riferimento a una struttura di modulo che fa parte di un'applicazione Forms, assicurarsi di specificare il percorso completo, ad esempio Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Oggetto com.adobe.idp.Document contenente dati da unire al modulo. Se non si desidera unire i dati, passare un oggetto com.adobe.idp.Document vuoto.
    • Un oggetto PDFFormRenderSpec che memorizza le opzioni di runtime.
    • Oggetto URLSpec contenente i valori URI richiesti dal servizio Forms per il rendering di un modulo basato su frammenti.
    • Oggetto java.util.HashMap che memorizza gli allegati. Questo è un parametro facoltativo ed è possibile specificare null se non si desidera allegare file al modulo.

    Il metodo renderPDFForm restituisce un oggetto FormsResult che contiene un flusso di dati del modulo che deve essere scritto nel browser Web client.

  5. Scrivere il flusso di dati del modulo nel browser Web client

    • Creare un oggetto com.adobe.idp.Document richiamando il metodo getOutputContent dell'oggetto FormsResult.
    • Ottenere il tipo di contenuto dell'oggetto com.adobe.idp.Document richiamando il relativo metodo getContentType.
    • Impostare il tipo di contenuto dell'oggetto javax.servlet.http.HttpServletResponse richiamando il relativo metodo setContentType e passando il tipo di contenuto dell'oggetto com.adobe.idp.Document.
    • Creare un oggetto javax.servlet.ServletOutputStream utilizzato per scrivere il flusso di dati del modulo nel browser Web client richiamando il metodo getOutputStream dell'oggetto javax.servlet.http.HttpServletResponse.
    • Creare un oggetto java.io.InputStream richiamando il metodo getInputStream dell'oggetto com.adobe.idp.Document.
    • Creare una matrice di byte popolarla con il flusso di dati del modulo richiamando il metodo read dell'oggetto InputStream e passando la matrice di byte come argomento.
    • Richiama il metodo write dell'oggetto javax.servlet.ServletOutputStream per inviare il flusso di dati del modulo al browser Web client. Passare la matrice di byte al metodo write.

Consulta anche

Rendering di Forms basato su frammenti

Quick Start (modalità SOAP): rendering di un modulo basato su frammenti tramite API Java

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione