Skip to content

Script applications

Name script applications after the script interface that calls them (for example, ScriptBeforeUpload or ScriptAfterUpload). Provide them in either EXE or BAT format (for example, ScriptBeforeUpload.exe or ScriptBeforeUpload.bat).

Info

If the script directory contains both an *.exe and *.bat file with the same name, the system executes only the *.exe file.

Script applications are called via the command line with the following parameters.

Parameter Description
/ConfigFileW: Absolute path (path and name) of the UTF-16 encoded interface file
/rd: Path of the server archive
/at: Execution location

Info

For compatibility, you can also use interface files in the local code page. Use the parameter /ConfigFile: for this purpose. Set /ConfigFile: to the absolute path of the interface file encoded in the local code page, provided the conversion from UTF-16 is possible without loss of information.

Check all existing scripts for Unicode support and update them if necessary.

Example

Call the script application ScriptBeforeUpload.exe on the server side using the information from the interface file:

ScriptBeforeUpload.exe /ConfigFile:D:\ServerArchive\VD_TMP_VD\639DA01F8ABD4D9D80C702AF85C822F5.ini /rd:D:\ServerArchive
/at:s /ConfigFileW:D:\ServerArchive\VD_TMP_VD\F9E5E19475BC4AC7945E2DA75ED8E74A.ini

Info

If the script application returns an error while starting or running, the system marks the job as failed and includes the error in the job result.

Use an initialization file to assign scripts to specific component types. Name this file after the corresponding Script*.exe (e.g. ScriptBeforeEdit.exe -> ScriptBeforeEdit.ini):

[General] section

Key Description
default Name of the SCRIPT file to be executed for all component types
{Component type ID} Name of the SCRIPT file to be executed for the specified component type (multiple keys with different component type IDs are possible)