Parameters

All the parameters described here apply to the PDF and ISPF commands as well as ISPSTART.

Read syntax diagramSkip visual syntax diagramISPSTARTPANEL( panel_name)OPT(ZSTART)OPT(panoptBASICcmd_stack_var_name)ADDPOPCMD( commandparm1parm2)LANG(APLCREX)PGM( program_name)PARM( parameters)ZSTARToptionBASICcmd_stack_var_nameCODEPAGE( codepage)CHARSET( character_set)NEWAPPL( application_id)SHRPROFEXCLPROFSCRNAME( screen_name)TESTTESTXTRACETRACEXNOLOGOLOGO( logo_panel_name)BATSCRW( screen_width)BATSCRD( screen_depth)BDISPMAX( max_number_of_displays)BREDIMAX( max_number_of_redisplays)BDBCSDANISHENGLISHGERMANJAPANESEPORTUGUESPANISHKOREANFRENCHITALIANCHINESETCHINESESSGERMANUPPERENGNESTMACS
where:
panel_name
Start of changeSpecifies the name of the first panel to be displayed. This panel is referred to in this section as the primary option menu.End of change
OPT
Start of changeSpecifies an initial option or an initial command stack variable to be processed by the primary option menu. If you specify an option or an initial command stack variable that is not valid, the primary option menu displays an appropriate error message.End of change
panopt
Start of changeSpecifies an initial option, which should be a valid option on the primary option menu. This causes direct entry to that option without displaying the primary option menu. The primary option menu is processed in nondisplay mode, as though the user had entered the option.

A NULL panopt value, OPT(), can be used to bypass processing of the ZSTART variable. When this is used, the primary option menu is displayed in display mode with no option selected and without executing any options listed in variable ZSTART.

End of change
BASIC
When the default initial command stack variable ZSTART is defined, BASIC can be used to bypass processing of the ZSTART variable. Start of changeWhen this is used, the primary option menu is displayed in display mode with no option selected and without executing any options listed in variable ZSTART.End of change
cmd_stack_var_name
The name of an ISPF profile variable that contains an initial command stack to be processed by ISPF. Start of changeThe specified command stack is processed by ISPF as though it had been entered on the initial display of the primary option menu.End of change The first four characters of the variable value must be "ISPF" followed by the command delimiter character followed by the initial command stack.
Note: The default command delimiter is a semi-colon (;). You can change it in the ISPF settings.
The following example specifies a command stack to have three logical screens created when ISPF starts:
Screen 1 - Data Set List Utility (ISPF option 3.4)
Screen 2 - z/OS® UNIX Directory List Utility (ISPF option 3.17)
Screen 3 - SCLM (ISPF option 10)
The Data Set List Utility is the initial logical screen displayed:

ISPF;3.4;START 3.17;START 10;SWAP 1
When the PANEL parameter is specified and the OPT parameter is not specified, the default cmd_stack_var_name value ZSTART is used. Start of changeIf the ZSTART variable is defined and valid, ISPF executes the command stack contained in the ZSTART variable as though entered on the initial display of the primary option menu. If ISPF cannot retrieve the ZSTART variable or the variable definition is not valid, ISPF displays the primary option menu.End of change

Start of changeTo support an initial command stack being provided in an ISPF variable, ISPF puts the variable name (or "ZSTART DEFAULT" when the default cmd_stack_var_name value ZSTART is used) into the ZCMD variable. Then, the )PROC section of the first primary option menu displayed is executed before the initial display of the panel. The primary option menu must not perform verification of the ZCMD variable in the )PROC section unless the verification allows for the initial command stack variable name (for example, ZSTART) to be stored in ZCMD.End of change

ADDPOP
Specifies that the panel displayed from a SELECT service appears in a pop-up window. An explicit REMPOP is performed when the SELECT PANEL has ended.
command
Specifies a command procedure (CLIST or REXX), an APL2® command, or a TSO command processor that is to be invoked as the first dialog function. For more information about invoking APL2 dialogs, refer to the z/OS ISPF Services Guide.
CLIST or REXX command parameters can be included within the parentheses. For example, the call format would be:
   ISPSTART CMD(MYCLIST parm1 parm2 …)

These parameters are passed to the command procedure. For information about specifying CLIST parameters, see z/OS TSO/E CLISTs. For information about specifying REXX parameters, see z/OS TSO/E REXX User's Guide.

You can type a percent sign (%) preceding the CLIST or REXX procedure name to:
  • Improve performance
  • Prevent ISPF from entering line-display mode when the procedure is started.
    Note: When starting a CLIST or REXX procedure or a program through the SELECT service, a MODE(LINE|FSCR) parameter is available for specifying either line mode or full-screen mode. If you do not specify the mode parameter or do not use the % prefix, ISPF enters line-display mode.
  • Ensure that the command procedure is invoked if ISPF has access to a program function that has the same name as the procedure. If you use the percent sign prefix, ISPF searches only for a procedure with the specified name. However, without the percent sign prefix, ISPF searches first for a program, then for a CLIST or REXX procedure.
On extended data stream terminals, using the percent sign causes the keyboard to remain in a locked condition. To avoid this condition, the CLIST or REXX procedure can issue output line I/O before issuing a READ.
LANG(APL|CREX)
Specifies special language invocations. LANG(APL) specifies to start the command specified by the CMD keyword, and to start an APL2 environment. LANG(CREX) specifies that the command specified by the CMD keyword is a REXX exec that has been compiled and link-edited into a LOAD module and that a CLIST/REXX function pool is to be used. LANG(CREX) is optional if the compiled REXX has been link-edited to include any of the stubs EAGSTCE, EAGSTCPP, or EAGSTMP.
program_name
Specifies the name of a program that is to be invoked as the first dialog function. In PL/I, it must be a MAIN procedure. This parameter must specify the name of a load module that is accessible by use of the LINK macro.

However, if the program dialog consists of multiple tasks and if any of the subtasks use ISPF services, the CMD keyword, not the PGM keyword, must be used. Dialog developers should avoid using prefixes ISP and ISR, the ISPF component codes, in naming dialog functions. Special linkage conventions, intended only for internal ISPF use, are used to invoke programs named ISPxxxxx and ISRxxxxx.

parameters
Specifies input parameters to be passed to the program. The program should not attempt to modify these parameters.

The parameters within the parentheses are passed as a single character string, preceded by a half-word containing the length of the character string, in binary. (The length value does not include itself.) This convention is the same as that for passing parameters by use of the PARM= keyword on a JCL EXEC statement.

Parameters on the ISPSTART command to be passed to a PL/I program are coded in the standard way:
XXX:  PROC (PARM) OPTIONS(MAIN);
      DCL PARM CHAR (nnn) VAR;
 

If the value of the PARM field is to be used as an ISPF dialog variable, it must be assigned to a fixed character string because the VDEFINE service cannot handle varying length PL/I strings. In PL/I the first character of the PARM field must be a slash (/), as PL/I assumes that any value before the slash is a runtime option.

option|BASIC|cmd_stack_var_name
Start of changeSpecifies an initial option or an initial command stack variable to be processed by the default primary option menu. If you specify an option or an initial command stack variable that is not valid, the default primary option menu displays an appropriate error message.End of change
option
Start of changeSpecifies an initial option, which should be a valid option on the default primary option menu. This causes direct entry to that option without displaying the default primary option menu. The default primary option menu is processed in nondisplay mode, as though the user had entered the option.End of change
BASIC
When the default initial command stack variable ZSTART is defined, BASIC can be used to bypass processing of the ZSTART variable. Start of changeWhen this is used, the default primary option menu is displayed in display mode with no option selected and without executing any options listed in variable ZSTART.End of change
cmd_stack_var_name
The name of an ISPF profile variable that contains an initial command stack to be processed by ISPF. Start of changeThe specified command stack is processed by ISPF as though it had been entered on the initial display of the default primary option menu.End of change The first four characters of the variable value must be "ISPF" followed by the command delimiter character followed by the initial command stack.
Note: The default command delimiter is a semi-colon (;). You can change it in the ISPF settings.
The following example specifies a command stack to have three logical screens created when ISPF starts:
Screen 1 - Data Set List Utility (ISPF option 3.4)
Screen 2 - z/OS UNIX Directory List Utility (ISPF option 3.17)
Screen 3 - SCLM (ISPF option 10)
The Data Set List Utility is the initial logical screen displayed:

ISPF;3.4;START 3.17;START 10;SWAP 1
When none of these three options (option, BASIC, and cmd_stack_var_name) is specified, the default cmd_stack_var_name value ZSTART is used. Start of changeIf the ZSTART variable is defined and valid, ISPF executes the command stack contained in the ZSTART variable as though entered on the default primary option menu. If ISPF cannot retrieve the ZSTART variable or the variable definition is not valid, ISPF displays the default primary option menu.End of change

Start of changeTo support an initial command stack being provided in an ISPF variable, ISPF puts the variable name (or "ZSTART DEFAULT" when the default cmd_stack_var_name value ZSTART is used) into the ZCMD variable. Then, the )PROC section of the default primary option menu is executed before the initial display of the panel. The default primary option menu must not perform verification of the ZCMD variable in the )PROC section unless the verification allows for the initial command stack variable name (for example, ZSTART) to be stored in ZCMD.End of change

