BeforeCompare & AfterCompare

Script applications called from these interfaces are used to modify the data of a new version before comparison and to undo these modifications after comparison. The script applications are always started at the same time as a client-sided comparison (for example, between two versions or between a backup and a version). The comparison is only executed when the script application ScriptBeforeCompare has ended (completed, cancelled, or suspended due to timeout).

 

Process

  1. The scripting interface BeforeCompare is triggered and the scripting application begins.
  2. The comparison begins.
  3. Files and projects are transferred and operations are executed.
  4. The scripting interface AfterCompare is triggered and the scripting application starts.
  5. The comparison ends.
  6. Temporary files are deleted.
  7. The comparison is finished.

For example: unzip the archive before the comparison. This allows you to carry out a detailed comparison. After the comparison, the temporary folder into which the data was unpacked for the comparison can be deleted again.

If an error occurs in a script application, the checked-in data remains unchanged and the processing state of the component is not changed. An error message will be displayed.

 

Command lines for ScriptBeforeCompare

ScriptBeforeCompare.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the client archive] /at:c

 

Command lines for ScriptAfterCompare

ScriptAfterCompare.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the client archive] /at:c

 

Description of the BeforeCompare interface file

The sections [Common] and [Component] are described in Global interface file sections.

The sections [User] and [Version] is not given.

[Specific]

INI key I/O Description
WorkingDirM I Complete path to the working directory of the master
ArchiveM I

Complete path to the archive file of the master

If this key is empty, the files are not unzipped and can be found in WorkingDirM.
WorkingDirS I Complete path to working directory of the slave
ArchiveS I

Complete path to the archive file of the slave

If this key is empty, the files are unzipped and you can find them in WorkingDirS.
Type I

The key contains information on which files are compared

The following values are possible:

  • 1: Backup with backup
  • 2: Version with backup
  • 4: Version with version
BackgroundChangeCheck I

Displays whether the process is part of a background check

The background check only checks for differences. It does not check for consistency or for creating a version.

Possible values are Y and N. The default value is N

 

[Result]

The general keys of this section are described in Global interface file sections.

INI key I/O Description
WorkingDirM O

Complete path to the master folder in which the project data files of the script application are contained

If this key is empty, the files can be found in the WorkingDirM folder.
DeleteWorkingDirM O

Displays whether the contents of the WorkingDirM folder will be deleted when the execution of the scripting application has finished

This key is only used if the WorkingDirM folder was used and has not been deleted already.
Possible values are Y and N. The default value is N
WorkingDirS O

Complete path to the slave folder in which the project data files of the script application are contained

If this key is empty, the files can be found in the WorkingDirM folder
DeleteWorkingDirS O

Displays whether the contents of the WorkingDirS will be deleted when the execution of the scripting application has ended

This key is only used if the folder WorkingDirS was used and is not already deleted.
Possible values are Y and N. The default value is N.

 

Description of the interface file for AfterCompare

The sections [Common], [Component] and [Result] are described in Global interface file sections.

The sections [User] and [Version] is not given.

[Specific]

INI key I/O Description
Type I

The key contains information on which files are compared

The following values are possible:

  • 1: Backup with backup
  • 2: Version with backup
  • 4: Version with version
WorkingDirM I Complete path to the working directory of the master
WorkingDirM_BC I

Complete path to the archive folder of the master in which project of the script application ScriptBeforeCompare.exe is stored.

If this key is empty, the BeforeCompare.exe script application was not executed or did not return any results.
WorkingDirS I Complete path to working directory of the slave
WorkingDirS_BC I

Complete path to the archive folder of the slave, in which the project data of the script application ScriptBeforeCompare.exe is stored

If this key is empty, the BeforeCompare.exe script application was not executed or did not return any results.
BackgroundChangeCheck I

Displays whether the check is part of a background check

The background check only checks for differences. It does not check for consistency or for creating a version.

Possible values are Y and N. The default value is N

 

Related topics

Global interface file sections