Grooper Help - Version 25.0
25.0.0023 2,165
  • Overview
  • Help Status

Metadata Options

Embedded Object Grooper.Core

Specifies the set of metadata values to be included when generating a PDF file.

Remarks

Overview

The Metadata Options object allows you to control which metadata fields are populated in the output PDF when exporting or merging documents. This includes standard PDF metadata fields (such as title, author, subject, and keywords), as well as custom fields mapped from Data Field values.

Key Features

  • Standard Metadata:
    Configure values for standard PDF metadata fields, such as 'Title', 'Author', 'Creator', 'Subject', 'Creation Date', and 'Modification Date'. These can be set to static values, expressions, or mapped from document data.

  • Keywords:
    Specify keywords manually or extract them dynamically using a Value Extractor. Keywords improve searchability and categorization of exported PDFs.

  • Custom Data Fields:
    Export values from selected Data Fields as custom metadata fields in the PDF. This enables downstream systems to access structured data directly from the PDF file.

Usage Guidance

  • Assign a Metadata Options object to the 'Metadata' property of a PDF Data Mapping behavior.
  • Configure each property as needed. You can use static values, expressions, or reference data from the current Document Type.
  • Enable 'Export Data Fields' to include custom data fields, and use 'Field Filter' to control which fields are exported.

Example Scenarios

  • Set the 'Title' to the document's type or a specific field value.
  • Use a Value Extractor to automatically generate keywords from the document's content.
  • Export key index fields (such as invoice number or customer ID) as custom metadata for integration with external systems.

Notes

  • If a property is left blank, the corresponding PDF metadata field may be omitted or set to a default value.
  • Expressions can reference document data, user information, or system values.
  • Custom metadata fields are only included if 'Export Data Fields' is enabled.

Properties

NameTypeDescription
General
Keywords
Custom Data Fields

See Also

Used By

Notification