Assemblaggio programmatico di documenti PDF

Esempi ed esempi in questo documento sono solo per AEM Forms in ambiente JEE.

È possibile utilizzare l'API di Assembler Service per assemblare più documenti PDF in un unico documento PDF. L’illustrazione seguente mostra tre documenti PDF uniti in un singolo documento PDF.

Per assemblare due o più documenti PDF in un unico documento PDF, è necessario un documento DDX. Un documento DDX descrive il documento PDF prodotto dal servizio Assembler. In altre parole, il documento DDX indica al servizio Assembler quali azioni eseguire.

Ai fini di questa discussione, si supponga che venga utilizzato il seguente documento DDX.

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
     <PDF result="out.pdf">
         <PDF source="map.pdf" />
         <PDF source="directions.pdf" />
     </PDF>
 </DDX>

Questo documento DDX unisce due documenti PDF denominati map.pdf e directs.pdf in un singolo documento PDF.

Considerazioni quando si richiama il servizio Assembler utilizzando i servizi Web

Quando si aggiungono intestazioni e piè di pagina durante l'assemblaggio di documenti di grandi dimensioni, è possibile che si verifichi un errore OutOfMemory e che i file non vengano assemblati. Per ridurre la possibilità che si verifichi questo problema, aggiungi un elemento DDXProcessorSetting al documento DDX, come illustrato nell'esempio seguente.

<DDXProcessorSetting name="checkpoint" value="2000" />

Puoi aggiungere questo elemento come elemento secondario dell’elemento DDX o come elemento secondario di un elemento PDF result. Il valore predefinito per questa impostazione è 0 (zero), che disattiva il controllo e il DDX si comporta come se l'elemento DDXProcessorSetting non fosse presente. Se si è verificato un errore OutOfMemory, potrebbe essere necessario impostare il valore su un numero intero, in genere compreso tra 500 e 5000. Un piccolo valore di checkpoint genera un controllo più frequente.

Riepilogo dei passaggi

Per assemblare un singolo documento PDF da più documenti PDF, eseguire le operazioni seguenti:

1. Includi file di progetto.
2. Creare un client Assembler PDF.
3. Fai riferimento a un documento DDX esistente.
4. Riferimento ai documenti PDF di input.
5. Impostare le opzioni di esecuzione.
6. Assemblare i documenti PDF di input.
7. Estrai i risultati.

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, assicurati di includere i file proxy.

I seguenti file JAR devono essere aggiunti al percorso della classe del progetto:

• adobe-livecycle-client.jar
• adobe-usermanager-client.jar
• adobe-assembler-client.jar
• adobe-utilities.jar (richiesto se AEM Forms è distribuito su JBoss)
• jbossall-client.jar (richiesto se AEM Forms è distribuito su JBoss)

se AEM Forms è distribuito su un server applicazioni J2EE supportato diverso da JBoss, è necessario sostituire i file adobe-utilities.jar e jbossall-client.jar con file JAR specifici per il server applicazioni J2EE in cui viene distribuito AEM Forms.

Creare un client Assembler PDF

Prima di poter eseguire un'operazione Assembler a livello di programmazione, è necessario creare un client Assembler.

Riferimento a un documento DDX esistente

Per assemblare un documento PDF è necessario fare riferimento a un documento DDX. Ad esempio, considera il documento DDX introdotto in questa sezione. Questo documento DDX indica al servizio Assembler di unire due documenti PDF in un unico documento PDF.

Riferimento a documenti PDF di input

Fare riferimento ai documenti PDF di input che si desidera passare al servizio Assembler. Ad esempio, se si desidera passare due documenti PDF di input denominati Mappa e indicazioni, è necessario passare i file PDF corrispondenti.

È necessario inserire sia il file map.pdf che il file directs.pdf in un oggetto raccolta. Il nome della chiave deve corrispondere al valore dell'attributo di origine PDF nel documento DDX. Non importa quale sia il nome del file PDF se la chiave e l'attributo di origine nel documento DDX corrispondono.

Impostare le opzioni di esecuzione

È possibile impostare le opzioni di esecuzione che controllano il comportamento del servizio Assembler mentre esegue un processo. Ad esempio, è possibile impostare un'opzione che indica al servizio Assembler di continuare l'elaborazione di un processo in caso di errore. Per informazioni sulle opzioni di esecuzione che è possibile impostare, vedere il riferimento alla classe AssemblerOptionSpec in Riferimento API di AEM Forms.

Assemblare i documenti PDF di input

Dopo aver creato il client di servizio, fare riferimento a un file DDX, creare un oggetto raccolta che memorizza i documenti PDF di input e impostare le opzioni di esecuzione, è possibile richiamare l'operazione DDX. Quando si utilizza il documento DDX specificato in questa sezione, i file map.pdf e Direction.pdf vengono uniti in un unico documento PDF.

Estrarre i risultati

Il servizio Assembler restituisce un oggetto java.util.Map che può essere ottenuto dall'oggetto AssemblerResult e che contiene i risultati dell'operazione. L'oggetto java.util.Map restituito contiene i documenti risultanti ed eventuali eccezioni.

Nella tabella seguente sono riepilogati alcuni dei valori chiave e dei tipi di oggetto che è possibile individuare nell'oggetto java.util.Map restituito.

Consulta anche

Inclusione dei file libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Smontaggio programmatico dei documenti PDF

Assemblare documenti PDF utilizzando l'API Java

Assemblare un documento PDF utilizzando l'API del servizio Assembler (Java):

1. Includi file di progetto.

   Includi file JAR client, come adobe-assembler-client.jar, nel percorso di classe del progetto Java.

2. Creare un client Assembler PDF.

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

3. Fai riferimento a un documento DDX esistente.

   • Creare un oggetto java.io.FileInputStream che rappresenta il documento DDX utilizzando il relativo costruttore e passando un valore di stringa che specifica la posizione del file DDX.
   • Creare un oggetto com.adobe.idp.Document utilizzando il relativo costruttore e passando l'oggetto java.io.FileInputStream.

4. Riferimento ai documenti PDF di input.

   • Creare un oggetto java.util.Map utilizzato per memorizzare i documenti PDF di input utilizzando un costruttore HashMap.

   • Per ciascun documento PDF di input, creare un oggetto java.io.FileInputStream utilizzando il relativo costruttore e passando la posizione del documento PDF di input.

   • Per ciascun documento PDF di input, creare un oggetto com.adobe.idp.Document e passare l'oggetto java.io.FileInputStream che contiene il documento PDF.

   • Per ciascun documento di input, aggiungere una voce all'oggetto java.util.Map richiamando il relativo metodo put e passando i seguenti argomenti:

     • Valore stringa che rappresenta il nome della chiave. Questo valore deve corrispondere al valore dell'elemento di origine PDF specificato nel documento DDX.
     • Un oggetto com.adobe.idp.Document (o java.util.List che specifica più documenti) contenente il documento PDF di origine.

5. Impostare le opzioni di esecuzione.

   • Creare un oggetto AssemblerOptionSpec che memorizza le opzioni di esecuzione utilizzando il relativo costruttore.
   • Impostare le opzioni di esecuzione per soddisfare i requisiti aziendali richiamando un metodo appartenente all'oggetto AssemblerOptionSpec. Ad esempio, per dare istruzioni al servizio Assembler di continuare a elaborare un processo quando si verifica un errore, richiamare il metodo setFailOnError dell'oggetto AssemblerOptionSpec e passare false.

6. Assemblare i documenti PDF di input.

   Richiama il metodo invokeDDX dell'oggetto AssemblerServiceClient e passa i seguenti valori obbligatori:

   • Un oggetto com.adobe.idp.Document che rappresenta il documento DDX da utilizzare
   • Un oggetto java.util.Map che contiene i file PDF di input da assemblare
   • Un oggetto com.adobe.livecycle.assembler.client.AssemblerOptionSpec che specifica le opzioni di esecuzione, incluso il tipo di carattere predefinito e il livello di registro dei processi

   Il metodo invokeDDX restituisce un oggetto com.adobe.livecycle.assembler.client.AssemblerResult che contiene i risultati del processo ed eventuali eccezioni.

