DB.11 - Agent Job Definition Panel

Setting Up and Maintaining Jobs › DB.11 - Agent Job Definition Panel

DB.11 - Agent Job Definition Panel

The DB.11 - Agent Job Definition panel lets you enter or review data related to agent jobs.

To display the panel, enter:

A as the FUNCTION on the DB Menu panel; this leads to another menu for job type selection.
DB.11 as the FUNCTION on any other menu or formatted input panel.
DB.11 or AGJOB as a top line command.

To exit the panel:

Press PF3. If you entered the agent job command (excluding menu commands), you are returned to the DBM Menu panel except with the TSO-ISPF interface when the PF3 key is assigned to another function. If you entered the DB panel, you are returned to the menu from which you can directly invoke the agent.
Move the cursor to the top line of the panel and enter a top line command for another function.

When you enter a DB panel identifier for a valid agent job type, or traverse through the menus, the CA-7 Agent Job Definition panel is displayed with the Agent Job Type field pre-filled. If you enter DB.11 or AGJOB, the Agent Job Type field is not pre-filled.

If you use the Format command to clear the screen and want to add a new agent job definition, you must supply the Agent Job Type.

Note: You can change the agent job type. Be careful that you do not change it to a value that is not valid for the type of job you want to execute.

------------------------- CA-7 Agent Job Definition ------------------------ Function: (Add, DD, Delete, DELPRRN, Format, List, Purge, Update) Job: System: JOBNET: Owner: UID: Agent Job Type: NT_JOB Agent: User: Parmlib: Member: Use-Ovrd-Lib: EXEC: Hold: Verify: DRClass: ARFSET: Satisfaction Lead Time: WLBClass: WLBPRTY: Clock Time: Don't Schedule Before: After: LTERM: Prompt: Rqmt List: Rqmts Not Used: PROGRAM: SM23 MSG-INDX: nn -- DB.11 -- yy.ddd / hh:mm:ss MESSAGE: ENTER FUNCTION, TRANSFER OR ENTER A COMMAND ON THE TOP LINE

This panel contains the following fields:

Function

Specifies the function to perform. Value must be the name of some other panel or one of the following:

Add: Adds a job to the database if the same-named job does not currently exist.
DD: Deletes a job and its associated data from the database (documentation, schedules, and so forth).
Delete: Deletes a job and its associated data from the database (documentation, schedules, and so forth).
DELPRRN: Deletes the parameter and associated data from the prior run queue for this job.
Format: Clears the panel of all input data.
List: Lists a job and job-related information. In batch, a formatted panel is not listed; only a found or not found message is returned.
Purge: Same as delete, but also deletes job trigger definitions that trigger the job being deleted and job requirement definitions that require the job being deleted. This includes all virtual resources connected to the job.
Update: Updates database information about a job.

Batch keyword: Positional parameter

Note: A default interpretation can be set for the DELETE function in the CA Workload Automation SE initialization file. For more information, see the OPTIONS statement in the chapter "Initialization" of the Systems Programming Guide.

Job

Defines the job name on which to perform the indicated function.

Limits: 1 to 8 alphanumeric characters. The job name format of UCC7Rxxx (where xxx is any three characters) is reserved for use with Workload Balancing. This imposes a restriction that no other user-defined job can begin with UCC7R as the first five characters.

Batch keyword: Positional parameter

System

(Optional) Defines the user-defined application system name of which this job is a part. The internal agent job ID uses this field. If the System Name is blank, the word "SYSTEM" is used as part of the internal agent job ID.

Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma.

Batch keyword: SYSTEM

JOBNET

(Optional) Defines the name of a job network of which this job is a part.

Note: This field is not transmitted to the cross-system platform but may be used within CA Workload Automation SE internally.

Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma.

Batch keyword: JOBNET

Owner

(Optional) Defines the ID identifying ownership of this job. Depending on the CA Workload Automation SE startup options taken and the external security product being used, CA Workload Automation SE can offer this value to the external security package at job submission time as the authority for this job to execute.

Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists.

Batch keyword: OWNER

UID

(Optional) Defines the CA Workload Automation SE user security identification.

Default: 0 (No internal security identification)

Limits: 1 to 3 numeric characters from 0 to 255

Batch keyword: USERID

Agent Job Type

Defines the type of agent job. The valid values are listed in the Agent Command/Job Type table found in the Interface Reference Guide.

The field has no default. If you use the menus (starting with DB.A or XPSMENU), the Agent Job Type is pre-filled based on your menu selection.

Batch keyword: AGJOBTYP

Agent

Identifies the explicit distributed platform where the job is to run.

Limits: 1 to 16 alphanumeric characters. The value must be defined to CA Workload Automation SE using the IASAGENT DD statement.

Batch keyword: AGENT

User

(Optional) Defines the user ID that is passed to the distributed platform where the job is to run.

Limits: Two 64-byte lines comprising 128 alphanumeric characters.

Batch keyword: AG1, AG2

Parmlib

Defines an indexed or symbolic (PDS) library from where execution data that is associated with this job can be found. This information is normally keyword parameters and values required by the particular agent job type.

Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and denote the library variable as defined using a /JCL command.

Batch keyword: PRMLIB

Member

(Optional) Indicates the PDS member name of the preceding library where the parameters for this job reside.

Default: Same as the Job field

Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character

Batch keyword: MEMBER

Use-Ovrd-Lib

(Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only (Y or N). This field is automatically set back to N the next time the job comes into the request queue.

Default: N

Batch keyword: JOVRDLIB

EXEC

(Optional) Indicates whether to execute this job.

Y: Specifies to execute the job. This is the default.
N: Specifies that the job does not run but shows a normal completion as if it did run.

Note: Consider the following items:

Since nonexecutable jobs do not get executed, no data sets are created. This means that any jobs waiting for data set requirement that may have been created for the job execution are not created and thus jobs may wait on these data set requirements.
VRM definitions are ignored for the nonexecutable jobs.
Critical Path Management flows cannot be started with nonexecutable jobs and thus the critical path may not be monitored.
ARF recovery is not invoked for nonexecutable jobs.

Batch keyword: EXEC

Hold

(Optional) Specifies whether to put this job in a hold status when it enters the request queue.

N: Does not put this job in a hold status. This is the default.
Y: Puts this job in a hold status.

Batch keyword: HOLD

Verify

(Optional) Specifies whether this job requires any presubmission manual verification.

Note: This function is similar to VERIFY command.

N: Specifies that this job does not require presubmission manual verification. This is the default.
Y: Specifies that this job requires presubmission manual verification.

Batch keyword: VERIFY

DRClass

(Optional) Defines the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.

Note: For more information about disaster recovery mode, see the Systems Programming Guide.

Limits: 1 to 8 alphanumeric characters. Values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks.

Batch keyword: DRCLASS

ARFSET

(Optional) Defines the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for nonexecutable jobs.

Limits: 1 to 8 alphanumeric characters. The specified ARFSET must be defined in the ARF database.

Batch keyword: ARFSET

Satisfaction Lead Time

(Optional) Defines the number of hours to consider when satisfying job dependent requirements.

The following are the possible values:

0: Indicates no lead time is to be considered when satisfying this job's requirements. This is the default.
99: Indicates that the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete normally while this job is in the request queue.
nn: Indicates that each predecessor job must have run within the last nn hours since the last run of this job.

Limits: 1 to 98

Batch keyword: JOBLDTM

Note: For agent jobs, JOB and DSN Satisfaction Lead Time are treated as one.

WLBClass

(Optional) Defines the CA Workload Automation SE WLB job class. If Workload Balancing is used, any job without a specified job class is automatically assigned to class A. Also, for workload balancing, any job that enters the queue as a result of a RUN(H) command is assigned to class 9.

Default: A

Limits: 1 alphanumeric character

Batch keyword: CLASS

WLBPRTY

(Optional) Defines the CA Workload Automation SE WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed.

Default: 100 if WLB is used or 0 is WLB is not used

Limits: 1 to 3 numeric characters from 0 to 255

Batch keyword: PRTY

Clock Time

(Optional) CA Workload Automation SE maintains certain feedback data in its database, including a weighted average elapsed execution time. If the database is updated with a clock time of 0000, then in addition to this clock time field the counters for the number of runs, number of times late, and number of restarts is also set to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. The deadline time remains due-out time minus lead time.

Note: Clock time average is not updated if the job is not successful in its execution. The weighted average is the value in the database times five, plus the value from the current execution, divided by six. This tends to keep the current run from possibly skewing the value.

Default: 0000

Limits: 4 numeric characters specified as hhmm, where hh can be 00 through 23, and mm can be 00 through 59

Batch keyword: ELAPTM

Don't Schedule Before

(Optional) Specifies that this job is not to be scheduled before this date and time. This keyword is especially helpful for timing the start of new jobs.

Panel input is:

BEFORE: yyddd hhmm

Batch input is:

BDATE=yyddd,BTIME=hhmm

Default: All zeros

Limits: Julian date specified as yyddd and time specified as hhmm

Batch keyword: BDATE and BTIME

After

(Optional) Specifies that this job is not to be scheduled after this date and time. This keyword is especially helpful for timing the permanent discontinuation of a job.

Panel input is:

AFTER: yyddd hhmm

Batch input is:

ADATE=yyddd,ATIME=hhmm

Default: 99999 0000

Limits: Julian date specified as yyddd and time specified as hhmm

Batch keyword: ADATE and ATIME

Note: If BDATE and BTIME values are equal to ADATE and ATIME, the job is not scheduled and does not appear on forecasts. If BDATE and BTIME values are greater than ADATE and ATIME, the job is not available for scheduling during the inclusive times only. Thus, if BDATE=09031 and BTIME=2359 and ADATE=09001 and ATIME=0000, the job does not schedule during the time from Jan. 1, 2009 through Jan. 31, 2009, but does schedule at all other times. CA Workload Automation SE uses current date and time for comparisons.

LTERM

(Optional) Defines a logical terminal name to receive messages about this job.

Default: MASTER

Limits: 1 to 8 alphanumeric characters

Batch keyword: LTERM

Note: Although a CPU job can specify LTERM either on the JOB Definition (DB.1) panel or in the initialization file JCL statement from which the JCL is pulled, for agent jobs, the only place to define the terminal to which messages are sent is on the AGJOB (DB.11) panel.

Prompt

(Optional) Specifies whether to issue prompt messages if this job is late.

Y: Issues the prompt messages. This is the default.
N: Does not issue the prompt messages.

Batch keyword: PROMPT

Note: If LATEPROMPT=LATE is specified on the OPTIONS statement of the CA Workload Automation SE initialization file, setting this value to no (N) prevents the job from ever having a status of LATE on an LQ or LRLOG display. Jobs defined with a value of yes (Y) are processed the same regardless of the LATEPROMPT setting.

Rqmt List

(Optional) Specifies whether to list the pre-execution requirements for this job when it enters the request queue.

Y: Lists the requirements. This is the default.
N: Does not list the requirements.

Batch keyword: RQLST

Rqmts Not Used

(Optional) Specifies whether to issue error messages for job requirements not used.

Y: Issues error messages. This is the default.
N: Does not issue error messages.

Batch keyword: RQMSG