BeforeChangeCheck & AfterChangeCheck
Script applications called by this interface serve to modify files before or after a change check.
The command that made the change check necessary is only executed when the scripting application has finished (completed, cancelled, or suspended due to time out).
AfterChangeCheck is only triggered if BeforeChangeCheck was executed before. AfterChangeCheck is triggered when the scripting application BeforeChangeCheck ended in an error.
Process
- The system is checked.
- The script interface BeforeChangeCheck is triggered and starts the scripting application.
- Files and projects are transferred and operations are executed.
- A new version is created.
- The octoplant system checks whether changes to the working directory have been carried out since the beginning of the change check.
- An archive is created.
- The checksum of the archive is calculated.
- An update to the database is carried out.
- The script interface AfterChangeCheck is triggered the associated script application is executed.
For example: simplify the folder structure of the directory by copying all files to the same temporary folder and restore the folder structure after it has been simplified for testing. This makes it possible to compare projects that are structured differently in the working directory and in their archived form.
Command lines for ScriptBeforeChangeCheck
| ScriptBeforeChangeCheck.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the client archive] /at:c |
Command lines for ScriptAfterChangeCheck
| ScriptAfterChangeCheck.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the client archive] /at:c |
Description of the script interface BeforeChangeCheck
The sections [Common], [User], [Component], [Version], [QuickSave], [ExclusiveUse] and [UnderDevelopment] are described in Global interface file sections.
The sections [ExclusiveUse] and [UnderDevelopment] are not given in the background check.
[Specific]
| INI key | I/O | Description |
|---|---|---|
| WorkingDir | I | Complete path to the working directory of the component |
| HversionNext | I |
This key contains the version number that will be assigned to the next version |
| BaseVersionPresent | I | Shows whether a base version for this component exists. Possible values are Y and N. The default value is Y |
| BackgroundChangeCheck | I |
Displays whether the process is part of a background check
Possible values are Y and N. The default value is N |
Result]
The general key of this section are described in Global interface file sections.
| INI key | I/O | Description |
|---|---|---|
| ChangeReason | O |
Change reason The value is provided by the script. |
| ChangeReason_Forced | O |
Displays if the user can still change the value for ChangeReason Possible values are Y and N. The default value is Y
|
| Comment | O |
Change commentary The value is provided by the script |
| Comment_Forced | O |
Shows whether the user can still change the value of the Comment key Possible values are Y and N. The default value is Y
|
| HversionUserDefined | O |
User defined version identifier The value is provided by the script |
| HversionUserDefined_ Forced |
O |
Displays if the user can still change the value of the HversionUserDefined key Possible values are Y and N The default value is N
|
Description of script interface file AfterChangeCheck
The sections [Common], [User], [Component], [Version], [QuickSave], [ExclusiveUse] and [UnderDevelopment] are described in Global interface file sections.
The sections [ExclusiveUse] and [UnderDevelopment] are not given in the background check.
[Version]
The keys of this section are described in Global interface file sections.
No version will be created if the key Hversion is not provided or if it is left empty.
[Specific]
| INI key | I/O | Description |
|---|---|---|
| WorkingDir | I | Complete path to the working directory of the component |
| BaseVersionPresent | I |
Shows whether a base version for this component exists. |
| BackgroundChangeCheck | I |
Displays whether the process is part of a background check The background check only checks for differences. It doesn’t check for consistency or if a version has been created. Possible values are Y and N. The default value is N |
| Failed | I |
Displays whether the change check (and, if necessary, the process of creating a version) failed. |
| Related topics |
|---|