Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Merge

Code Activity Grooper.Activities

Merges the contents of all child objects to a multi-page file, and saves the result an attachment or custom file.

Remarks

The Merge activity combines the contents of all child Batch Folders and/or Batch Pages into a single multi-page file, saving the result as either an attachment or a custom-named file.

Output Format and Destination

  • The output file format is determined by the 'Merge Format' property. Supported formats include PDF, TIFF, and others as defined by the selected Merge Format.
  • The merged file can be saved as:
    • An attachment (overwriting any existing attachment on the Batch Folder), or
    • A custom file using the 'Custom Filename' property.

> Note: When saving as an attachment, any existing attachment will be replaced.

Typical Use Cases

  • Combine a sequence of separated pages into a single multi-page document.
  • Merge multiple child Batch Folders into a compound PDF with a table of contents.
  • Export attachments from multiple child Batch Folders to a ZIP file.

Configuration Guidance

  • Set the 'Merge Format' property to specify the desired output file type.
  • Use the 'Attachment Name' property to define a dynamic filename for the attachment. This can include field data from the associated Content Type.
  • If you need to merge field data into the attachment name, set the 'Content Type' property first. This enables intellisense for Data Elements in the 'Attachment Name' editor.
  • To save the output as a custom file (not as an attachment), specify a value for 'Custom Filename'. Any existing file with the same name will be overwritten.
  • Enable 'Clear On Completion' to delete all descendants of the folder after the merged file is created.

Workflow Placement

The Merge activity is typically run after all processing and Review steps are complete, but before the Export activity. This ensures that all content is finalized before merging and output.

Example Scenarios

  • Post-Separation: After using a separation activity to split a batch into documents, use Merge to generate a single PDF for each document.
  • Compound Document Creation: Merge several related documents into a single PDF with bookmarks or a table of contents.
  • Bulk Export: Collect attachments from multiple child Batch Folders and export them as a ZIP archive.

For more information on related concepts, see Batch Folder, Content Type, and Export activities.

Properties

NameTypeDescription
General
Processing Options

See Also

Used By

Notification