Home Search

DriveWorks Pro 22
PDF: Set Metadata

Send Feedback

PDF: Set Metadata

This Specification Task will set the given Metadata in a PDF file.

When the given Key does not exist a new one will be created.


Property NameDescription
TitleChanges the Title (not the name) of the task.
PDF FileThe path to the PDF file to modify.
KeyThe metadata key. If a key with the same name already exists its value will be updated otherwise a new entry will be added. Keys are case sensitive.
ValueThe value to set. This can be left as an empty string.

To see the Metadata of a PDF document use the function PDFGetMetadata.


When this Task is added the properties are static. To be able to build rules on a static property see How To: Change A Static Property To A Dynamic Property.

Property NameExample RuleMeaning
PDF File"D:\DriveWorks\ProductGuide.pdf"Will set the Metadata for the ProductGuide.pdf document.
Key"xmp:MetadataDate"Set the MetadataDate.
Value"28/02/22"Will apply the value 28/02/22 to the given Key.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:


  • The Metadata was set successfully.

Success with Warnings

  • N/A


  • There was an error.
  • The PDF file could not be found or accessed.
  • The file given does not have a valid .pdf extension.