7. Estrai i risultati.

   Per ottenere il documento PDF appena creato, eseguire le operazioni seguenti:

   • Richiama il metodo getDocuments dell'oggetto AssemblerResult. Restituisce un oggetto java.util.Map.
   • Iterare l'oggetto java.util.Map fino a trovare l'oggetto com.adobe.idp.Document risultante. Per ottenere il documento è possibile utilizzare l'elemento risultato PDF specificato nel documento DDX.
   • Richiamare il metodo copyToFile dell'oggetto com.adobe.idp.Document per estrarre il documento PDF.
   NOTA

   Se LOG_LEVEL è stato impostato per produrre un registro, è possibile estrarre il registro utilizzando il metodo AssemblerResult dell'oggetto getJobLog.

Consulta anche

Avvio rapido (modalità SOAP): Assemblaggio di un documento PDF utilizzando l’API Java

Inclusione dei file libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Assemblare documenti PDF utilizzando l'API del servizio Web

Assemblare documenti PDF utilizzando l'API del servizio Assembler (servizio Web):

1. Includi file di progetto.

   Creare un progetto Microsoft .NET che utilizza MTOM. Assicurati di utilizzare la seguente definizione WSDL: http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.

   NOTA

   Sostituisci localhost con l'indirizzo IP del server che ospita AEM Forms.

2. Creare un client Assembler PDF.

   • Creare un oggetto AssemblerServiceClient utilizzando il relativo costruttore predefinito.

   • Creare un oggetto AssemblerServiceClient.Endpoint.Address utilizzando il costruttore System.ServiceModel.EndpointAddress. Passa un valore stringa che specifica il WSDL al servizio AEM Forms (ad esempio, http://localhost:8080/soap/services/AssemblerService?blob=mtom). Non è necessario utilizzare l'attributo lc_version . Questo attributo viene utilizzato quando si crea un riferimento a un servizio.

   • Crea un oggetto System.ServiceModel.BasicHttpBinding ottenendo il valore del campo AssemblerServiceClient.Endpoint.Binding . Imposta il valore restituito su BasicHttpBinding.

   • Impostare il campo MessageEncoding dell'oggetto System.ServiceModel.BasicHttpBinding su WSMessageEncoding.Mtom. Questo valore assicura che venga utilizzato MTOM.

   • Abilita l’autenticazione HTTP di base eseguendo le seguenti attività:

     • Assegna il nome utente del modulo di AEM al campo AssemblerServiceClient.ClientCredentials.UserName.UserName.
     • Assegna il valore della password corrispondente al campo AssemblerServiceClient.ClientCredentials.UserName.Password.
     • Assegna il valore costante HttpClientCredentialType.Basic al campo BasicHttpBindingSecurity.Transport.ClientCredentialType.
     • Assegna il valore costante BasicHttpSecurityMode.TransportCredentialOnly al campo BasicHttpBindingSecurity.Security.Mode.

3. Fai riferimento a un documento DDX esistente.

   • Creare un oggetto BLOB utilizzando il relativo costruttore. L'oggetto BLOB viene utilizzato per memorizzare il documento DDX.
   • Creare un oggetto System.IO.FileStream richiamando il relativo costruttore e passando un valore di stringa che rappresenta la posizione del file del documento DDX e la modalità di apertura del file.
   • Creare una matrice di byte che memorizza il contenuto dell'oggetto System.IO.FileStream. È possibile determinare le dimensioni dell'array di byte ottenendo la proprietà Length dell'oggetto System.IO.FileStream.
   • Compilare l’array di byte con i dati del flusso richiamando il metodo Read dell’oggetto System.IO.FileStream e passando l’array di byte, la posizione iniziale e la lunghezza del flusso da leggere.
   • Compilare l'oggetto BLOB assegnando la relativa proprietà MTOM con il contenuto dell'array di byte.

4. Riferimento ai documenti PDF di input.

   • Per ciascun documento PDF di input, creare un oggetto BLOB utilizzando il relativo costruttore. L'oggetto BLOB viene utilizzato per memorizzare il documento PDF di input.
   • Creare un oggetto System.IO.FileStream richiamando il relativo costruttore e passando un valore di stringa che rappresenta la posizione del file del documento PDF di input e la modalità di apertura del file.
   • Creare una matrice di byte che memorizza il contenuto dell'oggetto System.IO.FileStream. È possibile determinare le dimensioni dell'array di byte ottenendo la proprietà Length dell'oggetto System.IO.FileStream.
   • Compilare l’array di byte con i dati del flusso richiamando il metodo Read dell’oggetto System.IO.FileStream. Passa la matrice dei byte, la posizione iniziale e la lunghezza del flusso da leggere.
   • Compilare l'oggetto BLOB assegnando il relativo campo MTOM con il contenuto dell'array di byte.
   • Creare un oggetto MyMapOf_xsd_string_To_xsd_anyType. Questo oggetto raccolta viene utilizzato per memorizzare i documenti PDF di input.
   • Per ciascun documento PDF di input, creare un oggetto MyMapOf_xsd_string_To_xsd_anyType_Item. Ad esempio, se si utilizzano due documenti PDF di input, creare due oggetti MyMapOf_xsd_string_To_xsd_anyType_Item.
   • Assegna un valore stringa che rappresenta il nome della chiave al campo MyMapOf_xsd_string_To_xsd_anyType_Item dell'oggetto key. Questo valore deve corrispondere al valore dell'elemento di origine PDF specificato nel documento DDX. Esegui questa operazione per ogni documento PDF di input.
   • Assegnare l'oggetto BLOB che memorizza il documento PDF nel campo MyMapOf_xsd_string_To_xsd_anyType_Item dell'oggetto value. Esegui questa operazione per ogni documento PDF di input.
   • Aggiungere l'oggetto MyMapOf_xsd_string_To_xsd_anyType_Item all'oggetto MyMapOf_xsd_string_To_xsd_anyType. Richiama il metodo Add dell'oggetto MyMapOf_xsd_string_To_xsd_anyType e passa l'oggetto MyMapOf_xsd_string_To_xsd_anyType. Esegui questa operazione per ogni documento PDF di input.

5. Impostare le opzioni di esecuzione.

   • Creare un oggetto AssemblerOptionSpec che memorizza le opzioni di esecuzione utilizzando il relativo costruttore.
   • Impostare le opzioni di esecuzione per soddisfare i requisiti aziendali assegnando un valore a un membro dati appartenente all'oggetto AssemblerOptionSpec. Ad esempio, per dare istruzioni al servizio Assembler di continuare a elaborare un processo in caso di errore, assegna false al membro dati AssemblerOptionSpec dell'oggetto failOnError.

6. Assemblare i documenti PDF di input.

   Richiama il metodo invoke dell'oggetto AssemblerServiceClient e passa i seguenti valori:

   • Un oggetto BLOB che rappresenta il documento DDX.
   • Array mapItem contenente i documenti PDF di input. Le chiavi devono corrispondere ai nomi dei file di origine PDF e i relativi valori devono essere gli oggetti BLOB che corrispondono a tali file.
   • Un oggetto AssemblerOptionSpec che specifica le opzioni di esecuzione.

   Il metodo invoke restituisce un oggetto AssemblerResult che contiene i risultati del processo ed eventuali eccezioni.

7. Estrai i risultati.

   Per ottenere il documento PDF appena creato, eseguire le operazioni seguenti:

   • Accedere al campo documents dell'oggetto AssemblerResult, che è un oggetto Map che contiene i documenti PDF risultanti.
   • Iterare l'oggetto Map fino a trovare la chiave che corrisponde al nome del documento risultante. Quindi eseguire il cast di value del membro della matrice su un BLOB.
   • Estrarre i dati binari che rappresentano il documento PDF accedendo alla proprietà MTOM dell’oggetto BLOB corrispondente. Restituisce una matrice di byte che è possibile scrivere in un file PDF.
   NOTA

   Se LOG_LEVEL è stato impostato per produrre un registro, è possibile estrarre il registro ottenendo il valore del membro dati AssemblerResult dell'oggetto jobLog.

Consulta anche

Richiamo di AEM Forms tramite MTOM