Dialog Box: File Naming and Output Path

This dialog box allows you to specify a file naming and output path rule. This dialog box appears if you select Custom... in the File name drop-down list in the Output Profile Settings dialog box.

Option name Option description

The file naming and output path rule. The rule can contain elements from the Elements list and document attributes if enclosed in angle brackets <>. Any other elements must be typed without angle brackets. Any elements without angle brackets will be passed as is. Only one backslash is allowed to specify a subfolder in the output folder.

Note. Names of elements are case-sensitive.

To insert an element from the list, select it and click the Insert element button. To insert a document attribute, type the attribute name in angle brackets. If the document does not have any attributes so named, an empty string will be used instead of the attribute value.

Important! The following elements cannot be used when setting up a naming rule for saved source files: Barcode, IndexField, CustomText, DocumentType, UserDefinedEntity, EmailFileName, and EmailSubject.

For example,

  • <Barcode>.<Ext>
    The barcode value will be used as the name of the output file.
  • <Barcode>\<FileName>.<Ext>
    The barcode value will be used as the name of the folder. This is useful for sorting documents by barcode value.
  • <Folder>.<Ext>
    The name of the input folder will be used as the name of the output file. This is useful if each subfolder contains images that refer to the same document and the Create one document for each job document separation method is selected on the 3. Document Separation tab of the Workflow Properties dialog box.
  • <Filename>.<SourceExt>.<Ext>
    The input image extension will be preserved in the output file name.
  • OCR_<FileName>.<Ext>
    The prefix "OCR_" will be added to the output file name.

Directly under the rule, you can see an example of how your file name will look like.

Note. If a conflict of names arises when saving a file to the output folder (i.e. if a file with this name already exists), a 4-digit number will be appended to the file name.

Add source library folder structure to output path The option of preserving the folder structure of the source library is available in all Document Library workflows. By default, this option is enabled in all such workflows. If this option is disabled, all output documents will be placed in the root folder of the output library.
Add SharePoint site and library structure to output path Select this option to add the names of the source site and SharePoint library to the output path.

The following file naming and output path elements can be used in the rule:

  • Barcode
    The value of the separating barcode.

Note. This element is available if the Start new document after barcoded page method is selected on the 3. Document Separation tab of the Workflow Properties dialog box.

  • CustomText
    The value of the CustomText property that can be filled by the document separation script or the document identification and indexing script.
  • Dd
    Current date
  • DocumentType
    The type of the document, as detected during document indexing
  • Ext
    Output format extension
  • FileName
    The name of the input file.
    When processing an e-mail, the subject of the e-mail is used as its file name. For e-mail attachments, the names of the attachment files are used.
  • EmailFileName
    The name of the input e-mail file (.eml or .msg)
  • EmailSubject
    The subject of the input e-mail
  • Folder
    The name of the parent subfolder in the image folder
  • Mm
    Current month
  • SourceExt
    The extension of the input image file
  • Time
    Current time
  • Yy
    Current year (2 digits)
  • Yyyy
    Current year (4 digits)

To the right of the list, you can see descriptions of the elements that you select.

Insert Element...


Inserts a selected element into the rule.

See also

Output Tab of Workflow Properties Dialog Box

29.08.2023 11:55:30

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.