KB-127738: AfterUpload

AfterUpload

Scripting applications called by this interface are executed after an upload is created, however this is done before it is archived in octoplant. This makes it possible to modify uploads.

Example: when making changes to device backups, that have their own backup function but are not yet supported by octoplant.

If an error occurs during the upload, the interface AfterUpload will not be triggered and the script application will not be started.

Command lines for this scripting application

Without agents:

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

With agents:

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

Description of the interface file

The sections [Component] and [Result] are described in Global interface file sections.

The sections [User] and [Version] are not included.

[Common]

The key RootDirAdmin and DirPrjData are not given. Other keys are described in Global interface file sections.

[Specific]

INI key I/O Description

UploadClass I Name of the upload class

DirBackup I

Complete path of the directory in which the unzipped backup is/will be stored

PathArchive I

Complete path to the archive file (ZIP) of the last checked in version

This key can be empty or missing (even when a version has been checked in).

PathPreBackup I

Complete path to the archive file (ZIP) of the previous backup

This key can be empty or missing (even when there is an archived backup)

Type I

Module that triggered the upload The following values are possible:

1: Scheduler (manual/automatic)

2: Upload&Compare function

The default value is 1

JobName I

Name of the job in the job configuration

Spaces in names are allowed

JobID I ID of the job (as a string with 32 characters)

[UploadParameters]

The keys in this section are always stored in Base64. The data is encoded in the following way: {ParamId}={Value} …{ParamId}={Value} .

If there is a key with no parameter, the key will not be given

INI key I/O Description

Class I

Parameter of the upload class

(Source octoplant server:VD$AConfigurationUploadClasses.ini) This key can be empty or missing.

Job I Upload job parameter

Agent I

Parameter of the computer on which the agents are installed

(Source agent:VD$AConfigurationUploadAgentStation.ini)

This key can be empty or missing.


Last update: September 15, 2023

Related Articles

IMPRINT | PRIVACY POLICY | COOKIE POLICY

Privacy Preference Center