StartScriptConfig

Configuration object for script executions.

Methods

getAlias

getAlias(): string

Returns the specified alias used for this script.

If set to null (default) the current context alias is used.

Returns

string

the alias specified used for the script, or null if not set.

---

getIdentifier

getIdentifier(): string

Returns the specified identifier used to recognize the executed script.

Returns

string

the identifier used for the executed script.

---

getLocalVariables

getLocalVariables(): any

Returns the set local variables for the process execution.

Returns

any

a map with variables (key, value only string), or null if not set.

---

getScript

getScript(): string

Returns the specified code to be executed as string.

Returns

string

the specified code to be executed, or null if not set.

---

setAlias

setAlias(pAlias): StartScriptConfig

The alias to be used for the script; 'null' for the current context alias.

Parameters

pAlias

string | number | boolean

Returns

StartScriptConfig

---

setIdentifier

setIdentifier(pIdentifier): StartScriptConfig

An identifier that can be used to recognize the script

Parameters

pIdentifier

string | number | boolean

Returns

StartScriptConfig

---

setLocalVariables

setLocalVariables(pLocalVariables): StartScriptConfig

Sets the local variables that are passed to the process during execution.

Parameters

pLocalVariables

any

A map with variables (key, value only string) that are passed to the process as $local variables. The name of the corresponding variable in the process is then $local.[key]. null if you do not want to pass variables.

Returns

StartScriptConfig

StartScriptConfig

---

setScript

setScript(pScript): StartScriptConfig

The code to be executed. Imports within the script must be separated by "\r\n".

Parameters

pScript

string | number | boolean

Returns

StartScriptConfig