TOGGLE_SYSTEM_STATUS

Use the TOGGLE_SYSTEM_STATUS script function to stop or start the automatic processing of a client. For more information, see System Monitoring.

Important! You must have the following privilege "Change system status (STOP/GO)"

Note: This script function writes all open transactions of the script to the AE database. For more information, see Script Processing.

Syntax

TOGGLE_SYSTEM_STATUS (Status)

Parameters

• TOGGLE_SYSTEM_STATUS
  Sets the system status to either STOP or GO
• Status
  Changes the status
  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.

Examples

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

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

See also: