Rendering di Forms basato su frammenti

Rendering di Forms basato su frammenti

Il servizio Forms è in grado di eseguire il rendering dei 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ù strutture del modulo. Ad esempio, un frammento può contenere un blocco indirizzo o note legali.

Utilizzando i frammenti è possibile creare e gestire in modo semplice e veloce anche grandi quantità di moduli. Durante la creazione di un nuovo modulo, è possibile inserire un riferimento al frammento desiderato 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 del modulo basate sui frammenti, vedere Forms Designer

Un frammento può includere diversi sottomoduli racchiusi in un set sottomodulo selezionato. I set sottomodulo selezionati controllano la visualizzazione dei sottomoduli in base al flusso di dati proveniente da una connessione dati. È possibile utilizzare istruzioni condizionali per determinare quale sottomodulo del set visualizzare nel modulo finale. Ad esempio, ogni sottomodulo di un set può includere informazioni per una particolare posizione geografica e il sottomodulo visualizzato può essere determinato in base alla posizione dell'utente.

Un frammento di script contiene funzioni JavaScript riutilizzabili o valori memorizzati separatamente da qualsiasi oggetto particolare, ad esempio analisi delle date o chiamata a un servizio Web. Questi frammenti includono un singolo oggetto script visualizzato come elemento secondario delle variabili nella palette Gerarchia. Non è consentito creare frammenti derivati da script di proprietà di altri oggetti, ad esempio script di evento che eseguono operazioni di convalida, calcolo o inizializzazione.

L’uso dei frammenti presenta i seguenti vantaggi:

  • Riuso del contenuto: È possibile utilizzare i frammenti per riutilizzare il contenuto in più strutture del modulo. Se è necessario utilizzare parte dello stesso contenuto in più moduli, l'uso di un frammento risulta più semplice e rapido rispetto alla copia o alla ricreazione del contenuto. I frammenti garantiscono inoltre che le parti di un modello di modulo usate di frequente siano uniformi, per aspetto e contenuto, in tutti i moduli che vi fanno 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, i binding dei dati, il layout o gli stili di un frammento e tutti i moduli XDP che fanno riferimento al frammento rifletteranno le modifiche.
  • Ad esempio, un elemento comune in molti moduli potrebbe essere un blocco indirizzo che include un oggetto elenco a discesa per il paese. Se è necessario aggiornare i valori per l'oggetto elenco a discesa, è necessario aprire molti moduli per apportare le modifiche. Se si inserisce il blocco indirizzo in un frammento, è necessario aprire un solo file di frammento per apportare le modifiche.
  • 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 una conoscenza approfondita delle funzioni di script o di altre funzioni avanzate di Designer possono creare e condividere frammenti che si avvalgono di proprietà dinamiche e script. I progettisti di moduli possono utilizzare tali frammenti per configurare strutture del moduli e per garantire che tutte le parti di un modulo abbiano aspetto e funzionalità uniformi, indipendentemente dall’autore del modulo.

Assemblare una struttura del modulo assemblata utilizzando i frammenti

È possibile assemblare una struttura del modulo da trasmettere al servizio Forms in base a più frammenti. Per assemblare più frammenti, utilizzare il servizio Assembler. Per un esempio di utilizzo del servizio Assemble per creare una struttura del modulo utilizzata da un altro servizio Forms (il servizio Output), vedere Creazione di documenti PDF utilizzando i frammenti. Invece di utilizzare il servizio Output, è possibile eseguire lo stesso flusso di lavoro utilizzando il servizio Forms.

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

NOTA

Per ulteriori informazioni sul servizio Forms, vedere Guida di riferimento dei servizi per AEM Forms.

NOTA

Per informazioni sulla creazione di un'applicazione basata sul Web per il rendering di moduli basati sui 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 operazioni seguenti:

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

Includi file di progetto

Includete i file necessari nel progetto di sviluppo. Se create un'applicazione client utilizzando Java, includete i file JAR necessari. Se utilizzate i servizi Web, accertatevi di includere i file proxy.

Creare un oggetto Forms Client API

Prima di eseguire un'operazione API client di Forms Service a livello di programmazione, è necessario creare un client di servizi Forms.

Specificare i valori URI

