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 variable Allowed values: STOP - stops the automatic processing of a client GO - starts the automatic processing of a client

Syntax

Description/Format

Status

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

Allowed values:
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.

This script function sets the system status to STOP or GO. For more information, see System Monitoring.

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

Note: The script statement causes all open transactions of the script to be written to the AE database. For more information, see Script Processing.

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#