KVP Metadata

The 'Include Relation' property controls whether a reference to the related exported file (such as a PDF or image) is added to the metadata output.

Usage

• Enable this option to provide downstream systems with a direct link between the metadata and the exported content file.
• The related file path is output as a key named Related_To in the key-value pairs.

> Note:
> This is useful for workflows where metadata and content files are delivered together and need to be associated.

The 'Include Parent Data' property determines whether metadata from parent Batch Folders or ancestor documents is included in the export.

What is Parent Data?

"Parent data" refers to data elements belonging to a parent Content Type in a hierarchical batch structure. This relationship is established using the 'Child Of' property on a Content Type. When a Content Type is configured as a child of another, its exported metadata can include data from its parent and ancestor folders/documents.

For example, if you have a batch structure like:

• Personnel File (parent Content Type)
  • Employee_ID (field on Personnel File)
  • Employee_Name (field on Personnel File)
  • Benefits Change Form (child Content Type, with 'Child Of' set to Personnel File)
    • Request_Date (field on Benefits Change Form)
    • Change_Reason (field on Benefits Change Form)

Enabling 'Include Parent Data' on the export format for 'Benefits Change Form' will include both its own fields and the parent Personnel File's fields (such as Employee_ID and Employee_Name) in the exported metadata.

How to Configure Parent Data

1. In your Content Type configuration, set the 'Child Of' property to establish the parent-child relationship between content types.
2. When exporting metadata, enable 'Include Parent Data' to include data from the parent and ancestor folders/documents as defined by the batch structure and content type hierarchy.

> Tip:
> Use this option for multi-level batch structures where child documents need to reference or include data from their parent folders or documents. Be aware that enabling this may introduce additional fields into the export, which should be considered for downstream integration.

The 'Use Display Names' property controls how field names are written in the key-value output.

Usage

• Enable to use user-friendly, human-readable field names as keys in the export.
• Disable to use fully-qualified field names (code paths), which may be required for integration with systems expecting exact field identifiers.

Example:

• Display Name: Invoice Number
• Fully-Qualified Name: Document.InvoiceNumber

> Tip:
> Use display names for readability and reporting; use fully-qualified names for strict system integration or when field names must be unique.