21

Sets the JobMode to be used in the Initialize step

Yes

Sometimes it can be useful to keep log files only if the initialize step was successful. For example, it does not make sense to keep logs with a high number of entries, where each entry indicates the same error cause like some globally missing input data package.

If the value is set to “Yes”, existing log files will be overwritten at start time.

Yes

If this option is set to “Yes”, files with 0 byte size are rejected. Depending on the JobMode configuration, it can happen that a Stop Job File is written and processing is halted (see parameter <Activate_StopJobFile>.

In JobMode 21/24 only the document file which represents the document content is checked (and not the belonging metadata files).

<ColdInputBaseDirectory>/<SpoolType>

In this directory the incoming files with data and documents to be processed are expected.

No

If this option is set to “Yes”, copies of all files that are put into a process chain are stored in the backup directory <ColdSaveBaseDirectory>.

Yes

If this option is set to “Yes”, for each file in the spool an entry is generated in the file <AcceptSummaryLogFile>.

<ColdLogsBaseDirectory>/<SpoolType>/accept_<SpoolType>.log

Within this file all filenames of those files are written, which are included in a spool with their associated generation number.

No

If this option is set to “Yes”, data from the input directory is directly moved to the docs directory. This is useful if no prepare or splitting step is needed and the incoming data is already present in a format and structure that can directly be used for archiving.

No

If this option is set to “Yes”, an additional copy of each file that is moved into a spool is created in the directory <AdditionalCustomerCopyPath>.

<ColdDataDirectory>/CustomerCopy/
<SpoolType.Generation>

In this directory an additional copy of each spool file is created if the option <AdditionalCustomerCopy> is set to “Yes”.

BIF_dbnummer.<Generation>

This value determines the filename of the copied file in the directory <AdditionalCustomerCopyPath>. If multiple generations of one such file are processed, this value is used as a directory name. If the value is left empty, the original filename is used.

0.0007

If this value is greater than 0, only such files and subdirectories in the input directory are processed, which have the given minimum age (in days). The example value V=0.0007 represents an age of roughly one minute (60.48 seconds). To calculate the value (V), based on an age in minutes “M” or hours “H”, you can use one of the following formulas:

In practice, it is enough to round up the value to 4 decimal places as illustrated above, and it hardly makes sense to go below 0.0001, which corresponds to 8.64 seconds.

The parameter <LastModificationTime_CheckMode> determines which kind of modification is used in the age calculation (i.e. time of latest content change or latest property change).

No

If this option is set to “Yes”, the command <SUDOCommand> is executed before processing the file. This is not supported by all JobModes.

chown -R sysadm:tsystems

If the value <SUDOChangeOwner> is set to “Yes”, this command is executed on files/directories which are copied into the spool directory.

No

If this option is set to “Yes”, an unexpected number of items raises an error or halts processing until a minimum number of expected items is signaled.

This requires a special case, where an additional file <CheckInfoAmountFileName> is generated  that contains the expected number of items:

• In JobMode 3 the number of expected files is signaled.

• In JobMode 22 the number of expected subdirectories is signaled.

ready.txt

This value specifies the name of the file, which contains the number of expected items. It is used, if the value <CheckInfoAmountFile> is set to “Yes”.

****DBI****.csv

If this value is set, only such files are taken into the spool, which match the given pattern. The complete filename is checked with its file type extension.

The following wildcards are supported:

• * any single character

• # any single digit (0-9)

• ~ an arbitrary number of any characters

Example:

• Invoice_###.pdf

  • Accepts: Invoice_123.pdf, Invoice_324.pdf

  • Rejects: Invoice_ABC.pdf, INVOICE_123.PDF, Inv_123.pdf

Alternatively, a more powerful regular expression can be used, e.g.:

ISREGEX;^TELEKOM_(Rechung|Gutschrift)_WF_.+$

A few more details about regular expressions are given in <TransFileNameMask>.

csv

A file with this file type extension is taken into the spool and interpreted as an “indexing file” (a metadata file which specifies the future ImageMaster 9 attribute values of a document). Refer to the AdminClient user manual [UM AdminClient] (chapter Document types (handling the document structure)) for an in-depth discussion of these ImageMaster-specific terms.

This value is not used by all JobModes. There are JobModes where multiple index file extensions can be given, which have to be separated by a blank, e.g.:

IndexFileExtension = csv CSV dat

TIF

A file with this extension is taken into the spool and interpreted as a document “content file” (which later represents an ImageMaster 9 document revision that is shown in a viewer).

Usually this file is accompanied by an “indexing file” (or metadata file) with the same name but a different file type extension <IndexFileExtension>.

This value is not used by all JobModes. There are JobModes where multiple content file extensions can be given, which have to be separated by a blank, e.g.:

DataFileExtension = TIF tif PDF pdf

Data_

If this value is set, the filename must begin with this prefix to be taken into the spool.

This value is not used by all JobModes.

ready.txt

If this value is set, the system checks whether this file exists before taking any content of the belonging directory into the spool.

done

If this value is set, the system checks whether the directory has the given suffix before taking any content of this directory into the spool.

7

Checks if there are files in the input directory, which are older than the given value (in days). This can help to identify remaining indexing files that were delivered without belonging content files (JobMode 21). This will only generate log output, but no error is raised. To deactivate this, set the value to 0.

To calculate the value (V), you can determine the desired age in hours “H” and use the following formula: V=H÷24

Examples:

• 12hours:0.5

• 24hours:1

• 48hours:2

• 7days:7

The following files in the input spool are too old:

This message text is positioned before the listing of too old files, which are identified based on <MaxFileAgeInInputDir>.

5000

Maximum number of files which is accepted in a spool

_

If this value is set, directories with the given prefix in their name are ignored. It is common to signal, e.g. via an underscore “_”, that a directory is not yet complete in use cases where <LastModificationTime> is not enough. This parameter is case-sensitive!

No

If this option is set to “Yes” and <WriteSaveDirectory> is also set to “Yes”, a timestamp is appended to each copied file in the backup directory. By doing this, older copies remain available in cases with multiple initialize runs (which otherwise would be overwritten).

end

In JobMode 32 a so called “Flag File” is used to signal the availability of a file. This Flag File is not processed in any other way and it is deleted eventually. If this flag mechanism is used, you must make sure that a different extension is used than the ones for <IndexFileExtension> and <DataFileExtension> because each kind of extension is used to trigger different kinds of follow-up processes and error handling scenarios.

OK

The parameter <IndexFileExtension> is overwritten by <CheckInfoAmountFileNameExt> in JobMode 24 and it is called by JobMode21. This allows using different extensions in Prepare and Initialize.

0

If this value is set to an integer greater than 0, processing is halted until the given minimum number of files is available. This can be used to avoid small pre-processing generations.

This parameter is used in combination with <MaximumStartDelayMinutes> to avoid that the processing is halted for too long.

The value 0 deactivates this mechanism, which is only used by JobMode 20.

30

This age parameter can override the halt caused by <MinimumStartFileCount>. If the minimum number of files is not yet available, but the oldest file reaches the given age limit in minutes, waiting is abandoned and pre-processing proceeds.

^.*_INUSE_.*$

A regular expression to identify files that are ignored in an Initialize. Files with matching filenames are not processed. If the value is left empty, the parameter has no effect.

AGE

The incoming files are sorted based on age or time. The latest sorting that is applied in a process chain also determines about the order in which files will eventually be sent to the archive.

The following options are available:

• AGE

  oldest file first

• REVERSEAGE

  youngest file first

• NAME

  sort alphabetically ascending (from “a” to “z”)

• REVERSENAME

  sort alphabetically descending (from “z” to “a”)

No

Keeps the directory structure as it is while it is being moved in the spool/docs directories, without removing the directory name (as usual).

This is useful for JobModes, which accept complete directories as input (JobMode 9 and 22).

^([A-Za-z]+_[A-Za-z]+_).+$

A regular expression for grouping input files:

Input is processed in groups, which are represented by strings in the indexing filenames. Some matching example group names based on the given example regular expression above are listed below:

• Firma_AbC_2348792.csv

• Company_XY_Rechnung_1782.csv

Files of the same group are processed in each generation separately, where one group is chosen by random. There is a higher chance that larger groups (with more files) are selected first.

On the whole, this approach helps to clean up the processing structure, which can also help troubleshooting.

The regular expression must cover all potentially incoming groups because items with filename patterns that do not match will be ignored!

The round brackets signify, which part is interpreted as the group identifier:

^([A-Za-z]+_[A-Za-z]+_).+$

Regular expression quick reference:

beginning

ending

any case-insensitive combination of letters, but at least one letter

any case-insensitive combination of letters and digits, but at least one

an arbitrary combination of any characters, but at least one

one up to four digits

exactly five digits

DataFileNameReplace= _idx,_data

This feature was designed for JobMode 21 to identify files which belong together:

In other JobModes it is assumed that an indexing file and its belonging content file only differ in the file type extension (e.g. 5711.csv and 5711.pdf).

This parameter can be used to identify belonging files in cases where this pattern is not met, where some constant part of the indexing filename can be replaced by another constant part to identify the belonging content filename:

• Example 1: DataFileNameReplace= _idx,_data

  Indexing file: 0123_idx.csv

  Content file: 0123_data.pdf

• Example 2: DataFileNameReplace= _idx,

  Indexing file: 0123_idx.csv

  Content file: 0123.pdf

Leave this parameter empty to deactivate the mechanism.

1

This value determines with which file property the file age shall be calculated (which is used as control parameter  <LastModificationTime>):

• 1 file content modification time

• 2 file inode change time (i.e. last modification time of any file property)

• 3 the more recent of both above

No

If the value of the configuration parameter ZeroByteFileCheckInvolvesIndexFile is true, the index file is included in the ZeroByteFileCheck. The default is "No". Currently only supported by JobMode 21.