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, |
GET_ATT, |
Active | OH_Inactive | Change Program | |
Created |
USER_CREATED |
The name of the User object, |
GET_ATT, |
DATE_CREATED |
Timestamp in the format "YYYY-MM-DD HH:MM:SS" |
GET_ATT |
|
Modified |
USER_MODIFIED |
The name of the User object, |
GET_ATT, |
DATE_MODIFIED |
Timestamp in the format "YYYY-MM-DD HH:MM:SS" |
GET_ATT |
|
MODIFY_COUNT |
The number of object modifications. |
GET_ATT |
|
Last Executed
|
LAST_USER |
The name of the User object, |
GET_ATT, |
LAST_DATE |
The timestamp in the format "YYYY-MM-DD HH:MM:SS" |
GET_ATT, |
|
USAGE_COUNT |
Number of object usages |
GET_ATT, |
|
Archive key 1 |
ARCHIVE_KEY1 |
User-defined, |
GET_ATT, |
Archive key 2 |
ARCHIVE_KEY2 |
User-defined, |
GET_ATT, |
Int. Account |
INT_ACCOUNT, INT_ACC, K |
User-defined, |
GET_ATT, |
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, |
GET_ATT, |
TimeZone |
TIMEZONE |
User-defined |
GET_ATT, |
Generate Task at runtime |
GEN_AT_RUNTIME |
"Y" - Yes, "N" - No |
GET_ATT |
|
MAX_PARALLEL_TASKS |
User-defined, |
GET_ATT, |
Parallel running tasks - Else |
MAX_PARALLEL_ELSE |
"WAIT" - The event waits until processing is possible. |
GET_ATT, |
Automatically Deactivation: Deactivate on Finish |
AUTO_DEACT |
"Never" - Never deactivate automatically. |
GET_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, |
Time delay minutes (for Always) |
AUTO_DEACT_DELAY |
User-defined, |
GET_ATT, |
Runtime Page
Field |
Attribute |
Value |
Access Via: |
---|---|---|---|
Return code <= |
MAX_RETCODE |
User-defined, |
GET_ATT, |
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, |
GET_ATT, |
Object name |
OBJECT_NAME |
User-defined, |
Change Program |
Automic Web Interface Mode |
DCMODUS |
"Y" - The Automic Web Interface is active |
GET_ATT |
See also: