KEYL (Key List)

The KEYL tag defines a key mapping list where keys can be mapped to commands.

Syntax


>>-<KEYL--NAME=key-list-name--+----------------------+---------->
                              '-HELP=help-panel-name-'   

>--+--------------------+--+-----------------------+------------>
   |         .-UPDATE-. |  '-APPLID=application-id-'   
   '-ACTION=-+-DELETE-+-'                              

>-->--</KEYL>--------------------------------------------------><

Parameters

NAME=key-list-name

This attribute specifies a name for a key list. The HELP, HELPDEF, PANEL, and PANDEF tag refer to the key-list-name.

The key-list-name must follow the standard naming convention described in Rules for variable names.

The name of the keylist table is xxxxKEYS where xxxx represents the application identifier provided to ISPDTLC with the KEYLAPPL keyword when invoked, in the "Keylist Application ID" field on the invocation panel, or with the APPLID attribute of this tag.

The key-list-name is used to identify the entry in the keylist table. For example, if NAME=CONVLIST and KEYLAPPL=XYZ, then CONVLIST is written as a table entry to member XYZKEYS in the table library partitioned data set.

Keylists are updated using ISPF table services. Input is obtained from the ISPTLIB DDname allocation and output is written to the ISPTABL DDname allocation. See the description of how to allocate libraries before starting ISPF in the z/OS ISPF User's Guide Vol I for more information about the use of ISPTLIB and ISPTABL.

See Using the conversion utility for more information on invocation parameters for the conversion utility.

HELP=help-panel-name

This attribute names a help panel that displays when the user requests help on a keylist display.

If a user requests help for a keylist and no help has been defined by the KEYL tag, the ZKEYHELP variable is checked for a help panel name. If the application has not set ZKEYHELP, a message that keyshelp is not available is displayed.

The help-panel-name must follow the standard naming convention described in Rules for variable names.

See HELP (Help Panel) for information about creating help panels.

ACTION=UPDATE | DELETE

This attribute specifies the type of action requested for the keylist specified by key-list-name.

When ACTION=DELETE is specified, it is not necessary to nest any KEYI tags within the KEYL tag definition.

APPLID=application-id

This attribute provides the application ID used to build the keylist name. The application-id overrides the KEYLAPPL invocation option value.

Comments

The KEYL tag defines a key mapping list where keys can be mapped to commands.

To display these keys on a panel requires that the PANEL or PANDEF tag refer to the key-list-name. ISPF uses the specified key mapping list when building the display dependent on the user's setting by the FKA command. For more information about displaying and formatting of the function key area, refer to the appropriate section in the z/OS ISPF Dialog Developer's Guide and Reference.

Restrictions

The KEYL tag requires an end tag.
The KEYL tag cannot be nested within any other tag definition.
When ACTION=UPDATE is specified (or defaulted), at least one KEYI tag must be included in the keylist definition.

Processing

Table 1. The tags you can code within a KEYL definition
Tag	Reference	Usage	Required
KEYI	KEYI (Key Item)	Multiple	No

Examples

Here is source file markup that contains a key mapping list and an application panel that refers to the key mapping list. Figure 1 shows the formatted application panel with the displayed keys.

<!DOCTYPE DM SYSTEM(
  <!entity sampvar1 system>
  <!entity sampabc system>
  <!entity sampbody system>)>
&sampvar1;

<KEYL NAME=keyltbl>
  <KEYI KEY=f1  CMD=help     FKA=yes>Help
  <KEYI KEY=f2  CMD=split    FKA=yes>Split
  <KEYI KEY=f3  CMD=exit     FKA=yes>Exit
  <KEYI KEY=f5  CMD=search   FKA=no>Display
  <KEYI KEY=f6  CMD=keyhlp   FKA=no>Keyshelp
  <KEYI KEY=f7  CMD=backward FKA=yes>Backward
  <KEYI KEY=f8  CMD=forward  FKA=yes>Forward
  <KEYI KEY=f9  CMD=swap     FKA=yes>Swap
  <KEYI KEY=f10 CMD=actions  FKA=no>Actions
  <KEYI KEY=f12 CMD=cancel   FKA=yes>Cancel
</KEYL>

<PANEL NAME=keyl KEYLIST=keylxmp>Library Card Registration
<AB>
&sampabc;
</AB>
&sampbody;
</PANEL>

Figure 1. Function keys

   File  Search  Help
 --------------------------------------------------------------------------
                         Library Card Registration

 Type in patron's name and card number if applicable.

 Then select an action bar choice.

 Date . . . :
 Card No. . . _______  (A 7-digit number)
 Name . . . . _________________________  (Last, First, M.I.)
 Address  . . _________________________

 Choose one of the following           Check valid branches
 __  1.  New                           _  North Branch
     2.  Renewal                       _  South Branch
     3.  Replacement                   _  East Branch
                                       _  West Branch

 Enter a command ===> ______________________________________________________
  F1=Help        F2=Split       F3=Exit        F6=KEYSHELP    F9=Swap
 F12=Cancel