DocumentationAEM 6.4Forms Guide

Working with PDF Utilities working-with-pdf-utilities

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

About the PDF Utilities Service

The PDF Utilities service can convert between PDF and XDP file formats, set and retrieve PDF document properties, and manipulate XMP metadata. For example, before converting a PDF document to another format, it is useful to inspect its properties to determine which service operation to invoke for the conversion.

You can accomplish these tasks using the PDF Utilities service:

NOTE
For more information about the PDF Utilities service, see Services Reference for AEM Forms.

Converting PDF Documents into XDP Documents converting-pdf-documents-into-xdp-documents

You can use the PDF Utilities Java and web service APIs to programmatically convert PDF documents into XDP documents.

NOTE
For more information about the PDF Utilities service, see Services Reference for AEM Forms.

Summary of steps summary-of-steps

To convert a PDF document into an XDP document, perform the following steps:

  1. Include project files.
  2. Create a PDFUtilityService client.
  3. Invoke the PDF to XDP conversion operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a PDFUtilityServiceClient object. With the web service API, this is accomplished by using a PDFUtilityServiceService object.

Invoke the PDF to XDP conversion operation

After you create the service client, you can invoke the PDF to XDP conversion operation.

See also

Convert PDF documents into XDP documents using the Java API

Convert PDF documents into XDP documents using the web service API

Including AEM Forms Java library files

Setting connection properties

Convert PDF documents into XDP documents using the Java API convert-pdf-documents-into-xdp-documents-using-the-java-api

Convert PDF documents into XDP documents by using the PDF Utilities API(Java):

  1. Include project files

    Include client JAR files, such as the adobe-pdfutility-client.jar, in your Java project’s class path…

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceClient object by using its constructor and passing a ServiceClientFactory object that contains connection properties.

  3. Invoke the PDF to XDP conversion operation

    To perform the conversion, invoke the PDFUtilityServiceClient object’s convertPDFtoXDP method and pass in a com.adobe.idp.Document object that represents the PDF file. The method returns a com.adobe.idp.Document object that represents the newly created XDP file.

See also

Converting PDF Documents into XDP Documents

Including AEM Forms Java library files

Setting connection properties

Convert PDF documents into XDP documents using the web service API convert-pdf-documents-into-xdp-documents-using-the-web-service-api

Convert PDF documents into XDP documents by using the PDF Utilities API (web service):

  1. Include project files

    • Create a Microsoft .NET client assembly that consumes the PDF Utilities service WSDL file.
    • Reference the Microsoft .NET client assembly.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceService object by using your proxy class constructor.

  3. Invoke the PDF to XDP conversion operation

    Invoke the PDFUtilityServiceService object’s convertPDFtoXDP method and pass in a BLOB object that represents the PDF file. The method returns a BLOB object that represents the newly created XDP file.

See also

Converting PDF Documents into XDP Documents

Invoking AEM Forms using Base64 encoding

Creating a .NET client assembly that uses Base64 encoding

Converting XDP Documents into PDF Documents converting-xdp-documents-into-pdf-documents

You can use the PDF Utilities Java and web service APIs to programmatically convert XDP documents into PDF documents.

NOTE
For more information about the PDF Utilities service, see Services Reference for AEM Forms.

Summary of steps summary_of_steps-1

To convert an XDP document into a PDF document, perform the following steps:

  1. Include project files.
  2. Create a PDFUtilityService client.
  3. Invoke the XDP to PDF conversion operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a PDFUtilityServiceClient object. With the web service API, this is accomplished by using a PDFUtilityServiceService object.

Invoke the XDP to PDF conversion operation

After you create the service client, you can invoke the XDP to PDF conversion operation.

See also

Convert XDP documents into PDF documents using the Java API

Converting XDP documents into PDF documents using the web service API

Including AEM Forms Java library files

Setting connection properties

Convert XDP documents into PDF documents using the Java API convert-xdp-documents-into-pdf-documents-using-the-java-api

Convert XDP documents into PDF documents by using the PDF Utilities API (Java):

  1. Include project files

    Include client JAR files, such as adobe-pdfutility-client.jar, in your Java project’s class path.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceClient object by using its constructor and passing a ServiceClientFactory object that contains connection properties.

  3. Invoke the XDP to PDF conversion operation

    To perform the conversion, invoke the PDFUtilityServiceClient object’s convertXDPtoPDF method and pass in a com.adobe.idp.Document object that represents the XDP file. The method returns a com.adobe.idp.Document object that represents the newly created PDF file.

See also

Converting XDP Documents into PDF Documents

Including AEM Forms Java library files

Setting connection properties

Converting XDP documents into PDF documents using the web service API converting-xdp-documents-into-pdf-documents-using-the-web-service-api

Convert XDP documents into PDF documents by using the PDF Utilities API (web service API):

  1. Include project files

    • Create a Microsoft .NET client assembly that consumes the PDF Utilities service WSDL file.
    • Reference the Microsoft .NET client assembly.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceService object by using your proxy class constructor.

  3. Invoke the XDP to PDF conversion operation

    To perform the conversion, invoke the PDFUtilityServiceService object’s convertXDPtoPDF method and pass in a BLOB object that represents the XDP file. The method returns a BLOB object that represents the newly created PDF file.

See also

Converting XDP Documents into PDF Documents

Invoking AEM Forms using Base64 encoding

Creating a .NET client assembly that uses Base64 encoding

Retrieving PDF Document Properties retrieving-pdf-document-properties

You can use the PDF Utilities Java and web service APIs to programmatically retrieve PDF document properties, such as whether the document is a fillable form or the minimum Acrobat version required to read the document.

NOTE
For more information about the PDF Utilities service, see Services Reference for AEM Forms

Summary of steps summary_of_steps-2

To retrieve PDF document properties, perform the following steps:

  1. Include project files.
  2. Create a PDFUtilityService client.
  3. Invoke the properties retrieval operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a PDFUtilityServiceClient object. With the web service API, this is accomplished using a PDFUtilityServiceService object.

Invoke the properties retrieval operation

After you create the service client, you can invoke the properties retrieval operation.

See also

Retrieve PDF document properties using the Java API

Retrieve PDF document properties using the web service API

Including AEM Forms Java library files

Setting connection properties

Retrieve PDF document properties using the Java API retrieve-pdf-document-properties-using-the-java-api

Retrieve PDF document properties by using the PDF Utilities API (Java):

  1. Include project files

    Include client JAR files, such as adobe-pdfutility-client.jar, in your Java project’s class path.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceClient object by using its constructor and passing a ServiceClientFactory object that contains connection properties.

  3. Invoke the properties retrieval operation

    To perform the conversion, invoke the PDFUtilityServiceClient object’s getPDFProperties method and pass in the following:

    • A com.adobe.idp.Document object that represents the PDF document.
    • A PDFPropertiesOptionSpec object that contains the properties to be evaluated.

    The method returns a PDFPropertiesResult object that contains the results of the query.

See also

Retrieving PDF Document Properties

Including AEM Forms Java library files

Setting connection properties

Retrieve PDF document properties using the web service API retrieve-pdf-document-properties-using-the-web-service-api

Retrieve PDF document properties by using the PDF Utilities web service API:

  1. Include project files

    • Create a Microsoft .NET client assembly that consumes the PDF Utilities service WSDL file.
    • Reference the Microsoft .NET client assembly.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceService object by using your proxy class constructor.

  3. Invoke the properties retrieval operation

    To perform the conversion, invoke the PDFUtilityServiceService object’s getPDFProperties method and pass in the following:

    • A BLOB object that represents the PDF document.
    • A PDFPropertiesOptionSpec object that contains the properties to be evaluated.

    The method returns a PDFPropertiesResult object that contains the results of the query.

See also

Retrieving PDF Document Properties

Invoking AEM Forms using Base64 encoding

Creating a .NET client assembly that uses Base64 encoding

Setting PDF Document Save Modes setting-pdf-document-save-modes

You can use the PDF Utilities service Java and web service APIs to programmatically set a save mode for a PDF document. When using the PDF Utilities service to set a save mode, the PDF Utilities service only sets the save mode and does not actually save the PDF document. The PDF document is saved when it is passed to another service operation. For example, you can use the PDF Utilities service to set a specific save mode and pass it to the Encryption service, where the PDF document is actually saved and encrypted.

NOTE
For more information about the PDF Utilities service, see Services Reference for AEM Forms.

Summary of steps summary_of_steps-3

To set the save option for PDF documents, perform the following steps:

  1. Include project files.
  2. Create a PDFUtilityService client.
  3. Set the save mode.
  4. Invoke the save operation.
  5. Pass the PDF document to another operation.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

Create a PDFUtilityService client

Before you can programmatically perform a PDF Utilities operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a PDFUtilityServiceClient object. With the web service API, this is accomplished using a PDFUtilityServiceService object.

Set the Save mode

You can choose one of the following save options:

  • INCREMENTAL: To save incrementally to reduce the time required to save
  • FAST_WEB_VIEW: save for fast web viewing
  • FULL: To save using a full save (without optimizations)

Invoke the save style operation

After you create the service client, you can invoke the properties retrieval operation.

Pass the PDF document to another AEM Forms operation

Once the PDF Utilities service sets the specified Save mode, pass the PDF document to another AEM Forms operation. Once returned from that operation, the PDF document is saved in the specified mode. For example, if you use the PDF Utilities service to set the FAST_WEB_VIEW mode and then pass the PDF document to the Encryption service’s encryptUsingPassword operation, the returned PDF document is encrypted with a password and save in the FAST_WEB_VIEW mode.

NOTE
The Quick Start that is associated with this section sets the FAST_WEB_VIEW mode and then passes the PDF document to the Encryption service’s encryptUsingPassword operation.

See also

Set PDF document save options using the Java API

Set PDF document save options using the web service API

Including AEM Forms Java library files

Setting connection properties

Encrypting PDF Documents with a Password

Set PDF document save options using the Java API set-pdf-document-save-options-using-the-java-api

Set the PDF document save options by using the PDF Utilities API (Java):

  1. Include project files

    Include client JAR files, such as adobe-pdfutility-client.jar, in your Java project’s class path.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceClient object by using its constructor and passing a ServiceClientFactory object that contains connection properties.

  3. Set the Save mode

    • Create a PDFUtilitySaveMode object by using its constructor.
    • Set the save mode by invoking the PDFUtilitySaveMode object’s setSaveStyle method and passing a string value that specifies the save mode. For example, to save for fast web viewing, pass FAST_WEB_VIEW.

  4. Invoke the save style operation

    Invoke the PDFUtilityServiceClient object’s setSaveMode method and pass the following values:

    • A com.adobe.idp.Document object that represents the PDF document.
    • A PDFUtilitySaveMode object that contains the save style to be used.
    • A Boolean value used to determine whether to override any previous settings.

    The method returns a com.adobe.idp.Document object formatted using the specified save style.

  5. Pass the PDF document to another AEM Forms operation

    • Pass the returned com.adobe.idp.Document object to another AEM Forms operation.

See also

Setting PDF Document Save Modes

Including AEM Forms Java library files

Setting connection properties

Set PDF document save options using the web service API set-pdf-document-save-options-using-the-web-service-api

Set the PDF document save options by using the PDF Utilities AP (web service):

  1. Include project files

    • Create a Microsoft .NET client assembly that consumes the PDF Utilities service WSDL file.
    • Reference the Microsoft .NET client assembly.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceService object by using your proxy class constructor.

  3. Set the Save mode

    • Create a PDFUtilitySaveMode object by using its constructor.
    • Set the save mode by assigning a string value to the PDFUtilitySaveMode object’s saveStyle method that specifies the save mode. For example, to save for fast web viewing, specify FAST_WEB_VIEW.

  4. Invoke the save style operation

    Invoke the PDFUtilityServiceService object’s setSaveMode method and pass the following values:

    • A BLOB object that represents the PDF document.
    • A PDFUtilitySaveMode object that contains the save style to be used.
    • A Boolean value used to determine whether to override any previous settings.

    The method returns a BLOB object formatted using the specified save style. You can then save that object as a PDF document.

  5. Pass the PDF document to another Forms operation

    • Pass the returned BLOB object to another AEM Forms operation.

See also

Setting PDF Document Save Modes

Invoking AEM Forms using Base64 encoding

Creating a .NET client assembly that uses Base64 encoding

Sanitizing PDF Documents sanitizing-pdf-documents

You can use the PDF Utilities Java APIs to programmatically convert PDF documents into XDP documents.

NOTE
For more information about the PDF Utilities service, see Services Reference for AEM Forms.

Summary of steps summary_of_steps-4

To sanitize PDF document, perform the following steps:

  1. Include project files.
  2. Create a PDFUtilityService client.
  3. Invoke the sanitization operation.

Include project files

Include necessary files into your development project. To create a client application using Java, include the necessary JAR files.

Create a PDFUtilityService client

Before you can programmatically perform a sanitization operation, you must create a PDFUtilityService client. With the Java API, this is accomplished by creating a PDFUtilityServiceClient object.

Invoke the PDF to XDP conversion operation

After you create the service client, you can invoke the sanitization operation.

See also

Convert PDF documents into XDP documents using the Java API

Convert PDF documents into XDP documents using the web service API

Including AEM Forms Java library files

Setting connection properties

Sanitize PDF documents using the Java API sanitize-pdf-documents-using-the-java-api

Sanitize documents by using the PDF Utilities API (Java):

  1. Include project files

    Include client JAR files, such as the adobe-pdfutility-client.jar, in your Java project’s class path.

  2. Create a PDFUtilityService client

    Create a PDFUtilityServiceClient object by using its constructor and passing a ServiceClientFactory object that contains connection properties.

  3. Invoke the PDF to XDP conversion operation

    To perform the conversion, invoke the PDFUtilityServiceClient object’s convertPDFtoXDP method and pass in a com.adobe.idp.Document object that represents the PDF file. The method returns a com.adobe.idp.Document object that represents the newly created XDP file.

See also

Sanitizing PDF documents

Including AEM Forms Java library files

Setting connection properties

recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da