Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > GET_OBJECT_TYPE

GET_OBJECT_TYPE

Script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,…: Returns a taskAn executable object that is running. Tasks are also referred to as activities.'s object typeAn individual object is provided for the individual activities: There are User, UserGroup, Notification, Cockpit, CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include, Job, Workflow, Calendar, Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync, Variable and TimeZone objects

Syntax

GET_OBJECT_TYPE(Object name)

Syntax

Description/Format

Object name

Name of the objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task whose type should be retrieved
Format: script literal or script variableA placeholder for a value within a script.


Return codes

Short form of the object type
"20223" - The object does not exist.

Comments

This scriptA particular Automation Engine object type. function first searches the object in the 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. in which the script is processed and then in system client 0000.

The script statement :ON_ERROR may be used to determine the reaction to an erroneous object name. The error may be analyzed using the script functions for error handling. Script processing continues but may also be canceled if required.

Example

The following example returns "JOBP" because MM.DAY is a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."].

:SET &OBJECT_TYPE# = GET_OBJECT_TYPE("MM.DAY")

 

See also:

Script Elements - Reading or Modifying 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