XMP Utilities

Retrieves or replaces existing metadata in the PDF document. The metadata is specified as XML source in EXtensible Metadata Platform (XMP) format or as a reusable PDF document.

XMP provides a standard format for creating, processing, and interchanging metadata for a wide variety of applications. XMP uses the W3C standard Resource Description Framework (RDF).

In XMP, metadata consists of a set of properties that are associated with a document. Metadata includes the properties author, creator, keywords, producer, subject, and title of a PDF document. In a PDF document, metadata can be stored in two places:

  • The file trailer dictionary of text, not in XML format using a XMPUtilityMetadata (com.adobe.livecyclSe.xmputility.client.XMPUtilityMetadata) value.

  • In the Metadata dictionary of the document catalog. This dictionary contains metadata associated with the entire document. This information is represented in XMP format which can be saved to file.

For information about using the XMP Utilities service, see Services Reference for Adobe LiveCycle ES4.

    Export Metadata operation

    Exports the metadata from the specified PDF document that you can save as process data.

    The PDF document you specify can be stored as process data or specified directly as a file from the file system.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Property to specify the PDF document.

    Input PDF Document

    A document value that represents the PDF document.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset.)

    Output properties

    Property to specify the location to store the metadata.

    Output Metadata

    The location to store the metadata. The data type is XMPUtilityMetadata.

    Exceptions

    This operation can throw an XMPUtilityException exception.

    Import Metadata operation

    Imports metadata from process data and replaces the existing metadata in the specified PDF document.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Properties to specify the new metadata and the PDF document.

    Input PDF Document

    A document value that represents the PDF document.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset.)

    Metadata

    An XMPUtilityMetadata value containing the metadata to replace in the specified PDF document. Any null property values in the supplied XMPUtilityMetadata process data results in an empty attribute in the PDF document.

    Output properties

    Property to specify the location to store the PDF document containing new metadata.

    Output PDF

    The location to store the PDF document that contains new metadata. The data type is document.

    Exceptions

    This operation can throw an XMPUtilityException exception.

    Export XMP operation

    Exports the metadata as XMP data from the specified PDF document. You can save the metadata as a PDF document to process data or a file to be reused.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Property to specify the PDF document.

    Input PDF Document

    A document value that represents the PDF document.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset.)

    Output properties

    Property to specify the location to save the metadata.

    Output XMP

    The location to store the PDF document that contains new metadata. The data type is document.

    Exceptions

    This operation can throw an XMPUtilityException exception.

    Import XMP operation

    Imports metadata from a document value and replaces the existing metadata in the specified PDF document.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Input properties

    Properties to specify the PDF document and metadata.

    Input PDF Document

    A document value that represents the PDF document.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset.)

    Input XMP Document

    A document value that represents the metadata formatted in XMP.

    If you provide a literal value, clicking the ellipsis button opens the Select Asset dialog box. (See About Select Asset.)

    Output properties

    Property to specify the location of the PDF document.

    Output PDF

    The location to save a PDF document that contains new metadata. The data type is document.

    Exceptions

    This operation can throw an XMPUtilityException exception.

    XMP Utilities exceptions

    The XMP Utilities service provides the following exception.

    XMPUtilityException

    Thrown when an error occurs importing metadata into a PDF document or exporting metadata from a PDF document.