Attributes for All Job Types

The following overview includes the attributes of Job objects and describes their functions, allowed values and ways of modification.

Predefined variables may be used in scripts, and script variables may be set to attributes retrieved via predefined variables.

General Page

Title

OBJECT_TITLE

Value: User-defined

Length: 255 characters

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

Active

OH_Inactive

Access through: Change Program

Created by

USER_CREATED

Value: Name of the User object

Length: Max. 200 characters

Access through: GET_ATT, predefined variable

DATE_CREATED

Value: Timestamp

Format: YYYY-MM-DD HH:MM:SS. If not available, 0000-00-00 00:00:00

Access through: GET_ATT

Modified by

USER_MODIFIED

Value: Name of the User object

Length: 200 characters

Access through: GET_ATT, predefined variable

DATE_MODIFIED

Value: Timestamp

Format: YYYY-MM-DD HH:MM:SS. If not available, 0000-00-00 00:00:00

Access through: GET_ATT

MODIFY_COUNT

Value: Number of object modifications

Access through:GET_ATT

Last Executed

LAST_USER

Value: Name of the User object

Length: 200 characters

Access through: GET_ATT, predefined variable

LAST_DATE

Value: Timestamp

Format: YYYY-MM-DD HH:MM:SS. If not available, 0000-00-00 00:00:00

Access through: GET_ATT, predefined variable

USAGE_COUNT

Value: Number of object usages

Access through: GET_ATT, predefined variable

Archive Key 1

ARCHIVE_KEY1

Value: User-defined

Length: 60 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Archive Key 2

ARCHIVE_KEY2

Value: User-defined

Length: 20 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Int. Account

INT_ACCOUNT, INT_ACC, K

Value: User-defined

Length:16 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Sync Page

Sync Object

SYNC_OBJECT

Value: Name of the Sync object

Length: 20 characters

Access via: Change Program

Runtime Page

Return code <=

MAX_RETCODE

Value: User-defined

Length: 10 characters

Access via: 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.

Attributes Page

Agent

HOST

Sets the Agent on which the Job will run.

Value: Name of the Agent

Length: 32 characters

Access via: GET_ATT, :PUT_ATT (Pre-Process), Change Program, predefined variable

Login

LOGIN

Sets the Login object that contains the credentials that the Agent needs to access the target system.

Value: Name of the Login object

Length: 200 characters

Access via: GET_ATT, :PUT_ATT (Pre-Process, Process), Change Program, predefined variable

LOGIN_INFO

Value: Complete information about the Login object

Access via: GET_ATT, predefined variable

USERID

Login information

Value: User ID contained in the Login object

Access via: GET_ATT, predefined variable

Pre-Process Page

Code on the Pre Process Page

Changes the code on the Pre Process page

PSCRIPT

Access through: Change Program

Process Page

Code on the Process Page

SCRIPT

Changes the code on the Process page

Access through: Change Program

Post Process Page

Code on the Post Process Page

Changes the code on the Post Process page

OSCRIPT

Access through: Change Program

Child Post Process Page

Code on the Child Post Process Page

CSCRIPT

Changes the code on the Child Post Process page

Access through: Change Program

Attributes Page

Queue

QUEUE

Value: Name of a Queue

Length: Max. 200 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Group

GROUP

Value: Name of a Group

Length: Max. 200 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Int. Account

INT_ACCOUNT, INT_ACC, K

Value: User-defined

Length: Max. 16 characters

Access through: GET_ATT, :PUT_ATT (process), Change Program, predefined variable

Consume <x> resources

RESOURCE_CONSUMPTION

Value: User-defined

Length: A value between 0 and 99999

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process), Change Program, predefined variable

Automation Engine priority

UC4_PRIORITY

Value: User-defined

Length: A value betwen 0 and 255

Access through: GET_ATT, :PUT_ATT, predefined variable

TimeZone

TIMEZONE

Value: Nmae of a Time Zone object

Length: Max. 8 characters

