z/OS ISPF Dialog Tag Language Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Conversion utility syntax

z/OS ISPF Dialog Tag Language Guide and Reference
SC19-3620-00

This topic provides an alternative way to invoke the conversion utility. This alternative way provides compatibility with previous ISPDTLC releases, and allows you to issue multiple calls from a user-specified EXEC file. To read the conversion utility syntax, see How to read the syntax diagrams for more information.

You can view the allowable syntax and a description of the options by entering this command on the ISPF command line:
   ISPDTLC ?

This command causes the general help panel to be displayed. The first line of information contains the ISPDTLC version, APAR, and PTF numbers.

This diagram shows the conversion utility syntax:
Read syntax diagramSkip visual syntax diagram
                             .-REPLACE---.  .-SCREEN-.   
>>-ISPDTLC source-filespec(--+-----------+--+--------+---------->
                             '-NOREPLACE-'  '-DISK---'   

   .-NODBCS-.                                 .-NOPANEL-.   
>--+--------+--+--------+--+---------------+--+---------+------->
   '-DBCS---'  +-NOKANA-+  '-KEYLAPPL=xxxx-'  '-PANEL---'   
               '-KANA---'                                   

   .-NOMSGSUPP-.  .-NOCUASUPP-.  .-PREP---.  .-CUAATTR---.   
>--+-----------+--+-----------+--+--------+--+-----------+------>
   '-MSGSUPP---'  '-CUASUPP---'  '-NOPREP-'  '-NOCUAATTR-'   

   .-NOLSTVIEW-.  .-STATS---.  .-NOSCRIPT-.   
>--+-----------+--+---------+--+----------+--------------------->
   '-LSTVIEW---'  '-NOSTATS-'  '-SCRIPT---'   

   .-NOLISTING------------.  .-NOMSGEXPAND-.  .-LOGREPL---.   
>--+----------------------+--+-------------+--+-----------+----->
   |         .-NOFORMAT-. |  '-MSGEXPAND---'  '-NOLOGREPL-'   
   '-LISTING-+----------+-'                                   
             '-FORMAT---'                                     

   .-LISTREPL---.  .-ACTBAR---.  .-GUI---.  .-VERSION---.   
>--+------------+--+----------+--+-------+--+-----------+------->
   '-NOLISTREPL-'  '-NOACTBAR-'  '-NOGUI-'  '-NOVERSION-'   

   .-NOMERGESAREA-.  .-NODISPLAY-.  .-NODISPLAYW-.   
>--+--------------+--+-----------+--+------------+-------------->
   '-MERGESAREA---'  '-DISPLAY---'  '-DISPLAYW---'   

   .-DSNCHK---.  .-GRAPHIC---.  .-ZVARS---.  .-NODBALIGN-.   
>--+----------+--+-----------+--+---------+--+-----------+------>
   '-NODSNCHK-'  '-NOGRAPHIC-'  '-NOZVARS-'  '-DBALIGN---'   

   .-NOPLEB-.  .-NOMCOMMENT-.  .-NOV3PADC-.   
>--+--------+--+------------+--+----------+--------------------->
   '-PLEB---'  '-MCOMMENT---'  '-V3PADC---'   

>--+-----------------------+--+----------+---------------------->
   +-PROFILE=data-set-name-+  +-MAXFILES-+   
   '-PROFDDN=ddname|*------'  +-=--------+   
                              |.-25--.   |   
                              '+-nnn-+---'   

>--+-------------------+---------------------------------------><
   '-national-language-'   

As shown in this diagram, when you specify options, a left parenthesis "(" is required before the first option. If you specify mutually exclusive options such as SCREEN and DISK, the conversion utility issues an error message and stops processing.

The syntax description follows:
source-filespec
Specify the source-filespec as a member of a partitioned data set (PDS) that contains the DTL source to be converted to ISPF dialog elements. The first-level qualifier is the "user ID" and the second-level qualifier is "GML" for the input data set name unless the PROFILE option is specified to override the default.
Note: The conversion utility output is stored as commands, keylists, messages and panels. A single source file might result in any or all of these objects. The source file might contain multiple command tables, keylists, message members or panels. The names for the output objects are provided by the CMDTBL, KEYL, MSGMBR, PANEL, and HELP tags. See the descriptions of these tags for additional information.
REPLACE | NOREPLACE
Indicates whether members generated by the conversion utility replace existing members of the same name. If you specify NOREPLACE, the conversion utility issues a warning message for each existing member with the same name, but does not overwrite the existing member. If you specify REPLACE, the conversion utility overwrites any existing member with the same name. REPLACE and NOREPLACE affect keylists, commands, messages, panels, and SCRIPT files.
SCREEN | DISK
Indicates where to send information, warning, and error messages that occur while running the conversion utility. If you specify SCREEN (the default), conversion messages are sent to the display screen. If you specify DISK, conversion messages are sent to the designated log file.
Note: If your messages are not being written to the ISPF log, the specified conversion utility log file must be preallocated. If your messages are being written to the ISPF log, the ISPF Settings option must specify that an ISPF log is to be created.

Running the conversion utility with the DISK option causes additional messages to be appended to the existing sequential ISPDTLC log file or the ISPF log. When using the conversion utility log file, a separator record indicating the date and time of the execution is written to the log file before any messages.

Messages are written to the screen automatically when:
  • The conversion utility detects errors during initialization.
  • System I/O errors occur.
DBCS | NODBCS
Indicates whether DBCS validation is performed on tag text following the tag suffix ">". Errors found during DBCS validation cause the conversion utility to issue error or warning messages. DBCS shift-out and shift-in characters are considered part of the text, thereby contributing to the length of the text.
Attention: DBCS strings cannot span records. That is, DBCS shift-out and shift-in characters (shift-in characters end the DBCS string) must be on the same record. The conversion utility ends with a severe error for incorrectly formed DBCS strings. If DBCS is specified and no language is specified, the default language is Japanese.
KANA | NOKANA
Indicates whether the KANA keyword is added to the )BODY statement on panels and the message ID line of messages. There is no default. If KANA is specified and no language is specified, the default language is Japanese. See the z/OS ISPF Dialog Developer's Guide and Reference for more information.
KEYLAPPL=xxxx
The KEYLAPPL=xxxx option, where "xxxx" is equal to the 1–4 character application ID, must be specified when the user includes a key list or lists in the DTL source and the APPLID attribute is omitted on the KEYL tag. The application ID is used by the conversion utility to write to the correct key list file.
Note: You cannot use "ISP" as an application ID, because the conversion utility is running as an ISP application.
See z/OS ISPF Dialog Developer's Guide and Reference for restrictions on updating key lists.
PANEL | NOPANEL
The PANEL keyword forces the conversion utility to display the invocation panel even if a source-filespec has been entered. The PANEL keyword is disregarded when the conversion utility is running in a batch job.
MSGSUPP | NOMSGSUPP
The MSGSUPP keyword causes the conversion utility to suppress warning messages concerning panel formatting.
CUASUPP | NOCUASUPP
The CUASUPP keyword causes the conversion utility to suppress warning messages concerning CUA Architecture non-compliance.
PREP | NOPREP
The NOPREP keyword causes the preprocessing of the output panel to be bypassed. Panel output is stored in ISPF panel format.
CUAATTR | NOCUAATTR
The NOCUAATTR keyword forces the conversion utility to create panels with attribute definitions compatible with ISPF Version 3.1 and Version 3.2. CUAATTR causes panels to be created using CUA attribute types as defined in the z/OS ISPF Dialog Developer's Guide and Reference.
Note: If you specify NOCUAATTR, the conversion utility issues a message and changes the default GRAPHIC option to NOGRAPHIC because GRAPHIC support is implemented only for CUA attributes.
LSTVIEW | NOLSTVIEW
The LSTVIEW keyword causes the conversion utility to display the "converting source file" message in line mode when the user has routed the log file messages to DISK. NOLSTVIEW causes the "converting source file" message to be displayed as a long message in full-screen mode. The NOLSTVIEW keyword is disregarded when the conversion utility is running in a batch job; the "converting source file" message is written to file SYSTSPRT.
STATS | NOSTATS
The NOSTATS keyword causes the conversion utility to bypass the creation of member statistics on created panels and messages. STATS and NOSTATS affect messages, panels, and SCRIPT files.
SCRIPT | NOSCRIPT
The SCRIPT keyword causes the conversion utility to create a panel image template as a member of a file allocated to DTLSCR. The panel image template has BookMaster® tags included so that it may be incorporated into documentation files. Input and output fields in the panel image are shown as underscores. Runtime substitution variables are shown as "&varname". Editing is required to supply appropriate information for input and output fields and "&varname" values.
Note: The specified conversion utility SCRIPT output file must be preallocated.
LISTING | NOLISTING
The LISTING keyword causes the conversion utility to create a list file of the processed source GML records. This file is allocated to DTLLIST or if no file name is provided to the conversion utility, the list is added to the standard ISPF list data set. The file you provide can be in either sequential or partitioned format.
Note: If your messages are not being written to the ISPF list file, the specified conversion utility list file must be preallocated.

