Event Object Attributes

The following tables list the attributes that apply to all event object types and describe their functions, allowed values and ways of modifying the attribute.

Attributes for All Event Types

The attributes of an event can only be written in the Process Pages if the event is activated.

Important! Reading or writing an attribute that does not belong to the particular event type causes the script processing to abort.

General Page

Field

Attribute

Value

Access Via:

Title

OBJECT_TITLE

User-defined,
limited to 255 characters.

GET_ATT,
:PUT_ATT (Pre-Process, Process),
predefined variable

Active OH_Inactive   Change Program

Created

USER_CREATED

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

GET_ATT,
predefined variable

DATE_CREATED

Timestamp 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

Timestamp 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 Executed

 

LAST_USER

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

GET_ATT,
predefined variable

LAST_DATE

The timestamp 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

Int. Account

INT_ACCOUNT, INT_ACC, K

User-defined,
limited to 16 characters.

GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Sync Page

Field Description Attribute Access Via:
Assigned Sync object SYNC_OBJECT The name of a Sync object,
a maximum of 20 characters must not be exceeded.
Change Program

Attributes Page

Field

Attribute

Value

Access Via:

Queue QUEUE The name of a queue,
limited to 200 characters.
GET_ATT,
:PUT_ATT,
Change Program,
predefined variable
Job Group GROUP The name of a group,
limited to 200 characters.
" " - for immediate start
GET_ATT,
:PUT_ATT,
Change Program,
predefined variable

Automation Engine priority

UC4_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 Task at runtime

GEN_AT_RUNTIME

"Y" - Yes, "N" - No

GET_ATT

Maximum Executions Allow <x> simultaneous executions (in parallel)

MAX_PARALLEL_TASKS

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

GET_ATT,
:PUT_ATT,
predefined variable

Parallel running tasks - Else

MAX_PARALLEL_ELSE

"WAIT" - The event waits until processing is possible.
"ABEND" - Event processing is interrupted.

GET_ATT,
:PUT_ATT

Automatically Deactivation: Deactivate on Finish

AUTO_DEACT

"Never" - Never deactivate automatically.
"After error-free execution" - In the case of error-free processing, deactivate automatically.
"After error free restart" - In the case of an error-free restart, deactivate automatically. 
"Always" - Always deactivate automatically.

GET_ATT,
:PUT_ATT

Error-free status (for After an error-free restart)

AUTO_DEACT_ERROR_FREE

Task Status limited to 20 characters

For more information, see System Return Codes of Executable Objects

GET_ATT,
:PUT_ATT

Time delay minutes (for Always)

AUTO_DEACT_DELAY

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

GET_ATT,
:PUT_ATT

Runtime Page

Field

Attribute

Value

Access Via:

Return code <=

MAX_RETCODE

User-defined,
limited to 11 numbers.

GET_ATT,
:PUT_ATT (Pre-Process, Process)

Note: The status of the file transfer does not affect its return code. If, for any reason, a file transfer fails, the return code is still 0.

Process Page

Field

Attribute

Value

Access Via:

The string in the Process tab of the event should be changed.

PSCRIPT

 

Change Program

Event Process Page

Field

Attribute

Value

Access Via:

Modification of the Event Process page of events. SCRIPT  

Change Program

Event Attributes not in a Tab

Field

Attribute

Value

Access Via:

Event type

EVENT_TYPE, EVENT_TYP

"CN" - Console event,
"DS" - Database event with time, 
"DT" - Database event with interval
"FA" - File System event with automatic monitoring,
"FS" - File System event with time, 
"FT" - File System event with interval
"TS" - Time event with time,
"TT" - Time event with interval

GET_ATT,
predefined variable

Object name

OBJECT_NAME

User-defined,
maximum 200 characters

Change Program

Automic Web Interface Mode

DCMODUS

"Y" - The Automic Web Interface is active
"N" - No Automic Web Interface is active

GET_ATT

See also: