CIB merge technical documentation (EN)

6. Call parameters in detail

6.39. Parameter --keep-fields

[-k]

The --keep-fields parameter continues the mixing process, even if not all fields can be filled using the data supply.


Syntax

--keep-fields=<Option>
<Option>: unresolved-ref, unresolved-ref-as-formfield, all oder none


Description

If not all fields can be filled during the data supply (information is not yet available), it is possible to tell CIB merge to skip these fields without aborting the merge process using the parameter --keep-fields.

Possible values <Option> are:

Option

Description

unresolved-ref

all unsupplied ref fields remain in the output file

unresolved-ref-as-formfield

all unsupplied ref fields are replaced by {\rtf...formtext...}

all

Default value, all fields are kept in the output file, for fields supplied with data the result is filled accordingly.

none

no keep


Example

--logfile=!cibmerge_Bausteine_KeepFields.log
--target-directory=csv
--source-directory=..\templates
--inputfile=wurzelbaustein.rtf
--outputfile=!..\result\KeepFields_out.rtf
--datafile=multi_undef.csv
--multidatafile
--charformat
--keep-fields=unresolved-ref

Here, the variable kont_kontoart is used in one of the RTF modules. However, this variable is not supplied from the data sources. With the parameter --keep-fields=unresolved-ref the mixing process is continued, the REF field for kont_kontoart remains in the output file KeepFields_out.rtf.

The usage of the parameter is explained in the example Templates.

 

Note:

If CIB merge writes a field as such (without merging the data) because of the parameter keep or because of the switch \* LEAVE (LASSEN), a textual error message appears in the logfile. This action is not considered an error and therefore does not generate an error return value.

(From CIB merge version 3.9.181)

When controlling via field switches, there are other possibilities besides \* LEAVE (LASSEN):

\*keepalways: This field statement always remains in the output document.

\*keepuntilresolved: This field statement remains in the output document until it is filled.

 

Hint:

As --keep-fields=unresolved-ref, this parameter is perfectly suited for realizing a residual data acquisition with the CIB office modules. Ask the CIB support for further information for your use case.