Script Editor overview

The script editor can be used to create and save complex scripts. The stored scripts can be used and executed in your actions.

The script editor interface is subdivided into four areas as follows.

  1. The script editor toolbar for controlling the script editor (create new script, open/select script, import, export, etc.)
  2. The script code editor for viewing / editing the script instructions.
  3. A comment field for adding comments relating to the current script.
  4. The script parameter editor for editing the script parameters pertaining to the script code.

Script Editor Toolbar

The following standard functions are currently available:

Script

Description

CopyFile

Copies a file to the remote device.

CopyFolder

Copies a folder to the remote device

DeleteFile

Deletes a file on the remote device.

DeleteFolder

Deletes a folder on the remote device

Register

Copies a registry file to the remote device and executes it.

ExportRegistry

Writes a registry key to a registry file on the remote device.

RenameFile

Renames a file on the remote device.

RenameFolder

Renames a folder on the remote device.

Restart

Executes a restart on the remote device

Run

Starts a certain process on the remote device

Script-Code-Editor

Syntax-highlighting code editor with method tip support.

Comment field

Brief description of the function of the script currently being edited.

Script-Parameter-Editor

Column

Description

Name

Name of the parameter as it appears in the script code (as <%ParameterName%> or <$ParameterName$>).

 

Resolution

The column "Resolution" defines who uses the parameter value. This can either happen through the configurator when the update is started ("ClientVar") or in the context of the target system ("ServerVar").

 

Valid values:

"ClientVar" for resolution of the parameter value on the configurator side.
"ServerVar" for resolution of the parameter value on the CX side

EditorClass

Determines the parameter value editor for parameter value resolution on the configurator side ("ClientVar"). E.g.

 

Valid values:

"None" for no editor
"Folder" for a directory selection dialog
"File" for file selection dialog
...

Repository type

Determines the purpose of the current parameter (source or target) for the NetShare folder. Used in combination with the "Repository Link" entry.

 

Valid values:

"None" :
"ShareSource" : Parameter refers to a value from the configuration context or the source side (e.g. for transferring the filename from the source file to the target)
"ShareTarget" : Parameter valid in the context of the target system / CX or the target side (e.g. for defining the target directory for a copy operation on the target).

Repository Link

Defines the corresponding complementary "Repository Type" parameter, e.g. for the ShareTarget for the current ShareSource or vice versa. Used in combination with the "Repository Type" field.

Comment

Description text for the current parameter.