ZIP Format

Specifies which additional Export Formats should be executed and their resulting files included in the ZIP archive. Each format in this list is run for the current Batch Folder, and the generated files are added to the ZIP alongside any attachments.

• Use this property to include custom exports, such as merged PDFs, text files, or metadata, in addition to or instead of original attachments.
• If 'Include Child Attachments' is false, at least one export format must be specified to ensure the ZIP contains content.
• The order of formats in the list determines the order in which files are added to the archive.

Example:
Add a PDF export and a JSON metadata export to this list to include both a merged PDF and structured metadata in the ZIP file.

> Tip:
> Combine this property with 'Include Child Attachments' for maximum flexibility—include both original files and custom exports as needed.

Can be one of the following values:

Controls the tradeoff between file size and export speed for the generated ZIP file.

• Higher compression reduces file size but may increase processing time.
• Lower compression is faster but results in larger ZIP files.
• Set this property based on the requirements of your delivery or storage workflow.

> Tip:
> Use 'Optimal' for most scenarios, or 'Fastest' when speed is more important than file size.

The 'Always Build' property controls whether the export process should generate a file, even if a file of the appropriate export format already exists..

Usage

• Enable this option to ensure that the most current content is always exported, regardless of whether a file already exists.
• Disable to skip export if the output file is already present, which can improve performance in incremental or repeat export scenarios.

> Note:
> Overwriting files may impact downstream systems or integrations that rely on file timestamps or versioning.

The 'Page Skip Count' property specifies how many pages, starting from the first child, will be excluded from the merged export.

Usage

• Use this option to remove cover sheets, separator pages, or other non-essential content from the beginning of the output file.
• Set to 0 to include all pages; set to a positive integer to skip that number of leading pages.

Example:
If a Batch Folder contains 10 pages and 'Page Skip Count' is set to 2, only pages 3–10 will be included in the merged file.

The 'Filename' property allows you to define a dynamic Path Expression to control the name of the file produced by this Export Format. If no expression is provided, a default filename based on the item's display name and file extension will be used.

Purpose and Usage

• Use this property to generate filenames that incorporate document metadata, extracted field values, dates, or other variables.
• The expression can reference any field or property available in the export context, enabling highly customized and meaningful filenames.
• Supports Visual Basic string interpolation, composite formatting, and helper functions such as CleanFileName() to ensure valid filenames.

Example Expressions

Example 1: Use the document type and date

$"Invoice_{CurrentDocument.ContentTypeName}_{Now:yyyyMMdd}.pdf"
' Output: Invoice_InvoiceType_20250831.pdf

Example 2: Use an extracted field

$"Claim_{ClaimNumber}_{Date:yyyy-MM-dd}.pdf"
' Output: Claim_12345_2025-08-31.pdf

Example 3: Use folder name and a custom suffix

$"{CurrentDocument.Name}_Final.pdf"
' Output: MyDocument_Final.pdf

Example 4: Sanitize a field for use in a filename

$"Invoice_{CleanFileName(InvoiceNumber)}.pdf"
' Output: Invoice_123-ABC.pdf

Configuration Guidance

• If the expression is left blank or evaluates to an empty string, the default filename will be used.
• Ensure the resulting filename does not contain invalid path characters. Use CleanFileName() as needed.
• Only the filename portion is used; directory paths in the expression will be ignored for file naming purposes.