Automation Engine Script Guide > Ordered by Function > Activate Objects > TOGGLE_OBJECT_STATUS

TOGGLE_OBJECT_STATUS

Script Function: Stops or starts the automatic processing of several object types.

Syntax

TOGGLE_OBJECT_STATUS(RunID, Status, [Tasks])

Syntax	Description/Format
RunID	The run number of the activated object Format: AE name, script literal or script variable
Status	The processing status that should be set: Format: AE name, script literal or script variable Allowed values: "STOP" and "GO" "STOP" - Stops the automatic processing of a task. "GO" - Starts the automatic processing of a task.
Tasks	ALL - The automatic processing of tasks that run within workflows, groups and schedules also stops or starts. Format: AE name, script literal or script variable

Syntax

Description/Format

RunID

The run number of the activated object
Format: AE name, script literal or script variable

Status

The processing status that should be set:
Format: AE name, script literal or script variable

Allowed values: "STOP" and "GO"
"STOP" - Stops the automatic processing of a task.
"GO" - Starts the automatic processing of a task.

Tasks

ALL - The automatic processing of tasks that run within workflows, groups and schedules also stops or starts.

Format: AE name, script literal or script variable

Return code
"0" - Status modification was successful

Comments

This script function changes the processing of workflows, groups, events, RemoteTaskManager and schedules.

The privilege "Modify at runtime" is required for this script function!

Examples

The following example determines the RunID of an event and reads a script variable. The automatic processing of the event stops and at the same time, the determined RunID is passed on to the script variable.

:SET &RUNNR# = GET_UC_OBJECT_NR(DUMP.CONTROL)
:SET &RET# = TOGGLE_OBJECT_STATUS(&RUNNR#, "STOP")
:PRINT &RET#