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

File Export

Export Definition Grooper.Core

Defines a base class for export operations to file system and HFS storage platforms.

Remarks

Overview

The FileExport class provides core functionality for exporting documents and folders from Grooper to a file system or hierarchical file storage (HFS) platform. It is designed to be extended for specific file-based export providers.

Configuration

  • Target Folder:
    Set the 'Target Folder' property to specify the root directory where exported files will be saved.
  • Relative Path:
    Use the 'Relative Path' property to define subfolder structure and filenames dynamically, based on document data or expressions.
  • Export Formats:
    Choose one or more export formats to control the file type(s) and extensions for exported documents.

Usage Notes

  • The export operation creates directories as needed and writes files to the specified locations.
  • If multiple export formats are defined, each document is exported in each format, with unique file extensions.
  • The 'Link Name' property (inherited from Export Definition) can be used to label the exported Content Link for tracking and round-trip scenarios.

Example Scenarios

  • Exporting invoices as PDF files to a network share, organized by year and customer.
  • Saving scanned documents as both TIFF and PDF/A files in a compliance archive.
  • Using expressions to generate filenames based on extracted metadata (e.g., invoice number, date).

See Also

<em>For more information on configuring file exports, see the Grooper documentation on file system integration.</em>

Properties

NameTypeDescription

Derived Types

There are 3 implementations of File Export.

File Export Exports content over a local network to the Windows file system.
FTP Export Exports content using the FTP protocol.
SFTP Export Exports content using the SFTP protocol.

See Also

Notification