Commands table syntax and parameters
This topic explains the syntax for entries in the commands table.
The syntax is as follows:
$ACTCMD commandName,#commandEquivalent,parameterName=value, X
Commands table variables
Variable | Description |
|---|---|
commandName | Name of the command that appears in the Commands List panel |
objectType | Object’s two-, three-, or four-character abbreviation The LIST command specifies an object type, such as LIST AL. |
expandedName | Alternate or full name of the command (for example, ALIASES) |
commandEquivalent | Characters or numbers that represent a command For example, #COL or 081 can represent the COLSTATS command. For a list of valid characters and numbers, see the $ACTCEQU member in the HLQ.BMCMAC library. |
parameterName | Parameter (for example, OBJECTS) that you use to define the Catalog Manager commands For a list of valid parameters, see the $ACTCMD member in the HLQ.BMCMAC library. Also, some of the parameters in the member are described in this section. |
value | Valid value for the parameter |
You can use the following parameters with $ACTCMD:
&CLIST | Indicates whether the command is a CLIST or REXX (YES/NO). If &CLIST=YES, the product issues the command as SELECT CMD(&LOAD). The default value is NO. |
|---|---|
&CMD | Specifies the command verb, should be the first parameter of the macro, and must be inserted in the table in alphabetical order. The maximum length is 16 bytes, and the command verb must be unique to the other command names. Embedded spaces are not allowed. |
&DB2MAX | Specifies the maximum (latest) version of Db2 for which the command is valid. |
&DB2MIN | Specifies the minimum (earliest) version of Db2 for which the command is valid. |
&HELP | Specifies which Help panel to display when the command is selected. The default is ACTHCMDS. |
&LOAD | Specifies the user load module or CLIST for the command. &LOAD is the entry point of the command processor. |
&LOG | Indicates whether any Catalog Manager commands, DML commands, and Db2 TERM UTILITY commands are recorded in the Session Log. You must issue log requests from the program to use this feature. Catalog Manager ships with ACTCOMND session logging enabled for all commands that support logging. If &LOG=NO, the log requests are ignored. The default value is NO. |
&LSTO | Indicates whether the command can be entered only against list items. If the value of &LSTO=YES, users must enter the command on the Command line. The default value is NO. |
&NLIST | Indicates whether to hide the command or to display it in the list that the COMMANDS command produces. &NLIST=YES hides the command from users. The default value is NO. |
&NOSERVER | Indicates whether the product can execute the command on the server that is in use. If &NOSERVER=YES, the product cannot use the command when you are connected to one Db2 subsystem and attached to another. The default value is NO. |
&NUM | Specifies the command ID number. User-written commands should be assigned command numbers greater than 1000. |
&OBJECTS | Lists the two-character codes for the object types to which the command applies. See the tables in Selecting-an-Action to show the objects that the list can include. Enclose the object list in parentheses and use a plus symbol (+) to separate each two-letter code. |
&PARSE | Indicates whether the command processor passes the command text without parsing it. If &PARSE=YES (the default), the text is scanned for an object type as the first token. If an object type is found, the field exccobjc is set to the type found. |
&PLAN | Specifies the plan to be opened and closed by Catalog Manager when the command processor is called. If no plan is involved or the command processor opens and closes its own plans, you can set this parameter to NO (the default). |
&WFEK | This parameter indicates whether this command is a Wait-for-Enter command. A Wait-for-Enter command is one that you can specify for multiple items in a list so that Catalog Manager can process them as a group when you press the Enter key. If &WFEK=YES, all objects found with the repeat function (equal sign) or the ALL parameter are added to the object list and one call is made to the user program. If &WFEK=NO (the default), the REPEAT function is not allowed, and Catalog Manager displays individual user prompts for each specified object. For CLISTs, use WFEK= NO. |
Related topic