User Guide > Objects > Alphabetical Listing > Notification Attributes

Notification Attributes

The following table describes the attributes of a Notification objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.

Predefined variables may be used in scripts, and script variables may be set to attributes retrieved via predefined variablesFixed variables that can be used in the attributes or the script of executable objects. The values refer to the object or the system..

Header Tab

Field

Attribute

Value

Access Via:

Title

OBJECT_TITLE

User-defined,
limited to 255 characters.

GET_ATT,
:PUT_ATT (Pre-Process, Process),
predefined variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type.

Created

USER_CREATED

The name of the User object,
limited to 200 characters.

GET_ATT,
predefined variable

DATE_CREATED

Time stamp in the format "YYYY-MM-DD HH:MM:SS"
If not available: "0000-00-00 00:00:00"

GET_ATT

Modified

USER_MODIFIED

The name of the User object,
limited to 200 characters.

GET_ATT,
predefined variable

DATE_MODIFIED

Time stamp in the format "YYYY-MM-DD HH:MM:SS"
If not available: "0000-00-00 00:00:00"

GET_ATT

MODIFY_COUNT

The number of object modifications.

GET_ATT

Last Used

 

LAST_USER

The name of the User object,
limited to 200 characters.

GET_ATT,
predefined variable

LAST_DATE

The time stamp in the format "YYYY-MM-DD HH:MM:SS"
If not available: "0000-00-00 00:00:00"

GET_ATT,
predefined variable

USAGE_COUNT

Number of object usages

GET_ATT,
predefined variable

Archive key 1

ARCHIVE_KEY1

User-defined,
limited to 60 characters

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Archive key 2

ARCHIVE_KEY2

User-defined,
limited to 20 characters

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

 Sync Tab

Field Description Attribute Access Via:
Assigned Sync objectIt synchronizes executable objects based on defined states and actions. A particular Automation Engine object type. SYNC_OBJECT The name of a Sync object,
a maximum of 20 characters must not be exceeded.
Change Program

 Attributes Tab

Field

Attribute

Value

Access Via:

Queue QUEUE The name of a queueA particular Automation Engine (AE) object type. In AE, a queue determines the maximum number of concurrent tasks, their priorities and the order in which tasks should be executed. In ARA, queues are containers for workflow executions that should be executed at a certain time one after another.,
limited to 200 characters.
GET_ATT,
:PUT_ATT,
Change Program,
predefined variable
Group GROUP The name of a groupAn Automation Engine object type that integrates tasks so that they can be processed together.,
limited to 200 characters
" " - For an immediate start
GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Int. account

INT_ACCOUNT, INT_ACC, K

User-defined,
limited to 16 characters.

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Priority

CO_PRIORITY

"HIGH" - High priority
"NORMAL" - Normal priority
"LOW" - Low priority

GET_ATT,
:PUT_ATT,
predefined variable

Type

CO_TYPE

"QUESTION" - Request
"MESSAGE" - Message
"ALARM" - Alert
"EMAIL" - Email

GET_ATT,
:PUT_ATT,
predefined variable

SNMP connection

CO_SNMP

"Y" - Activate SNMP connection
"N" - No SNMP connection

GET_ATT,
:PUT_ATT

Send Email

CO_EMAIL

"Y" - Send Email
"N" - No Email

GET_ATT,
:PUT_ATT

Escalation - After ... Min. without response

CO_RISING_TIME

The time in minutes, any value between "1" and "9999"

Reading the attribute creates a 16-figure value with leading zeros.

GET_ATT,
:PUT_ATT,
predefined variable

Escalation - Notification

CO_RISING_NAME

The name of a notificationAn Automation Engine object type used to send messages to users and user groups. [Formerly called "CallOperator."],
limited to 200 characters.

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Automation Engine priorityAffects the order of task execution within an Automation Engine system.

AE_PRIORITY

User-defined,
any value between "0" and "255".

