Script Function: Deletes an existing objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.
REMOVE_OBJECT (Object Name)
Syntax |
Description/Format |
---|---|
Object Name |
Name of the object that should be deleted. REMOVE_OBJECT cannot be used to delete a folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities.. |
Return codes |
---|
"0" - Deletion was successful. |
A deleted object is moved to the Recycle Bin and can be restored afterwards.
The scriptA particular Automation Engine object type. statement :ON_ERROR can be used to define the reaction to errors that can subsequently be analyzed using the script functions for error handling. Depending on the specifications you have made, script processing either continues or is canceled.
This script statement has the effect that all open transactions of the script are written to the AE databaseA database is an organized collection of data including relevant data structures..
This following example deletes the object "FIRM.CALENDAR2003".
:SET &RET# = REMOVE_OBJECT("FIRM.CALENDAR2003")
See also:
Script element | Description |
---|---|
Creates an object (Calendar, Login and Variable only). | |
MODIFY_OBJECT | Changes an existing object (Calendar, Login and Variable only). |
MOVE_OBJECT | Moves an object to a folder. |
:ON_ERROR | Determines the reaction to certain errors and messages of script elements. |
Script Elements - Handle Objects
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 |