StartProcessAsyncConfig

Configuration for an asynchronous process execution.

Methods

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.

---

getName

getName(): string

Returns the set name of the process to be executed.

Returns

string

the name of the process

---

getServersToExcecuteOn

getServersToExcecuteOn(): string[]

Contains all user-defined servers on which the process is to be executed. If no explicit server list has been specified, the server ID of this server is always added automatically.

Returns

string[]

list of servers the process will be executed on.

---

getShouldShowErrorDialog

getShouldShowErrorDialog(): boolean

Retuens the flag if an error dialog is to be shown.

Returns

boolean

true if a dialog is to be shown (if possible, only if TIMERTYPE_CLIENT_RUN)

---

getThreadPriority

getThreadPriority(): number

Returns the thread priority of the process.

Returns

number

thread priority as int (THREADPRIORITY_*)

---

getTimerType

getTimerType(): number

Returns the timer type.

Returns

number

timer type as int (see process.TIMERTYPE_*)

---

getUser

getUser(): string

Returns the user title of the user which is used for the process execution.

Returns

string

the user title

---

setLocalVariables

setLocalVariables(pLocalVariables): StartProcessAsyncConfig

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

StartProcessAsyncConfig

StartProcessAsyncConfig

---

setName

setName(pProcessName): StartProcessAsyncConfig

Sets the name of the process to be executed.

Parameters

pProcessName

string | number | boolean

the process name

Returns

StartProcessAsyncConfig

StartProcessAsyncConfig

---

setServersToExcecuteOn

setServersToExcecuteOn(pServerList): StartProcessAsyncConfig

Sets the servers on which the process is to be executed. If no explicit server list has been specified, the server ID of this server is always added automatically.

Parameters

pServerList

string[]

list of servers the process will be executed on.

Returns

StartProcessAsyncConfig

StartProcessAsyncConfig

---

setShowErrorDialog

setShowErrorDialog(pShowErrorDialog): StartProcessAsyncConfig

"true" shows an error message if an error occurs (if possible, only if TIMERTYPE_CLIENT_RUN).

Parameters

pShowErrorDialog

boolean

Returns

StartProcessAsyncConfig

---

setThreadPriority

setThreadPriority(pThreadPriority): StartProcessAsyncConfig

The priority of the thread: process.THREADPRIORITY_*.

Parameters

pThreadPriority

number

Returns

StartProcessAsyncConfig

StartProcessAsyncConfig

---

setTimerType

setTimerType(pTimerType): StartProcessAsyncConfig

The timer type, see process.TIMERTYPE_*.

Parameters

pTimerType

number

Returns

StartProcessAsyncConfig

StartProcessAsyncConfig

---

setUser

setUser(pUser): StartProcessAsyncConfig

The user title of the user under whose name the process will be executed. 'Null' for anonymous. Not for TIMERTYPE_CLIENT_RUN.

Parameters

pUser

string | number | boolean

Returns

StartProcessAsyncConfig