CODEPAGE(codepage) CHARSET(character_set)

Start of changeIfEnd of change your terminal or emulator does not support code pages, these values are used as the host code page and character set. Otherwise, these values are ignored.

NEWAPPL(application_id)
Specifies a 1- to 4-character code that identifies the application that is being invoked. The code is to be prefixed to the user and edit profile names or to the command table associated with the application, as follows:
User Profile   -  xxxxPROF
Edit Profile   -  xxxxEDIT
Command Table  -  xxxxCMDS
where xxxx is the application_id. If the application_id is omitted, or if the NEWAPPL keyword is omitted, the application_id defaults to ISP.
SHRPROF
Specifies that ISPF is to enable the multi-logon profile sharing support. The parameter is optional.
EXCLPROF
Specifies that ISPF is to disable the multi-logon profile sharing support. The parameter is optional
SCRNAME(screen_name)
Specifies a screen name to be used with the SWAP command and the ISPF task list. The name can be from 2 to 8 characters in length, must satisfy the rules for a member name, but cannot be LIST, PREV, or NEXT.
TEST
Specifies that ISPF is to be operated in TEST mode, described under ISPF test and trace modes.
TESTX
Specifies that ISPF is to be operated in extended TEST mode, described under ISPF test and trace modes.
TRACE
Specifies that ISPF is to be operated in TRACE mode, described under ISPF trace modes.
TRACEX
Specifies that ISPF is to be operated in extended TRACE mode, described under ISPF trace modes.
LOGO(logo_panel_name)
Specifies that ISPF displays the named panel before invoking the specified dialog object. Subsequent SELECT service requests that identify a LOGO panel will not result in the indicated panel being displayed. This includes a repeat of the first SELECT as a result of a split-screen request or a logical screen restart following a severe dialog error.

Applications can choose to display their own LOGO panel directly. These applications can determine whether the user specified the NOLOGO keyword on ISPSTART by retrieving the ISPF system variable ZLOGO. Applications that choose to display their own LOGO panel are responsible for controlling that display operation during split-screen operations and logical-screen restart situations.

NOLOGO
Specifies that ISPF is to bypass the display of the message pop-up window containing the product title and copyright statement.
screen_width
For batch mode, specifies screen width in character positions. The default value is 80. This parameter is ignored when not running in batch mode.

All screen sizes from 24 x 80 to 62 x 160 are valid.

screen_depth
For batch mode, specifies screen depth in lines. The default value is 32. This parameter is ignored when not running in batch mode.
max_number_of_displays
For batch mode, specifies the maximum number of displays that can occur during a session. This number includes the total of all SELECT PANEL calls, plus all DISPLAY and TBDISPL calls (with or without panel name). This number does not include redisplays related to the .MSG control variable. The largest number that can be specified is 999999999. The batch default value is 100. This parameter is ignored when not running in batch mode.
max_number_of_redisplays
For batch mode, specifies the maximum number of redisplays allowed for a .MSG-redisplay loop. The largest number that can be specified is 255. The batch default value is 2. This parameter is ignored when not running in batch mode.
BDBCS
For batch mode, specifies that Double-Byte Character Set (DBCS) terminal support is required. This parameter is ignored when not running in batch mode.
DANISH, ENGLISH, GERMAN, JAPANESE, PORTUGUE, SPANISH, KOREAN, FRENCH, ITALIAN, CHINESET, CHINESES, SGERMAN, UPPERENG
Specifies the national language that is to override the default language for this session. The JAPANESE keyword specifies that the KANJI character set is to be used. The CHINESET keyword stands for Traditional Chinese, CHINESES stands for Simplified Chinese, and SGERMAN stands for Swiss-German. The UPPERENG keyword specifies that the uppercase English character set is to be used. For information about establishing the default session language, refer to z/OS ISPF Planning and Customizing.
Note:
  1. Attempting to run a dialog under a session language other than that for which it was intended may produce unexpected results.
  2. When the Korean, French, Italian, Traditional Chinese, Simplified Chinese, Spanish, Brazilian-Portuguese, Danish, German or Swiss-German session language is specified, its respective literal module is used. However, the ISPF product panels and messages are displayed in English.
NESTMACS
Specifies that all REXX and CLIST edit macros invoked during the ISPF session are to run as nested commands, allowing output from these macros to be trapped using either the REXX OUTTRAP function or the CLIST &SYSOUTTRAP control variable.