DocumentazioneAEM 6.5Guida utente

Assemblaggio di documenti PDF con segnalibri assembling-pdf-documents-with-bookmarks

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 assemblare un documento PDF contenente segnalibri. Si supponga, ad esempio, di disporre di un documento PDF che non contiene segnalibri e di voler modificarlo fornendo segnalibri. Utilizzando il servizio Assembler, è possibile passare un documento PDF che non contiene segnalibri e restituire un documento PDF che contiene segnalibri.

I segnalibri contengono le seguenti proprietà:

  • Titolo visualizzato come testo sullo schermo.
  • Azione che specifica cosa accade quando un utente fa clic sul segnalibro. L'azione tipica di un segnalibro consiste nello spostamento in un'altra posizione nel documento corrente o nell'apertura di un altro documento PDF, anche se è possibile specificare altre azioni.

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="FinalDoc.pdf">
          <PDF source="Loan.pdf">
             <Bookmarks source="doc2" />
          </PDF>
       </PDF>
 </DDX>

All'interno di questo documento DDX, si noti che all'attributo di origine viene assegnato il valore Loan.pdf. Questo documento DDX specifica che un singolo documento PDF viene passato al servizio Assembler. Durante l'assemblaggio di un documento PDF con segnalibri, è necessario specificare un documento XML segnalibro che descriva i segnalibri presenti nel documento risultante. Per specificare un documento XML segnalibro, verificare che l'elemento Bookmarks sia specificato nel documento DDX.

In questo esempio di documento DDX, l'elemento Bookmarks specifica doc2 come valore. Questo valore indica che la mappa di input passata al servizio Assembler contiene una chiave denominata doc2. Il valore della chiave doc2 è un valore com.adobe.idp.Document che rappresenta il documento XML segnalibro. Consultate "Bookmarks Language" in Assembler Service e riferimento DDX.

In questo argomento viene utilizzato il seguente linguaggio di segnalibri XML per assemblare un documento PDF contenente segnalibri.

 <?xml version="1.0" encoding="UTF-8"?>
 <Bookmarks xmlns="https://ns.adobe.com/pdf/bookmarks" version="1.0">
       <Bookmark>
          <Action>
             <Launch NewWindow="true">
                <File Name="C:\Adobe\LoanDetails.pdf" />
             </Launch>
          </Action>
         <Title>Open the Loan document</Title>
       </Bookmark>
 <Bookmark>
          <Action>
             <Launch>
                <Win Name="C:\WINDOWS\notepad.exe" />
             </Launch>
          </Action>
     <Title>Launch NotePad</Title>
       </Bookmark>
 </Bookmarks>

All'interno di questo documento XML segnalibro, notare l'elemento Action che definisce l'azione eseguita quando un utente fa clic sul segnalibro. Sotto l'elemento Action è l'elemento Launch che avvia applicazioni, come NotePad, e apre file, come i file PDF. Per aprire un file PDF, è necessario utilizzare l'elemento File che specifica il file da aprire. Ad esempio, nel file XML del segnalibro specificato in questa sezione, il nome del file aperto è LoanDetails.pdf.

NOTE
Per informazioni complete sulle azioni supportate, vedere " Action element" in Assembler Service e DDX Reference.

Dato il documento DDX specificato in questa sezione e il file XML dei segnalibri come input, il servizio Assembler assembla un documento PDF contenente i seguenti segnalibri.

aw_bmark

Quando un utente fa clic sul segnalibro Apri dettagli prestito, viene aperto LoanDetails.pdf. Analogamente, quando l'utente fa clic sul segnalibro Avvia NotePad, NotePad viene avviato.

NOTE
Prima di leggere questa sezione, è consigliabile avere familiarità con l'assemblaggio di documenti PDF utilizzando il servizio Assembler. In questa sezione non vengono descritti concetti quali la creazione di un oggetto raccolta contenente documenti di input o l'apprendimento dell'estrazione dei risultati dall'oggetto raccolta restituito. (Vedi Assemblaggio a livello di programmazione di documenti di 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.

Riepilogo dei passaggi summary-of-steps

Per assemblare un documento PDF contenente segnalibri, eseguire le operazioni seguenti:

  1. Includi file di progetto.
  2. Creare un client PDF Assembler.
  3. Fare riferimento a un documento DDX esistente.
  4. Fare riferimento a un documento PDF a cui vengono aggiunti segnalibri.
  5. Fare riferimento al documento XML segnalibro.
  6. Aggiungere il documento PDF e il documento XML segnalibro a un insieme Map.
  7. Impostare le opzioni di runtime.
  8. Assemblare il documento PDF.
  9. Salvare il documento PDF contenente i segnalibri.

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 su cui è distribuito AEM Forms. Per informazioni sulla posizione di tutti i file JAR di AEM Forms, vedi Inclusi i file della libreria Java di AEM Forms.

Creare un client Assembler PDF

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

Riferimento a un documento DDX esistente

Per assemblare un documento PDF è necessario fare riferimento a un documento DDX. Questo documento DDX deve contenere l'elemento Bookmarks, che indica al servizio Assembler di assemblare un PDF contenente segnalibri. Per un esempio, vedere il documento DDX illustrato in precedenza in questa sezione.

Riferimento a un documento PDF a cui sono aggiunti segnalibri

Fare riferimento a un documento PDF a cui vengono aggiunti segnalibri. Non importa se il documento PDF a cui si fa riferimento contiene già segnalibri. Se l'elemento Bookmarks è figlio dell'elemento di origine PDF, i segnalibri sostituiranno quelli già esistenti nell'origine PDF. Tuttavia, se desideri mantenere i segnalibri esistenti, assicurati che Bookmarks sia di pari livello dell'elemento di origine PDF. Ad esempio, considera l’esempio seguente:

 <PDF result="foo">
      <PDF source="inDoc"/>
      <Bookmarks source="doc2"/>
 </PDF>

Riferimento al documento XML segnalibro

Per assemblare un PDF contenente nuovi segnalibri, è necessario fare riferimento a un documento XML segnalibro. Il documento XML segnalibro viene passato al servizio Assembler all'interno dell'insieme Map. Per un esempio, consultate il documento XML dei segnalibri mostrato in precedenza in questa sezione.

NOTE
Consultare "Bookmarks Language" in Assembler Service e DDX Reference.

Aggiungere il documento PDF e il documento XML segnalibro a una raccolta di mappe

Aggiungere all'insieme Map sia il documento PDF al quale vengono aggiunti segnalibri che il documento XML segnalibro. Pertanto, l'insieme Map contiene due elementi: un documento PDF e il documento XML segnalibro.

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 il documento PDF

Per assemblare un documento PDF contenente nuovi segnalibri, utilizzare l'operazione invokeDDX del servizio Assembler. Il motivo per cui è necessario utilizzare l'operazione invokeDDX rispetto ad altre operazioni del servizio Assembler come invokeOneDocument è che il servizio Assembler richiede un documento XML segnalibro passato all'interno dell'oggetto insieme Map. Questo oggetto è un parametro dell'operazione invokeDDX.

Salvare il documento PDF contenente i segnalibri

Estrarre i risultati dall'oggetto mappa restituito e salvare il documento PDF corrispondente. Consultare "Estrarre i risultati" in Assemblaggio a livello di codice di documenti PDF.

Consulta anche

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Assemblaggio di documenti PDF a livello di programmazione

Assemblare documenti PDF con segnalibri tramite API Java assemble-pdf-documents-with-bookmarks-using-the-java-api

Assemblare un documento PDF con segnalibri 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. (Vedere Impostazione delle 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. Fare riferimento a un documento PDF a cui vengono aggiunti segnalibri.

    • Creare un oggetto java.io.FileInputStream utilizzando il relativo costruttore e passando il percorso del documento PDF.
    • Creare un oggetto com.adobe.idp.Document utilizzando il relativo costruttore e passare l'oggetto java.io.FileInputStream che contiene il documento PDF.

  5. Fare riferimento al documento XML segnalibro.

    • Creare un oggetto java.io.FileInputStream utilizzando il relativo costruttore e passando il percorso del file XML che rappresenta il documento XML segnalibro.
    • Creare un oggetto com.adobe.idp.Document e passare l'oggetto java.io.FileInputStream che contiene il documento PDF.

  6. Aggiungere il documento PDF e il documento XML segnalibro a un insieme Map.

    • Creare un oggetto java.util.Map utilizzato per memorizzare sia il documento di input PDF che il documento XML segnalibro.

    • Aggiungere il documento di input PDF richiamando il metodo put dell'oggetto java.util.Map 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 contenente il documento PDF di input.

    • Aggiungere il documento XML segnalibro richiamando il metodo put dell'oggetto java.util.Map e passando i seguenti argomenti:

      • Valore stringa che rappresenta il nome della chiave. Questo valore deve corrispondere al valore dell'elemento di origine Segnalibri specificato nel documento DDX.
      • Oggetto com.adobe.idp.Document contenente il documento XML segnalibro.

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

  8. Assemblare il documento 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 sia il documento di input PDF che il documento XML segnalibro.
    • 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.

  9. Salvare il documento PDF contenente i segnalibri.

    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.

Consulta anche

Guida rapida (modalità SOAP): assemblaggio di documenti PDF con segnalibri tramite l’API Java

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

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

Assemblare un documento PDF con segnalibri 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 il relativo campo MTOM al contenuto della matrice di byte.

  4. Fare riferimento a un documento PDF a cui vengono aggiunti segnalibri.

    • Creare un oggetto BLOB utilizzando il relativo costruttore. L'oggetto BLOB viene utilizzato per memorizzare il 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 e passando 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.

  5. Fare riferimento al documento XML segnalibro.

    • Creare un oggetto BLOB utilizzando il relativo costruttore. L'oggetto BLOB viene utilizzato per memorizzare il documento XML segnalibro.
    • 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 e passando 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.

  6. Aggiungere il documento PDF e il documento XML segnalibro a un insieme Map.

    • Creare un oggetto MyMapOf_xsd_string_To_xsd_anyType. Questo oggetto insieme viene utilizzato per memorizzare i documenti PDF di input e il documento XML segnalibro.
    • Per ogni documento di input PDF e per il documento XML segnalibro, creare un oggetto 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.
    • Assegnare l'oggetto BLOB che memorizza il documento PDF al campo value dell'oggetto MyMapOf_xsd_string_To_xsd_anyType_Item.
    • 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 e per il documento XML segnalibro.)

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

  8. Assemblare il documento PDF.

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

    • Oggetto BLOB che rappresenta il documento DDX
    • Array MyMapOf_xsd_string_To_xsd_anyType contenente i documenti di input
    • Oggetto AssemblerOptionSpec che specifica le opzioni di runtime

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

  9. Salvare il documento PDF contenente i segnalibri.

    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 al campo MTOM dell'oggetto BLOB. Restituisce una matrice di byte che è possibile scrivere in un file PDF.

Consulta anche

Richiamare AEM Forms tramite MTOM

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