SPLIT configuration
SPLITCFG-#Number
Nr. |
Parameter |
Example |
---|---|---|
1
|
MetaDocTypeID |
1 |
This is the MetaDocTypeID for splitting which indicates which database table receives the data during archiving in ImageMaster 8. |
||
2
|
1,2,3,4,5,0,0 |
|
This parameter specifies which database columns receive index values in an ImageMaster 8 database. Index values can be written into multiple columns by using the pipe separator “|”, e.g. 1,5|3,4 means to say that the first index value goes into column 1, the second index value goes into columns 5 and 3, and the third index value goes into column 4. Alternatively, SPLITCFG-14 <Value_?> can be used. In this case leave the parameter “Positions” empty. |
||
3
|
7 |
|
This value indicates which column contains the filename of the content file. If this value is set to 0, content files will not be copied into the docs directory. You must use only one of the parameters, i.e. either <FileField> or <FileFieldRegisterBlob> and deactivate the other one by setting it to 0. |
||
4
|
0,0,1,0,2,0,3 |
|
This parameter specifies which fields are subject to a format command which transforms an input value with a given structure to an output value of another desired structure by applying rules. The given numbers represent specific “format types”, or rules, which are further specified by the belonging parameter <Format?Type>. For example, the format type “2” is further specified by its belonging parameter <Format2Type>. Multiple format commands can be applied to one value by using the pipe separator “|”, e.g. 0,0,1|2,3 specifies for the third column to first apply format type 1 and then format type 2. |
||
5
|
Format?Type |
DATE |
By this parameter one of the following format types must be specified:
The related parameters <Format?Input> and <Format?Output> (with the same number instead of the question mark in the parameter name) further specify the formatting rule. |
||
6 |
Format?Input |
YY.MM.DD |
|
By this parameter the expected input format must be specified. The allowed values to use depend on the format type (see <Format?Type>) as follows: |
|
|
DATE: A date format string is expected. The pattern YYYY indicates a four-digit year, YY is a two-digit year. MM indicates the month and DD the day of the month. Other characters are ignored. The length of the incoming character string must match the length of this format string. The string “US_LOCAL” is also allowed to read common US dates. |
|
|
TIME: A time format string is expected. HH represents hours, MM minutes and SS seconds. Other characters are ignored. The length of the incoming character string must match the length of this format string. |
|
|
DATETIME: A combined date and time format string is expected. You can use all placeholders from DATE and TIME, but to differentiate between month an minutes, minutes must be specified by lower-case letters “mm”:
Other characters are ignored. The length of the incoming character string must match the length of this format string. |
|
|
REPLACE: In this kind of format string a list of comma-separated values to be replaced is specified. If a column value is encountered which is the same as one of the given values, its value is replaced by the content described by <Format?Output>. This allows for example transforming a Boolean value such as “Yes” into a value such as “1”. To refer to a comma, a space or an empty value, the following expressions must be used: [COMMA] [SPACE] [EMPTY] |
|
|
PARTREPLACE: This kind of format string is the same as REPLACE, but instead of targeting a complete value only parts of a column value are replaced. Multiple replacements are possible by using a comma-separated list. A replacement like the following can be done for example: REF1_1234567890_ABCDEF => 1234567890_ABCDEF |
|
7 |
Format?Output |
DD.MM.YYYY |
|
This parameter specifies the desired output format of a transformation rule. The allowed values to use depend on the format type (see <Format?Type>) and the same patterns apply as for <Format?Input> with some additional aspects: |
|
|
DATE: The following patterns are available to refer to year, month, and day: YYYY (four-digit year), YY (two-digit year), MM (month), and DD (day). Fill characters are visible in the output. If a two-digit input year is converted to a four-digit year, “20” will be put in front. |
|
|
TIME: The following patterns are available to refer to hours, minutes, and seconds: HH, MM, and SS. Fill characters are visible in the output. |
|
|
DATETIME: The following patterns are available:
Fill characters are visible in the output. If a two-digit input year is converted to a four-digit year, “20” will be put in front. |
|
|
REPLACE: In this kind of format string a list of comma-separated values is specified, which are used to replace the original values. If a column value is encountered that shall be replaced according to <Format?Input>, the according value specified here will be the new value. This allows for example transforming a Boolean value such as “Yes” into a value such as “1”. To refer to a comma, a space or an empty value, the following expressions must be used: [COMMA] [SPACE] [EMPTY] |
|
PARTREPLACE: This kind of format string is the same as REPLACE, but instead of targeting a complete value only parts of a column value are replaced (see PARTREPLACE in parameter <Format?Input>). |
||
8
|
AddConstantSuffixString |
|
Via this parameter a constant value string can be appended to the data. |
||
9
|
0 |
|
Via this parameter a length check can be activated. The value specified here determines the behavior of this check (and NOT the actual length!):
The length value itself is specified via <LengthCheckValues>. |
||
10
|
LengthCheckValues |
0,50,30,0,20,0,0 |
If <EnableLengthCheck> is active, the maximum lengths are specified via this parameter. With the value 0 the check for a specific column value can be deactivated. Any value larger than 0 specifies an actual length limit. |
||
11
|
ImaFileApiActivateAddImage |
No |
Deprecated |
||
12
|
ImaFileApiAddImageValue |
No |
Deprecated |
||
13
|
IndexValueEncoding |
UTF-8 |
Specifies the encoding of the index values when the splitting step is reached. Examples are UTF-8 or ISO_8859-15. A default value no longer exists. Instead, the pipeline runs into an error if this value is missing. |
||
14 |
Invoice.InvoiceDate |
|
This parameter was introduced to replace SPLITCFG-2 <Positions> and it can only be used if the parameter <Positions> is empty. It enables a mapping of “Value_x” from the CSV file to some associated index value in ImageMaster. This must be set for all fields from the CSV file! If no mapping shall be applied for a specific value, set an empty value. Use a pipe “|” if one value shall be set in multiple indexing/attribute values, e.g.: COL3|COL4 ImageMaster 8 requires an existing ImageMaster 8 database table name of one of the numbered “COL” tables which is used for storing index values, e.g. “COL3”. ImageMaster 9 requires an existing document attribute name, which is typically characterized by a concatenation of a document type name and an attribute name e.g. “Proposal.Number”. By using the prefix “Property.” a value can be mapped to an ImageMaster file property. For example, considering a value such as “application/pdf” use “Property.mimetype” to have this set as the property with the key “mimetype”. In ImageMaster 9 such properties are also accessible via RAQL. In related web service requests, e.g. based on SOAP/XML, property information can be visible as follows: …<property key="mimetype">application/pdf</property>… |
||
Table 113: SPLIT configuration file parameters (ImageMaster 8) |
Since ImageMaster 9
Nr. |
Parameter |
Example |
---|---|---|
19
|
PrimaryAttachmentField |
12 |
This value indicates in which column of the data the filename of the primary attachment is located. In the column ‘PrimaryAttachmentField’ the filename without path is expected. A value of 0 disables this field. There can be at most one primary attachment file in an ImageMaster document, which makes sense when an ImageMaster document consists of multiple attachment files. The primary attachment is considered as the preferred attachment, which is used, for example, as the default that is displayed in the WorkplaceClient document preview. |
||
50 |
searchLatestRevisionByKey |
|
|
Available options:
|
|
|
These options reflect FIS operations according to section Search definition file for SAP deletion in [SM FIS]. |
|
51
|
Ima9SearchAttributes |
1,2 |
There are two different modes to use this parameter: If you search by a query (Ima9SearchDocumentsByType=searchByQuery) the value of this parameter must be an ImageMaster 9 RAQL query. Otherwise the value specifies from which positions in the CSV file the search values are taken (e.g. 1,2), and via the parameters <Value_?> (e.g. Value_1 and Value_2) the names of the targeted ImageMaster 9 document attributes must be specified. |
||
52
|
Ima9Options |
AddFiles;AddMD5Hash |
Multiple options separated by a semicolon can be specified here, which influence the overall behavior and which relate to the content of the file “meta.xml” internally used by FIS according to [SM FIS]: For update operations:
SAP operations:
Other:
|
||
53 |
0 |
|
|
This value indicates which column contains the filename of the content file. You must use only one of the parameters, i.e. either <FileFieldRegisterBlob> or <FileField> and deactivate the other one by setting 0. |
|
|
If this option is used, in contrast to using SPLITCFG-3 <FileField>, files will be processed via the ImageMaster 9 blob feature (RegisterBlob/UnregisterBlob), which can increase performance in use cases with large files where the same content files are used multiple times. |
|
54 |
CustomerOrder.Emails |
|
This parameter allows importing indexing data into an ImageMaster 9 multi-value attribute, where the name of such an existing ImageMaster 9 attribute is specified here. It is only usable in the pre-processing modes archiving and update. Based on <MultiValueSplittingChar> incoming data values are split and the resulting elements are transferred into multi-value attribute fields. (This is also reflected in the internal FIS meta.xml file structure where these values will occur in multiple XML attribute value entries). The name of the field must be specified like in SPLITCFG-14 <Value_?>. Multiple fields separated by commas can be specified. The operations “ModifyDocs” and “CheckDocs” do not support multi-value attributes!
|
||
55 |
| |
|
This parameter specifies the separator character for splitting input data into multiple elements according to SPLITCFG-54 <MultiValueField>. |
||
Table 114: SPLIT configuration file parameters (ImageMaster 9) |