The following parameters can be defined as Local or Global parameters using the CTMBLT utility. For complete descriptions of these parameters, see the Job Production parameters chapter in the Control-M for z/OS User Guide.
Note that in the following tables:
Table 99 CTMBLT General Job Parameters
Parameter |
M |
Value |
Description |
Default |
Usage |
---|---|---|---|---|---|
ADJUST-CONDS |
|
Y (Yes), N (No), |
Adjust conditions indicator. For SMART Table Entities only |
N |
2,4 |
APPL |
|
1 through 20 characters |
Application name |
|
1,2 |
CTBE-ARGS |
|
1 through 45 characters within apostrophes |
Arguments passed to Control-M/Analyzer |
|
1,5 |
CTBE-NAME |
|
1 through 8 characters |
Name of the Control-M/Analyzer mission or rule associated with the CTBEND step |
|
1,5 |
CTBEND |
|
None |
Define the |
|
1,5 |
CTBE-TYPE |
|
R (RULE) or M (MISSION) |
Type of Control-M/Analyzer entity associated with the CTBEND step |
|
1,5 |
CTBS-ARGS |
|
1 through 45 characters within apostrophes |
Arguments passed to Control-M/Analyzer |
|
1,5 |
CTBS-NAME |
|
1 through 8 characters |
Name of the Control-M/Analyzer mission or rule associated with the CTBSTART step |
|
1,5 |
CTBSTART |
|
None |
Define Control-M/Analyzer step as first job step |
|
1,5 |
CTBS-TYPE |
|
R (RULE) or M (MISSION) |
Type of Control-M/Analyzer entity associated with the CTBSTART step |
|
1,5 |
DESC |
++ |
Up to 70 characters per DESC parameter |
Description of job |
|
1,2 |
DOCLIB |
|
1 through 44 characters |
Documentation library |
|
1,2 |
DOCMEM |
|
1 through 8 characters To leave DOCMEM blank, specify |
Documentation member |
Same as MEMNAME |
1,2 |
GROUP |
|
1 through 20 characters |
Group name (Ignored if SMART table was created via the GROUP-ENTITY parameter) |
|
|
MEMLIB |
|
1 through 44 characters |
Library containing JCL member |
GENERAL |
1 |
NJE-NODE |
|
1 through 8 characters |
NJE node name |
|
1 |
OWNER |
|
1 through 8 characters |
User-identification |
USER who submitted the job; jobname, if user is unknown |
1,2 |
OVERLIB |
|
1 through 44 characters |
Overriding JCL library name |
|
1,5 |
PREVENT-NCT2 |
|
Y, N, F, L, or blank |
Prevent ‘NOT CATLGD 2’ errors |
|
1 |
SCHENV |
|
1 through 16 characters |
Workload management scheduling environment name |
|
1 |
SETVAR |
++ |
1 through 66 characters %%varname=value |
Set AutoEdit value If value contains delimiter characters (for example, commas), enclose the entire parameter text in quotes or apostrophes (for example, ‘%%varname=value’). |
|
1,2 |
STAT-CAL |
|
1 through 8 characters |
Statistics calendar name |
|
1,2 |
SYSTEM-ID |
|
1 through 5 characters |
System affinity name |
|
1 |
RBC-RELATION |
|
A (And) or O (Or) |
Relationship between rule-based calendars and basic scheduling criteria |
O |
1,4,5 |
TASKTYP |
|
3 characters |
Type of task |
JOB and TBC for SMART Tables |
1,2,5 |
Table 100 CTMBLT Scheduling Parameters
Parameter |
M |
Value |
Description |
Default |
USAGE |
---|---|---|---|---|---|
ACTIVE-FROM |
|
6 digit date in the format yymmdd |
Date in the RBC ACTIVE FROM or DEFINITION ACTIVE FROM fields |
|
1,3 |
ACTIVE-UNTIL |
|
6 digit date in the format yymmdd |
Date in the RBC ACTIVE UNTIL or DEFINITION ACTIVE UNTIL fields |
|
1,3 |
CATEGORY |
|
1 through 20 characters |
Category for Control-D |
|
1 |
CONFCAL |
|
1 through 8 characters |
Confirmation calendar name |
|
1,3 |
DATES |
+ |
4 characters |
DATES scheduling |
|
1,3 |
DAYS |
+ |
1 through 3 characters |
Scheduling days (non-periodic) |
|
1,3 |
DAYSKEEPNOK |
|
2 digits (0–99) |
The minimal number of days that the folder and its jobs are kept in the AJF after the folder is marked as "NOT-OK". 1-98 – Number of days to keep. 99 – Keep forever. The above two options are invalid when REMOVEATONCE is set to "No". 0 – Do not keep. This is the only valid value when REMOVEATONCE is set to "No". |
0 |
1,3 |
DCAL |
|
1 through 8 characters |
DAYS calendar name |
|
1,3 |
EXT-SHIFT |
|
2 through 3 characters |
Additional shift |
|
|
|
Blank |
No additional shift |
|
|
|
|
–nn |
Shift n days backward |
|
|
|
|
+nn |
Shift n days forward |
|
|
|
MAXWAIT |
|
2 digits (00...98,99) |
Maximum days job is retained 0-98 99 that indicates "forever" |
Value specified in optional Wish WM2367 |
1,2,3 |
MINIMUM |
|
3 digits |
Minimum tracks left free |
|
1 |
MONTHS |
+ |
0 |
NO months |
|
|
1 through 3 characters |
MONTHS scheduling |
ALL |
1,3 |
||
PDS |
|
1 through 44 characters |
Full name of PDS Library to be checked |
|
1 |
PERIOD |
+ |
4 through 5 characters (DnPi or LnPi) |
Periodic scheduling days |
|
1,3 |
RELATION |
|
A or O |
AND or OR relation between DAYS or WDAYS |
O |
1,3 |
REMOVEATONCE |
|
Y (Yes) or N (No) |
Indicates that all the jobs will be removed together, when the folder is ready to be removed. |
N |
1,3 |
RETRO |
|
Y (Yes) or N (No) |
Retroactive selection In SMART Tables, N is the only value permitted for the RETRO parameter. |
Value specified in optional Wish WM2548 |
1,3 |
SCHEDULE-RBC |
+ |
1 through 20 characters or *END |
Rule-based calendar name |
|
1,2, 3,4,5 |
SHIFT |
|
1 character Blank, >, <, @ |
Shift on confirmation calendar |
|
1,3 |
WCAL |
|
1 through 8 characters |
WDAYS calendar name |
|
1,3 |
WDAYS |
+ |
1 through 4 characters |
Weekly scheduling days (non-periodic) |
|
1,3 |
WPERIOD |
+ |
4 through 5 characters (DnPi or LnPi) |
Periodic weekly scheduling days |
|
1,3 |
Table 101 CTMBLT Runtime Parameters
Parameter |
M |
Value |
Description |
Default |
Usage |
---|---|---|---|---|---|
CONFIRM |
|
Y (Yes) or N (No) |
Confirmation for scheduling |
|
1,2 |
CONTROL |
++ |
(control,type,opt)
|
Control resource Name of Control resource |
Blank |
1,2 |
DUE-IN |
|
SKP |
Skip Due-In time check |
|
1,2,6 |
ORDER |
|
HLD |
Set the job status to HELD immediately after being ordered. |
|
1,2,6 |
DUE-OUT |
|
(hhmm,nnn) |
Time when the job finishes executing nnn is an offset of up to 120 days |
0 |
1 |
IN |
++ |
(cond,date)
|
IN condition Name of IN condition |
ODAT (for date reference) |
1,2 |
Note: If the condition name contains boolean characters (open or close parentheses), enclose the parameter value in quotation marks rather than parentheses. |
|||||
PIPE |
++ |
pipe name (1 to 44 characters) |
MAINVIEW Batch Optimizer (MVBO)/Job Optimizer Pipes pipe name |
|
1,5 |
Note: This field is supported only if MAINVIEW Batch Optimizer (MVBO) is installed at your site. |
|||||
PRIORITY |
|
1 to 2 characters |
Priority. |
|
1,2 |
RESOURCE |
++ |
(resource,number, opt1, opt2)
|
Quantitative resource.
Name of resource.
Quantity of resource. Disposition of the resource when job ends OK (D=Delete) Disposition of the resource when job ends NOTOK (K=Keep) |
Blank
Blank |
1,5 |
SAC |
|
1 character (P, N, -, +, blank) |
Schedule Adjustment for Conversion. |
|
1,2 |
TIMEFROM |
|
(hhmm,nnn) |
Earliest time to submit job nnn is an offset of up to 120 days |
0 |
1,2 |
TIMEUNTIL |
|
(hhmm,nnn) >,nnn |
Latest time to submit job Submit as soon as possible nnn is an offset of up to 120 day |
0 |
1,2 |
TIME-ZONE |
|
1 through 3 characters |
Time zone designation |
|
1, 2 |
Table 102 CTMBLT Post-Processing Parameters
Parameter |
M |
Value |
Description |
Default |
Usage |
---|---|---|---|---|---|
OUT |
++ |
(out,date,option)
|
Name of OUT condition Date reference Function: ADD or DELETE |
ODAT (for the date reference) + (for the option) |
1,2 |
AUTOARC |
|
Y (Yes) or N (No) |
Archive SYSDATA |
Y (Yes) |
1 |
SYSDB |
|
Y (Yes) or N (No) |
Archive to common data set |
Y (Yes) |
1 |
MAXDAYS |
|
2 digits |
Expiration period |
|
1 |
MAXRUNS |
|
3 digits |
Max number of runs |
|
1 |
SYSOUT-OP |
|
1 character (C,F,N,D,R) |
SYSOUT option |
|
1 |
SYSOUT-FRM |
|
1 character |
SYSOUT option FROM CLASS |
|
1 |
SYSOUT-PRM |
|
For SYSOUT-OP:
|
SYSOUT parameter – according to SYSOUT option SYSOUT-OP |
|
1 |
MAXRERUN |
|
3 digits; Up to 255 |
Maximum number of reruns. |
|
1 |
MAXRERUN- |
|
4 digits; 0 through 9999 |
Maximum number of cyclic runs. Effective only if TASKTYPE is set to CYC or TBC for SMART cyclic table. |
|
1,2 |
RERUNMEM |
|
1 through 8 characters |
Name of rerun job |
|
1 |
INTERVAL |
|
5 digits, 0 through 64800 |
Time interval between reruns |
|
1,2 |
INTERVAL-TYP |
|
S, E, T |
Start or End of Interval or Target |
END |
1,2 |
INTERVL-UNIT |
|
M, H, D |
The units in which INTERVAL is expressed (Minutes, Hours, or Days) |
M |
1,2 |
CYCLIC-TYPE |
|
C, S, V |
Type of interval between cycles:
|
C |
1,2,5 |
TOLERANCE |
|
1 to 4 digits |
Enhanced cyclic tolerance - the maximum number of minutes after the specified time permitted for a late submission. |
0000 |
1,2,5 |
VAR-INTERVAL |
++ |
nnnnn, unit |
Enhanced cyclic varying interval (nnnnn - interval length, unit = M (Minutes), H (Hours), D (Days) |
M |
1,2,5 |
CYC-RUNTIME |
++ |
hhmm, nnn |
Enhanced cyclic specific run times in 24-hour format: hh (hour), mm (minutes) with an optional day-offset (nnn) |
|
1,2,5 |
RET-DAYS |
|
3 digits |
Retention number of days |
|
1 |
RET-GENS |
|
2 digits |
Retention number of generations |
|
1 |
STEPRNG |
+ |
1 through 7 characters |
Step Range name |
|
1 |
FROMPGM |
|
1 through 8 characters |
FROM PGM STEP in step range |
|
1,5 |
FROMPROC |
|
1 through 8 characters |
FROM PROC STEP in step range |
|
1,5 |
TOPGM |
|
1 through 8 characters |
TO PGM STEP in step range |
|
1,5 |
TOPROC |
|
1 through 8 characters |
TO PROC STEP in step |
|
1,5 |
ON-SYSOUT |
+ |
(text) 1 through 40 characters, including quotes if the text contains special/blank characters |
Identifies the beginning of an ON-SYSOUT block |
|
|
FROM-TO-COL |
|
(from-col,to-col) 1 through 3 digits |
from-col and to-col have values from 1 through 132 |
from-col=1 to-col=132 |
1,2,5 |
ONSYS-RELATE |
+ |
A or O |
AND or OR relation |
|
1,2,5 |
ONVAR-NAME |
+ |
1 to 64 characters
|
Name of an AutoEdit variable in an ON VAR block |
|
1,2,5 |
ONVAR-OPERAT |
+ |
For an integer:
For a string:
|
Comparison operator for checking the current value of the AutoEdit variable |
|
1,2,5 |
ONVAR-VALUE |
+ |
1 to 64 characters Can contain AutoEdit variables. Not relevant for operators IR and NR. For operators MP and NP, leave empty. |
The value that the variable must match for the DO action to be performed |
|
1,2,5 |
ONVAR-MIN |
+ |
1 to 64 characters Relevant for operators IR and NR. |
Lower limit of the value range that the variable must match for the DO action to be performed |
|
1,2,5 |
ONVAR-MAX |
+ |
1 to 64 characters Relevant for operators IR and NR. |
Upper limit of the value range that the variable must match for the DO action to be performed |
|
1,2,5 |
ONVAR-RELATE |
+ |
A or O |
AND or OR relation in the ON VAR block |
|
1,2,5 |
ONPGM |
+ |
|
Identifies the beginning of an ON block |
|
1,2,5 |
STEP |
+ |
1 through 8 characters
GROUPEND |
PROGRAM STEP name for ON block
GROUPEND parameters for SMART Table Entities only. Codes OK and NOTOK |
|
1,2,5 |
PROCST |
+ |
1 through 8 characters |
PROC STEP name for ON block |
|
1,5 |
CODES |
+ |
(6 chars,6 chars,...) |
ON block codes |
|
1,2,5 |
ON-RELATE |
+ |
A or O |
AND or OR relation |
|
1,5 |
DO=OK |
|
OK |
Changes the status of a job step or SMART Table from NOTOK to OK |
|
1,2,5 |
DO=NOTOK |
|
NOTOK |
Changes the status of a job step or SMART Table from OK to NOTOK |
|
1,2,5 |
DO=REMEDY |
|
REMEDY |
Open a Remedy problem ticket |
|
1,2 |
URG |
|
1 character (L,M,H,U) |
Urgency rating of the message |
|
1,2 |
RMD-SUM |
+ |
1 through 128 characters |
Summary of reason for Remedy case Note: At least one line must be entered |
|
1,2 |
RMD -DES |
+ |
1 through 1024 characters |
Description of Remedy case Note: At least one line must be entered |
|
1,2 |
Note: There is a limit of 2 RMD-SUM and 15 RMD-DES text lines. |
|||||
DO=RERUN |
|
RERUN |
Reschedules jobs following an unsuccessful job run |
|
1,5 |
DO=COND |
+ |
COND |
|
|
1,2,5 |
CONDS |
+ |
(out,date,option) |
OUT condition |
Same as OUT parameter |
1,2,5 |
DO=FORCEJOB |
+ |
FORCEJOB |
|
|
1,2,5 |
Note: DO=FORCEJOB applies to both regular and remote FORCEJOB (REMFORCE) blocks. It is considered a remote FORCEJOB if any of the RFJ-xxx keywords are present. |
|||||
FORCE-TAB |
|
1 through 8 characters, or 1 through 64 characters for distributed system jobs |
Table name |
|
1,2,5 |
FORCE-JOB |
|
1 through 8 characters, or 1 through 64 characters for distributed system jobs |
Job name |
|
1,2,5 |
FORCE-DATE |
|
6 characters |
Date |
ODAT |
1,2,5 |
FORCE-LIB |
|
1 through 44 characters. Ignored for distributed system jobs. |
Library name |
|
1,2,5 |
RFJ-CTM |
|
1 through 20 characters |
Control-M name |
|
1,2,5 |
RFJ-VAR |
|
1 through 70 characters. |
Set AutoEdit value. If the value contains delimiter characters (for example, commas), enclose the entire parameter text in quotes or apostrophes (for example, '%%varname=value'). |
|
1,2,5 |
RFJ-VAL |
|
1 through 70 characters. |
Continuation of the AutoEdit value specified by the previous RFJ-VAR or RFJ-VAL parameters. If the value contains delimiter characters (for example, commas), enclose the entire parameter text in quotes or apostrophes (for example, '%%varname=value'). |
|
1,2,5 |
DO=IFRERUN |
|
|
|
|
1,5 |
IFRERN-FROM |
|
1 through 16 characters |
From |
|
1,5 |
Note: IFRERN-FROM is a 16 character field whose value consists of an 8 character program step name and an 8 character proc step name. If a proc step name is specified and the program step name is less than 8 characters, then the program step name must be padded with blanks and the value must be enclosed by delimiters. |
|||||
IFRERN-TO |
|
1 through 16 characters |
To |
|
1,5 |
Note: IFRERN-TO is the same as described in the footnote above. |
|||||
IFRERN-CONF |
|
Y (Yes) or N (No) |
Confirm |
|
1,5 |
DO=CTB |
|
CTB |
|
|
1,5 |
CTB-RULE |
|
1 through 45 characters |
Rule name |
|
1,5 |
CTB-ARG |
|
1 through 36 characters |
Arguments |
|
1,5 |
DO=SET |
+ |
SET |
|
|
1,2,5 |
SETVAR |
|
1 through 66 characters %%varname=value |
Set AutoEdit value. If value contains delimiter characters (for example, commas), enclose the entire parameter text in quotes or apostrophes (for example, ‘%%varname=value’). |
|
1,2 |
DO=SHOUT |
+ |
SHOUT |
|
|
1,2 |
MSG |
|
1 through 70 characters |
SHOUT message |
|
1,2 |
DEST |
|
1 through 16 characters |
SHOUT destination |
OPER |
1,2 |
URG |
|
1 character (R,U,V) |
SHOUT urgency |
R |
1,2 |
DO=STOPCYCL |
|
|
Stops reruns of cyclic jobs |
|
1,2,5 |
DO=SYSOUT |
+ |
SYSOUT |
|
|
1,5 |
SYSOUT-OP |
|
1 character (C,F,N,D,R) |
SYSOUT option |
|
1,5 |
SYSOUT-FRM |
|
1 character |
SYSOUT option FROM CLASS |
|
1,5 |
SYSOUT-PRM |
|
For SYSOUT-OP:
|
SYSOUT parameter – according to SYSOUT option SYSOUT-OP |
|
1,5 |
DO=MAIL |
|
|
|
|
1.2 |
M-ATTACHMENT |
|
1 character (Y,N,D) |
e-mail SYSOUT attachment |
D |
1.2 |
MAIL-TO |
+ |
(addr1,addr2,...) |
e-mail TO addresses |
|
1.2 |
MAIL-CC |
+ |
(addr1,addr2,...) |
e-mail CC addresses |
|
1,2 |
Note: There is a limit of 255 MAIL-TO and 255 MAIL-CC addresses. |
|||||
MAIL-SB |
|
‘subject-line’ |
e-mail subject line |
|
1,2 |
MAIL-TX |
+ |
‘text-line’ |
e-mail text line |
|
1,2 |
Note: There is a limit of 255 MAIL-TEXT lines. |
|||||
SHOUT-WHEN |
+ |
Valid values are:
|
Indicates start of SHOUT block |
|
1,2 |
TIME |
|
(time-opt,nnn) |
SHOUT on LATE or LATESUB or EXECTIME
nnn is an offset of up to 120 day |
"*" for the LATE or LATESUB values 0 |
1,2 |
MSG |
|
1 through 70 characters |
SHOUT message |
|
1,2 |
DEST |
|
1 through 16 characters |
SHOUT destination |
OPER |
1,2 |
URG |
|
1 character (R,U,V) |
SHOUT urgency |
R |
1,2 |
ON-CAPTURE |
+ |
1 through 4 characters or *END |
CAPTURE block header or trailer |
|
1,5 |
CAPT-SEARCH |
|
1 through 53 characters |
Capture search string |
|
1,5 |
CAPT-SKIPROW |
|
0-99999999 |
Capture - number of rows to skip |
0 |
1,5 |
CAPT-BY |
|
W or C |
Capture by word(W) or character(C) |
W |
1,5 |
CAPT-SKIP |
|
0-255 |
Capture - number of words or characters to be skipped |
0 |
1,5 |
CAPT-DELIM |
|
1 character |
Capture - words delimiter |
blank |
1,5 |
CAPT-INTO |
|
AutoEdit variable name |
Capture - target AutoEdit variable for storing capture results |
|
1,5 |
CAPT-TAKE |
|
0-44 |
Capture - number of words or characters to store in the AutoEdit variable |
1 - Word mode; Empty - end of line - Char mode |
1,5 |
Table 103 CTMBLT Special Parameters
Parameter |
M |
Value |
Description |
Default |
Usage |
---|---|---|---|---|---|
APPL_FORM |
|
|
See notea |
|
1,5 |
APPL_TYPE |
|
|
|
||
APPL_VER |
|
|
|
||
CM_VER |
|
|
|
||
DEFTYPE |
|
X |
Job/table definition should be treated as a distributed (non-mainframe) job definition. See CTMTLB – Produce XML and CTMBLT Utility Files for details. |
|
1,2 |
JCL |
+ |
1 through 72 characters |
In-line JCL statement |
|
1,5 |
MODEL |
|
library-name, table-name, job-name |
Job definition skeleton |
|
1,2 |
a These parameters are for use in jobs defined on a distributed platform (for example, UNIX or SAP) only. For details on their meaning, use, format, and valid values, see the relevant guide.
Parent Topic |