GET_ATT,
:PUT_ATT,
predefined variable

TimeZone

TIMEZONE

User-defined,
limited to 8 characters.

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

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).

GEN_AT_RUNTIME

"Y" - Generation at runtime.
"N" - Generation at activation time.

GET_ATT

Tasks running parallel - Max. number

MAX_PARALLEL_TASKS

User-defined,
any value between "0" and "99999"

GET_ATT,
:PUT_ATT,
predefined variable

Tasks running parallel - Else

MAX_PARALLEL_ELSE

"WAIT" - Notification waits until execution is possible.
"ABEND" - Notification terminates.

GET_ATT,
:PUT_ATT

Automatically deactivate when finished

AUTO_DEACT

"NEVER" - Never deactivate automatically.
"ENDED_ERROR_FREE" - In the case of error-free processing, deactivate automatically.
"RESTART_ERROR_FREE" - In the case of an error-free restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts., deactivate automatically. 
"ALWAYS" - Always deactivate automatically.

GET_ATT,
:PUT_ATT

Error-free statusThis represents the condition of a task (such as active, blocked, generating). (for After an error-free restart)

AUTO_DEACT_ERROR_FREE

Task status,
limited to 20 characters

GET_ATT,
:PUT_ATT

Time delay minutes (for Always)

AUTO_DEACT_DELAY

User-defined,
any value between "0" and "99".

GET_ATT,
:PUT_ATT

Notification Tab

Field

Attribute

Value

Access Via:

Subject SUBJECT User-defined,
limited to 255 characters.
GET_ATT,
:PUT_ATT,
predefined variable

Message

 

CALL_TEXT

User-defined

GET_ATT,
:PUT_ATT,
via script variableA placeholder for a value within a script.

Script variables that are used in texts and should be changed must be used within the first 256 characters. All script variables that are use afterward will not be considered.

Attach reports from Task (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 .) ATTACH_REPORTS_RUNID User-defined,
limited to 32 characters.
GET_ATT,
:PUT_ATT,
predefined variable
Source ATTACH_REPORTS_SOURCE "DB" - Database
"EXTERNAL" - External files
"ALL" - All
GET_ATT,
:PUT_ATT,
via script variable,
predefined variable
Attach a file from Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. (path and file name) ATTACH_FILE User-defined,
limited to 255 characters.
GET_ATT,
:PUT_ATT,
predefined variable

Recipients Tab

Field

Attribute

Value

Access Via:

Assigned calendarAn Automation Engine object type that defines a set of days based on calendar keywords. CALENDAR The name of a calendar,
limited to 200 characters.
:ADD_ATT,
Change Program
Assigned calendar keywordThe attribute of a Calendar object that defines which days included in the calendar. CALENDAR_KEYWORD The name of a calendar keyword,
limited to 200 characters.
ADD_ATT,
Change Program

Recipients

RECIPIENT

Recipients can be added to the runtime by using the scriptA particular Automation Engine object type. element ADD_ATT and removed with REMOVE_ATT.

:ADD_ATT,
:REMOVE_ATT

Runtime Tab

Field

Attribute

Value

Access Via:

Return code <=

MAX_RETCODE

User-defined,
limited to 11 numbers.

GET_ATT,
:PUT_ATT (Pre-Process, Process)

Process Tab

Field

Attribute

Value

Access Via:

The string in the Process tab of the jobAn Automation Engine object type for a process that runs on a target system. should be changed.

SCRIPT

 

Change Program

Notification Attributes Not on a Tab

Field

Attribute

Value

Access Via:

Object name

OBJECT_NAME

User-defined,
limited to 200 characters.

Change Program

Mode UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."]

DCMODUS

"Y" - UserInterface is active
"N" - No UserInterface is active

GET_ATT

 

See also:

Notification
Attributes

:PUT_ATT statement

GET_ATT function

:ADD_ATT statement

:REMOVE_ATT statement

AE DB Change

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH