Code values

Code values can be condition codes, user abend codes, system abend codes, various end codes and statuses, and certain keywords. They can also be prefaced by certain qualifiers. All of these are described below.

A maximum of 245 codes can be specified for any On step statement, as follows:

• Each line of an On statement contains fields for specification of up to four codes.
• Whenever a fourth code on a line is specified, and Enter is pressed, a new line within the same On statement is opened, allowing specification of up to another four codes.

  NOTE: If a Set to Ok statement is specified in the job scheduling definition, it is ignored for steps for which any of the following codes apply: Job was canceled during executing, Job not submitted, Maximum reruns number reached, unknown error occurred.

  Value	Description
  Condition return code	Step condition code. 4-digit value.
  System ABEND code	Step system abend code. 3-character hex value.
  User ABEND code	Step user abend code. a 4-digit value.
  Job was queued for execution	Any step that executes, including steps with JCL errors and steps returned with an ABEND code. For reasons of backward compatibility, the Job was queued for execution code does not include steps with the FLUSH code or SNRUN (described below). The Job was queued for execution code does, however, include jobs not submitted and jobs whose output was lost if Any program step is specified.
  Job was Set to Ok	This code applies when a Job is Set to OK from the Control‑M Monitoring screen (Screen 3). To specify a code of FORCE, all of the following must apply: No other code can be specified in the same statement. The PGMST value must be Any program step. No PROCST value can be specified. No other On statements can appear in the On block. Valid DO statements for the FORCE code are: Notify Add/Remove Condition Order Job Set Variable Notify
  Job Output was lost	Job Output was lost. This value can be specified only with the Any program step step value.
  Job was canceled during executing	Job was canceled during execution or re-execution. This value can be specified only with the Any program step step value.
  Job failed due to JCL error	Job failed due to JCL error.
  Job failed due to security requirements	Job failed due to security requirements (only under ACF2). This value can be specified only with the Any program step step value.
  Job not submitted	Job not submitted. Submission of a job or initiation of a started task failed for any reason. This value can be specified only with the Any program step step value.
  Job Ended OK	A program step finished executing OK (by default with a condition code of C0004 or less). This value can be specified only with the Any program step step value. NOTE: Through parameter MAXCCOK in member CTMPARM in the IOA PARM library, the default condition code can be set to C0000. If a job is ORDERED OK, the DO statements following an any program step.. CODES OK statement are processed only if the FRCOKOPT parameter in the CTMPARM member in the IOA PARM library is set to Y.
  Job Ended Not OK	A program step (or the job) finished executing NOTOK. This code covers all types of failures, including non-execution errors (for example, job not run, JCL error, job not submitted), and (by default) any condition code greater than C0004. This value can only be specified with the Any program step step value. You can use the MAXCCOK parameter in the CTMPARM member in the IOA PARM library to set the default condition code to C0000.
  Any type of execution error	Any type of execution error. It is the same as NOTOK, but is triggered only if the job has actually started executing. This value can only be specified as the Any program step step value.
  File allocation problem (NCT2)	A NOT CATLGD 2 or NOT RECATLGD 2 event occurred in the job step. The default result of this event is a NOTOK status for the step. A message containing the data set name is written to the IOA Log file. If you do not want to be alerted to NOT RECATLGD 2 events, see your INCONTROL administrator.
  Job terminated by CMEM	Job terminated by CMEM due to an NCT2 event.
  Maximum reruns number reached	Rerun (recovery) is needed, but no more reruns are available. REC is followed by a zero (0), not a letter O.
  unknown error occurred	An unknown error occurred, usually as a result of a computer crash during job execution. This value can only be specified with the Any program step step value.
  Job was queued for execution	Job was queued for re-execution.
  Step not executed (FLUSH)	A JCL COND or JCL IF/THEN/ELSE statement caused a step to not run. This code is described in more detail in below.
  Step not executed	A step did not run.

Step not executed (FLUSH)

The FLUSH code generally applies when a step does not run but no error is indicated. This code is assigned when:

• A JCL COND or JCL IF/THEN/ELSE statement caused the step not to run. Control-M detects code FLUSH steps by the IEF272I message (Step was not executed).
• If a job was restarted by Control‑M/Restart, and Control-M is to consider all job runs during post-processing (ALLRUNS is set to YES in the CTRPARM member), a step is defined as FLUSH if both the following statements are true:
  • Either the step did not previously run, or Control‑M/Restart did not recapture a completion or abend code from a previous run
  • Either of the following statements is also true:
    • It was not executed during the RESTART run because of a JCL COND or JCL IF/THEN/ELSE statement.
    • It was not executed due to a RESTART decision (the CTR103I message).
    • Because a code of FLUSH does not indicate that an error occurred during job execution, assignment of this status does not cause a job status of NOTOK.
    • If a JCL statement other than the COND or IF/THEN/ELSE statement caused the step not to run, it is not defined as a FLUSH step.
    • If the failure of a step causes subsequent steps not to be executed, these subsequent steps are not defined as FLUSH steps.

For reasons of backward compatibility (that is, to ensure that the application of the Job was queued for execution code remains unchanged), the Job was queued for execution code does not include FLUSH steps.

Step not executed

A step is defined as code step not executed if it did not run. This code includes:

• Any step with a code of FLUSH.
• Any step that does not appear in the job.
• Instances where a step does not run because of a JCL error in a prior step (the step with the JCL error does not have a status of SNRUN)
• If a job was restarted by Control‑M/Restart, and Control-M is to consider all job runs during post-processing (the ALLRUNS parameter is set to YES in the CTRPARM member), a step is defined as step not executed if both the following statements are true:
  • Either the step did not previously run, or Control‑M/Restart did not recapture a completion or abend code from a previous run.
  • The step was not executed during the RESTART run.

Step not executed cannot be specified together with Any program step. (Because Step not executed includes steps that do not exist in a job, and any program step includes all step names even if they do not exist in a job, specifying both in the same job would cause a condition that Step not executed could not process.).

A status of Step not executed does not indicate that an error occurred during a job execution, nor does it cause a job status of NOTOK. It only indicates that it did not run.

For backward compatibility (that is, to ensure that the application of the Job was queued for execution code remains unchanged), the Job was queued for execution code does not include Step not executed steps.

Code qualifiers and relationships

Any character in a condition code, system abend code or user abend code may be replaced by an asterisk (*). An asterisk means "any value" for the character it replaces. For example, if S*13 is specified, the code criteria for the step is satisfied by codes S013, S613, S913, and so on.

The additional qualifiers in the following table can be used in specific circumstances.

The N qualifier indicates that the DO statements must not be performed if the specified condition exists. It does not indicate that the DO statements must be performed if the specified condition does not exist.

The relationship between multiple codes in an On statement is OR (that is, the appearance of any of the codes in the specified step satisfies the On criteria), except for range specifications (for example, >10 <40).

However, code criteria qualified by N take precedence over all other code criteria. If a code that is specified with an N qualifier is generated by the specified step, accompanying DO actions are not performed even if other On code criteria are satisfied.

If Step1 ends with a condition code of C0004 and Step 5 ends with system abend code S0C4, perform the indicated notification.

On Statement PGMST= Step1 PROCST= Codes=C0004 AND

On Statement PGMST= Step5 PROCST= Codes=S0C4

Notify To=emuser Urgn=Regular Msg= Backup operations ...