Contents of a panel installation file

The following figure shows the contents of a panel installation file.

Figure 1. Format of a panel installation file

*Application Manager INSTALLATION FILE
*SYSTEM             system name
*PANEL
*PANEL_NAME         panel name
*LANGUAGE           language
*KEYWORD            keyword
*PANEL_TITLE        panel title
*PRIMARY_PANEL      Y/N
*MODEL_ISPF_PANEL   panel ID
*INVOKING_PANEL     panel-name
 panel-appl-language
 selection-id
**************************************************************
***********  Only one of the following two entries can be used.
**************************************************************
*AFTER              application-name
 appl-language

   OR

*POSITION number
*----------
*ADMIN_DESC         administrator description
*USER_DESC_1        first line of user description
*USER_DESC_2        second line of user description
*STARTUP_FUNCTION   start-up function name
*TERM_FUNCTION      termination function name
*OPTION             option ID
 option-name
 language
*HELP_TEXT
 first line of help text
⋮
 last line of help text

A description of each panel-installation-file entry follows:

*Application Manager INSTALLATION FILE

identifies the file as an installation file. Application Manager does not load the installation file unless the first entry is *Application Manager INSTALLATION FILE.

*SYSTEM system name

identifies the system on which the installation file is to be loaded and run. system name contains the characters MVS™ TSO/E. Application Manager does not load the installation file unless the second entry is *SYSTEM MVS TSO/E.

*PANEL

identifies the type of installation file, in this case panel. Application Manager does not load the installation file unless the third entry is *PANEL, *FUNCTION, or *ENVIRONMENT.

*PANEL_NAME panel name

identifies the panel installation file. panel name consists of 1-12 characters, the first of which must be alphabetic (A-Z) or one of the special characters ($,#,@). The remaining characters can be any combination of alphabetic, numeric (0-9), or one of the special characters ($,#,@). Application Manager requires a panel name when defining a panel.

*LANGUAGE language

specifies the language used on the panel. language can be up to 8 characters in length. The QAMLANGL variable defined in the ICQENVIRON application contains alist of the languages that are valid in ISPF. The non-English versions of the Information Center Facility are available after the English version and must be ordered separately. Therefore, non-English versions of the Information Center Facility may not be available at your installation.

Your installation can define a default value for LANGUAGE using the ISPF ZLANG variable.If the installation file does not contain an entry for LANGUAGE, Application Manager uses the value in ZLANG. For information about ZLANG, see .

*KEYWORD keyword

provides a short descriptive name for a selectable panel. The keyword is displayed on menus and users can type it on the Option line to select the associated panel. keyword consists of 1-11 characters, the first of which must be alphabetic (A-Z). The remaining characters can be any combination of alphabetic, numeric (0-9), or one of the special characters ($,#,@). Application Manager requires a keyword when defining a panel.

*PANEL_TITLE panel title

specifies the title that appears at the top of the panel. panel title can be up to 50 characters in length. Application Manager requires panel title when defining a panel.

*PRIMARY_PANEL Y/N

indicates whether the panel is a primary panel.A primary panel is the starting point for selecting options and the panel to which you return after issuing the ISPF RETURN command. ISPF uses the primary panel as the base for the jump function.The jump function enables you to go to any option on the most recently displayed primary panel by typing its option ID preceded by an equal sign in any field on a subsequent panel.

Set PRIMARY_PANEL to Y to indicate that the panel is a primary panel or N to indicate that it is not a primary panel. If the installation file does not contain *PRIMARY_PANEL, Application Manager assumes that the panel is not a primary panel.

*MODEL_ISPF_PANEL panel ID

specifies the panel ID of an existing ISPF panel to use as a model for a menu.The ISPF panel acts as a framework upon which to place the directions, options, keywords, and descriptions. If the installation file does not contain *MODEL_ISPF_PANEL, Application Manager assumes that the model panel is ICQAMED1.

*INVOKING_PANEL panel name

panel-appl-language

selection-id

specifies that the application is to automatically become an option on an existing panel.

panel name follows INVOKING_PANEL in the first record of an entry and specifies the name of an existing panel on which to install the application.

panel-appl-language appears in the next record, and specifies the language of the existing panel. The language of the panel must be specified because an installation can have two panels with the same name, but in different languages.

selection-id appears on the invoking panel for the installed application in the next record of the entry. selection-id specifies the selection character(s) that is to appear on the invoking panel for the installed application.

The INVOKING_PANEL entry can appear as many times as desired in an installation file, causing the installed application to become an option on several panels. Each INVOKING_PANEL entry must be accompanied by either an AFTER entry or a POSITION entry.

*AFTER application name

appl-language

specifies that the panel is to be placed as an option after an existing option on the invoking panel.

application name follows AFTER in the first record of an entry and specifies the name of an existing application.

appl-language appears in the next record and specifies the language of the existing application. This entry is valid only if it is immediately preceded by an INVOKING_PANEL entry.

*POSITION number

specifies the numeric position, among the existing options, in which to place the panel being installed.

A specified POSITION argument causes existing options equal to and greater than the number specified to be advanced (moved down) one position. If the POSITION argument is greater than the number of existing options, the panel being installed is placed last on the invoking panel. This entry is valid only if immediately preceded by an INVOKING_PANEL entry.

*ADMIN_DESC administrator description

provides a short description of the application that administrators see when applications are listed. administrator description can be up to 38 characters in length. Application Manager requires the administrator description when defining a panel.

*USER_DESC_1 first line of user description

*USER_DESC_2 second line of user description

provides the first and, if needed, the second line of the description of an application that appears after the keyword on a menu that the users see. Each line can be up to 59 characters in length. Application Manager requires the first line of user description when defining a panel.

*STARTUP_FUNCTION startup function name

provides the name of a function to be invoked before the panel is displayed. startup function name can be up to 12 characters in length.

*TERM_FUNCTION termination function name

provides the name of a function to be invoked when the user presses the END PF key after the panel is displayed. termination function name can be up to 12 characters in length.

*OPTION option ID

option name

language

identifies each option that users can select from the panel being added.

option ID, which follows OPTION in the first record of an entry, is displayed on the menu being defined. Users can type option ID on the Option line of the panel to select the associated function or panel. option ID contains 1-3 characters and can be any combination of alphabetic (A-Z), numeric (0-9), or one of the special characters ($,#,@).

option name, which appears in the next record, specifies the function or panel to be invoked when a user selects this option. option name can be up to 12 characters long.

language, which appears in the next record of the entry, specifies the language of the function or panel. language can be up to 8 characters long.

*HELP_TEXT

first line of help text

⋮

last line of help text

provides a short description of the panel being added. The text is part of the help information that users see when they choose the DESCRIBE option for a panel that contains this panel as an option. Each line of the help text can be up to 58 characters in length.