View source for Compare feature

<div style="display:block; text-align:left; font:16px Helvetica, sans-serif; color: #555; margin:0 0 20px; padding:20px; border:2px solid #BC5C52; -webkit-border-radius: 2px; -moz-border-radius: 2px; border-radius: 2px"><em style="display:block; font:normal 24px Helvetica, sans-serif; color:#BC5C52; margin:0 10px 20px">Updating Wiki - Mise &agrave; jour du Wiki</em><p>The Wiki is currently being updated to the Blu Age 5.4 version. - Le Wiki est en cours de migration vers la version 5.4 de Blu Age.</p><p>&mdash; The Blu Age Team</p></div>

Last updated : 25 juin 2014<br/>
Apply to versions : '''Blu Age II 5.0 - all technologies''' <br/>

= Requirements =
BluAge Compare generates HTML reports with <i>localStorage</i> based Javascript functions.<br/>
This HTML 5 feature is supported by browsers listed below:
* Firefox: 3.5 +
* Chrome: 4+
* Internet Explorer: 8+
* Safari: 4+
* Opera: 10.5+

= Introduction =
Each batch you created needs to be tested on one or more '''test cases'''.

A '''test case''' of a batch consists in
* Run the batch on LEGACY environment
* Capture data before/after the LEGACY run
* Transform LEGACY data in MOD data
* Run the batch on MOD environment on before data
* Compare output MOD data with expected data
MOD: Modernized

<gallery widths=871px heights=333px>
File:CT_test-case.png|Test case
</gallery>

Compare output MOD data with expected data consists in
* '''Compare EBCDIC files''' output EBCDIC files from MOD with EBCDIC output files from LEGACY
* '''Compare flat files''' output flat files from MOD with output flat files from LEGACY
* '''Compare databases''' output database from MOD with output database from LEGACY
To automate testing process, compare tool has been developed and integrated to Blu Age software.

For one test case, you need
* If your batch creates output files
** Output and expected files
** A repository of copybooks
** A file with mapping of files / copybooks
*** A run job file
*** A substitution property file
* If your batch modifies the database
** Output and expected databases
** A repository of SQL views

<gallery widths=211px heights=273px>
File:CT_project-structure.png|Project structure
</gallery>

All information is stored in properties files used by Bluage Compare.

A property file contains
* Either information for at least one comparison type
* Comparison to compute are listed in "comparison.list" property
** Choices are :
*** Database
*** Ebcdic
*** FlatFile

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property file for EBCDIC files'''</td>
  <td>'''Property file for flat files'''</td>
  <td>'''Property file for databases'''</td>
 </tr>
 <tr>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="properties">
# General information
compare.repo.dir=${project.workspace}/Compare-repository
result.dir=${project.workspace}/Batch-project/test/result

comparison.list=Ebcdic

# Compare files information
copybook.dir=${project.workspace}/Batch-project/copybooks
expected.dir=${project.workspace}/Batch-project/data/expected
output.dir=${project.workspace}/Batch-project/data/outputs
runjob.file=${project.workspace}/Batch-project/specific/runJob.xml
</syntaxhighlight>
</div>
  </td>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="properties">
# General information
compare.repo.dir=${project.workspace}/Compare-repository
result.dir=${project.workspace}/Batch-project/test/result

comparison.list=FlatFile

# Compare files information
expected.dir=${project.workspace}/Batch-project/data/expected
output.dir=${project.workspace}/Batch-project/data/outputs
runjob.file=${project.workspace}/Batch-project/specific/runJob.xml
</syntaxhighlight>
</div>
  </td>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="properties">
# General information
compare.repo.dir=${project.workspace}/Compare-repository
result.dir=${project.workspace}/Batch-project/test/result

comparison.list=Database

# Compare databases information
db.type=DB2
db.source.host=SRV-111110
db.source.name=DBOUT
db.target.host=SRV-111110
db.target.name=DBEXP
db.tables=TABLE_1,TABLE_2
</syntaxhighlight>
</div>
  </td>
 </tr>
</table>

Depending on information in the property file, to launch Bluage Compare, you need to
* Select one property file
* Right click on the file
* Select “Bluage compare” menu
** Select "Compare all" submenu

<gallery widths=543px heights=76px>
File:CT_menu.png|Bluage Compare menu
</gallery>

When you select a submenu, compare tool execution is launch and information is displayed 
* On progress bar: execution timeline
* On console: execution log
** In the same folder than the property file, log and error files are created
** When execution finished, log and error file content are displayed to the console
** To follow step-by-step the execution, open and refresh the log and error files

<gallery>
File:CT_progress-bar.png|1. Progress bar
File:CT_log-start.png|2. Console log (start)
File:CT_log-end.png|3. Console log (end)
File:CT_log-err-files.png|4. Log and error files
File:CT_sample-result-files-1.png|5. Result files index
File:CT_sample-result-files-2.png|6. Result files detail
File:CT_sample-result-db-1.png|7. Result databases index
File:CT_sample-result-db-2.png|8. Result databases detail
</gallery>

= How does it works ? =
== Comparison process ==
'''To compare EBCDIC files'''
# Transform expected and outputs files to CSV files using copybooks
#: Specify copybook folder
#: Transform all files in output and expected folders
#: Get mapping between files/copybboks from either runjob or substitution property file
#: Get copybook from copybook folder
# Generate Javascript files from copybooks for HTML report
# Generic CSV comparison

'''To compare flat files'''
# Format expected and outputs flat files
# Generate Javascript files from flat file headers (for HTML report)
# Generic CSV comparison

'''To compare databases'''
# Extract output and expected database data to CSV files using SQL scripts (views)
#: Specify object names to compare
#: Get SQL scripts from compare repository
# Generate Javascript files from system tables using SQL scripts (for HTML report)
#: Run SQL scripts and view on a reference database
# Generic CSV comparison

'''Generic CSV comparison'''
# Compare two folders with CSV files base on file name
# For each couple of CSV file which differ
## Compute differences between CSV files using DIFF command
## Transform DIFF report (textual report) in HTML report (browsable report) using specific ANT scripts

<gallery widths=985px heights=503px>
File:CT_overview.png|Compare tool overview
</gallery>

== Comparison result directory ==
Result directory is a folder structure where files and databases comparison artefacts and report are generated.

In result directory, there are directories matching with IDs list into '''comparison.list''' properties

In each comparison result folder, there are
* A folder '''diff''' : diff text report (CSV comparison text result by diffutils)
* Folders '''expected''' and '''outputs''' : expected and outputs CSV files
** For databases : extracted using SQL sscripts
** For files : extracted using Java transformation
* A folder '''html''' : HTML report files
** Start comparison result page is '''index.html''' 

<gallery widths=126px heights=202px>
File:CT result-directory.png|Result directory structure
</gallery>

== Comparison states ==
Matching between files is based on file name.

Comparison state can be
* <span style="color:green;">Equals</span>: there are left and right files with the same name and there are equal
* <span style="color:red;">Differ</span>: there are left and right files with the same name but they differ
* <span style="color:red;">No output file</span>: there is an expected file but no output file with the same name
* <span style="color:red;">No expected file</span>: there is an output file but no expected file with the same name

<gallery widths=626px heights=138px>
File:CT_comparison-states.png|Comparison states
</gallery>

== Comparison repository ==
BluAge Compare repository is a folder structure where you put your copybooks and views to use in comparison.

The BluAge Compare repository must contains
* A folder '''db'''
** A subfolder '''views''' : all SQL views
** A subfolder '''js''' : all javascript files generated from views 
* A folder '''files'''
** A subfolder '''copybooks''' : all copybooks
*** A subfolder '''common''' : copybooks used by one or more batches
*** A '''subfolder for each batch''' (name equal to batch project name) : copybooks used only by the corresponding batch
** A subfolder '''js''' : all javascript files generated from copybooks
<gallery widths=228px heights=327px>
File:CT_compare-repository.png|Compare repository structure
</gallery>

== Report legend ==
When files differ, there are 3 types of differences : added lines, deleted lines and modified lines.<br/>
A color is set for each type of difference.
<gallery widths=752px heights=114px>
File: CT_legend.png|Legend
</gallery>

Legend colors are background color in table rows (to display differences) or titles (to display summary).<br/>
<gallery widths=157px heights=19px>
File: CT_legend-squares.png|Differences summary
</gallery>

Differences summary are displayed in
* Differences between two files in HTML index report
* If CSV files are split, differences between two split files in HTML index report
* If HTML report is split, differences for each part in HTML part index report
* Differences in HTML detail report
* If CSV files is polymorphic, differences for each record type

A modified line can have cells with
* Important differences: background color: gray / text color: red
* Unimportant differences (value equal when remove spaces): background color: gray / text color: orange
* No differences: background color: blue / text color: black
<gallery widths=539px heights=77px>
File: CT_legend-modified-line.png|Modified line
</gallery>

= General properties =
In property file, you can use properties below (automatically computed).
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">project.name</span></td>
  <td>Project name (name of Eclipse project)</td>
 </tr>
 <tr>
  <td><span style="color:blue;">project.workspace</span></td>
  <td>Absolute path to workspace</td>
 </tr>
</table>

All properties files must have at least properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">result.dir</span></td>
  <td>Absolute path to comparison result folder</td>
 </tr>
 <tr>
  <td><span style="color:blue;">compare.repo.dir</span></td>
  <td>Absolute path to compare repository folder</td>
 </tr>

All properties files must have at these properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">comparison.list</span></td>
  <td>List of comparison to compute : Database, Ebcdic or/and FlatFiles separated by ','</td>
 </tr>
</table>

= Compare options =
== Split CSV file ==
This feature consists in splitting a CSV file in many parts (cut by number of lines) if the file size is more than the maximum file size.<br/>
The file is split from a number of lines (each part will contain the same number of lines except the last part).<br/>
The part file name is: '''[file name].split[part number].csv'''.<br/>
:''[part number]'' starts with 0 and is on 5 digits (00000).<br/>

Be careful when you use this feature because comparison process will apply for each part of file and not on the whole file.

Two properties must be added to your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">compare.split.size</span></td>
  <td>Maximum file size in MB before split a CSV file</td>
  <td>100</td>
  <td>1 to N</td>
 </tr>
 <tr>
  <td><span style="color:blue;">compare.split.lines</span></td>
  <td>Number of lines in each part when a CSV file is split</td>
  <td>100000</td>
  <td>1 to N</td>
 </tr>
</table>

If you split a file but you didn’t have the same number of parts between left and right file, you will have comparison state below
* <span style="color:red;">No split left file</span>: The right file has been split in more parts than left file.
* <span style="color:red;">No split right file</span>: The left file has been split in more parts than right file.

Example
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>CSV file</td>
  <td>D22TREX1.G0009V00<br/>
* More than 500 MB
* 104 240 lines
[[File:CT_split-csv-1.png|File before split]]</td>
 </tr>
 <tr>
  <td>Compare tool options</td>
  <td>compare.split.size=100<br/>compare.split.lines=10000</td>
 </tr>
 <tr>
  <td>Result</td>
  <td>File size = 500 MB > 100 MB = Maximum file size<br/>
So the file is split in parts of 10 000 lines<br/>
98 parts are produced where
* Part 0 to 96 contain 10 000 lines each
* Part 97 contains 7 240 lines
Total lines: 97 x (10 000) + 7 240 = 104 240 lines<br/>
[[File:CT_split-csv-2.png|File after split - first parts]]<br/>
...<br/>
[[File:CT_split-csv-3.png|File after split - last parts]]
 </tr>
</table>
Comparison index examples
<gallery widths=600px heights=150px >
File:CT split-csv-4.png|Index when split
File:CT split-csv-5.png|Index when split and not same number of parts
</gallery>

= Compare flat files =
== Requirements ==
Output and expected files must have the same name.<br/>
'''Spaces''' are not allowed in file names.

== Special characters ==
The rules below is automatically applied on each field value of each line of a file during CSV formating.
* Each character ''';''' (CSV separator character) is replaced if needed by a '''space''' character

== Required properties ==
To compare files, you must set properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">expected.dir</span></td>
  <td>
Absolute path to folder which contains expected files.<br/>
No subfolders allowed.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path</td>
 </tr>
 <tr>
  <td><span style="color:blue;">output.dir</span></td>
  <td>
Absolute path to folder which contains output files.<br/>
No subfolders allowed.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path</td>
 </tr>
</table>

You also must set one of the two properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
<tr>
  <td><span style="color:blue;">substitution.props.file</span></td>
  <td>
To set if your project use a '''substitution property file''' to run.<br/>
Absolute path to substitution property file.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path to a file.</td>
 </tr>
 <tr>
  <td><span style="color:blue;">runjob.file</span></td>
  <td>
To set if your project use a '''runjob file''' to run.<br/>
Absolute path to runjob file.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path to a file.</td>
 </tr>
</table>

== Comparison states ==
For files, there are 1 more comparison states:
* <span style="color:orange;">Format CSV error</span>: an error has occured during CSV formatting
<gallery widths=631px heights=205px>
File:CT comparison-files-states.png|Comparison file states
</gallery>

== Quick example ==
In this example, we have:
* A Blu Age batch project named '''Batch-project'''
** A file produced by the batch File-1.csv
** The corresponding expected file of File-1.csv
** A runjob and substitution property file with refer to File-1.csv
** A property file '''Test.properies''' with comparison information
* A Compare repository
** Javascript files for all flatfiles
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Project Batch-project'''</td>
 </tr>
 <tr>
  <td>[[File:BluAgeCompare_projet_example.jpg|Sample project structure]]</td>
 </tr>
</table>

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Runjob file'''</td>
  <td>'''Substitution property file'''</td>
 </tr>
 <tr>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="xml">
<project name="runJob" >
 <property name="jobDef" value="Job.xml" />	
 <property name="substitutions" value="
   DUMMY.FILENAME_OUT=${basedir}/../data/outputs/File-1.csv" />
</project>
</syntaxhighlight>
</div>
  </td>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="xml">
<substitution-props>
	<prop name="DUMMY.FILENAME_OUT" value="__DATA__/../data/outputs/File-1.csv" />
</substitution-props>
</syntaxhighlight>
</div>
  </td>
 </tr>
</table>

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Test property file'''</td>
 </tr>
 <tr>
<td>
<div style="font-size: 12px;">
<syntaxhighlight lang="properties">
# General information
compare.repo.dir=${project.workspace}/Compare-repository
result.dir=${project.workspace}/Batch-project/test/result

comparison.list=FlatFile

# Compare files information
expected.dir=${project.workspace}/Batch-project/data/expected
output.dir=${project.workspace}/Batch-project/data/outputs
runjob.file=${project.workspace}/Batch-project/specific/runJob.xml
substitution.props.file=${project.workspace}/Batch-project/specific/SubstitutionsProperties.xml
</syntaxhighlight>
</div>
  </td>
 </tr>
</table>

= Compare EBCDIC files =
== Requirements ==
BluAge Compare uses attribute '''cobolRecordName''' of '''RecordFormat''' node of copybook files (.fileformat files). <br/>
Acrross all copybooks of the project, '''cobolRecordName''' must be unique!

Output and expected files must have the same name.<br/>
'''Spaces''' are not allowed in file names.

== Special characters ==
The rules below is automatically applied on each field value of each line of a file during transformation from EBCDIC to CSV.
* Each character '''x01 to x1F + x7F''' is replaced by a '''space''' character
* Each character ''';''' (CSV separator character) is replaced by a '''space''' character
* Each '''line break''' is replaced by a '''space''' character
* Each '''tabultation''' is replaced by a '''space''' character

== Required properties ==
To compare files, you must set properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">copybook.dir</span></td>
  <td>
Absolute path to folder which contains copybooks.<br/>
One subfolder allowed : '''common'''.<br/>
* A ''copybook right under this folder'' is a ''specific copybook'' for the project
* A ''copybook under folder common'' is a ''common copybook'' used by many projects
</td>
  <td>N/A</td>
  <td>Any valid absolute path</td>
 </tr>
 <tr>
  <td><span style="color:blue;">expected.dir</span></td>
  <td>
Absolute path to folder which contains expected files.<br/>
No subfolders allowed.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path</td>
 </tr>
 <tr>
  <td><span style="color:blue;">output.dir</span></td>
  <td>
Absolute path to folder which contains output files.<br/>
No subfolders allowed.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path</td>
 </tr>
</table>

You also must set one of the two properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
<tr>
  <td><span style="color:blue;">substitution.props.file</span></td>
  <td>
To set if your project use a '''substitution property file''' to run.<br/>
Absolute path to substitution property file.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path to a file.</td>
 </tr>
 <tr>
  <td><span style="color:blue;">runjob.file</span></td>
  <td>
To set if your project use a '''runjob file''' to run.<br/>
Absolute path to runjob file.
  </td>
  <td>N/A</td>
  <td>Any valid absolute path to a file.</td>
 </tr>
</table>

== Comparison states ==
For files, there are 3 more comparison states:
* <span style="color:orange;">No copybook</span>: there is no copybook referenced for the file (expected or output)
* <span style="color:orange;">Transformation to CSV error</span>: an error has occured during transformation from EBCDIC to CSV
* <span style="color:#615F60;">Empty file</span>: there is an output and expected file linked to a copybook named emptyFile.fileformat
<gallery widths=631px heights=205px>
File:CT comparison-files-states.png|Comparison file states
</gallery>

== Quick example ==
In this example, we have:
* A Blu Age batch project named '''Batch-project'''
** A common copybook: Copybook-1.fileformat
** A specific copybook: Copybook-2.fileformat
** A file produced by the batch File-1
** The corresponding expected file of File-1
** A runjob and substitution property file with mapping betwwen File-1 and Copybook-1.fileformat
** A property file '''Test.properies''' with comparison information
* A Compare repository
** Common and specific copybooks
** Javascript files for all copybooks
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Project Batch-project'''</td>
  <td>'''Compare repository'''</td>
 </tr>
 <tr>
  <td>[[File:CT_project-structure.png|Sample project structure]]</td>
  <td>[[File:CT_compare-repository-files.png|Sample project structure]]</td>
 </tr>
</table>

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Runjob file'''</td>
  <td>'''Substitution property file'''</td>
 </tr>
 <tr>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="xml">
<project name="runJob" >
 <property name="jobDef" value="Job.xml" />	
 <property name="substitutions" value="
   DUMMY.copybook_out=${basedir}/../copybooks/common/Copybook-1.fileformat
   DUMMY.FILENAME_OUT=${basedir}/../data/outputs/File-1" />
</project>
</syntaxhighlight>
</div>
  </td>
  <td>
<div style="font-size: 12px;">
<syntaxhighlight lang="xml">
<substitution-props>
	<prop name="DUMMY.FILENAME_OUT" value="__DATA__/../data/outputs/File-1" />
	<prop name="DUMMY.copybook_out" value="__DATA__/../copybooks/common/Copybook-1.fileformat" />
</substitution-props>
</syntaxhighlight>
</div>
  </td>
 </tr>
