Automation Engine Script Guide > Ordered by Function > Activation Data > GET_PARENT_NAME

GET_PARENT_NAME

Script Function: Returns the name of the superordinate taskThere are various ways of activating objects. The originator of the activation is referred to as the superordinate task (parent). (Parent)

Syntax

GET_PARENT_NAME(RunID, [Activation Type])

Syntax

Description/Format

RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component .

RUN number of the current taskAn executable object that is running. Tasks are also referred to as activities.

Activation Type

Allowed values:

ACT = Activator
PRC = Processor (default value)


Return codes

Name of the superordinate task
"*SCRIPT" - The task has been activated via a CallAPIA programming interface that processes a script in the Automation Engine system. It can be called directly from within the program itself or from a different program.
" " - There is no superordinate task (only for activation type PRC)

Comments

With 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,…, the name of the superordinate task of an objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task that is part of the object classThere are four classes of objects: executable, active, passive and system objects. executable objects may be retrieved. With manual activation, this is the name of the User object (e.g. SMITH/DEV).

If no activation type is indicated, this script function supplies the processor.

If the name of a groupAn Automation Engine object type that integrates tasks so that they can be processed together. is to be retrieved, "Generate at Runtime" (in the Attributes tab) must be activated in the task that is used with this script function. Otherwise, the name can only be retrieved for jobs in post script.

Example

The following example retrieves the running number of a task and then its Activator.

:SET &RunID = GET_UC_OBJECT_NR(MM.END.PROCESSING)
:
SET &RET# = GET_PARENT_NAME(&RunID, ACT)
:
PRINT "The name of the superordinate task is: &RET#"

 

See also:

Script element Description

GET_PARENT_NR

Returns the run number (RunID) of the superordinate task (Parent)

GET_PARENT_TYPE

Returns the 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 of the superordinate task (Parent)

Script Elements - Activation Data

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