Splitting

SPLIT-#Number#

Nr.

Parameter

Example

3000

 

JobMode_Splitting

1

Sets the JobMode to be used in the Splitting step

3001

 

SplittingProtectionSymbol?

\\#,#

So called “protection symbols” are needed if there are dedicated columns which can contain the <SplittingChar> but where it is NOT desired that such a character is interpreted as a splitting character in pre-processing. In such a case these characters must be specially marked by an escape character, so the process can identify these. In the given example value the hash symbol “#” is protected by a backslash “\”. After the Splitting step the escaped hash symbol “\#” is replaced by a simple hash symbol “#”.

Multiple splitting protection symbols can be defined (which is implied by the question mark in the parameter name that has to be replaced by a sequential integer number, where the first entry starts with 1):

  • SplittingProtectionSymbol1=\\#,#

  • SplittingProtectionSymbol2=\\;,;

  • SplittingProtectionSymbol3=\\[COMMA],[COMMA]

The part before the comma is the protected symbol as a regular expression, which requires that the backslash itself is escaped by a second backslash (since this is also the escape character in regular expressions). This part before the comma will be replaced by the substitution part after the comma.

To encode the characters for a comma, a blank or for an empty value use the placeholder values [COMMA] [SPACE] [EMPTY]. (These will internally be replaced before the regular expression is evaluated.)

If no protection symbol is needed, don’t use the parameter at all or comment it out. (There can be errors otherwise, if you just leave this parameter with an empty value for example.)

3002

 

SplittingSubstitutionChar?

',[SPACE]

If there are special characters which must be replaced for some technical reason before inserting them in the ImageMaster 9 repository, this value can be used. With the given example value any inverted comma is replaced by a blank.

Multiple splitting substitution characters can be defined, which is implied by the question mark in the parameter name that has to be replaced by a sequential integer number, where the first entry starts with 1:

  • SplittingSubstitutionChar1=’,[SPACE]

  • SplittingSubstitutionChar2=”,[SPACE]

3003

 

SplittingFileSeparator

;

If there are multiple filenames of files to be archived in one data field, these must be separated by some other character which is different from <SplittingChar>. This other separator character is defined here.

3004

 

SplittingEnableMultiDocDir

No

If this option is set to “Yes”, multiple directories are created for archiving, where each directory contains a maximum number of <SplittingMaxDocDirBatch> files.

3005

 

SplittingMaxDocDirBatch

10000

This is the maximum number of files in one archiving directory if the archiving batch mode is active based on <SplittingEnableMultiDocDir>.

3006

 

SplittingBatchDirExtension

bch

If the archiving batch mode is active based on <SplittingEnableMultiDocDir>, the subdirectories  in the docs directory will be fitted with this extension as a suffix.

3007

 

SplittingDocTypeCol

0

This value indicates which column contains the split definition file’s name. If the value is set to 0, the default split configuration is used, which is based on the spool name.

3008

 

SplittingAddConstantPrefixString

<CurrentDate><SplittingChar>

Before splitting the data, constant fields can be added (new constant attribute values that are added to the metadata of each document). In the given example the current date is added. Another example use case could be to add some constant value that identifies a specific pre-processing source for a set of documents.

3009

 

SplittingDefDir

<ColdConfigDirectory>/split

In this directory the split definition files are expected.

3010

 

SplittingDefPrefix

split.<SpoolType>

Names of split files always start with this prefix, even if the split files are taken from <SplittingDocTypeCol>.

3011

 

SplittingDefSuffix

Cfg

Names of split files always end with this suffix.

3012

 

SplittingDetailedLog

Yes

If this option is set to “Yes”, some additional debug information is output in the log files.

3013

 

SplittingManipulationNotification

No

If this option is set to “Yes”, at finalization of the split process an overview of all data manipulating actions is sent via e-mail to <SplittingManipulationEmail>. The e-mail system must be configured beforehand and <eMailNotification> must be activated as well.

3014

 

SplittingManipulationEmail

batch.processing.manager@t-systems.com

This is the recipient e-mail address of the manipulation notification, which can be activated via <SplittingManipulationNotification>.

3015

 

SplittingBinary

<ColdBinDirectory>/splittool_sun

With this parameter a binary application can be specified that is executed for splitting.

3016

 

SplittingBinaryOptions

–z –c <ColdConfigDirectory>/splittool.cfg –g <Generation>

Additional options which are passed to the <SplittingBinary> application can be given here.

3017

 

SplittingBinaryCfgFile

<ColdConfigDirectory>/afp/<SpoolType>.adf

With this parameter an additional configuration file can be specified that is passed to the <SplittingBinary> application. This is only used in JobMode 10 (AFP).

3018

 

AFPSplitterFileServer

Imadbetr

This parameter specifies the file server which is written into the configuration file of the AFP splitter.

3019

 

SplittingBatchDirCol

3

This value indicates the column in the CSV file which is used for the directory name. In the ImageMaster 8 compressed mode with JobMode 21 this represents the name of the archive (e.g. “rech042007_1”). If this value is set to 0, some default value is used.

3020

 

ImaFileApiSetNullValues

No

ImageMaster 8 legacy option – ImaFileApi:

By activating this option, in the ImaFileApi mode “UpdateByKeyValues” all undefined values can be set to null. In the documentation of the ImaFileApi the corresponding option is “SetNullValues=[Yes/No]”.

3021

 

SplittingHeaderFile

<ColdConfigDirectory>/header.afp

ImageMaster 8 legacy option – FastArchiver:

By this option in the FastArchiver compressed mode an existing header file can be specified. Within the CAT file in “[Resource].Header” this filename is used as given here. The content of this file is copied from the source file. If this parameter is left empty, no header file is used.

3026

 

SplittingMinimumDocsDigitCount

6

If this parameter is set to a value greater than 0, it specifies the minimum number of digits that appear in the Docs directory names. The default value is 6 (digits).

Table 95: Splitting configuration parameters