Piece Info Options

Specifies data values to be exported as PDF PieceInfo.

Remarks

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.

Properties

Name	Type		Description
Name	String	►	The name of the PieceInfo dictionary. Requiredtrue Sets the name of the PieceInfo dictionary in the PDF. This name is used to identify the custom data dictionary within the PDF structure. Must not contain whitespace or any of the following characters: (){}[]<>/%. Choose a descriptive name to facilitate downstream processing or integration.
Direct	Boolean	►	Specifies whether PieceInfo dictionaries should be created as direct or indirect PDF objects. DefaultTrue Controls whether the PieceInfo dictionary is embedded as a direct or indirect object in the PDF. Set to true (default) for direct objects, which are simpler and more efficient for most use cases. Set to false to create the dictionary as an indirect object, which may be required for advanced PDF workflows.
Fields	Data Field[]	►	Specifies the set of field values to be included. EditorField List Editor ConverterAll Fields Converter Selects which Data Fields will be exported as key-value pairs in the PieceInfo dictionary. Add one or more Data Fields to include their values. If left empty (and 'Key Column' is not set), all single-instance Data Fields will be exported. Use this to limit the exported data to only the most relevant fields.
Key Column	Data Column	►	If set, outputs key-value pairs into the piece info from a Table Instance. EditorKey Column Editor When set, exports key-value pairs from the specified Data Table using the selected 'Key Column' and 'Value Column'. Use this to export dynamic or repeating data (such as line items) as key-value pairs. When this property is set, 'Value Column' must also be specified. Each row in the table will produce a key-value pair in the PieceInfo dictionary.
Value Column	Data Column	►	Specifies the value column to be used when the Key Column property is set. EditorValue Column Editor Selects the Data Column whose values will be used as the values in key-value pairs when 'Key Column' is set. This property is required when 'Key Column' is set. Each row in the table will produce a key-value pair using the key from 'Key Column' and the value from 'Value Column'.

See Also

Data FieldData Column

Used By

PDF Data Mapping