In these two variables, you can define commands for calling external programs and internal objects.
Key |
Value |
New start required |
---|---|---|
Description of the menu command |
Path and name of the program -f%01 |
|
Description of the menu command |
Name of an executable objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task |
UserInterface |
variables are supplied with 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. 0000. From there they can be copied into your own client and customized to your requirements.
In order to allow for easier distinction, the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. "UC_SENDTO" (context menu of the Explorer) is available for objects and "UC_SENDTO_ACT" (context menu of the Activity Window) for tasks.
You can handle objects and tasks AE-internally but also externally with your own programs, thereby transferring object codes. The Send To menu in the context menu of the UserInterface is created according to your definitions made in the variable. The Send To sub-menu lists all the specified programs and executable objects in alphabetical order. Highlight one or more objects or tasks to call the menu command as shown below:
Note that the menu Send to is also available in the context menus of monitors and in the Search functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,….
Changes made in these two variables only become effective in the UserInterface after a restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts..
Internal Handling
Here, object codes are transferred to objects that are able to be activated. The keys you define are used as menu commands of the Send To menu. In the Value column of the variable you specify the names of the objects to be called. Note that the specified object is started for each highlighted object/taskAn executable object that is running. Tasks are also referred to as activities..
The following variables are automatically supplied in the read/input buffer:
Variable |
Description |
---|---|
&OH_IDNR# |
Object code |
&NAME# |
Name of the object/task |
&TYPE# |
Type of the object/task |
Additionally for tasks: |
|
&RUN# |
Run number (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 the task |
&LNR# |
Placement in workflows and schedule |
&PARENT_RUN# |
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_NAME# |
Name of the superordinate task |
&PARENT_TYPE# |
Object type of the superordinate task |
Use the scriptA particular Automation Engine object type. statement :READ to read these variables. The option Generate at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start). , however, must not be activated (Attributes tab).
Example:
:READ &NAME#,,
:PRINT &NAME#
:READ &TYPE#,,
:PRINT &TYPE#
:READ &PARENT_RUN#,,
:PRINT &PARENT_RUN#
External Handling
You can define menu commands in the variables for calling your own programs in order to handle objects and tasks externally.
The keys you define are used as menu commands for the Send To menu. In the Value column of the variable you specify the names of the programs followed by the parameter -f%01. This parameter serves to assign a temporary file (SEND_TO_n.txt) containing the codes of the highlighted objects.
The content of this temporary file is clearly structured. The first line contains the name of the AE system, the client and the userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. who started the program call. The object codes are then listed one below the other.
Example:
UC4 - 0150 - SMITH/UC4
3486524
12234
3097486
1512
Key |
Value |
---|---|
Determining Schedule data (Script) |
SCRI_SCHEDULE_DATA |
Test system |
C:\AUTOMIC\TRANSPORT.EXE -f%01 |
See also:
Overview of all variables
in table form
Variable
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |