Previous Topic

Next Topic

Book Contents

Book Index

Control-M Analyzer Rule

Invokes a Control‑M/Analyzer rule to be executed.

Additional information

Description

Usage

Optional

Variable Support

None

Alternate names

  • Control‑M/EM Utilities: DOCTBRULE
  • Control-M Report: (none)
  • Control‑M/Server Utilities: (none)
  • Control‑M for z/OS: DO CTBRULE
  • Control‑M/EM API: do_ctbrule

Alternate formats

Control‑M/EM Utilities

DOCTBRULE contains the following sub-parameters.

NAME

Name of the Control‑M/Analyzer rule that is to be executed.

PAR

Arguments

Sub-parameters

name

Text box.

Name of the Control‑M/Analyzer rule that is to be executed. The Control‑M/Analyzer rule contains all balancing specifications to be performed. Mandatory.

Length

1 through 8 characters

Case Sensitive

Yes

Invalid Characters

Blanks; non-English characters

ARG

Text box.

Arguments that are passed to the Control‑M/Analyzer rule. Separate multiple arguments by commas. Optional.

Length

1 through 45 characters

Case Sensitive

Yes

Invalid Characters

Blanks; non-English characters

When Control-M Analyzer is specified, balancing is performed by the Control-M/Analyzer Runtime environment according to the specified rule definition and using the specified arguments. The Control-M/Analyzer Runtime environment is invoked once for each Control-M Analyzer statement in the job scheduling definition.

If Control-M Analyzer is specified under ON PGMST ANYSTEP, the Control-M/Analyzer Runtime environment is invoked only once.

When Control-M calls a Control-M/Analyzer rule, Control-M/Analyzer System variable SYSOPT contains the value CTMWORK. This variable can then be tested within the Control-M/Analyzer rule definition to determine if Control-M invoked the Control-M/Analyzer Runtime environment.

When the Control‑M/Analyzer Runtime environment is invoked by Control‑M, that is, Control‑M/Analyzer System variable SYSOPT is set to CTMWORK, Control‑M/Analyzer can analyze and balance SYSDATA. For more information about invoking Control‑M/Analyzer rules from Control-M job scheduling definitions, see the discussion of the interface to Control-M in the Control-M/Analyzer User Guide.

This parameter is available only for Control‑M for z/OS jobs at sites using Control‑M/Analyzer.

EXAMPLE: Execute a Control‑M/Analyzer rule when a job ends OK

If the job ends OK, execute Control-M/Analyzer balancing rule GOVTBAL.

JOB: GOVTREPT LIB CTM.PROD.SCHEDULE FOLDER: BACKUP

COMMAND ===> SCROLL===> CRSR

+--------------------------------------------------------------------------+

TIME: FROM UNTIL PRIORITY DUE OUT SAC CONFIRM

TIME ZONE:

===========================================================================

OUT FINANCE-GOVTREPT-OK ODAT +

AUTO-ARCHIVE Y SYSDB Y KEEP ACTIVE FOR MAXIMUM RERUNS

RETENTION: # OF DAYS TO KEEP 030 # OF GENERATIONS TO KEEP

Output OP (C,D,F,N,R) FROM

MAXIMUM RERUNS RERUNMEM INTERVAL FROM

STEP RANGE FR (PGM.PROC) . TO .

ON PGMST ANYSTEP PROCST CODES OK A/O

DO CTBRULE = GOVTBAL ARG DOREPORT,10,%%ODATE

DO

ON PGMST PROCST CODES A/O

DO

NOTIFY WHEN NOTOK TO TSO-M44 URGN R

MS JOB GOVTREPT ENDED "NOT OK"

NOTIFY WHEN TO URGN

MS

======= >>>>>>>>>>>>>>>>>> END OF SCHEDULING PARAMETERS <<<<<<<<<<<<<<< ======

COMMANDS: EDIT, DOC, PLAN, JOBSTAT 11.17.00

Parent Topic

On/Do Actions