Per eseguire correttamente il rendering di un modulo basato su frammenti, è necessario assicurarsi che il servizio Forms sia in grado di individuare il modulo e i frammenti (file XDP) a cui fa riferimento la struttura del modulo. Ad esempio, si supponga 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 inserendo il modulo in un'unica posizione e i frammenti in un'altra posizione, oppure posizionare tutti i file XDP nella stessa posizione. Ai fini di questa sezione, si supponga che tutti i file XDP si trovino nell'archivio di AEM Forms . Per informazioni sull'inserimento di file XDP nell'archivio di AEM Forms , vedere Risorse di scrittura.

Durante 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. Assicurarsi di posizionare i frammenti in un percorso in cui il servizio Forms possa individuarli.

Eseguire il rendering del modulo

È possibile eseguire il rendering di un modulo basato su frammenti allo stesso modo dei moduli non frammentati. In altre parole, è possibile eseguire il rendering del modulo come PDF, HTML o guide del modulo (obsoleto). L'esempio riportato in questa sezione esegue il rendering di un modulo basato sui frammenti come modulo PDF interattivo. (Vedere Rendering di PDF forms interattivi.)

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

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

Consulta anche

Rendering di moduli basati su frammenti mediante l'API Java

Rendering di moduli basati su frammenti tramite l'API del servizio Web

Inclusione file libreria Java AEM Forms

Impostazione delle proprietà di connessione

Avvio rapido di Forms Service API

Rendering di PDF forms interattivi

Creazione di applicazioni Web per il rendering di Forms

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

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

  2. Creare un oggetto Forms Client API

    • Creare un oggetto ServiceClientFactory che contiene 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.
    • Richiamare il metodo URLSpec dell'oggetto setApplicationWebRoot e passare un valore di stringa che rappresenta la radice Web dell'applicazione.
    • Richiamare il metodo URLSpec dell'oggetto setContentRootURI e passare un valore di stringa che specifica il valore URI radice del contenuto. Verificare che la struttura del modulo e i frammenti si trovino nell'URI principale del contenuto. In caso contrario, il servizio Forms genera un'eccezione. Per fare riferimento alla directory archivio, specificare repository://.
    • Richiamare il metodo URLSpec dell'oggetto setTargetURL e passare un valore di stringa che specifica il valore dell'URL di destinazione in cui vengono inviati i dati del modulo. Se si definisce l'URL di destinazione nella struttura del modulo, è possibile passare una stringa vuota. È inoltre possibile specificare l'URL al quale viene inviato il modulo per eseguire i calcoli.
  4. Eseguire il rendering del modulo

    Richiamare il metodo FormsServiceClient dell'oggetto renderPDFForm e trasmettere i seguenti valori:

    • Una stringa che specifica il nome della struttura del modulo, inclusa l'estensione del nome file. Se si fa riferimento a una struttura del modulo che fa parte di un'applicazione Forms, è necessario specificare il percorso completo, ad esempio Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Un oggetto com.adobe.idp.Document che contiene i 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 esecuzione.
    • Un oggetto URLSpec contenente valori URI richiesti dal servizio Forms per eseguire il rendering di un modulo basato su frammenti.
    • Un oggetto java.util.HashMap che memorizza gli allegati. Si tratta di un parametro facoltativo ed è possibile specificare null se non si desidera allegare file al modulo.

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

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

    • Creare un oggetto com.adobe.idp.Document richiamando il metodo FormsResult object ‘s getOutputContent.
    • Ottenere il tipo di contenuto dell'oggetto com.adobe.idp.Document richiamandone il metodo getContentType.
    • Impostare il tipo di contenuto dell'oggetto javax.servlet.http.HttpServletResponse richiamandone il 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 del client richiamando il metodo javax.servlet.http.HttpServletResponse dell'oggetto getOutputStream.
    • Creare un oggetto java.io.InputStream richiamando il metodo com.adobe.idp.Document dell'oggetto getInputStream.
    • Per creare un array di byte, è necessario inserirlo nel flusso di dati del modulo richiamando il metodo readdell'oggetto InputStream e passando l'array di byte come argomento.
    • Richiamare il metodo javax.servlet.ServletOutputStream dell'oggetto write per inviare il flusso di dati del modulo al browser Web del client. Passate l'array di byte al metodo write.

Consulta anche

Rendering di Forms basato su frammenti

Avvio rapido (modalità SOAP): Rendering di un modulo basato su frammenti utilizzando l'API Java

Inclusione file libreria Java AEM Forms

Impostazione delle proprietà di connessione

Rendering di moduli basati su frammenti utilizzando l'API del servizio Web

