SUBMENU Statement

Managing Sessions Using CA Automation Point Windows › Customizing Menus › Menu Control Statements › SUBMENU Statement

SUBMENU Statement

The SUBMENU keyword defines the items to appear in the drop-down list of menu options. Each item can be defined to perform either one of the following tasks:

Keyboard operation: Standard terminal operations and CA Automation Point desktop operations that can be initiated from the keyboard. For more information, see the appendix "Customizing Special CA Automation Point Files."
AXC command processor: CA Automation Point built-in command processors that perform automation-related tasks such as, issuing z/OS commands to an automated session or initiating a REXX program. For more information, see ADDRESS AXC Commands in the Command and Keyword Reference Guide.

The item also specifies the descriptive title for the menu option as well as an optional hot key that may also be used to invoke the menu option. Select the menu option to invoke the keystroke operation or AXC command string specified.

SUBMENU= SubmenuName, [NAME=(SubmenuTitle[, HelpKey] ) ,]
ITEM=('ItemTitle', KEY(KeyOperation) | XCCMD(AXCCommandString)
[ , ItemComment | TYPE(REM | PM) ] ) [, 
ITEM=('ItemTitle', KEY(KeyOperation) | XCCMD(AXCCommandString)
[ , ItemComment | TYPE(REM | PM) ] )  ]    [,
…
ITEM=('ItemTitle', KEY(KeyOperation) | XCCMD(AXCCommandString)
[ , ItemComment | TYPE(REM | PM) ] )  ]

SubmenuName

Internal name assigned to the submenu.

SubmenuTitle

(Optional) External submenu name or title that is displayed on the menu bar. A SubmenuTitle must be specified to define a submenu not previously defined either by CA Automation Point in the axc2p.mnu file or by the user in the user.mnu file.

(Optional) Submenu hot key: The SubmenuTitle text can also be used to specify a hot key. To assign a hot key to a submenu, insert a tilde character (~) before any letter in the SubmenuTitle text. The hot key must be unique within the menu.

HelpKey

(Optional) This option applies only to versions of CA Automation Point running in a non-Windows environment. CA Automation Point disregards this option when running in a Windows environment.

ItemTitle

Descriptive text for the menu option that displays in the drop-down list of menu options. The text must not exceed 31 characters.

(Optional) Menu option hot key: The ItemTitle text can also be used to specify a hot key. A hot key executes a menu option if you press it while viewing the menu containing that option. To assign a hot key to a menu option, insert a tilde character (~) before any letter in the ItemTitle text. The hot key must be unique within the submenu.

KEY(KeyOperation)

Invokes the key operation specified by KeyOperation keyword and the CA Automation Point keyboard parameter file. See "Customizing Special CA Automation Point Files" for a list of valid key operation keywords and their descriptions.

XCCMD( 'AXCCommandString ')

Issues the AXC command specified by AXCCommandString.

Note: &FOCUS_WIN is a special variable that can be referenced in the XCCMD statement that contains the name of the window from which you selected the menu option.

ItemComment

(Optional) Additional text that displays to the right of the ItemTitle in the drop-down list of menu options. This text may be used to specify the hot key for the menu option if it exists.

TYPE

(Optional) The TYPE keyword is used to indicate where the menu option is to be displayed. If the TYPE keyword is not specified, then the menu option is displayed in both the CA Automation Point desktop and Remote Viewer windows.

PM: Displays this menu option only in menus that appear on the CA Automation Point desktop.
REM: Displays this menu option only in menus that appear on Remote Viewer windows.

Notes:

Place commas after each line in the statement except the last one. See the examples of SUBMENU statements.
To enable the specified hot keys from the CA Automation Point desktop, press the Alt key to display hot key submenu indicators for the selected window. The hot key for the submenu will be underscored in the menu bar. Press any hot key and the associated drop down list of menu options displays. Hot keys for any of the menu options will also be underscored in the drop-down list. Press hot key designated for a menu option to execute.

Example 1:

The following set of SUBMENU statements specifies each submenu for the Merged Msg window.

