Skip to content

BeforeCheckOut

Script applications that are called by this interface are used to influence the data before Check-Out. The Check-Out is only executed when the script application has ended (completed, canceled or timed out).

Procedure

  1. The entire system is checked.
  2. The BeforeCheckOut interface is called and the associated script application is started.
  3. The Check-Out process begins.

Command lines for this script application

Without agents:

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

When using agents:

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

Description of the interface file

The [Common], [User], [Component], [Version], [ExclusiveUse], [UnderDevelopment] and [Result] sections are described in General sections of the interface file.

Section Version

The [Version] section shows information on the version checked out in the working directory.

When executing the Copy version to directory function, the information is only displayed here if the version was not yet available on the client before the function was executed.

The section keys are described in General sections of the interface file.

Section Specific

In the [Specific] section, the following keys can be configured:

Key I/O Description Values Default
WorkingDir I Full path of the component's working directory
UnderDevelopment I Indicates whether the component is marked as Under development during the Check-Out process. Y/N N
InExclusiveUse I Indicates whether the component is Locked during the Check-Out process. Y/N N
SupplierCheck-Out I Indicates whether a supplier Check-Out is performed. Y/N N

Section SupplierCheckOut

The [SupplierCheckOut] section shows information on the Supplier Check-Out. This section is only output if the value Y has been assigned for [Specific]\SupplierCheckOut.

Key I/O Description Values
Flat I Indicates whether the structure of the working directory has been retained. Y/N
Unzipped I Indicates whether the project data was made available unzipped. Y/N
DestinationDir I Complete path of the destination directory for the Check-Out