BeforeCheckIn & AfterCheckIn
BeforeCheckIn
Script applications that trigger this interface are used to take influence on the data before the check-in. The check-in is executed once the script application ended (completed, cancelled, or timed-out)
AfterCheckIn
Script applications that trigger this interface are used to take influence on the data after the check-in. The script application is executed once the check-in ended (completed, cancelled, or timed-out)
Process
-
The scripts are checked by forming the checksum.
- The interface BeforeCheckIn is triggered and starts the associated script application.
- Files and projects are transferred and operations are executed.
- A new version is created.
- The Check-In process starts.
- The Check-In process ends.
- The interface AfterCheckIn is triggered and starts the associated script application.
Commando lines for the script application ScriptBeforeCheckIn
Without agents:
| ScriptBeforeCheckIn.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the server archive] /at:s |
With agents:
| ScriptBeforeCheckIn.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the agent archive] /at:s |
Commando lines for the script application ScriptAfterCheckIn
Without agents:
| ScriptAfterCheckIn.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the server archive] /at:s |
With agents:
| ScriptAfterCheckIn.exe /ConfigFileW:[absolute path to the interface file] /rd:[path to the agent archive] /at:s |
Description of the interface file for BeforeCheckIn
The sections [Specific], [User], [Common], [Component] and [Version] are described in Global interface file sections.
[Specific]
This section contains the complete path to the working directory of the component.
The keys of this section are described in Global interface file sections.
[User]
This section contains all the data of the executing user with the corresponding rights (administrator).
This records the User-Id, Name, FullName, Domain, EmailAddress, LocalLogon, Admin and Groups.
The keys of this section are described in Global interface file sections
[Common]
This section contains the information needed to run the script.
The most important line is Trigger=BeforeCheckIn.
This records the Language, ComputerName, RootDirAdmin, DirPrjData, DirTemp, TimeOut, PathLog, PathExeVdog, SilentMode and Licence.
The keys of this section are described in Global interface file sections
[Component]
This section contains the data concerning the component.
This records the Dir, Id and ComponentTypeId.
The keys of this section are described in Global interface file sections
[Version]
This section contains the data of the checked-out version in the working directory.
This records the VersionUUID, HVersion, HVersionUserDefined, TimeStampLocal, TimeStampUtc, ChangeReason, UserId, UserName, UserFullName, UserDomainName, UserEmailAddress, ComputerName, DNameStorage, and State.
The keys of this section are described in Global interface file sections
Description of the interface file for AfterCheckIn
The sections [Specific], [User], [Common], [Component] and [Version] are described in Global interface file sections.
[Specific]
This section contains the complete path to the working directory of the component. The keys of this section are described in Global interface file sections.
[User]
This section contains information concerning the user that executes the script with corresponding rights (Administrator). This records the User-Id, Name, FullName, Domain, EmailAddress, LocalLogon, Admin and Groups. The keys of this section are described in Global interface file sections.
[Common]
This section contains the information needed to run the script.
The most important line is Trigger=AfterCheckIn.
This records the Language, ComputerName, RootDirAdmin, DirPrjData, DirTemp, TimeOut, PathLog, PathExeVdog, SilentMode and Licence. The keys of this section are described in Global interface file sections.
[Component]
This section contains the data concerning the component. This records the Dir, Id and ComponentTypeId. The keys of this section are described in Global interface file sections.
[Version]
This section contains the data of the checked-out version in the working directory.
This records the VersionUUID, HVersion, HVersionUserDefined, TimeStampLocal, TimeStampUtc, ChangeReason, UserId, UserName, UserFullName, UserDomainName, UserEmailAddress, ComputerName, DNameStorage, and State.
The keys of this section are described in Global interface file sections.
| Related topics: |
|---|
| Global interface file sections |