CIB merge technical documentation (EN)

6. Call parameters in detail

6.4. Parameter --analyse

The parameter --analyse is only relevant for the reporting tool "CIB report&analyse". It determines the static field structure.


Syntax
--analyse=<Dateiname>

Description

The structure, which is determined by means of --analyse, can be used for further analysis or presentation. The message is sent to a separate file in CSV format. Initially, only Ref, Mergerec, Next and Includetext (Ref, Record, Next and Insert text) fields are determined. They have only one parameter, which is also reported. This parameter is useful in the additional project CIB report&analyse.

The static field structure is the same order of the fields as written down.


Example for static field structure

{If {Mergerec ?Data} <> 0 „{Ref Name}{Next data}” \* Solange} reports 1. If, 2. Mergerec, 3. Ref and 4. Next

The dynamic field structure is the order of the fields during the evaluation.


Examples for dynamic field structure

{If {Mergerec ?Data} <> 0 „{Ref Name}{Next data}” \* Solange} reports 1. If, 2. Mergerec, 3. Ref, 4. Next, 5. Mergerec, 6. Ref, 7. Next, 8. Mergerec, 9. Ref, 10. Next, … etc., until the loop is complete.

CSV-Dateien bestehen aus Zeilenschaltungen getrennte Datenzeilen, welche durch Komma, Tabulator oder Semikolon () getrennt sind. Die erste Zeile enthält die Spaltenüberschriften (Feldnamen). Jede Zeile muss die gleiche Anzahl Felder haben. Felder, die Feldtrenner oder Zeilenschaltungen oder Anführungszeichen im Inhalt haben, werden von Anführungszeichen umschlossen. Die inhaltlichen Anführungszeichen werden verdoppelt.

Example: Extract from the parameter file:

--logfile=!fields.csv
-mPath;Field;Value
--logfile=!cibmerge_blocks_analyse.log
--source-directory=templates
--outputfile=-
--analyse=+fields.csv
# for all text 
--inputfile=basicblock.rtf
-m@
--filter
--inputfile=reference.rtf
-m@
--filter
... for all RTF blocks...
--inputfile=rootblock.rtf
-m@
--filter
-mdone 

This example consists of several RTF blocks. The --analyse parameter is used to generate the output "fields.csv". This file has the following structure:

Path;Field;Value

A more detailed description of the output can be found in the application example blocks.


Note:

Because of the static field sequence, fields in loops are output only once. For the same reason, fields from both the then and else branches of an if statement will be output. Since the filter and not the merge process generates the output, no fields are calculated and therefore no embedded texts (include text) are expanded or their fields output.

If you do a related field analysis over a whole lot of texts and blocks, you will also get the call tree with the inserted blocks. Identical fields that occur more than once are also reported several times (e.g.: two times {Ref Name})