Indentation of nested tags (to a limit of 30 columns) is provided for readability. The listing is limited to an 80-column format. Tag contents that would extend beyond the right column are flowed to multiple lines.

The formatted listing is unchanged from the original DTL source file except for indentation processing.

FORMAT | NOFORMAT
The FORMAT keyword causes the conversion utility to create a list file of the source GML records after entity substitution is performed. (The FORMAT keyword implies the LISTING keyword.) The number at the left side of the list indicates the file nest level. If the LISTING keyword is specified in combination with the NOFORMAT keyword, all substitution is bypassed and the listing can be used as a formatted input GML file.
MSGEXPAND | NOMSGEXPAND
The MSGEXPAND keyword causes the conversion utility to expand the warning and error messages to include an indicator of the major type of tag in process (PANEL, HELP, KEYL, MSGMBR, CMDTBL) along with the object name.
LOGREPL | NOLOGREPL
Indicates whether members generated by the conversion utility replace existing log file PDS members of the same name. If you specify NOLOGREPL, the conversion utility issues a warning message for each existing member with the same name but does not overwrite the existing member.
LISTREPL | NOLISTREPL
Indicates whether members generated by the conversion utility replace existing list file PDS members of the same name. If you specify NOLISTREPL, the conversion utility issues a warning message for each existing member with the same name but does not overwrite the existing member.
ACTBAR | NOACTBAR
Indicates whether the ISPF panel statements for action bars are added to the generated panel. If you specify NOACTBAR, the panel sections for )ABC, )ABCINIT, and )ABCPROC and the action bar lines from the panel body are not added to the output panel. (The DTL source for action bar creation is syntax-checked in all cases.)

