File naming options

File names and paths are generated automatically during export, based on the options specified by the user. File naming options can be specified both for data files and for image files.

Note: A file naming template for data files can be specified when exporting to files. A file naming template for image files can be specified when exporting to files, an ODBC-compatible database, SharePoint or image files.

Note: When working with document sets, the file naming options selected for original fields will also be used for index image fields.

Use the Destination and File Naming Template dialog box to specify file naming options and paths. Depending on the selected export type, click Edit... (to the left of the field with the file naming template) or File Naming Options... to open this dialog box.

In the View field, you can choose one of two ways to create a file naming template:

• Simple,

  details

  In this view, you can specify an additional path (not available if you set up export of images together with data to a file), a meaningful part of the file name, and, optionally, identifiers to be added the meaningful part of the name.

  To specify an additional path, select Use additional path and then specify if the path should be based on the structure of the Hot Folder (Source path relative to the Hot Folder) or on the name of the batch name (Batch name).

  The following can be used as meaningful parts of file names:

  • Source file name, which is determined as follows:
  • When adding files from a folder, the names of source files are used.
  • When adding multiple files, the name of the first added file is used.
  • For files scanned on a Scanning Station, the name of the scanning source is used and the output file is named {Empty Value}.
  • For files scanned on the Project Setup Station, the names of temporary files are used.
  • Document Definition name
  • Specified file name, which is a combination of characters specified by the user.

  The following can be used as additional identifiers:

  • Document identifier (select Add document identifier to file name);
  • Index field value (select Add index field to file name, then click ... and select an index field in the Select Fields dialog box).

• Advanced,

  details

  In this view, you can enter a file naming template in the File name template field. Your template can include an invariable part and tags to be replaced by specific information for specific files. You can type tags manually or use the Add tag... and Delete tag buttons.

  The following tags are supported:

  Important! Tag names are case-sensitive.

  • <Project> – the name of the project within which the document is to be processed.
  • <Batch> – the name of the batch within which the document is to be processed.
  • <DocumentDefinition> – the name of the Document Definition applied to the document.
  • <ImportSubPath> – the path to the import subfolder (must be specified for images imported from a subfolder).
  • <SourceFile> – the name of the source file without the extension.
  • <Identifier> – the identifier of the document in the folder.
  • <BatchType> – the name of the batch type within which the document is to be processed.
  • <Time> – the time of export in the format yyyy-MM-dd_HH-mm-ss.
  • <ExportRootPath> – the root export path (as specified on the General tab of the Project Properties dialog box).
  • <RegParam:...> – the value of the registration parameter (after the colon, specify the name of the parameter, for example: <RegParam:ParameterName>).

  Note: First, the program will look for the registration parameter in the document. If there is no such registration parameter in the document, the program will look for the registration parameter in the batch.

  • <Index:...> – the value of the index field (after the colon, specify the full path to the field in the Document Definition, for example: <Index:InvoiceName\Invoice Layout\Status>).

Make sure that the file naming options you specify do not result in empty file names. If the options you have specified may result in empty file names, the program will display a warning message.

Note: If document images are exported together with data, the same template that is used for naming data files can also be used for naming image files. To use the same template for both kinds of files, select the Same as data option in the Image Export Settings section of the Destination and File Naming Template dialog box.