Previous Topic

Next Topic

Book Contents

Book Index

Passing Arguments to and from Control-M/Analyzer

The arguments described in Table 301 are passed to the Control-M/Analyzer rule.

Table 301 Arguments Passed to the Control-M/Analyzer Rule

Argument

Description

Rule name

8-character rule name.

Mission name

8-character mission name.

Group name

20-character group name.

Result

Result or Termination status of the called rule (returned by Control-M/Analyzer). This argument is 4 bytes (1 fullword) in length. The result contains one of the following numeric values:

  • 1–OK status
  • 2–NOTOK status
  • 3–TOLER status

Number of User Arguments

Number of user arguments sent to the rule. This argument is 4 bytes (1 fullword) in length.

User Arguments

A maximum of 50 user arguments may be specified. Each argument has 101 characters and as is formatted as follows:

  • Byte 1 –The length of the user argument (from 1 to 100 characters).
  • Bytes 2-101–The value of the user argument.

The user argument format is illustrated in Figure 382.

Figure 382 User Argument Format

User arguments can be referenced by the rule through the RARGxx System variable. For example, RARG01 corresponds to the first user Argument, RARG02 corresponds to the second user argument, and so on

After rule termination, changes made to RARGxx System variable values during rule execution are returned to the calling program (the user program that invoked the rule).

Parent Topic

Interface to User Programs