Previous Topic

Next Topic

Book Contents

Book Index

Control-M Exits

The following table describes the available Control‑M exits:

Table 274 Control-M Exits

Exit

Description

CTMX001

This exit is invoked for every job order that must be placed in the Active Jobs file. The exit is usually used to modify job production parameters. This exit has an associated security module CTMSE01. For further details, see the INCONTROL for z/OS Security Guide.

CTMX001R

This exit is called a roof exit or driver exit because it can be used to activate as many as nine other Control‑M sample exits. Each sample exit activates a different function. The driver exit calls each sample exit in turn.

This roof exit is invoked during the Job Ordering process and receives the scheduling definition records. This roof exit enables the customer to combine several samples of Control‑M exits prefixed by CTMX001, each exit performing a specific processing function on job scheduling definitions.

CTMX002

Control‑M submission exit. Every line of the job stream submitted by Control‑M can be modified or deleted or replaced, and so on This exit has an associated security module CTMSE02. For further details, see the INCONTROL for z/OS Security Guide.

CTMX002@

This exit is called a roof exit or driver exit because it can be used to activate as many as nine other Control‑M sample exits. Each sample exit activates a different function. The driver exit calls each sample exit in turn.

This roof exit is invoked during the job submission process and receives JCL cards for a submitted job. This roof exit enables the customer to combine several samples of Control‑M exits prefixed by CTMX002, each exit performing a specific processing function on job JCL records.

CTMX003

Control‑M SYSOUT scan exit. After the job finishes executing, every line of the job’s SYSDATA is passed to the exit. The main use of this exit is to detect user generated constants in the SYSOUT (such as program DISPLAY messages) and to affect the execution results of the current job accordingly.

SYSDATA is an IOA term used to designate the data in the following three job SYSOUT datasets: job log (console messages), expanded JCL, and system output messages.

CTMX004

This exit allows the user to change the defaults of the Control‑M scheduling algorithm by assigning weights to quantitative resources. In this way, Control‑M can be fine-tuned to achieve maximum throughput.

CTMX005

Exit CTMX005 is an integral part of the statistical data accumulation process. It is invoked by utility CTMJSA, which accumulates job statistical data from the IOA Log file. The exit can be used for the following purposes:

By default the machine ID (one-character) is automatically derived from the SYSID (four-character) and from information contained in CTMPARM, before Exit CTMX005 is invoked. Exit CTMX005 can override the machine ID.

Exit CTMX005 enables the user to incorporate additional statistical data from sources other than the IOA Log (for example, performance monitors) into the job execution statistics.

CTMX008

This exit is used to control access to the Active Jobs file, such as user authorization line commands (hold, delete, and so on). This exit has an associated security module CTMSE08. For further details, see the INCONTROL for z/OS Security Guide.

Exit CTMX008 and security module CTMSE08 are also invoked by the Control‑M Application Server (CTMAS) and the Control‑M Application Server Interface (CTMAPI).

CTMX008 may be invoked from the Active Environment screen (Screen 3) by using option X. For further details, see the Control-M for z/OS User Guide.

CTMX010

This exit is used to control job submission using the Quick Submit facility. For example, it can force the use of Control‑M for production job submissions under TSO.

CTMX013

This exit is invoked each time a line is displayed by the Control‑M Online facility in the Job Statistics screen (Screen 3.S). The exit can modify the line to be displayed.

CTMX014

This exit is invoked when a request is made to edit a JCL member under Screen 2 and Screen 3 of the Online facility.

CTMX015

This exit is invoked when a job has finished executing and has been assigned a Control‑M termination status.

CTMX015R

This exit is called a roof exit or driver exit because it can be used to activate as many as nine other Control‑M sample exits. Each sample exit activates a different function. The driver exit calls each sample exit in turn.

This roof exit is invoked during job post-processing (that is, when a job finished its run and Control‑M assigns status ENDED OK or ENDED NOTOK to a job). This roof exit enables the customer to combine several samples of Control‑M exits that are prefixed by CTMX015, each exit performing a specific function on the post processing of a job.

CTMX017

The exit receives control each time the Tape Pull list utility (CTMTAPUL) attempts to resolve volumes for each DD statement of the job.

CTMX018

This exit receives control during the process of determining the anticipated elapse time of a job.

CTMX019

This exit receives control during the Control‑M external writer initialization phase.

CTMX020

This exit is called when a specific job starts and when it is still found running after its DUE-OUT time. The exit may be used to change the service class setting that the Control-M monitor, based on its search and matching algorithm, is about to reset the job to. For further details, see Workload management service class support.

CTMX021

This exit receives control each time a Load-Index is calculated, allowing you to modify the Load-Index calculation value and calculation note.

Some Control-M exits can be dynamically reloaded by issuing a Control-M operator command—with no need to recycle the Control-M Monitor. For more information, see Dynamically Reloading User Exits.

Parent Topic

Exits