Automatic File or Folder Naming

Use the following conventions to automatically name a file or a folder using the metadata included in a scanned document.

Specifying Metadata in File and Folder Names

Metadata of the destination connector can be added to file and folder names.

Enter the metadata directly in the destination connector settings window, select basic metadata elements from the drop-down list, or use either of the following specification methods:

  • Enter a custom metadata element: Enter a metadata element by enclosing the element name (ID) in curly brackets ({ }). You can enter a metadata element that cannot be selected from the drop-down list.

  • Combine a string and metadata element: Enter a file name by combining a directly entered string and a metadata element enclosed in curly brackets ({ }).

    For example, when "report ({userName})" is entered and the userName value is "Saito", the file name becomes "report (Saito)".

If the metadata specified as the file or folder name does not exist, "{tagName}" is used as the file or folder name. For example, when you select a port number that is metadata that applies only in a fax job as the file name or when you enter "{port}" directly, "{port}" is used as the file name of a scan job.

Related information

  • For details on metadata items, refer toConfigure Metadata Settings

  • For details about the characters that cannot be used in a string, refer to [Folder Naming Rules] and [File Naming Rules] of each connector.

Numerical format of metadata

To include in the file name a numerical metadata element such as the page number or resolution, specify the numerical format.

You can only specify a numerical format when the value is an integer. When the value includes a decimal point, the value after the decimal point is omitted.

Input example

Description

{tagName: NXX}

XX is the number of digits in the value. When the number of digits in the value is less than XX, a space is added in front of the value.

Example:

When "file{page:N3}" is entered, and the "page" value is 12, the file name "file 12.tif" is generated.

{tagName: N0XX}

XX is the number of digits in the value. When the number of digits in the value is less than XX, one or more zeros are added in front of the value.

Example:

When "{page:N05}_file" is entered, and the "page" value is 12, the file name "00012_file.tif" is generated.

Example of output value of provisional tag "metatag"

"metatag" value

Input

Output

12

{metatag : N4}

_ _12

{metatag : N04}

0012

123456

{metatag : N4}

123456

{metatag : N04}

123456

-12

{metatag : N4}

_-12

{metatag : N04}

-012

ABCDE

{metatag : N4}

_ _ _0

 

{metatag : N04}

0000

123ABCDE

{metatag : N4}

_123

{metatag : N04}

0123

123.45

{metatag : N4}

_123

{metatag : N04}

0123

NOTES:

  • The underscores in the Output column indicate spaces.
  • Spaces before or after a metatag value are automatically deleted. For example, "_123" (where the underscore indicates a space) becomes "123".
  • When a character other than "N" is included in the format, the format specification is ignored.
  • When the numerical format is not correctly specified, the "N04" format applies.

Date and time format of metadata

Specify either the local time or UTC time for the date and time in the metadata such as the date created (generationEpoch) and date registered (registrationEpoch). The time is displayed down to milliseconds.

Specifying the date and time format:

Input example

Description

{tagName: DX}

The format specified with X is displayed as the local time on the device.

{tagName: U0X}

The format specified with X is displayed as the UTC time (universal standard time).

"X" is the display format of the date. The table below shows the characters that can be used.

Character

Meaning

Y

Year

M

Month

d

Day

h

Hour in 12 hour format

H

Hour in 24 hour format

m

Minute

s

Second

S

Millisecond

For example, when the date and time are October 30, 2008, 2:37 PM Japan Standard Time, they are expressed as follows:

Format

Result

{metatag : DyyyyMMdd}

20081030

{metatag : DddMMyyyyHHmm}

301020081437

{metatag : UddMMyyyyHHmm}

301020080537

{metatag : DMMddyyhhmmss}

103008023700
  • Regardless of the value, it can be converted to a date and time by applying the format above.
  • When a character other than "D" or "U" is included in the date and time format, the format specification is ignored.
  • If the date and time format are not correctly specified, the format conversion may not be properly performed.

Other File Naming Conventions

The file name may change depending on the following conventions:

  • When a process connector that allows specifying of the file name in front of the destination connector is positioned in the delivery flow, the priority is given to the conversion result of the process connector.

  • If [File Naming Rules] is not configured in the destination connector properties, the document name specified on the device (or yyyyMMddHHmm when not specified) is used as the file name.

  • When the document is configured with multiple sections, a four-digit suffix is added to the file name for each section. The format is "BaseName_XXXX", where "XXXX" is the section number.

Example

In the case of a document consisting of three sections with the base name "FileName", the following files are created:

FileName_0001.tif, FileName_0002.tif, FileName_0003.tif

  • When the section number exceeds four digits, the section number itself is added.
  • When a file with the same name already exists in the delivery destination folder, a suffix enclosed in parentheses is added to the file name.

Example

FileName_0001(1).tif, FileName_0001(2).tif

A suffix is added to avoid a duplicate file name, and when 9999 is exceeded, an error occurs and the delivery fails. Because the number of suffixes increases and delivery takes longer to perform, accordingly try to avoid duplicate file names.