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
RunIDAbréviation du numéro d'identification unique. Il s'agit plus précisément d'un nombre qui identifie clairement l'exécution d'une Tâche. Le RunID peut comporter entre 7 et 10 caractères . Ils sont attribués par le composant Automation Engine.	The run number of the activated object Format: AE name, scriptEgalement un type d'objet distinct dans l'Automation Engine. 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

RunIDAbréviation du numéro d'identification unique. Il s'agit plus précisément d'un nombre qui identifie clairement l'exécution d'une Tâche. Le RunID peut comporter entre 7 et 10 caractères . Ils sont attribués par le composant Automation Engine.

The run number of the activated object
Format: AE name, scriptEgalement un type d'objet distinct dans l'Automation Engine. 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#

See also:

Script element	Description
TOGGLE_SYSTEM_STATUS	Stops or starts the automatic processing of a clientEnvironnement indépendant pour la création et l'exécution d'objets dans un système AE. Le nom d'un client est un nombre de quatre chiffres à saisir lors de la connexion d'un utilisateur au système AE. Les utilisateurs et leurs droits y sont aussi définis.Egalement un type d'objet distinct dans l'Automation Engine.

Script Elements - Activate Objects

About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function