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

GET_UC_OBJECT_NR

Script Function: Returns the 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 . of an activated objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task

Syntax

GET_UC_OBJECT_NR(Object Name)

Syntax

Description/Format

Object Name

Name of an executable object
Format: script literal or script variableA placeholder for a value within a script. 


Return code

Run number of the activated object
" " - The indicated object is not active

Comments

The 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,… GET_UC_OBJECT_NR may be used to retrieve the run number (RunID) of an object that belongs to the object class of executable objects.

If the object has been activated more than once, the oldest RunID is returned.

Example

The following example checks whether or not the taskAn executable object that is running. Tasks are also referred to as activities. is active.

:SET &RunID = GET_UC_OBJECT_NR(&task#)

:
IF &RunID = ""
:   
STOP MSG,50,"&task# is not active!"
:
ENDIF

 

See also:

Script element Description

GET_PARENT_NR

Returns the run number (RunID) of the superordinate taskThere are various ways of activating objects. The originator of the activation is referred to as the superordinate task (parent). (Parent).
SYS_ACT_TOP_NR Supplies the run number (RunID) of the top 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."]

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