AfterUpload¶
Script applications called from this interface are executed after an upload has been created, but before it has been archived in octoplant. This makes it possible to modify uploads.
Example: Customizing backups of devices that have their own backup function but are not yet supported by octoplant.
If an error occurs when creating the upload, the AfterUpload interface is not triggered and the script application is not started.
Command lines for this script application¶
Without agents:
ScriptAfterUpload.exe /ConfigFileW:[absolute path of the interface file] /rd:[path of the server archive] /at:s
When using agents:
ScriptAfterUpload.exe /ConfigFileW:[absolute path of the interface file] /rd:[path of the agent archive] /at:s
Description of the interface file¶
The [Component] and [Result] sections are described in General sections of the interface file.
The [User] and [Version] sections are not included.
Section Common¶
The keys RootDirAdmin and DirPrjData are not specified. The other keys in the [Common] section 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 |
|---|---|---|---|---|
| UploadClass | I | Name of the upload class | ||
| DirBackup | I | Full path of the directory in which the unpacked backup is or was saved | ||
| PathArchive | I | Full path of the archive file (ZIP) of the last checked-in version. This key can be empty or missing (even if a version is checked in). | ||
| PathPreBackup | I | Full path of the archive file (ZIP) of the previous backup. This key can be empty or missing (even if there is an archived backup). | ||
| Type | I | Module that triggered the upload. | 1: Scheduler (manual/automatic). 2: Upload & Compare function | 1 |
| JobName | I | Name of the job in the job configuration Spaces in the name are permitted. | ||
| JobID | I | Job ID | A 32-character string |
Section UploadParameters¶
The keys in the [UploadParameters] section are always saved in Base64. The data is coded as follows: {ParamId}={Value}\0...{ParamId}={Value}\0\0.
If there are no parameters for a key, the key is not specified.
| Key | I/O | Description |
|---|---|---|
| Class | I | Parameters of the upload class (source octoplant server:VD$A\Configuration\Upload\Classes.ini). This key can be empty or missing. |
| Job | I | Parameter of the upload job |
| Agent | I | Parameter of the computer on which the agents are installed (source Agent:VD$A\Configuration\Upload\AgentStation.ini). This key may be empty or missing. |