If a PANEL tag includes the keyword ACTBAR, this option is ignored for that panel.

GUI | NOGUI
The NOGUI keyword causes the GUI display mode panel keywords for mnemonics and check boxes to be removed from the generated panel.

If you specify MNEMGEN=YES on the AB tag or CHKBOX=YES on the SELFLD tag, this option is ignored for the specified tag. This option can be overridden by specifying the TYPE attribute on the PANEL tag.

VERSION | NOVERSION
Indicates whether the ISPDTLC version number, maintenance level, and member creation date and time are added as comments following the )END panel statement and the last message of a message member. In addition, VERSION causes the conversion language (ENGLISH, GERMAN, JAPANESE, and so on), Panel ID, and ISPF version to be added to the )ATTR panel statement line as a comment. If you specify NOVERSION, the comments are not added to the generated panel or message.
Note: If the PREP conversion option has been specified, the comments are not part of the final panel because they are not processed by the ISPPREP utility.
NOMERGESAREA | MERGESAREA
Indicates whether scrollable areas are merged into panel body sections. Merging occurs only when the entire scrollable area can be contained within the panel body, allowing for the function key area. This option can be overridden by specifying the MERGESAREA attribute on the HELP or PANEL tag.
NODISPLAY | DISPLAY

Indicates whether the converted panel is displayed by the conversion utility immediately after the panel is created. The display is in full-screen format. The DISPLAY keyword is disregarded when the conversion utility is running in a batch job.

Note: If you specify DISPLAY, ISPDTLC must be run in test mode (Option 7) to force display processing to use the current generated panel. An error message is issued if ISPDTLC is not being run in test mode and this option is specified.

DISPLAY causes each converted panel to be displayed until the user enters DISPLAY OFF on the command line of a displayed panel or selects option 2 from the display control panel. The control panel is displayed periodically, according to the interval specified in the "DISPLAY(W) option check interval" field on the invocation panel, or from the Miscellaneous choice on the Options action bar.

