Skip to content

AfterCheckOut

Script applications that are called by this interface are used to influence the checked out data after Check-Out.

Procedure

  1. The Check-Out process begins.
  2. The databases/archives are copied.
  3. The last version is restored.
  4. The local system is updated.
  5. The AfterCheckOut interface is called and the associated script application is started.
  6. The Check-Out process is completed.

Command lines for this script application

Without agents:

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

When using agents:

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

Description of the interface file

The sections [Common], [User], [Component], [Version], [ExclusiveUse], [UnderDevelopment] and [Result] 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 executing the function.

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

Section Specific

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

Key I/O Description Values Default
WorkingDir I Full path of the component's working directory
SupplierCheckOut I Indicates whether a supplier Check-Out is being performed. Y/N N
Failed I Indicates whether the recovery process has failed. Y/N N

Section SupplierCheckOut

The [SupplierCheckOut] section shows information on the supplier Check-Out. This section is only output if the [Specific]\SupplierCheckOut key has the value Y.

Key I/O Description Values
Flat I Shows 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

Section Backups

In the [Backups] section, the following keys can be configurated:

Key I/O Description Values
NumBackupsCopied I Number of (updated and new) backups copied to the client. {0..n}
0: There were no new or updated backups or that the user did not select the with backups option.
Errors I Indicates whether an error occurred when determining or copying the backups.
This error does not necessarily lead to the end of the Check-Out.		 Y/N