z/OS TSO/E Customization
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Contents of an environment installation file

z/OS TSO/E Customization
SA32-0976-00

The following figure shows the contents of an environment installation file.

Figure 1. Format of an environment installation file
*Application Manager INSTALLATION FILE
*SYSTEM             system-name
*ENVIRONMENT
*ENVIRONMENT_NAME   environment-name
*LANGUAGE           language
*ENVIRONMENT_DESC   environment-description
*ISPF_APPL_ID       ISPF-application-id
*VARIABLE           variable-name
 description
 value line 1
⋮
 value line n
*LIBRARY            ddname     type
 data set 1
⋮
 data set n
*INIT_COMMAND
 initialization command line 1
⋮
 initialization command line n
*INVOCATION_COMMAND
 invocation command line 1
⋮
 invocation command line n
*TERM_COMMAND
 termination command line 1
⋮
 termination command line n
A description of each environment-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.
*ENVIRONMENT
identifies the type of installation file, in this case environment. Application Manager does not load the installation file unless the third entry is *PANEL, *FUNCTION, or *ENVIRONMENT.
*ENVIRONMENT_NAME environment name
identifies the environment installation file. environment 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 an environment name when defining an environment.
*LANGUAGE language
specifies the language used in the environment. 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 .

*ENVIRONMENT_DESC environment description
provides a short description of the application that administrators see when applications are listed. environment description can be up to 38 characters in length. Application Manager requires environment description when defining an environment.
ISPF_APPL_ID ISPF application ID
specifies the prefix identifier that ISPF is to use for this environment. ISPF application ID consists of 1-4 characters, the first of which must be alphabetic. The remaining characters can by any combination of alphabetic (A-Z), numeric (0-9), or one of the special characters ($,#,@).
*VARIABLE variable name
  description
  value line 1
  value line n
identifies variables that one or more functions require.

The variable name identifies the variable and can be up to 8 characters in length.

The variable description provides a short description of the variable and can be up to 64 characters in length.

value line 1 through value line n specify the value of the variable. Application Manager appends the information from data columns 2 through 72 (fixed format) of each line to form the value, which can be up to 923 characters in length. If the records that contain the data have line numbers, they are ignored. You cannot define variables in terms of other variables.

Considerations for DBCS Data: Because double-byte character set (DBCS) data takes up from 2 to 4 bytes for every character, the installation may need to add place holder bytes at the end of the variable value line. Application Manager recognizes X'00' as the place holder value.

For example, to change a blank to X'00', enter on the COMMAND line:
c ' ' x'00'

Place the cursor on the character you want to change (usually between columns 2 and 72) and press the Enter key.

*LIBRARY ddname type
  data set 1
  data set n
identifies the data set(s) that is to be allocated under the specified ddname. The order in which you specify the data set names in the subsequent records determines the concatenation order.

ddname specifies the ddname under which the data sets of the library are concatenated. ddname can be up to 8 characters in length.

type specifies the library type. Valid values are:
ISPF
ISPF files
CLIST
CLIST files
EXEC
REXX files
INPUT
Any other type of input file During the process of allocation, if an INPUT type library has no current allocations, its ddname and list of data sets will be allocated. The allocation will specify SHR, which allows shared access to the library and data sets.If another application is invoked using the same INPUT library, the allocation is performed only when the list of data sets for both applications match.

When the library type is INPUT, and the data set information does not match, the second application is not invoked. An error message appears stating that the requested function cannot be invoked because the required files are in use.

OUTPUT
Any other type of output file Only one data set can be specified for the OUTPUT type library. The allocation will specify OLD, which allowsexclusive access to the library and data set. If an OUTPUT type library is currently allocated, the function cannot be invoked because the required files are in use. If OUTPUT is entered and more than one data set is specified, an error message appears.

data set 1 through data set n specify the data sets in the library. Each can be up to 46 characters in length. If you specify the high-level qualifier as part of the data set name, enclose the data set name in single quotation marks. If you do not enclose the data set name in quotes, the user's TSO/E prefix is used as the high-level qualifier.

*INIT_COMMAND
  initialization command line 1
  initialization command line n
identifies the panels, commands, or programs that execute before the associated function is invoked. The INIT_COMMAND uses the ISPF SELECT service to invoke one of the following:
  • PANEL(panel name) OPT(option)
  • CMD(command)
  • PGM(program name) PARM(parameter(s))
initialization command line 1 through initialization command line n (where n=1, 2, or 3) form the INIT_COMMAND. Application Manager appends data from columns 2 through 72 (fixed format) or from columns 10 through 80 (variable format) to form the command, which can be up to 213 characters in length. For information about the SELECT service, see .
*INVOCATION_COMMAND
  invocation command line 1
  invocation command line n
identifies the panels, commands, or programs that invoke the associated function. If a function does not have an INVOCATION_COMMAND, its environment must have one. The INVOCATION_COMMAND uses the ISPF SELECT service to invoke one of the following:
  • PANEL(panel name) OPT(option)
  • CMD(command)
  • PGM(program name) PARM(parameter(s))
invocation command line 1 through invocation command line n (where n=1, 2, or 3) form the INVOCATION_COMMAND. Application Manager appends the data from columns 2 through 72 (fixed format) or from columns 10 through 80 (variable format) of each line to form the command, which can be up to 213 characters in length. For information about the SELECT service, see .
*TERM_COMMAND
  termination command line 1
  termination command line n
identifies the panels, commands, or programs that execute after the associated function terminates. The TERM_COMMAND uses the ISPF SELECT service to invoke one of the following:
  • PANEL(panel name) OPT(option)
  • CMD(command)
  • PGM(program name) PARM(parameter(s))
termination command line 1 through termination command line n (where n=1, 2, or 3) form the TERM_COMMAND. Application Manager appends the data from columns 2 through 72 (fixed format) or from columns 10 through 80 (variable format) to form the command, which can be up to 213 characters in length. For information about the SELECT service, see .

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014