Automation Engine Script Guide > Ordered by Function > System Conditions and Settings > TOGGLE_SYSTEM_STATUS

TOGGLE_SYSTEM_STATUS

Script Function: Stops or starts the automatic processing of a client

Syntax

TOGGLE_SYSTEM_STATUS(Status)

Syntax

Description/Format

Status

Status modification
Format: AE name, script literal or script literal

Allowed values: "STOP" and "GO"
"STOP" - stops the automatic processing of a client
"GO" - starts the automatic processing of a client

Return codes

"0" - The client status has successfully been changed.
"9" - The required privilege for changing the client status is missing.

Comments

This script function sets the system status to STOP or GO.

 This script function can only be executed if the privilege "Change system status (STOP/GO)" was assigned!

The script statement causes all open transactions of the script to be written to the AE databaseA database is an organized collection of data including relevant data structures..

Examples

The following example stops the automatic processing. The return value of this script function is written to the report.

:SET &RET# = TOGGLE_SYSTEM_STATUS(STOP)
:PRINT &RET#

 

See also:

Script element Description

TOGGLE_OBJECT_STATUS

Stops or starts the automatic processing of workflows, groups, events or schedules

Script Elements - System Conditions and Settings

Changing System Status

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