</table>

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Test property file'''</td>
 </tr>
 <tr>
<td>
<div style="font-size: 12px;">
<syntaxhighlight lang="properties">
# General information
compare.repo.dir=${project.workspace}/Compare-repository
result.dir=${project.workspace}/Batch-project/test/result

comparison.list=Ebcdic

# Compare files information
copybook.dir=${project.workspace}/Batch-project/copybooks
expected.dir=${project.workspace}/Batch-project/data/expected
output.dir=${project.workspace}/Batch-project/data/outputs
runjob.file=${project.workspace}/Batch-project/specific/runJob.xml
substitution.props.file=${project.workspace}/Batch-project/specific/SubstitutionsProperties.xml
</syntaxhighlight>
</div>
  </td>
 </tr>
</table>

== Feature: Handle character LOW-VALUE ==
The special character '''x00''' is equal to '''LOW-VALUE''' (also equal to NUL).<br/>
This feature allow you to specify how to handle LOW-VALUE characters in comparison:
* Either consider them as spaces
** In this case, difference between LOW-VALUE and SPACE characters are skipped
* Or replace group of LOW-VALUE characters by a static string (LOW-VALUES)
** Default mode.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.write.lowvalues</span></td>
  <td>
Indicate how to handle LOW-VALUE characters.
</td>
  <td>true</td>
  <td>true / false</td>
 </tr>
</table>
<gallery widths=600px heights=100px >
File:CT_low-values-1.png|files.write.lowvalues = true
File:CT_low-values-2.png|files.write.lowvalues = false
</gallery>

== Feature: Handle Variable block file ==
A variable block file is an ebcdic file containning lines with a variable length.
Length is the first field of each line and the last have a variable length.
Into copybook, this string type field is mark with a length equals to "VB". BA compare tools handle that.

<gallery widths=600px heights=150px >
File:VariableBlock_comparison.jpg|Variable block file comparison.
</gallery>

In addition, if a variable block field have a value format like a csv line, you can compare each csv field instead of the whole csv line.
To activate this feature add "generate.csv.sub.column.separator" property values with csv separator character into compare tools configuration file.

<gallery widths=600px heights=150px >
File:VariableBlock_comparison_csv_activate.jpg|generate.csv.sub.column.separator=;
</gallery>

== Feature: Handle trimmed records into an EBCDIC File ==
In some case EBCDIC file records can be separate with a line separator and the last field trimmed. To handle that compare feature must know which separator is used. 

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">record.separator</span></td>
  <td>
String record separator value
</td>
  <td></td>
  <td></td>
 </tr>
<tr>
  <td><span style="color:blue;">record.separator.newline</span></td>
  <td>
Put this property at “true” if record separator is a new line. (Value of “line.separator" java property)
</td>
  <td></td>
  <td>true / false</td>
 </tr>
</table>

If “record.separator.newline” is set “record.separator” value is not take in account.

<gallery widths=600px heights=150px >
File:Trimmed EBCDIC files.gif|record.separator.newline=true
</gallery>

== Feature: Delete temporary folder ==
During comparison, compare tool creates work folders where CSV are generated, diff text report are made, etc…<br/> 
This feature allows you to automatically delete these temporary folders after comparison.<br/>

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.delete.temp.dir</span></td>
  <td>
Indicates if temporary folders will be deleted at the end of comparison.
</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
</table>
<gallery widths=150px heights=100px >
File:CT_files-delete-temp-dir-1.png|files.delete.temp.dir = false
File:CT_files-delete-temp-dir-2.png|files.delete.temp.dir = true
</gallery>

== Feature: Reject fields ==
Sometimes, you want to compare just a set of columns between two files because other columns are not relevant (like audit time, audit date, …).<br/>
From a '''list of FieldFormat names''' to reject, this feature automatically add '''ToReject="true"''' attribute for each FieldFormat in all copybooks.<br/>
During conversion in CSV, if a FieldFormat has attribute ToReject="true", compare tool writes '''(REJECT)''' instead of the real value in the CSV file.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.fields.reject</span></td>
  <td>
Indicate all FieldFormat to reject in comparison.
</td>
  <td>Empty</td>
  <td>List of FieldFormat names (each name is separated by a comma)</td>
 </tr>
</table>

<u>Note</u>: if you want to reject a FieldFormat for only one RecordFormat in one specific copybook, you must '''manually''' add attribute ToReject="true" in this FieldFormat and not add the name of this FieldFormat in files.fields.reject property.

<gallery widths=300px heights=100px >
File:CT_files-reject-fields-1.png|files.fields.reject =
File:CT_files-reject-fields-2.png|files.fields.reject = RC_COL_11
File:CT_files-reject-fields-3.png|files.fields.reject = RC_COL_11,RC_COL_13
</gallery>

== Feature: Remove fields ==
Sometimes, you want to compare just a set of columns between two files because other columns are not relevant (like audit time, audit date, …).<br/>
From a '''list of FieldFormat names''' to reject, this feature automatically add '''ToRemove="true"''' attribute for each FieldFormat in all copybooks.<br/>
During conversion in CSV, if a FieldFormat has attribute ToRemove="true", compare tool will '''not write the value''' of the field format in the CSV file.<br/>
You must generate the Javascript files for each files from which there is at least one field format of one copybooks listed as to remove.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.fields.remove</span></td>
  <td>
Indicate all FieldFormat to remove in comparison.
</td>
  <td>Empty</td>
  <td>List of FieldFormat names (each name is separated by a comma)</td>
 </tr>
</table>

<u>Note</u>: if you want to remove a FieldFormat for only one RecordFormat in one specific copybook, you must '''manually''' add attribute ToRemove="true" in this FieldFormat and not add the name of this FieldFormat in files.fields.remove property.

<gallery widths=300px heights=100px >
File:CT_files-remove-fields-1.png|files.fields.remove =
File:CT_files-remove-fields-2.png|files.fields.remove = RC_COL_2<br/>generate.js.files=true<br/>generate.js.files.filter=**/*.fileformat
File:CT_files-remove-fields-3.png|files.fields.remove = RC_COL_2,RC_COL_3<br/>generate.js.files=true<br/>generate.js.files.filter=**/*.fileformat
</gallery>

== Feature: Trim fields ==
This feature allows you to trim all data fields before comparing them.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.fields.trim</span></td>
  <td>
Indicate if data is trimmed before comparison.
</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
</table>
<gallery widths=350px heights=100px >
File:CT files-trim-1.png|files.fields.trim = false
File:CT files-trim-2.png|files.fields.trim = true
</gallery>

== Feature: Split CSV by record type ==
Sometimes, you want to split polymorphic files by record type to analyse comparison result by type per file '''"business view"''' and not by file '''"technical view"'''.<br/>
Each file coming from copybooks in this list will be split.

For each copybook is this list, compare tool automatically add '''ToSplit="true"''' attribute for FileFormat node.
During conversion in CSV, if a FileFormat of a copybook has attribute ToSplit="true", compare tool writes one CSV file per record format.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.split.copybooks</span></td>
  <td>
List of copybooks from which files will be split.
</td>
  <td>Empty</td>
  <td>List of copybook names.</td>
 </tr>
</table>
<u>Example</u>
* File_1 is conform to Copybook-1.fileformat
* Copybook-1.fileformat has two record format RECORD_TYPE_1 and RECORD_TYPE_2
* File_1 is a polymorphic file and contains record of each record type
<gallery widths=606px heights=90px >
File:CT files-split-record-type-1.png|files.split.copybooks=
File:CT files-split-record-type-2.png|files.split.copybooks=Copybook-1.fileformat
</gallery>

== Feature: Sort CSV ==
Sometimes, you want to sort a file before comparison process.

From a copybook name list, each file conforms to one of this copybook will be sorted using sort options.<br/>
Before sort a file, the file is automatically split.

You must specify a sort option for each record format of this copybook you want to sort.<br/>
Sort options can be
* A simple sort mode: sort file from left to right
* A specific sort mode: order columns and then sort file from left to right
* No sort

You may also want to keep original and sorted files iin comparison to see if sort option has benefit or not.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.sort.copybooks</span></td>
  <td>
List of copybooks from which files will be sorted.
</td>
  <td>Empty</td>
  <td>List of copybook names.</td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.sort.opt.[copybook].[record format]</span></td>
  <td>
Indicate sort mode for a record format of a copybook
</td>
  <td>Empty (no sort)</td>
  <td>
* '''simple''': simple sort mode
* '''[1 to N]''': specific sort mode: list of column indexes, like 10,2,4
  </td>
 </tr>
 <tr>
  <td><span style="color:blue;">files.sort.keep.files</span></td>
  <td>
Indicate if keep original and sorted file in comparison
</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
</table>
<gallery widths=500px heights=100px perrow=2>
File:CT files-sort-simple-1.png|files.sort.copybooks=Copybook-1.fileformat
File:CT files-sort-simple-2.png|Added  / Deleted lines because no sort
File:CT files-sort-simple-3.png|files.sort.copybooks=Copybook-1.fileformat<br/>files.sort.opt.Copybook-1.fileformat.RECORD_TYPE_1=simple<br/>files.sort.opt.Copybook-1.fileformat.RECORD_TYPE_2=simple
File:CT files-sort-simple-4.png|files.sort.copybooks=Copybook-1.fileformat<br/>files.sort.opt.Copybook-1.fileformat.RECORD_TYPE_1=simple<br/>files.sort.opt.Copybook-1.fileformat.RECORD_TYPE_2=simple<br/>files.sort.keep.files=true
</gallery>
Specific sort mode consists in reorder columns and then sort the file.
<gallery widths=500px heights=100px >
File:CT files-sort-specific-1.png|Original file
File:CT files-sort-specific-2.png|Specific sort: reorder 10,2,4
</gallery>

== Feature: Expected copybook ==
== Feature: Business key ==
To use this feature, you must set sort / split properties.

== Feature: Generate Javascript files ==
Comparison result are displayed in HTML table : headers came from Javascript files generated from copybooks.<br/>
This feature allows you to generate Javascript files before launch comparison.

For each copybook, you need to generate the corresponding Javascript file
* The first time you launch compare tool (if the Javascript file is not already generated in compare repository)
* Each time you modify the copybook

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">generate.js.files</span></td>
  <td>
Indicate if generate Javascript files for copybooks before compare.
</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
 <tr>
  <td><span style="color:blue;">generate.js.files.skip.common</span></td>
  <td>
Indicate if generate Javascript files for common copybooks.
</td>
  <td>true</td>
  <td>true / false</td>
 </tr>
 <tr>
  <td><span style="color:blue;">generate.js.files.filter</span></td>
  <td>
File filter to select from which copybooks generate Javascript files.
</td>
  <td>**/*.fileformat</td>
  <td>file filter</td>
 </tr>
</table>
<gallery widths=230px heights=219px >
File:CT_files-generate-js-1.png|Copybooks in project
File:CT_files-generate-js-2.png|Javascript files in compare repository
File:CT_files-generate-js-3.png|Javascript files in compare result folder
File:CT_files-generate-js-4.png|include.js generated file
</gallery>

= Compare databases =
Supported databases by BA compare tools are :
* DB2
* Oracle 10g/11g
* Postgresql 8/9
* SQL Server 2008

== Requirements ==
Each object is linked to a SQL file in located in '''[Compare repository]/db/views'''.<br/>
Each SQL file is named '''VW_[object name]''' and contains 2 SQL statements

# '''CREATE VIEW'''
## The first column is the business key of the object
## Don’t include IDENTIFIER and VERSION columns
## Don’t include foreign keys columns
## Join with parent tables to get the business key
# '''SELECT FROM VIEW'''
## The first column is the view name
## The second to the last columns are all other columns
## The statement is sorted by business key and then all other columns

A best pratice is to create one view per table.

<u>Example</u><br/>
In database, we want to compare a table named '''TABLE_1''' with 7 columns and business is composed by columns 3,4,2.<br/>

<gallery widths=289px heights=215px>
File:CT_db-view-create.png|CREATE VIEW statement
File:CT_db-view-select.png|SELECT FROM VIEW statement
</gallery>

== Required properties ==
To compare databases, you must set properties below.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.type</span></td>
  <td>Database type</td>
  <td>DB2</td>
  <td>DB2, Postgresql 8, Postgresql 9, SQL Server and Oracle</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.source.host</span></td>
  <td>Database source host</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.source.port</span></td>
  <td>Database source port</td>
  <td>50000</td>
  <td>1 ... N</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.source.name</span></td>
  <td>Database source name</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.source.schema</span></td>
  <td>Database source schema</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.source.user</span></td>
  <td>Database user</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.source.pwd</span></td>
  <td>Database password</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
</table>

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.target.host</span></td>
  <td>Database target host</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.target.port</span></td>
  <td>Database target port</td>
  <td>50000</td>
  <td>1 ... N</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.target.name</span></td>
  <td>Database target name</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.target.schema</span></td>
  <td>Database target schema</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.target.user</span></td>
  <td>Database user</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.target.pwd</span></td>
  <td>Database password</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
</table>

<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.tables</span></td>
  <td>
Indicate which objects to compare.<br/>
If the property contains '''.txt''', it's a reference to a text file with one object name by line.
</td>
  <td>Empty (take all object names)</td>
  <td>list of object names</td>
 </tr>
</table>

== Special characters ==
The rules below is automatically applied on each column value of each line of a file during transformation from EBCDIC to CSV.
* Each group of '''one or more x00''' characters is replaced by '''(LOW-VALUES)'''
* Each '''x01 to x1F + x7F''' characters is replaced by a '''space''' character
* Each '''line break''' character is replaced by a '''space''' character

If a column has potentially the character ''';''' (CSV separator character), it must be replaced by a '''space''' character in the CREATE VIEW statement using DB2 REPLACE function.<br/>
<span style="color:blue;">REPLACE</span>(COL_1,<span style="color:blue;">';'</span>,<span style="color:blue;">' '</span>) <span style="color:red;">AS</span> COL_1

== Feature: Delete temporary folder ==
During comparison, compare tool creates work folders where CSV are generated, diff text report are made, etc…<br/> 
This feature allows you to automatically delete these temporary folders after comparison.<br/>

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.delete.temp.dir</span></td>
  <td>
Indicates if temporary folders will be deleted at the end of comparison.
</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
</table>
<gallery widths=150px heights=100px >
File:CT_db-delete-temp-dir-1.png|db.delete.temp.dir = false
File:CT_db-delete-temp-dir-2.png|db.delete.temp.dir = true
</gallery>
== Feature: Reject fields ==
Sometimes, you want to compare just a set of columns between two objects because other columns are not relevant (like audit time, audit date, …).<br/>
To reject columns for database, you must modify '''SELECT VIEW''' statement by replacing the rejected column by constant string <span style="color:red;">'''(REJECT)'''</span><br/>

Do not remove the column from the SELECT VIEW!<br/>
Table headers are computed from columns view, you will miss one or more values if you remove column(s)!

<gallery widths=180px heights=261px >
File:CT db-reject-fields-3.png|SELECT VIEW with (REJECT)
</gallery>

<gallery widths=325px heights=133px >
File:CT db-reject-fields-1.png|No fields rejected
File:CT db-reject-fields-2.png|Reject COL_7
</gallery>

== Feature: Trim fields ==
Sometimes, you want to trim column value before comparing them.

To trim columns for database, you have to modify '''SELECT VIEW''' statement by calling DB2 trim function <span style="color:red;">'''LTRIM'''</span> (left trim) and <span style="color:red;">'''RTRIM'''</span> (right trim) on column.

<gallery widths=195px heights=273px >
File:CT_db-trim-3.png|SELECT FROM VIEW with TRIM
</gallery>

<gallery widths=380px heights=60px >
File:CT_db-trim-1.png|Without TRIM
File:CT_db-trim-2.png|With TRIM
</gallery>

== Feature: Generate Javascript files ==
Comparison result are displayed in HTML table : headers came from Javascript files generated from views using system tables.<br/>
If generate.js.db is set to true, compare tool will generate Javascript files before compare databases.

For each view, you need to generate the corresponding Javascript file
* The first time you launch compare tool (if the Javascript file is not already generated in compare repository)
* Each time you modify the view (sql file)

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">generate.js.db</span></td>
  <td>
Indicate if generate Javascript files for databases before compare.
</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
 <tr>
  <td><span style="color:blue;">generate.js.db.tables</span></td>
  <td>
List of object names from which generate Javascript files.
</td>
  <td>Empty (take all objects)</td>
  <td>list of object names</td>
 </tr>
</table>

A reference database is used to generate Javascript files.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.ref.host</span></td>
  <td>Database reference host</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.ref.port</span></td>
  <td>Database reference port</td>
  <td>50000</td>
  <td>1 ... N</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.ref.name</span></td>
  <td>Database reference name</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.ref.schema</span></td>
  <td>Database reference schema</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.ref.user</span></td>
  <td>Database user</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
 <tr>
  <td><span style="color:blue;">db.ref.pwd</span></td>
  <td>Database password</td>
  <td>Empty</td>
  <td>N/A</td>
 </tr>
</table>

<gallery widths=266px heights=146px >
File:CT_db-generate-js-1.png|Javascript files in compare repository
File:CT_db-generate-js-2.png|Javascript files in compare result folder
File:CT_db-generate-js-3.png|include.js generated file
</gallery>

== Feature: Generate SQL view scripts ==

BluAge Compare include a wizard to generate SQL view script required by database comparison.

'''Requirement :'''
* A property file with correct database connection informations

Follow these steps to generate SQL view scripts :

<gallery widths=266px heights=146px >
File:BluAgeCompare_generate_view_right_click.jpg|Right click on property file
File:BluAgeCompare generate view menu.png|Menu to open SQL view script generator
File:BluAgeCompare generate view wizard.png|Select tables and columns
File:BluAgeCompare generate view result.jpg |Result
</gallery>
'''Note :'''
* SQL scripts are created into [Compare repository]/db/views folder.

= Report options =
== Feature: Side-by-side ==
This feature allows you to generate a new HTML report called « side-by-side » report to broswe differences by showing left file and right file side-by-side (like Winmerge tool).

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">report.side.by.side</span></td>
  <td>Indicates if a side-by-side report must be generated.</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
</table>
<gallery widths=500px heights=100px >
File:CT_side-by-side-1.png|report.side.by.side = false
File:CT_side-by-side-2.png|report.side.by.side = true
</gallery>

<gallery widths=760px heights=200px >
File:CT_side-by-side-3.png|Side-by-side report
</gallery>

== Feature: Keep history ==
This feature allows you to copy previous comparison result folders (files and db) and timestamp them before launch a new comparison process.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">report.keep.history</span></td>
  <td>Indicates if previous comparison result folders  must be kept.</td>
  <td>false</td>
  <td>true / false</td>
 </tr>
</table>

<gallery widths=197px heights=130px >
File:CT_keep-history.png|report.keep.history = true
</gallery>

== Feature: Max differences ==
This feature allows you to split HTML detail report in many parts to be openeable and browable easier by a browser.

To use this feature, you must set the property below in your property file.
<table border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border:2px solid #62AEC4; margin-bottom:1em;">
 <tr>
  <td>'''Property'''</td>
  <td>'''Description'''</td>
  <td>'''Default value'''</td>
  <td>'''Possible values'''</td>
 </tr>
 <tr>
  <td><span style="color:blue;">report.max.differences</span></td>
  <td>Number of differences in each HTML report part.</td>
  <td>1000</td>
  <td>1 .. N</td>
 </tr>
</table>
<gallery widths=500px heights=150px >
File:CT_max-diif-1.png|report.max.differences = 5
File:CT_max-diif-2.png|report.max.differences = 2
</gallery>

= Annexes =
== Console view ==
Console view for compare tool extends standard Eclipse text console.

Features have been added to console:
* Close current compare tool console
* Close all compare tool consoles

<gallery>
File:CT_console-view-1.png|Console view
File:CT_console-view-2.png|Close current console
File:CT_console-view-3.png|Close all consoles
File:CT_console-view-4.png|Select older console
</gallery>