NODISPLAYW | DISPLAYW
Indicates whether the converted panel is displayed by the conversion utility immediately after the panel is created. The display is within a window. The DISPLAYW keyword is disregarded when the conversion utility is running in a batch job.
Note: If you specify DISPLAYW, ISPDTLC must be run in test mode (Option 7) to force display processing to use the current generated panel. An error message is issued if ISPDTLC is not being run in test mode and this option is specified.

DISPLAYW causes each converted panel to be displayed until the user enters DISPLAY OFF on the command line of a displayed panel or selects option 2 from the display control panel. The control panel is displayed periodically, according to the interval specified in the "DISPLAY(W) option check interval" field on the invocation panel, or from the Miscellaneous choice on the Options action bar.

DSNCHK | NODSNCHK
Indicates whether file validation is performed on the files specified on the interactive panel after the first conversion cycle has been completed. If you specify NODSNCHK and any specified file is unavailable, the conversion fails when the conversion utility attempts to use the file. The NODSNCHK keyword is disregarded when the conversion utility is running in a batch job.
GRAPHIC | NOGRAPHIC
Indicates, for host display only, whether the action bar separator line and visible horizontal divider lines display as dashed lines or as solid lines. The GRAPHIC option can be overridden by the tag definition that generates the line. See tag attribute descriptions for for information about the creation of action bar separator and various types of visible divider lines. (In GUI mode, the action bar separator always displays as a solid line, and divider lines always display as dashed lines.) If you specify NOGRAPHIC, the action bar separator line and visible divider lines are created as dashed lines.
Note: If you specify NOCUAATTR, the conversion utility issues a message and change the default GRAPHIC option to NOGRAPHIC because GRAPHIC support is implemented only for CUA attributes.
ZVARS | NOZVARS
Indicates whether variable names are formatted as Z variables. If you specify NOZVARS, the variable name is used in panel )BODY or )AREA formatting unless the variable name is longer than the defined field width.
DBALIGN | NODBALIGN
For DBCS language conversions only. Indicates whether fields with PMTLOC=ABOVE are aligned so that the first position of the prompt text is formatted above the first position of the field.
PLEB | NOPLEB
Indicates whether leading blanks in ENTITY text strings are processed. This option is effective only for ENTITY definitions that do not specify the "space" keyword.
MCOMMENT | NOMCOMMENT
Indicates whether multiple line comment blocks, starting with <! -- or <: -- and ending with the first --> found are valid. Comment blocks can include DTL tags.
NOV3PADC | V3PADC
Indicates whether ISPDTLC Version 3 padding is added to global definitions for input fields in the )ATTR panel section. When ISPDTLC is invoked with the V3PADC option, the ISPF keyword PADC('_') is added to input attribute definitions if there is no PAD or PADC attribute specified on the PANEL tag.
PROFILE=data-set-name | PROFDDN=ddname | PROFDDN=*
The PROFILE or PROFDDN option provides access to the data set name that contains the conversion utility defined ddnames and associated PDS or sequential file names to be used by the conversion utility during I/O. A sample profile member ISPDTLP is included in the ISPSLIB skeleton library.

The data-set-name value must be a fully qualified data set name that specifies either a sequential or a partitioned data set. If the profile entry is part of a partitioned data set, then the member name must be included in the data-set-name specification.

The ddname value specifies a ddname allocated to a profile data set.

The "*" value specifies that the ddnames used in the conversion are found as preallocated files. See Default data set names for the ddnames used by ISPDTLC.

The profile data set and all data sets defined within the profile must be preallocated.

Start of change MAXFILES=25|nnn End of change
Start of change The maximum number of nested embed files that the compiler can process. If the message ISPC810E is issued this number can be increased to as high as 999. Doing so does not guarantee a successful compilation and the DTL may still have to be restructured. End of change
national-language
Specifies the language rules to be used for formatting the tag text. Supported language keywords are:
CHINESES     ENGLISH      ITALIAN      PORTUGUE     UPPERENG
CHINESET     FRENCH       JAPANESE     SGERMAN
DANISH       GERMAN       KOREAN       SPANISH
Note: ISPF must have been installed to support the language requested by the conversion utility.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014