Eseguire il rendering di un modulo basato su frammenti utilizzando l'API di Forms (servizio Web):

  1. Includi file di progetto

    • Creare classi proxy Java che utilizzano il servizio WSDL di Forms.
    • Includete le classi proxy Java nel percorso della classe.
  2. Creare un oggetto Forms Client API

    Creare un oggetto FormsService e impostare i valori di autenticazione.

  3. Specificare i valori URI

    • Creare un oggetto URLSpec che memorizzi i valori URI utilizzando il relativo costruttore.
    • Richiamare il metodo URLSpec dell'oggetto setApplicationWebRoot e passare un valore di stringa che rappresenta la radice Web dell'applicazione.
    • Richiamare il metodo URLSpec dell'oggetto setContentRootURI e passare un valore di stringa che specifica il valore URI radice del contenuto. Verificare che la struttura del modulo si trovi nell'URI della directory principale del contenuto. In caso contrario, il servizio Forms genera un'eccezione. Per fare riferimento alla directory archivio, specificare repository://.
    • Richiamare il metodo URLSpec dell'oggetto setTargetURL e passare un valore di stringa che specifica il valore dell'URL di destinazione in cui vengono inviati i dati del modulo. Se si definisce l'URL di destinazione nella struttura del modulo, è possibile passare una stringa vuota. È inoltre possibile specificare l'URL al quale viene inviato il modulo per eseguire i calcoli.
  4. Eseguire il rendering del modulo

    Richiamare il metodo FormsService dell'oggetto renderPDFForm e trasmettere i seguenti valori:

    • Una stringa che specifica il nome della struttura del modulo, inclusa l'estensione del nome file. Se si fa riferimento a una struttura del modulo che fa parte di un'applicazione Forms, è necessario specificare il percorso completo, ad esempio Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Un oggetto BLOB che contiene i dati da unire al modulo. Se non si desidera unire i dati, passare null.
    • Un oggetto PDFFormRenderSpec che memorizza le opzioni di esecuzione. L'opzione PDF con tag non può essere impostata se il documento di input è un documento PDF. Se il file di input è un file XDP, è possibile impostare l'opzione PDF con tag.
    • Un oggetto URLSpec che contiene i valori URI richiesti dal servizio Forms.
    • Un oggetto java.util.HashMap che memorizza gli allegati. Si tratta di un parametro facoltativo ed è possibile specificare null se non si desidera allegare file al modulo.
    • Un oggetto com.adobe.idp.services.holders.BLOBHolder vuoto compilato dal metodo. Questo parametro viene utilizzato per memorizzare il modulo di cui è stato effettuato il rendering.
    • Un oggetto javax.xml.rpc.holders.LongHolder vuoto compilato dal metodo. Questo argomento consente di memorizzare il numero di pagine nel modulo.
    • Un oggetto javax.xml.rpc.holders.StringHolder vuoto compilato dal metodo. Questo argomento memorizzerà il valore delle impostazioni internazionali.
    • Un oggetto com.adobe.idp.services.holders.FormsResultHolder vuoto che conterrà i risultati dell'operazione.

    Il metodo renderPDFForm compila l'oggetto com.adobe.idp.services.holders.FormsResultHolder passato come ultimo valore argomento con un flusso di dati del modulo che deve essere scritto nel browser Web del client.

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

    • Creare un oggetto FormResult ottenendo il valore del membro di dati com.adobe.idp.services.holders.FormsResultHolder dell'oggetto value.
    • Creare un oggetto BLOB contenente dati del modulo richiamando il metodo FormsResult dell'oggetto getOutputContent.
    • Ottenere il tipo di contenuto dell'oggetto BLOB richiamandone il metodo getContentType.
    • Impostare il tipo di contenuto dell'oggetto javax.servlet.http.HttpServletResponse richiamandone il metodo setContentType e passando il tipo di contenuto dell'oggetto BLOB.
    • Creare un oggetto javax.servlet.ServletOutputStream utilizzato per scrivere il flusso di dati del modulo nel browser Web del client richiamando il metodo javax.servlet.http.HttpServletResponse dell'oggetto getOutputStream.
    • Creare un array di byte e compilarlo richiamando il metodo BLOB dell'oggetto getBinaryData. Questa attività assegna il contenuto dell'oggetto FormsResult all'array di byte.
    • Richiamare il metodo javax.servlet.http.HttpServletResponse dell'oggetto write per inviare il flusso di dati del modulo al browser Web del client. Passate l'array di byte al metodo write.

Consulta anche

Rendering di Forms basato su frammenti

Richiamo AEM Forms con codifica Base64

In questa pagina