BeforeUpload
Script applications that are called from this interface are executed before an upload is performed. The upload is only carried out when the script application has ended (completed, canceled or time-out). This allows uploads to be prepared.
Example: Creating backups for devices that have their own backup function but are not yet supported by octoplant.
Command lines for this script application
Without agents:
ScriptBeforeUpload.exe /ConfigFileW:[absolute path of the interface file] /rd:[path of the server archive] /at:s
When using agents:
ScriptBeforeUpload.exe /ConfigFileW:[absolute path of the interface file] /rd:[path of the agent archive] /at:s
Description of the interface file
The [Component] section is described under Interface file.
The [User] and [Version] sections are not included.
Common
The keys RootDirAdmin and DirPrjData are not specified. The other keys in the [Common] section are described under Interface file.
Specific
In the [Specific] section, the following keys can be configured:
| 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 stored | ||
| 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 may be empty or missing (even if there is an archived backup). | ||
| Type | I | Module that triggered the upload. | 1: Scheduler (manual/automatic) 2: Upload and Compare function | 1 |
| JobName | I | Name of the job in the job configuration. Spaces are allowed in the name. | ||
| JobID | I | Job ID | A 32-character string |
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 | Parameters of the upload job |
| Agent | I | Parameters of the computer on which the agents are installed. (Source agent -VD$A\Configuration\Upload\AgentStation.ini). This key can be empty or missing. |
Result
The [Result] section keys are described under Interface file.
| Key | I/O | Description | Values | Default |
|---|---|---|---|---|
| Done | O | Indicates whether the script application has already created a backup. | Y/N | N |
Related topics