Access through: GET_ATT, :PUT_ATT, Change Program, predefined variable

Attribute Dialog

ATTR_DLG

Value: Y (dialog is displayed) / N

Access through: GET_ATT

Generate Task at: Runtime

GEN_AT_RUNTIME

Value: Y / N

Access through: GET_ATT

Allow <x> simultaneous executions

MAX_PARALLEL_TASKS

Value: User-defined

Length: Any value between 0 and 99999

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

Remaining Tasks (for simultaneous executions)

MAX_PARALLEL_ELSE

Value: WAIT (Script waits until processing is possible) / ABEND

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process)

Automatically deactivate when finished

AUTO_DEACT

Value:

  • NEVER:
  • ENDED_ERROR_FREE
  • RESTART_ERROR_FREE
  • ALWAYS

Access through: GET_ATT, :PUT_ATT

Time delay minutes (for Always)

AUTO_DEACT_DELAY

Value: User-defined

Length: Any value between 0 and 99

Access through: GET_ATT, :PUT_ATT

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

AUTO_DEACT_ERROR_FREE

Value: Task status (System Return Codes of Executable Objects)

Length: Max. 20 characters

Access through: GET_ATT, :PUT_ATT

Output-Scan Page

Filter Object

PPF_FILTER

Value: Name of the Filter object

Length: 200 characters

Access through: Change Program

Action - Execute

PPF_EXECUTE

Value: Name of an executable object

Length: 200 characters

Access through: Change Program

PPF_INHERITANCE

Inherit to dynamic child tasks

Values:

  • Y - Yes

  • N - No

  • C - Children only

Access through: Change Program

Override Agent for File Scan: Agent

FSC_HOST

Value: Name of the Agent

Length: 32 characters

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process), Change Program, predefined variable

Override Agent for File Scan: Login

FSC_LOGIN

Value: Name of the Login object

Length: 200 characters

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process), Change Program, predefined variable

Job Attributes on no Page and on Agent Attribute Pages

Job Name

OBJECT_NAME

Value: User-defined

Length: Max. 200 characters

Access through: Change Program

File Names

FILENAME_JOB

Value: Name of the file (without path) that the Agent creates for the Job that should run

Access through: GET_ATT, predefined variable

FILENAME_SYSLST

Value: The name of the file (without path) that the Agent creates for the system output (SYSLST)

Access through: GET_ATT, predefined variable

FILENAME_SYSOUT

Value: The name of the file (without path) that the Agent creates for the system output (report)

Access through: GET_ATT, predefined variable

Maximum number of Job lines that should be generated

MAX_JCL_LINES

Value: User-defined, usually jobs with a maximum of 1000 job lines are generated. This value can be increased for large jobs.

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process)

AWI Mode

DCMODUS

Values: Y/N

Access through: GET_ATT

Job report

OO

Values:

  • J

    Saves the job report in AE

  • F

    Saves the job report in the target system

  • S

    Saves the job report on error only

  • N

    Does not save the job report

The following combinations are possible:

  • JF

    Saves the job report in AE and in the target system

  • JSF

    Saves the job report in the case of an error in AE and in the target system

  • JS

    Saves the job report in the case of an error in AE

  • SF

    Saves the job report in the case of an error in the target system

Access through: GET_ATT, :PUT_ATT (Pre-Process, Process. For BS2000: only Pre-Process)

Other

CODE

Value: Name of the Code Table

Length: 200 characters

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

Attributes for Rapid Automation Jobs

Many Rapid Automation agents include a list of attributes in the agent's documentation. Rapid Automation job attributes are not documented in the Automation Engine documentation, because they each agent is versioned separately and released on a different schedule than the Automation Engine.

Another way to retrieve the Rapid Automation attribute names including their values is to run the following command in the AE database (replace the JOBNAME by the job's actual object name):

select OCV_VName,ocv_value from OCV,oh where OCV_OH_Idnr=OH_Idnr and oh_name='JOBNAME'

See also: