PDF Metadata Utils

Overview

Organizations that generate PDF documents programmatically often need to embed structured metadata into those files to comply with document management standards, improve searchability, and meet regulatory or archival requirements.

This plug-in enables Appian process models to automatically set standard PDF metadata fields — such as title, author, subject, keywords, creator, and producer — directly on existing PDF documents stored in Appian. This eliminates the need for custom scripting or external tools outside of Appian, keeping the entire document lifecycle within the platform.

Typical use cases include:

  • Automatically stamping generated reports or contracts with the correct author and title before archival.
  • Embedding keywords into PDF files to improve search discoverability within document management systems.
  • Setting creator and producer metadata as part of a compliance workflow that requires document provenance tracking.
  • Standardizing metadata across a library of PDF documents as a batch processing step within a process model.

Key Features and Functionality

This plug-in includes a single Smart Service designed for simplicity and ease of integration into any Appian process model.

Smart Services:

  • SetPDFMetadata — Accepts an Appian document ID and up to six optional metadata string inputs. It loads the target PDF from Appian Content, applies the specified metadata values, and saves the updated document back to Appian. All fields are optional; only non-null values are applied.

Supported metadata fields:

  • Title: The document title embedded in the PDF properties.
  • Author: The name of the document author.
  • Subject: A brief subject or category description.
  • Keywords: A comma-separated list of search keywords.
  • Creator: The application or user that originally created the document.
  • Producer: The application that produced or converted the PDF.

Technical notes:

  • Built on Apache PDFBox 3.x (Apache 2.0 license).
  • Uses Appian ContentService to read and write documents — no direct filesystem access.
  • All resources and temporary files are properly closed and deleted after use.
  • Logging is performed through Log4j; no System.out or printStackTrace calls are used.
  • Source code is included within the plug-in JAR in compliance with Appian AppMarket policies.
Anonymous
Parents
  • Hello, when we have tried to install the plugin on our development environment, it is returning an error

    "Caused by: AppianRuntimeException: AppianException: The Plug-in com.datox.pdfmetadata Module SetPDFMetadata is missing the following internationalization bundle(s) for Locale en_US: [com.datox.pdfmetadata.SetPDFMetadata] (APNX-1-4200-000)"

    Will you be able to assist on adding the properties.

    Thank you.

    Roy

Comment
  • Hello, when we have tried to install the plugin on our development environment, it is returning an error

    "Caused by: AppianRuntimeException: AppianException: The Plug-in com.datox.pdfmetadata Module SetPDFMetadata is missing the following internationalization bundle(s) for Locale en_US: [com.datox.pdfmetadata.SetPDFMetadata] (APNX-1-4200-000)"

    Will you be able to assist on adding the properties.

    Thank you.

    Roy

Children
No Data