Inconsistency Check Step

From Okapi Framework
Jump to navigation Jump to search


Generates a report of potential inconsistencies found by comparing the source and targets segments across multiple input documents.

Takes: Filter events. Sends: Filter events.

This step checks for inconsistencies in both the source and target segments by:

  • comparing the target of each unique source and
  • comparing the source of each unique target.

The XML report that is generated lists all the potential inconsistencies by their "key text" and all the corresponding source or target strings, dependent on the key, for the given text. This allows for easy review of all the current strings pinpointing those that are inconsistent.

  • Inline codes are not taken into account when doing comparisons.
  • The comparison is case-sensitive and whitespace-sensitive.
  • Text units or segments that have no target are not included in the check.
  • Text units or segments that are empty are included in the check.


Check inconsistencies — Set this option to perform to look for inconsistencies. This option allows you to disable the step in a given pipeline.

Check for inconsistencies on a file-by-file basis — Set this option to process each input file individually. Consider selecting this option if there are issues with memory usage.

Path of the report file — Enter the full path of the XML report to generate. You can the variable ${rootDir} or ${inputRootDir} in the path.

Open report file after completion — Set this option to automatically open the report file after the process is complete.

Representation of the inline code in the report: — Set this option to change how the report displays inline code. The choices are:

  • Original codes: Choose this option to display the inline code as they appear in the input documents.
  • Generic markers: Choose this option to display the inline code as generic markers. For example, <1></1> or <2/>.
  • Plain text: Choose this option to remove all inline codes from the report.


  • You may run out of memory when processing a large number of segments.