BeforeCompare & AfterCompare (server-sided)

Script applications called by these interfaces are used to change the data of a new version before the comparison that follows an upload, and to undo these changes after the comparison. The comparison is only executed when the script application ScriptBeforeCompare has ended (completed, cancelled, or suspended due to timeout).

 

Workflow

  1. The job starts.
  2. The upload is carried out.
  3. The interface BeforeCompare is called and the associated script application is started.
  4. The comparison begins.
  5. Files and projects are transferred and operations are executed.
  6. The comparison is executed.
  7. The interface AfterCompare is called and the script application is started.
  8. The comparison ends.
  9. Temporary files are deleted.
  10. The comparison is finished.

Example: unzip an archive before a comparison in order to enable a detailed comparison, and delete the temporary archives in which the unzipped data of the comparison are stored once the comparison is complete

AfterCompare is independent from BeforeCompare and will also be triggered if an error occurs during the execution of BeforeCompare.

 

Commands lines for ScriptBeforeCompare

Without agents:

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

With agents:

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

 

Command lines for ScriptAfterCompare

Without agents:

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

With agents:

ScriptAfterCompareS.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the agent archive] /at:s

 

Description of the BeforeCompare interface file

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

The sections [User] and [Version] are not included.

[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 will not be unzipped and will not be present in the 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 will not be unzipped and will not be present in the WorkingDirS.
Type I

Displays which data 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

A background check only checks for differences and does not check for consistency or versioning.

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 directory, in which the project files of the script application are provided

If this key is empty the files will not be in the WorkingDirM
DeleteWorkingDirM O

Displays if the content of the WorkingDirM is deleted when the script application was ended

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

This key is only used if the WorkingDirM was used and has not been deleted.
WorkingDirS O

Complete path to the slave directory, in which the project files of the script application are provided

If this key is empty the files can be found in the WorkingDirS.
DeleteWorkingDirS O

Displays whether the contents of the WorkingDirS directory are deleted when the script application was ended

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

This key is only used if the WorkingDirS directory was used and is not deleted.

 

Description of the scripting interface file for AfterCompare

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

The sections [User] and [Version] are not included.

[Specific]

INI key I/O Description
Type I

Displays which files are compared

The following values are possible:

1: Backup with backup

2: Offline project with backup

4: Offline project with offline project
WorkingDirM I Complete path to the working directory of the master
WorkingDirM_BC I

Complete path of the archive directory of the master, where the BeforeCompareS.exe script application saves the project data

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

Complete path of the archive directory of the slave where the BeforeCompare.exe script application saves the project data

If this key is empty, the script application ScriptBeforeCompare.exe was not executed or didn’t return any results.
BackgroundChangeCheck I

Displays whether the check is part of a background check

The background check only checks for differences. It doesn’t check for consistency or versioning.

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

 

Related topics

Global interface file sections