DocumentazioneAEM 6.5Guida utente

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

Last update: Wed Mar 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Developer

Gli esempi e gli esempi contenuti in questo documento sono solo per l’ambiente AEM Forms su 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 GetLoanForm Java Servlet viene richiamato da una pagina HTML.
2
Il GetLoanForm Java Servlet utilizza l’API client del servizio Forms per eseguire il rendering del modulo di prestito sul browser web client. (vedere Eseguire il rendering di un modulo PDF interattivo tramite 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 HandleData Servlet Java. (vedere "Modulo di prestito".)
4
Il HandleData Java Servlet 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. (vedere Gestione dei Forms inviati.)
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. (vedere Precompilazione di Forms con layout fluibili.)

Modulo di prestito

Questo modulo di prestito interattivo è reso dalla richiesta di prestito campione GetLoanForm Servlet Java.

ri_ri_loanform

Modulo di conferma

Il modulo è fornito dalla richiesta di prestito di esempio HandleData Servlet Java.

ri_ri_confirm

Il HandleData Java Servlet 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. (vedere Precompilazione di Forms con layout fluibili)

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 {

             }

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

NOTE
Per ulteriori informazioni sul servizio Forms, consulta Guida di riferimento dei 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 utilizzi l’API Java, crea un’ FormsServiceClient oggetto. Se utilizzi l’API del servizio web Forms, crea un’ FormsService oggetto.

Specificare i valori URI

È possibile specificare i valori URI richiesti dal servizio Forms per il rendering di un modulo. È possibile fare riferimento a una progettazione di modulo salvata come parte di un’applicazione Forms utilizzando il valore URI della directory principale del contenuto repository:///. Si consideri, ad esempio, la struttura di modulo seguente denominata Loan.xdp si trova all’interno di un’applicazione Forms denominata FormsApplication:

ri_ri_formrepository

Per accedere a questa struttura di modulo, specifica Applications/FormsApplication/1.0/FormsFolder/Loan.xdp come nome del modulo (il primo parametro trasmesso al renderPDFForm metodo) e repository:/// come valore URI della directory principale del contenuto.

NOTE
Per informazioni sulla creazione di un’applicazione Forms tramite Workbench, consulta 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. (vedere Calcolo dati modulo.)

NOTE
Invece di specificare un valore URL per fare riferimento a un file XDP, puoi anche trasmettere un com.adobe.idp.Document al servizio Forms. Il com.adobe.idp.Document L'istanza contiene una struttura di modulo. (vedere 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.

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 di PDF interattivo, richiama FormsServiceClient dell'oggetto renderPDFForm metodo o renderPDFForm2 metodo.

Il renderPDFForm utilizza un URLSpec oggetto. La directory principale del contenuto del file XDP viene passata al servizio Forms utilizzando URLSpec dell'oggetto setContentRootURI metodo. 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 renderPDFForm2 il metodo accetta un com.adobe.idp.Document istanza 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 ServiceClientFactory oggetto che contiene proprietà di connessione.
    • Creare un FormsServiceClient mediante il costruttore e passando il ServiceClientFactory oggetto.

  3. Specificare i valori URI

    • Creare un URLSpec oggetto che memorizza i valori URI utilizzando il relativo costruttore.
    • Richiama URLSpec dell'oggetto setApplicationWebRoot e passare un valore string che rappresenta la radice web dell'applicazione.
    • Richiama URLSpec dell'oggetto setContentRootURI e passa un valore stringa che specifica il valore URI della directory principale 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, specifica repository:///.
    • Richiama URLSpec dell'oggetto setTargetURL e passa un valore stringa che specifica il valore dell'URL di destinazione in cui vengono pubblicati 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 java.util.HashMap oggetto per memorizzare gli allegati utilizzando il relativo costruttore.

    • Richiama java.util.HashMap dell'oggetto put metodo per ciascun file da allegare al modulo sottoposto a rendering. Passa i seguenti valori a questo metodo:

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

    • A com.adobe.idp.Document oggetto che contiene il file allegato.

    note note
    NOTE
    Ripetere questo passaggio per ogni file da allegare al modulo. Questo passaggio è facoltativo e puoi trasmettere null se non si desidera inviare file allegati.

  5. Rendering di un modulo PDF interattivo

    Richiama FormsServiceClient dell'oggetto renderPDFForm e trasmettere 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.
    • A com.adobe.idp.Document oggetto contenente dati da unire con il modulo. Se non desideri unire i dati, passa un campo vuoto com.adobe.idp.Document oggetto.
    • A PDFFormRenderSpec oggetto che memorizza le opzioni di runtime. Questo è un parametro facoltativo e puoi specificare null se non si desidera specificare le opzioni di runtime.
    • A URLSpec oggetto contenente valori URI richiesti dal servizio Forms.
    • A java.util.HashMap oggetto che memorizza gli allegati. Questo è un parametro facoltativo e puoi specificare null se non si desidera allegare file al modulo.

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

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

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

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 FormsService e impostare i valori di autenticazione.

  3. Specificare i valori URI

    • Creare un URLSpec oggetto che memorizza i valori URI utilizzando il relativo costruttore.
    • Richiama URLSpec dell'oggetto setApplicationWebRoot e passare un valore string che rappresenta la radice web dell'applicazione.
    • Richiama URLSpec dell'oggetto setContentRootURI e passa un valore stringa che specifica il valore URI della directory principale 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, specifica repository:///.
    • Richiama URLSpec dell'oggetto setTargetURL e passa un valore stringa che specifica il valore dell'URL di destinazione in cui vengono pubblicati 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 java.util.HashMap oggetto per memorizzare gli allegati utilizzando il relativo costruttore.

    • Richiama java.util.HashMap dell'oggetto put metodo per ciascun file da allegare al modulo sottoposto a rendering. Passa i seguenti valori a questo metodo:

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

    • A BLOB oggetto che contiene il file allegato

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

  5. Rendering di un modulo PDF interattivo

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

    Il renderPDFForm il metodo compila com.adobe.idp.services.holders.FormsResultHolder oggetto 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 FormResult dell'oggetto ottenendo il valore del com.adobe.idp.services.holders.FormsResultHolder dell'oggetto value membro dati.
    • Creare un BLOB oggetto che contiene i dati del modulo richiamando FormsResult dell'oggetto getOutputContent metodo.
    • Ottieni il tipo di contenuto del BLOB oggetto richiamando il relativo getContentType metodo.
    • Imposta il javax.servlet.http.HttpServletResponse tipo di contenuto dell'oggetto richiamando il relativo setContentType e passando il tipo di contenuto del BLOB oggetto.
    • Creare un javax.servlet.ServletOutputStream oggetto utilizzato per scrivere il flusso di dati del modulo nel browser web client richiamando javax.servlet.http.HttpServletResponse dell'oggetto getOutputStream metodo.
    • Creare una matrice di byte e popolarla richiamando il BLOB dell'oggetto getBinaryData metodo. Questa attività assegna il contenuto del FormsResult alla matrice di byte.
    • Richiama javax.servlet.http.HttpServletResponse dell'oggetto write metodo per inviare il flusso di dati del modulo al browser web client. Passare la matrice di byte al write metodo.

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