SUBMENU  =  action, NAME  =  (  ~Action, help_window ),
   ITEM  =  (  '~Open remote connection',    KEY(rem_conbox),                 TYPE(REM)),
   ITEM  =  (  '~Refresh automation rules',  XCCMD('REXX "loadrules.rex"') ),
   ITEM  =  (  'Save desktop ~layout',       KEY(screen_save),                TYPE(PM) ),
   ITEM  =  (  'New ~host log',              KEY(new_hostlog) ),
   ITEM  =  (  'New AP ~msg log',            KEY(new_xclog) ),
   ITEM  =  (  '~Dump screen to SCREEN.OUT', KEY(screen_dump) ),
   ITEM  =  (  '~Shutdown Automation Point', KEY(kill_xc) )

SUBMENU  =  window, NAME  =  (  ~Window, help_window ),
   ITEM  =  (  '~Jump to window',      KEY(jump) ),
   ITEM  =  (  '~Next window',         KEY(win_next),          Alt+J),
   ITEM  =  (  '~Increase font',       KEY(font_larger),       Ctrl+right ),
   ITEM  =  (  '~Decrease font',       KEY(font_smaller),      Ctrl+left  ),
   ITEM  =  (  '~Select font',         KEY(font_dialog) ),
   ITEM  =  (  '~Close this window',   KEY(quit) )

SUBMENU  =  edit, NAME  =  (  Edit, help_3270 ),
   ITEM  =  (  'Copy',  KEY(copy) ) ,
   ITEM  =  (  'Paste', KEY(paste) )

SUBMENU  =  cmdbox,  NAME  =  (  ~Cmdarea, help_3270 ),
   ITEM  =  (  '~Command recall'             , KEY(up)               , Up       ),
   ITEM  =  (  'C~lear command line'         , KEY(esc)              , Esc     ),
   ITEM  =  (  '~Next session'               , KEY(next)             , Alt+N      ),
   ITEM  =  ( '~Enter command to session'    , KEY(cmd_host)             ),
   ITEM  =  ( 'Sta~rt REXX program or script'   , KEY(execute)           ),
   ITEM  =  ( 'St~op REXX program'              , KEY(cancel_rexx)        ),
   ITEM  =  (  '~Pause/restart automation'   , KEY(pause)                       )

SUBMENU  =  help, NAME  =  (  ~Help, help_help ),
   ITEM  =  (  'A~P Help'             , KEY(xc_msg_help)                          ),
   ITEM  =  (  '~About Automation Point'      , KEY(about)                    )

Example 2:

The following SUBMENU statement specifies a menu option that enters a command to a session. This example uses the slash (/) character as an alternate delimiter in the AXC command string because the command string contains an embedded single quote.

SUBMENU  =  AS4aid, NAME  =  (  ~Aid, help_3270 ),
   ITEM  =  ('Display status', XCCMD('SESSCMD /dspstat ALL/ Session(as400rul)') )

Example 3:

The following SUBMENU statement specifies a menu option that will start a REXX program. This example uses the double quote (") character as an alternate delimiter in the AXC command because the command string contains an embedded single quote.

SUBMENU  =  action_opsmsg, NAME  =  ( ~Action, help_window ),
   ITEM  =  ( '~Refresh automation rules', XCCMD('REXX "loadrules.rex"') )

Example 4:

The following SUBMENU statement specifies hot keys for the submenu, 'Window', and its menu options.

SUBMENU  =  window, NAME  =  (  ~Window, help_window ),
   ITEM  =  (  '~Jump to window',      KEY(jump) ),
   ITEM  =  (  '~Next window',         KEY(win_next),          Alt+J),
   ITEM  =  (  '~Increase font',       KEY(font_larger),       Ctrl+right ),
   ITEM  =  (  '~Decrease font',       KEY(font_smaller),      Ctrl+left  ),
   ITEM  =  (  '~Select font',         KEY(font_dialog) ),
   ITEM  =  (  '~Close this window',   KEY(quit) )

Hot key specified for the 'Window' submenu is W. Hot key specified for the 'Next window' function is N. Press the Alt key to enable the hot keys. Then press W to display the menu options for the 'Window' submenu. Press N to select the 'Next window' menu option.