DocumentazioneAEM 6.5Guida utente

Rendering dei PDF forms interattivi rendering-interactive-pdf-forms

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 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.

Il servizio Forms esegue il rendering dei PDF forms interattivi sui dispositivi client, in genere i browser web, per raccogliere informazioni dagli utenti. Dopo aver eseguito il rendering di un modulo interattivo, un utente può immettere i dati nei campi del modulo e fare clic su un pulsante di invio presente nel modulo per inviare nuovamente le informazioni al servizio Forms. Adobe Reader o Acrobat devono essere installati nel computer che ospita il browser web client per rendere visibile un modulo interattivo di PDF.

NOTE
Prima di poter eseguire il rendering di un modulo utilizzando il servizio Forms, crea una progettazione del modulo. In genere, la progettazione di un modulo viene creata in Designer e salvata come file XDP. Per informazioni sulla creazione di una struttura di modulo, vedere Forms Designer.

Esempio di richiesta di prestito

Viene introdotta un'applicazione di prestito di esempio per dimostrare come il servizio Forms utilizza moduli interattivi per raccogliere informazioni dagli utenti. Questa applicazione consente a un utente di compilare un modulo con i dati necessari per ottenere un prestito e quindi di inviare i dati al servizio Forms. Il diagramma seguente mostra il flusso logico della richiesta di prestito.

ri_ri_finsrv_loanapp_v1

Nella tabella seguente vengono descritti i passaggi del diagramma.

Passaggio
Descrizione
1
Il servlet Java GetLoanForm viene richiamato da una pagina HTML.
2
Il servlet Java GetLoanForm utilizza l'API client del servizio Forms per eseguire il rendering del modulo di prestito al browser Web client. (Vedi Eseguire il rendering di un modulo PDF interattivo utilizzando l'API Java.)
3
Dopo che l'utente compila il modulo del prestito e fa clic sul pulsante di invio, i dati vengono inviati al servlet Java HandleData. (Vedere "Modulo prestito".)
4
Il servlet Java HandleData utilizza l'API client del servizio Forms per elaborare l'invio del modulo e recuperare i dati del modulo. I dati vengono quindi memorizzati in un database aziendale. (Vedi Gestione di Forms inviato.)
5
Viene eseguito il rendering di un modulo di conferma sul browser web. Dati quali il nome e il cognome dell'utente vengono uniti al modulo prima che questo venga sottoposto a rendering. (Vedi Precompilazione di Forms con layout percorribili.)

Modulo prestito

Questo modulo di prestito interattivo viene visualizzato dal servlet Java GetLoanForm dell'applicazione di prestito di esempio.

ri_ri_loanform

Modulo di conferma

Questo modulo viene visualizzato dal servlet Java HandleData dell'applicazione di prestito di esempio.

ri_ri_confirm

Il servlet Java HandleData precompila questo modulo con il nome e il cognome dell'utente e l'importo. Una volta precompilato, il modulo viene inviato al browser Web client. (Vedi Precompilazione di Forms con layout flessibili)

Servlet Java

L’esempio di applicazione di prestito è un esempio di applicazione di servizio Forms esistente come servlet Java. Un servlet Java è un programma Java in esecuzione su un server applicazioni J2EE, come WebSphere, e contiene il codice API client del servizio Forms.

Il codice seguente mostra la sintassi di un servlet Java denominato GetLoanForm:

     public class GetLoanForm extends HttpServlet implements Servlet {
         public void doGet(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {

         }
         public void doPost(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {

             }

In genere, il codice API client del servizio Forms non viene inserito nel metodo doGet o doPost di un servlet Java. È consigliabile programmare il codice all'interno di una classe separata, creare un'istanza della classe all'interno del metodo doPost (o del metodo doGet) e chiamare i metodi appropriati. Tuttavia, per la brevità del codice, gli esempi di codice in questa sezione sono limitati al minimo e gli esempi di codice sono inseriti nel metodo doPost.

NOTE
Per ulteriori informazioni sul servizio Forms, vedere Riferimento ai servizi per AEM Forms.

Riepilogo dei passaggi

Per eseguire il rendering di un modulo PDF interattivo, eseguire le operazioni seguenti:

  1. Includi file di progetto.
  2. Crea un oggetto API client di Forms.
  3. Specifica i valori URI.
  4. Allega file al modulo (facoltativo).
  5. Eseguire il rendering di un modulo PDF interattivo.
  6. 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 un'operazione API client di un servizio Forms a livello di programmazione, è necessario creare un oggetto API client Forms. Se si utilizza l'API Java, creare un oggetto FormsServiceClient. Se si utilizza l'API del servizio Web Forms, creare un oggetto FormsService.

Specificare valori URI

È possibile specificare i valori URI richiesti dal servizio Forms per il rendering di un modulo. È possibile fare riferimento a una struttura di modulo salvata come parte di un'applicazione Forms utilizzando il valore URI radice contenuto repository:///. Si consideri ad esempio il seguente design di modulo denominato Loan.xdp che si trova all'interno di un'applicazione Forms denominata FormsApplication:

ri_ri_formrepository

Per accedere alla struttura del modulo, specificare Applications/FormsApplication/1.0/FormsFolder/Loan.xdp come nome del modulo (il primo parametro passato al metodo renderPDFForm) e repository:/// come valore URI della radice del contenuto.

NOTE
Per informazioni sulla creazione di un'applicazione Forms tramite Workbench, vedere la Guida di Workbench.

Il percorso di una risorsa in un’applicazione Forms è:

Applications/Application-name/Application-version/Folder.../Filename

I seguenti valori mostrano alcuni esempi di valori URI:

  • Applications/AppraisalReport/1.0/Forms/FullForm.xdp
  • Applications/AnotherApp/1.1/Assets/picture.jpg
  • Applications/SomeApp/2.0/Resources/Data/XSDs/MyData.xsd

Quando esegui il rendering di un modulo interattivo, puoi definire valori URI come l’URL di destinazione in cui vengono pubblicati i dati del modulo. L’URL di destinazione può essere definito in uno dei seguenti modi:

  • Sul pulsante Invia durante la progettazione della struttura del modulo in Designer
  • Utilizzando l’API client del servizio Forms

Se l’URL di destinazione è definito nella progettazione del modulo, non eseguirne l’override con l’API client del servizio Forms. In altre parole, impostando l’URL di destinazione utilizzando l’API di Forms, l’URL specificato nella progettazione del modulo viene reimpostato su quello specificato utilizzando l’API. Se desideri inviare il modulo PDF all’URL di destinazione specificato nella progettazione del modulo, imposta a livello di programmazione l’URL di destinazione su una stringa vuota.

Se si dispone di un modulo contenente un pulsante di invio e un pulsante di calcolo (con uno script corrispondente in esecuzione sul server), è possibile definire a livello di programmazione l'URL a cui inviare il modulo per eseguire lo script. Utilizza il pulsante Invia nella struttura del modulo per specificare l’URL in cui vengono pubblicati i dati del modulo. (Vedi Calcolo dei dati del modulo.)

NOTE
Anziché specificare un valore URL per fare riferimento a un file XDP, è possibile passare un'istanza com.adobe.idp.Document al servizio Forms. L'istanza com.adobe.idp.Document contiene una struttura di modulo. (Vedi Trasmissione di documenti al servizio Forms.)

Allega file al modulo

È possibile allegare file a un modulo. Quando si esegue il rendering di un modulo PDF con file allegati, gli utenti possono recuperare i file allegati in Acrobat utilizzando il riquadro dei file allegati. È possibile allegare tipi di file diversi a un modulo, ad esempio un file di testo, oppure a un file binario, ad esempio un file JPG.

NOTE
L'aggiunta di allegati a un modulo è facoltativa.

Eseguire il rendering di un modulo PDF interattivo

Per eseguire il rendering di un modulo, utilizza una struttura di modulo creata in Designer e salvata come file XDP o PDF. È inoltre possibile eseguire il rendering di un modulo creato con Acrobat e salvato come file PDF. Per eseguire il rendering di un modulo PDF interattivo, richiamare il metodo renderPDFForm o renderPDFForm2 dell'oggetto FormsServiceClient.

renderPDFForm utilizza un oggetto URLSpec. La radice del contenuto del file XDP viene passata al servizio Forms utilizzando il metodo setContentRootURI dell'oggetto URLSpec. Il nome della struttura del modulo ( formQuery) viene passato come valore di parametro separato. I due valori vengono concatenati per ottenere il riferimento assoluto alla progettazione del modulo.

Il metodo renderPDFForm2 accetta un'istanza com.adobe.idp.Document che contiene il documento XDP o PDF da riprodurre.

NOTE
Impossibile impostare l'opzione di runtime PDF con tag se il documento di input è un documento PDF. Se il file di input è un file XDP, è possibile impostare l'opzione PDF con tag.

Eseguire il rendering di un modulo PDF interattivo tramite l’API Java render-an-interactive-pdf-form-using-the-java-api

Esegui il rendering di un modulo PDF interattivo 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 sia 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. Allega file al modulo

    • Creare un oggetto java.util.HashMap per archiviare gli allegati utilizzando il relativo costruttore.

    • Richiama il metodo put dell'oggetto java.util.HashMap per ogni file da allegare al modulo di cui è stato eseguito il rendering. Passa i seguenti valori a questo metodo:

      • Valore stringa che specifica il nome del file allegato, inclusa l'estensione.

    • Oggetto com.adobe.idp.Document contenente il file allegato.

    note note
    NOTE
    Ripetere questo passaggio per ogni file da allegare al modulo. Questo passaggio è facoltativo ed è possibile passare null se non si desidera inviare file allegati.

  5. Rendering di un modulo PDF interattivo

    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. Questo è un parametro facoltativo ed è possibile specificare null se non si desidera specificare le opzioni di runtime.
    • Oggetto URLSpec contenente i valori URI richiesti dal servizio Forms.
    • 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.

  6. 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 e 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.

Eseguire il rendering di un modulo PDF interattivo utilizzando l’API del servizio web render-an-interactive-pdf-form-using-the-web-service-api

Esegui il rendering di un modulo PDF interattivo utilizzando l’API Forms (servizio web):

  1. Includi file di progetto

    • Creare classi proxy Java che utilizzano il servizio Forms WSDL.
    • Includi le classi proxy Java nel percorso della classe.

  2. Creare un oggetto API client di Forms

    Creare un oggetto FormsService e impostare i valori di autenticazione.

  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 sia 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. Allega file al modulo

    • Creare un oggetto java.util.HashMap per archiviare gli allegati utilizzando il relativo costruttore.

    • Richiama il metodo put dell'oggetto java.util.HashMap per ogni file da allegare al modulo di cui è stato eseguito il rendering. Passa i seguenti valori a questo metodo:

      • Valore stringa che specifica il nome dell'allegato, inclusa l'estensione del nome file

    • Oggetto BLOB contenente il file allegato

    note note
    NOTE
    Ripetere questo passaggio per ogni file da allegare al modulo.

  5. Rendering di un modulo PDF interattivo

    Richiama il metodo renderPDFForm dell'oggetto FormsService 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 BLOB contenente dati da unire al modulo. Se non si desidera unire i dati, passare null.
    • Un oggetto PDFFormRenderSpec che memorizza le opzioni di runtime. Questo è un parametro facoltativo ed è possibile specificare null se non si desidera specificare le opzioni di runtime.
    • Oggetto URLSpec contenente i valori URI richiesti dal servizio Forms.
    • Oggetto java.util.HashMap che memorizza gli allegati. Questo è un parametro facoltativo ed è possibile specificare null se non si desidera allegare file al modulo.
    • Oggetto com.adobe.idp.services.holders.BLOBHolder vuoto popolato dal metodo. Viene utilizzato per memorizzare il modulo PDF di cui è stato eseguito il rendering.
    • Oggetto javax.xml.rpc.holders.LongHolder vuoto popolato dal metodo. Questo argomento consente di memorizzare il numero di pagine nel modulo.
    • Oggetto javax.xml.rpc.holders.StringHolder vuoto popolato dal metodo. Questo argomento consente di memorizzare il valore delle impostazioni locali.
    • Oggetto com.adobe.idp.services.holders.FormsResultHolder vuoto che conterrà i risultati dell'operazione.

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

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

    • Creare un oggetto FormResult ottenendo il valore del membro dati value dell'oggetto com.adobe.idp.services.holders.FormsResultHolder.
    • Creare un oggetto BLOB contenente dati del modulo richiamando il metodo getOutputContent dell'oggetto FormsResult.
    • Ottenere il tipo di contenuto dell'oggetto BLOB 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 BLOB.
    • 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 una matrice di byte e popolarla richiamando il metodo getBinaryData dell'oggetto BLOB. Questa attività assegna il contenuto dell'oggetto FormsResult alla matrice di byte.
    • Richiama il metodo write dell'oggetto javax.servlet.http.HttpServletResponse per inviare il flusso di dati del modulo al browser Web client. Passare la matrice di byte al metodo write.

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.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2