Script Function: Stops or starts the automatic processing of a clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type.
TOGGLE_SYSTEM_STATUS(Status)
Syntax |
Description/Format |
---|---|
Status |
Status modification Allowed values: "STOP" and "GO" |
Return codes |
---|
"0" - The client statusThis represents the condition of a task (such as active, blocked, generating). has successfully
been changed. |
This scriptA particular Automation Engine object type. functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… 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..
The following example stops the automatic processing. The return value of this script function is written to the reportA report provides more detailed information about a task's execution or a component..
:SET &RET# = TOGGLE_SYSTEM_STATUS(STOP)
:PRINT &RET#
See also:
Script element | Description |
---|---|
Stops or starts the automatic processing of workflows, groups, events or schedules |
Script Elements - System Conditions and Settings
About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |