PDF Data Mapping

Can be one of the following types:

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.

Can be one of the following types:

Overview

The Bookmark Options object controls the creation of PDF bookmarks during export or merge operations. Bookmarks are navigational aids that help users quickly locate and navigate to important sections, documents, or data elements within a PDF.

Types of Bookmarks

• Document Bookmarks:
  Automatically generated for each child Document Type in a compound document. These bookmarks mirror the batch hierarchy and use the display name of each document, which can be customized using the 'Caption' property of a Content Type.

• Data Bookmarks:
  Created for specific Data Elements (such as Data Sections, Data Tables, or Data Fields) defined in the 'Data Elements' property. These bookmarks allow users to jump directly to key data regions, such as sections, tables, or fields. The label for each bookmark is based on the display name of the element, and can be customized using the 'Caption' property.

Configuration

• Assign a Bookmark Options object to the 'Bookmarking' property of a PDF Data Mapping behavior.
• Use the 'Data Elements' property to select which Data Elements should have bookmarks generated.
• Customize the appearance of bookmarks using the 'Label Style' and 'Label Color' properties.

Example Scenarios

• Compound Document Navigation:
  Enable document bookmarks to allow users to quickly jump between multiple documents combined into a single PDF.

• Section and Table Navigation:
  Add data bookmarks for important sections or tables, making it easy to locate transactions, summaries, or repeating data.

• Custom Bookmark Styling:
  Use 'Label Style' and 'Label Color' to visually distinguish different types of bookmarks or to match organizational branding.

Notes

• Bookmarks are hierarchical and can reflect the structure of the batch or data model.
• The order and nesting of bookmarks are determined by the batch/document structure and the selected Data Elements.
• If no Data Elements are selected, only document-level bookmarks will be created.
• The label for each bookmark can be customized using the 'Caption' property on the corresponding Content Type or Data Section.

Can be one of the following types:

Overview

The Piece Info Options object allows you to embed custom data into the PDF's PieceInfo dictionary at the document or page level. PieceInfo is a standard PDF feature for storing private application data, enabling downstream systems or integrations to access Grooper-specific information directly from the PDF.

Key Features

• Custom Data Embedding:
  Export values from selected Data Fields or key-value pairs from a Data Table into the PDF's PieceInfo dictionary.

• Flexible Scope:
  Data can be embedded at the document level (for standalone exports) or at the page level (when included as a child in a compound PDF).

• Dictionary Naming:
  Assign a custom name to the PieceInfo dictionary for identification and retrieval.

Usage Guidance

• Assign a Piece Info Options object to the 'PieceInfo' property of a PDF Data Mapping behavior.
• Set the 'Name' property to define the PieceInfo dictionary name.
• Use the 'Fields' property to select which Data Fields to export as key-value pairs.
• Optionally, use 'Key Column' and 'Value Column' to export key-value pairs from a Data Table.
• Set 'Direct' to control whether the dictionary is created as a direct or indirect PDF object.

Example Scenarios

• Archival Metadata:
  Embed index fields (such as document ID, date, or status) for compliance or audit purposes.

• Integration:
  Store custom data for use by downstream systems that process or index exported PDFs.

• Table Data Export:
  Export line-item or transaction data from a Data Table as key-value pairs in the PieceInfo dictionary.

Notes

• The PieceInfo dictionary name must not contain whitespace or special characters: (){}[]<>/%.
• If both 'Fields' and 'Key Column' are left blank, all single-instance Data Fields will be exported.
• When 'Key Column' is set, 'Value Column' must also be specified.
• PieceInfo data is accessible to any system that can read PDF dictionaries, but is not visible in standard PDF viewers.

The 'Annotations' property allows you to add visual or interactive elements to exported PDF documents, mapped from Data Fields or Data Columns in your data model.

Overview

Each annotation in this collection defines a region or widget to be placed on the PDF, such as highlights, text boxes, signature fields, checkboxes, or radio groups. Annotations can be used to:

• Visually highlight extracted data on the PDF.
• Add comments or tooltips for reviewers.
• Place interactive form fields for data entry or signature.

Configuration

• Add one or more annotation objects to the collection. Each annotation can be linked to one or more Data Fields.
• Configure appearance, interactivity, and print options for each annotation type.
• Use the 'Fields' property of each annotation to specify which Data Fields or Data Columns it applies to. If no fields are specified, the annotation will apply to all single-instance fields in the Document Type.
• Adjust properties such as 'Padding', 'AllowEdit', and 'Print' to control the annotation's behavior and visibility.

Example Use Cases

• Highlight the value of a key field (such as "Total Amount") on the PDF for easy review.
• Add a signature widget to a specific location, mapped to a "Signature" Data Field.
• Place a group of checkboxes or radio buttons corresponding to extracted options or selections.

Notes

• Annotations are generated for each instance of the specified Data Fields that have a valid location on the page.
• Interactive widgets (such as textboxes and signature fields) may require a compatible PDF viewer for full functionality.
• The order of annotations in the collection determines their layering on the PDF.