DocumentazioneAEM 6.5Guida utente

Assemblaggio di documenti PDF a livello di programmazione programmatically-assembling-pdf-documents

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:

Creato per:

  • Sviluppatore

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

È possibile utilizzare l’API del servizio Assembler per assemblare più documenti PDF in un unico documento PDF. Nella figura seguente sono illustrati tre documenti PDF che vengono uniti in un unico documento PDF.

pa_pa_document_assembly

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 le azioni da eseguire.

Ai fini della presente 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 direction.pdf in un unico documento PDF.

NOTE
Per visualizzare un documento DDX che disassembla un documento PDF, vedere Disassemblaggio a livello di codice dei documenti PDF.
NOTE
Per ulteriori informazioni sul servizio Assembler, vedere Riferimento ai servizi per AEM Forms.
NOTE
Per ulteriori informazioni su un documento DDX, vedere Servizio assemblatore e riferimento DDX.

Considerazioni durante la chiamata del servizio Assembler tramite servizi Web considerations-when-invoking-assembler-service-using-web-services

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, aggiungere un elemento DDXProcessorSetting al documento DDX, come illustrato nell'esempio seguente.

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

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

Riepilogo dei passaggi summary-of-steps

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

  1. Includi file di progetto.
  2. Creare un client PDF Assembler.
  3. Fare riferimento a un documento DDX esistente.
  4. Fai riferimento ai documenti di input PDF.
  5. Impostare le opzioni di runtime.
  6. Assemblare i documenti di input PDF.
  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, accertati 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 è implementato su JBoss)
  • jbossall-client.jar (obbligatorio se AEM Forms è distribuito su JBoss)

se AEM Forms viene 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. Si consideri ad esempio 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 ai documenti di input PDF

Fare riferimento ai documenti di input PDF che si desidera passare al servizio Assembler. Se ad esempio si desidera trasmettere due documenti PDF di input denominati Mappa e Direzioni, è necessario trasmettere i file PDF corrispondenti.

Il file map.pdf e il file direction.pdf devono essere inseriti in un oggetto insieme. 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.

NOTE
Se si richiama l'operazione invokeDDX, viene restituito un oggetto AssemblerResult contenente un insieme. Questa operazione viene utilizzata quando si trasmettono due o più documenti di input PDF al servizio Assembler. Tuttavia, se si passa un solo PDF di input al servizio Assembler e si prevede un solo documento restituito, richiamare l'operazione invokeOneDocument. Quando si richiama questa operazione, viene restituito un singolo documento. Per informazioni sull'utilizzo di questa operazione, vedere Assemblaggio di documenti crittografati di PDF.

Impostare le opzioni di runtime

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

Assemblare i documenti di input PDF

Dopo aver creato il client di servizio, aver creato un riferimento a un file DDX, creato un oggetto insieme che memorizza i documenti di input PDF e impostato le opzioni di runtime, è 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.

Estrai 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 vengono riepilogati alcuni dei valori chiave e dei tipi di oggetto che possono trovarsi nell'oggetto java.util.Map restituito.

Valore chiave
Tipo di oggetto
Descrizione
documentName
com.adobe.idp.Document
Contiene i documenti risultanti specificati in un elemento DDX risultante
documentName
Exception
Contiene qualsiasi eccezione per il documento
OutputMapConstants.LOG_NAME
com.adobe.idp.Documen
Contiene il registro di processo

Consulta anche

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Disassemblaggio di documenti PDF a livello di programmazione

Assemblare documenti PDF utilizzando l’API Java assemble-pdf-documents-using-the-java-api

Assembla un documento PDF utilizzando l’API del servizio Assembler (Java):

  1. Includi file di progetto.

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

  2. Creare un client PDF Assembler.

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

  3. Fare 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 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. Fai riferimento ai documenti di input PDF.

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

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

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

    • Per ogni 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.
      • Oggetto com.adobe.idp.Document (o java.util.List che specifica più documenti) contenente il documento PDF di origine.

  5. Impostare le opzioni di runtime.

    • Creare un oggetto AssemblerOptionSpec che memorizza le opzioni di runtime utilizzando il relativo costruttore.
    • Impostare le opzioni di runtime per soddisfare i requisiti aziendali richiamando un metodo che appartiene all'oggetto AssemblerOptionSpec. Ad esempio, per indicare 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 di input PDF.

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

    • Oggetto com.adobe.idp.Document che rappresenta il documento DDX da utilizzare
    • Oggetto java.util.Map contenente i file PDF di input da assemblare
    • Oggetto com.adobe.livecycle.assembler.client.AssemblerOptionSpec che specifica le opzioni di runtime, inclusi il tipo di carattere predefinito e il livello di registro del processo

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

  7. Estrai i risultati.

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

    • Richiama il metodo getDocuments dell'oggetto AssemblerResult. Restituisce un oggetto java.util.Map.
    • Scorrere l'oggetto java.util.Map fino a trovare l'oggetto com.adobe.idp.Document risultante. È possibile utilizzare l'elemento risultato PDF specificato nel documento DDX per ottenere il documento.
    • Richiama il metodo copyToFile dell'oggetto com.adobe.idp.Document per estrarre il documento PDF.
    note note
    NOTE
    Se LOG_LEVEL è stato impostato per produrre un registro, è possibile estrarlo utilizzando il metodo getJobLog dell'oggetto AssemblerResult.

Consulta anche

Quick Start (modalità SOAP): assemblaggio di un documento PDF tramite API Java

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Assemblare documenti PDF utilizzando l’API del servizio web assemble-pdf-documents-using-the-web-service-api

Assemblare documenti PDF utilizzando l’API del servizio Assembler (servizio web):

  1. Includi file di progetto.

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

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

  2. Creare un client PDF Assembler.

    • 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.

    • Creare un oggetto System.ServiceModel.BasicHttpBinding ottenendo il valore del campo AssemblerServiceClient.Endpoint.Binding. Eseguire il cast del valore restituito in 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à:

      • Assegnare il nome utente dei moduli AEM al campo AssemblerServiceClient.ClientCredentials.UserName.UserName.
      • Assegnare il valore della password corrispondente al campo AssemblerServiceClient.ClientCredentials.UserName.Password.
      • Assegnare il valore costante HttpClientCredentialType.Basic al campo BasicHttpBindingSecurity.Transport.ClientCredentialType.
      • Assegnare il valore costante BasicHttpSecurityMode.TransportCredentialOnly al campo BasicHttpBindingSecurity.Security.Mode.

  3. Fare riferimento a un documento DDX esistente.

    • Creare un oggetto BLOB utilizzando il relativo costruttore. L'oggetto BLOB viene utilizzato per archiviare il documento DDX.
    • Creare un oggetto System.IO.FileStream richiamandone il costruttore e passando un valore 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 della matrice di byte ottenendo la proprietà Length dell'oggetto System.IO.FileStream.
    • Compilare la matrice di byte con i dati di flusso richiamando il metodo Read dell'oggetto System.IO.FileStream e passando la matrice di byte, la posizione iniziale e la lunghezza del flusso da leggere.
    • Compilare l'oggetto BLOB assegnando la relativa proprietà MTOM al contenuto della matrice di byte.

  4. Fai riferimento ai documenti di input PDF.

    • Per ogni documento di input PDF, 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 richiamandone il costruttore e passando un valore 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 della matrice di byte ottenendo la proprietà Length dell'oggetto System.IO.FileStream.
    • Compilare la matrice di byte con i dati di flusso richiamando il metodo Read dell'oggetto System.IO.FileStream. Passare la matrice di byte, la posizione iniziale e la lunghezza del flusso da leggere.
    • Compilare l'oggetto BLOB assegnando il relativo campo MTOM al contenuto della matrice di byte.
    • Creare un oggetto MyMapOf_xsd_string_To_xsd_anyType. Questo oggetto insieme viene utilizzato per memorizzare i documenti di input PDF.
    • Per ogni documento di input PDF, creare un oggetto MyMapOf_xsd_string_To_xsd_anyType_Item. Se ad esempio si utilizzano due documenti di input PDF, creare due oggetti MyMapOf_xsd_string_To_xsd_anyType_Item.
    • Assegnare un valore stringa che rappresenta il nome chiave al campo key dell'oggetto MyMapOf_xsd_string_To_xsd_anyType_Item. Questo valore deve corrispondere al valore dell'elemento di origine PDF specificato nel documento DDX. (Eseguire questa operazione per ogni documento di input PDF).
    • Assegnare l'oggetto BLOB che memorizza il documento PDF al campo value dell'oggetto MyMapOf_xsd_string_To_xsd_anyType_Item. (Eseguire questa operazione per ogni documento di input PDF).
    • 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. (Eseguire questa operazione per ogni documento di input PDF).

  5. Impostare le opzioni di runtime.

    • Creare un oggetto AssemblerOptionSpec che memorizza le opzioni di runtime utilizzando il relativo costruttore.
    • Impostare le opzioni di runtime per soddisfare i requisiti aziendali assegnando un valore a un membro dati che appartiene all'oggetto AssemblerOptionSpec. Ad esempio, per indicare al servizio Assembler di continuare a elaborare un processo quando si verifica un errore, assegnare false al membro dati failOnError dell'oggetto AssemblerOptionSpec.

  6. Assemblare i documenti di input PDF.

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

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

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

  7. Estrai i risultati.

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

    • Accedere al campo documents dell'oggetto AssemblerResult, che è un oggetto Map contenente i documenti PDF risultanti.
    • Scorrere l'oggetto Map fino a trovare la chiave corrispondente al nome del documento risultante. Quindi esegui il cast di value del membro dell'array in un BLOB.
    • Estrarre i dati binari che rappresentano il documento PDF accedendo alla proprietà MTOM dell'oggetto BLOB. Restituisce una matrice di byte che è possibile scrivere in un file PDF.
    note note
    NOTE
    Se LOG_LEVEL è stato impostato per produrre un log, è possibile estrarre il log ottenendo il valore del membro dati jobLog dell'oggetto AssemblerResult.

Consulta anche

Richiamare AEM Forms tramite MTOM

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