Previous Topic

Next Topic

Book Contents

Book Index

Reserved User-Defined Variables

Some user-defined variables are reserved by, and have a special meaning for, Control-O. The values of most reserved variables are tested by Control-O before performing specific DO statements, in order to establish the processing mode and the processing parameters of the DO statements.

Reserved variables, like other user-defined variables, are set by a DO SET statement, and then resolved automatically when they appear in other DO statements. They are never Global variables.

Table 191 shows the reserved user-defined variables are available.

Table 191 Reserved User-Defined Variables

Variable

Description

%%$AUTOLOG

The recording mode for the currently handled message or command.
Valid values are:

  • Y — The message or command is recorded to the Automation Log.
  • N — The message or command is not recorded.

For more information, see DO SET: Automated Console Action Parameter, and see the description of preventing the logging of unnecessary messages in the INCONTROL for z/OS Administrator Guide.

Example

ON MESSAGE TST*

DO SET=%%$AUTOLOG=N

%%$AUTOSYS

The default system in the Sysplex from which TYPE 1 XAE database variables are retrieved.

%%$COMMSYS

The system communication name or the Control-O system name (CTOGATE name).

  • For DO statements that support communication, such as DO COND, this variable can identify a remote Control-O that should perform the DO action.
  • If the DO statement has a SYSTEM subparameter, such as DO COMMAND, this variable can be used instead of that subparameter.

The DO statements are distributed by Sysplex or CTOGATE communication.

For more information, see Performing an Action on Another System ctoug3.

Example

DO SET %%$COMMSYS = SYS*

DO SHOUT=TO TSO-CICSOPR

URGENCY R SYSTEM

MESSAGE CICS IS DOWN!

%%$CTMLINE#

The current line, or job entry, in the Active Jobs file from which values are returned by the Control-M interface.

%%$DBROW

The current row in the current global variable pool, if the current pool is an AutoEdit variable database.

%%$DOLIMIT

The maximum number of DO actions that can be performed during execution of the current Control-O rule. Valid values are:

  • n — Allow execution of from 1 through 999999 DO actions in the current rule. If the rule attempts to exceed the specified number of DO actions, the rule is aborted and an error message is issued.
  • 0 — Allow the rule to execute an unlimited number of DO actions.

If %%$DOLIMIT is not specified in a Control-O rule, the rule is allowed to execute a maximum of 10,000 DO actions.

Example

To allow the current rule to execute a maximum of 500 DO actions, specify the following:

DO SET=%%$DOLIMIT = 500

%%$GLOBAL

The name of the global pool to be accessed.

Global pools contain Global variables and their values. One global pool ($GLOBAL) is defined as the default, but multiple global pools can be defined.

Unless a global pool is specified using a %%$GLOBAL parameter, the default $GLOBAL member is used.

After a pool is specified using a %%$GLOBAL parameter, that member remains assigned until a different pool is specified using another %%$GLOBAL parameter. To respecify the default, use this parameter to specify the $GLOBAL member.

For more information, see DO SET: Automated Console Action Parameter, and see the description of Global AutoEdit variables in the INCONTROL for z/OS Administrator Guide.

Example

DO SET=%%$GLOBAL = IMS

DO SET=%%STATUS = UP GLOBAL Y

%%$RESPMSG

IDs of messages expected in response to the DO COMMAND statement that follows the DO SET %%$RESPMSG statement. This variable is supported for historical reasons. For more information, see "Command-Response Mode" in General Information.

Example

DO SET=%%$RESPMSG = (CTM101I, CTM240I)

DO COMMAND=F CONTROLM,NEWCONLIST

%%$RJOBID

The ID of the job associated with DO COND, DO FORCEJOB, and DO RESOURCE requests. When specified, the value overrides the default job ID.

If this variable is set, you should also set the %%$RJOBNAME reserved user-defined variable. For an example of usage, see the %%$RJOBNAME variable in this table.

%%$RJOBNAME

The name of the job associated with DO COND, DO FORCEJOB, and DO RESOURCE requests. When specified, the value overrides the default job name. If this variable is set, you should also set the %%$RJOBID variable, described in this table.

Example

The IAT5210 JES3 tape mount message is issued under the address space of JES3, and Control-O sets the default job name to JES3. To associate the correct job, which mounts the tape, with the DO RESOURCE request, the job name and job ID are extracted from the text of the message, as follows:

DO SET=%%$RJOBNAME = %%$V3

DO SET=%%$RJOBID = %%$V4

DO RESOURCE=TAPE 0001 -

%%$STATID

The message ID under which the statistics for a message should be accumulated.

This variable can be used to combine the statistics of messages with individual statistics that are not required. This eliminates unnecessary messages from the Message Statistics screen.

Example

To combine the statistics for all messages with the prefix CKH into one general statistics item under the identifier CKHMSG, specify the following:

ON MSG CKH*

DO SET %%$STATID = CKHMSG

%%$SYSPCPU

The ordinal sequence number of the Sysplex-connected system with the name that will be accessed by the next resolution of %%SYSPCPUNAME.

For information on %%SYSPCPUNAME, see "%%SYSPCPUNAME" in Supported Variables.

%%$TIMEOUT

The time, in seconds, to wait for one of the following:

  • completion of the DO TSO or DO KSL statements running in WAIT mode
  • interception of responses to messages after a command was issued in command-response mode

The following formats are possible:

  • For DO COMMAND statements, use the syntax
    DO SET=%%$TIMEOUT=(value1,value2)

    In this syntax

    value1 is the maximum number of seconds to wait for the first message.

    value2 is the maximum number of seconds to wait between the first and the last message.

  • For DO KSL and DO TSO statements, use the syntax
    DO SET=%%$TIMEOUT=value1

    In this syntax, value1 is the maximum number of seconds Control-O waits for completion of the task or command before aborting the task or command.

This variable is supported for historical reasons. For more information, see "Command-Response Mode" in General Information.

%%$WAITKSL

Whether a Control-O rule waits for the KeyStroke OpenAccess (KOA) script to complete so that it can check return codes or Global variables set by the script and proceed accordingly.

Valid values are:

  • YES
  • NO

The value of %%$WAITKSL is automatically reset to NO after the completion of the KOA script.

Example

DO SET=%%$WAITKSL = YES

DO KSL=scriptname arg1 arg2 ... arg10

IF %%$KSLRC EQ# 4

DO SHOUT=...

This variable is supported for historical reasons. For more information, seeDO KSL: Automated Console Action Parameter.

%%$WAITRESP

Whether Control-O retrieves, in the same rule, all messages issued in response to an operator command.

Valid values are:

  • YES
  • NO

The value of %%$WAITRESP is automatically reset to NO after all response messages have been intercepted.

Example

DO SET=%%$WAITRESP = YES

DO COMMAND=D T

This variable is supported for historical reasons. For more information, see DO COMMAND: Automated Console Action Parameter.

%%$WAITTSO

Whether a Control-O rule waits for the completion of the TSO command, CLIST, or REXX procedure so that it can check return codes or Global variables set by the command and proceed accordingly.

Valid values are:

  • YES
  • NO

The value of %%$WAITTSO is automatically reset to NO after the completion of the TSO command, CLIST, or REXX procedure.

Example

DO SET=%%$WAITTSO = YES

DO TSO=...

IF %%$TSORC EQ# 4

DO SHOUT=...

This variable is supported for historical reasons. For more information, see DO TSO: Automated Console Action Parameter.

Parent Topic

System Variables