Convalida dei documenti DDX validating-ddx-documents

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

È possibile convalidare a livello di programmazione un documento DDX utilizzato dal servizio Assembler. In altre parole, utilizzando l'API del servizio Assembler, è possibile determinare se un documento DDX è valido o meno. Se ad esempio si è eseguito l'aggiornamento da una versione precedente di AEM Forms e si desidera verificare che il documento DDX sia valido, è possibile convalidarlo utilizzando l'API del servizio Assembler.

NOTE
Per ulteriori informazioni sul servizio Assembler, vedere Guida di riferimento dei 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 convalidare un documento DDX, eseguire le operazioni seguenti:

  1. Includi file di progetto.
  2. Creare un client Assembler.
  3. Fare riferimento a un documento DDX esistente.
  4. Impostare le opzioni di runtime per convalidare il documento DDX.
  5. Eseguire la convalida.
  6. Salvare i risultati della convalida in un file di registro.

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.

Creare un client PDF Assembler

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 convalidare un documento DDX, è necessario fare riferimento a un documento DDX esistente.

Impostare le opzioni di runtime per convalidare il documento DDX

Durante la convalida di un documento DDX, è necessario impostare opzioni di runtime specifiche che indichino al servizio Assembler di convalidare il documento DDX anziché eseguirlo. È inoltre possibile aumentare la quantità di informazioni che il servizio Assembler scrive nel file di registro.

Eseguire la convalida

Dopo aver creato il client del servizio Assembler, aver fatto riferimento al documento DDX e aver impostato le opzioni di runtime, è possibile richiamare invokeDDX operazione per convalidare il documento DDX. Durante la convalida del documento DDX, è possibile trasmettere null come parametro map (questo parametro in genere memorizza i documenti PDF necessari all'Assembler per eseguire le operazioni specificate nel documento DDX).

Se la convalida non riesce, viene generata un'eccezione e il file di registro contiene dettagli che spiegano perché il documento DDX non è valido. OperationException dell'istanza. Dopo aver superato l'analisi XML di base e il controllo dello schema, viene eseguita la convalida in base alla specifica DDX. Tutti gli errori presenti nel documento DDX vengono specificati nel registro.

Salvare i risultati della convalida in un file di registro

Il servizio Assembler restituisce i risultati della convalida che è possibile scrivere in un file di log XML. La quantità di dettagli che il servizio Assembler scrive nel file di log dipende dall'opzione di runtime impostata.

Consulta anche

Convalidare un documento DDX utilizzando l’API Java

Convalidare un documento DDX utilizzando l’API del servizio web

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Assemblaggio di documenti PDF a livello di programmazione

Convalidare un documento DDX utilizzando l’API Java validate-a-ddx-document-using-the-java-api

Convalidare un documento DDX 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 ServiceClientFactory oggetto che contiene proprietà di connessione.
    • Creare un AssemblerServiceClient mediante il costruttore e passando il ServiceClientFactory oggetto.
  3. Fare riferimento a un documento DDX esistente.

    • Creare un java.io.FileInputStream oggetto che rappresenta il documento DDX utilizzando il relativo costruttore e passando un valore stringa che specifica la posizione del file DDX.
    • Creare un com.adobe.idp.Document mediante il costruttore e passando il java.io.FileInputStream oggetto.
  4. Impostare le opzioni di runtime per convalidare il documento DDX.

    • Creare un AssemblerOptionSpec oggetto che memorizza le opzioni di runtime mediante il relativo costruttore.
    • Impostare l'opzione di runtime che indica al servizio Assembler di convalidare il documento DDX richiamando AssemblerOptionSpec metodo setValidateOnly dell'oggetto e passaggio true.
    • Impostare la quantità di informazioni che il servizio Assembler scrive nel file di log richiamando AssemblerOptionSpec dell'oggetto getLogLevel e il passaggio di un valore stringa soddisfa le tue esigenze. Durante la convalida di un documento DDX, è necessario disporre di ulteriori informazioni scritte nel file di registro che possano essere utili per il processo di convalida. Di conseguenza, puoi trasmettere il valore FINE o FINER.
  5. Eseguire la convalida.

    Richiama AssemblerServiceClient dell'oggetto invokeDDX e trasmettere i seguenti valori:

    • A com.adobe.idp.Document oggetto che rappresenta il documento DDX.
    • Il valore null per l'oggetto java.io.Map che in genere memorizza i documenti PDF.
    • A com.adobe.livecycle.assembler.client.AssemblerOptionSpec oggetto che specifica le opzioni di runtime.

    Il invokeDDX il metodo restituisce un AssemblerResult oggetto contenente informazioni che specificano se il documento DDX è valido.

  6. Salvare i risultati della convalida in un file di registro.

    • Creare un java.io.File e assicurarsi che l'estensione del nome file sia .xml.
    • Richiama AssemblerResult dell'oggetto getJobLog metodo. Questo metodo restituisce un com.adobe.idp.Document istanza che contiene informazioni di convalida.
    • Richiama com.adobe.idp.Document dell'oggetto copyToFile metodo per copiare il contenuto del com.adobe.idp.Document al file.
    note note
    NOTE
    Se il documento DDX non è valido, OperationException viene lanciato. All’interno dell’istruzione catch, puoi richiamare OperationException dell'oggetto getJobLog metodo.

Consulta anche

Convalida dei documenti DDX

Quick Start (modalità SOAP): convalida dei documenti DDX tramite l’API Java (modalità SOAP)

Inclusione dei file della libreria Java di AEM Forms

Impostazione delle proprietà di connessione

Convalidare un documento DDX utilizzando l’API del servizio web validate-a-ddx-document-using-the-web-service-api

Convalidare un documento DDX 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
    Sostituire localhost con l'indirizzo IP di Forms Server.
  2. Creare un client PDF Assembler.

    • Creare un AssemblerServiceClient utilizzando il costruttore predefinito.

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

    • Creare un System.ServiceModel.BasicHttpBinding dell'oggetto ottenendo il valore del AssemblerServiceClient.Endpoint.Binding campo. Invia il valore restituito a BasicHttpBinding.

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

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

      • Assegna al campo il nome utente dei moduli AEM AssemblerServiceClient.ClientCredentials.UserName.UserName.
      • Assegna il valore 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. Fare riferimento a un documento DDX esistente.

    • Creare un BLOB mediante il costruttore. Il BLOB viene utilizzato per memorizzare il documento DDX.
    • Creare un System.IO.FileStream richiamando il relativo costruttore e passando un valore stringa che rappresenta la posizione del file del documento DDX e la modalità di apertura del file in.
    • Creare una matrice di byte che memorizza il contenuto della System.IO.FileStream oggetto. È possibile determinare le dimensioni della matrice di byte ottenendo System.IO.FileStream dell'oggetto Length proprietà.
    • Compilare la matrice di byte con i dati di flusso richiamando System.IO.FileStream dell'oggetto Read e passando la matrice di byte, la posizione iniziale e la lunghezza del flusso da leggere.
    • Popolare il BLOB oggetto assegnando il relativo MTOM con il contenuto della matrice di byte.
  4. Impostare le opzioni di runtime per convalidare il documento DDX.

    • Creare un AssemblerOptionSpec oggetto che memorizza le opzioni di runtime mediante il relativo costruttore.
    • Impostare l'opzione di runtime che indica al servizio Assembler di convalidare il documento DDX assegnando il valore true al AssemblerOptionSpec dell'oggetto validateOnly membro dati.
    • Impostare la quantità di informazioni che il servizio Assembler scrive nel file di log assegnando un valore stringa al file AssemblerOptionSpec dell'oggetto logLevel membro dati. Metodo Durante la convalida di un documento DDX, è necessario inserire nel file di registro ulteriori informazioni utili per il processo di convalida. Puoi quindi specificare il valore FINE o FINER. Per informazioni sulle opzioni di runtime impostabili, vedere AssemblerOptionSpec riferimento di classe in Riferimento API di AEM Forms.
  5. Eseguire la convalida.

    Richiama AssemblerServiceClient dell'oggetto invokeDDX e trasmettere i seguenti valori:

    • A BLOB oggetto che rappresenta il documento DDX.
    • Il valore null per Map oggetto che in genere memorizza i documenti PDF.
    • Un AssemblerOptionSpec oggetto che specifica le opzioni di runtime.

    Il invokeDDX il metodo restituisce un AssemblerResult oggetto contenente informazioni che specificano se il documento DDX è valido.

  6. Salvare i risultati della convalida in un file di registro.

    • Creare un System.IO.FileStream richiamando il costruttore e passando un valore stringa che rappresenta la posizione del file di log e la modalità di apertura del file in. Verificare che l'estensione del nome file sia .xml.
    • Creare un BLOB oggetto che memorizza le informazioni di registro ottenendo il valore del AssemblerResult dell'oggetto jobLog membro dati.
    • Creare una matrice di byte che memorizza il contenuto della BLOB oggetto. Popolare la matrice di byte ottenendo il valore della BLOB dell'oggetto MTOM campo.
    • Creare un System.IO.BinaryWriter oggetto richiamando il relativo costruttore e passando il System.IO.FileStream oggetto.
    • Scrivere il contenuto della matrice di byte in un file PDF richiamando System.IO.BinaryWriter dell'oggetto Write e passando la matrice di byte.
    note note
    NOTE
    Se il documento DDX non è valido, OperationException viene lanciato. Nell’istruzione catch, puoi ottenere il valore della proprietà OperationException dell'oggetto jobLog membro.

Consulta anche

Convalida dei documenti DDX

Richiamare AEM Forms tramite MTOM

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