Conventions used in the documentation

This section tells you about the terminology and syntax notation used through the documentation for CICS. When an IBM product changes its name, to keep things short, this documentation shows only the most current name.

Terminology

Terms used in this documentation are listed in the CICS glossary.

IBM Developer for z System z®, Rational® Developer for z Systems
From Version 14.0, Rational Developer for z Systems changed its name to IBM Developer for z Systems. Unless explicitly stated, all references in this documentation to IBM Developer for z Systems include any earlier versions of this product that are supported for use with CICS, and are still called Rational Developer for z Systems.

Syntax notation

Notation Explanation
Read syntax diagramSkip visual syntax diagram
>>---A---------------------------------------------------------><

A required item. Required items are shown on the main path.
Read syntax diagramSkip visual syntax diagram
>>-+---+-------------------------------------------------------><
   '-A-'   

An optional item. Optional items are shown below the main path.
Read syntax diagramSkip visual syntax diagram
>>-+-A-+-------------------------------------------------------><
   +-B-+   
   '-C-'   

Alternative values for a single required item. You must specify one (and only one) of the values shown.
Read syntax diagramSkip visual syntax diagram
   .-------.   
   V       |   
>>---+-A-+-+---------------------------------------------------><
     +-B-+     
     '-C-'     

Alternative values, where you can specify more than one value. You must specify at least one of the values shown. You can specify additional values, in any sequence.
Read syntax diagramSkip visual syntax diagram
>>-+---+-------------------------------------------------------><
   +-A-+   
   +-B-+   
   '-C-'   

Alternative values for an optional item. You can specify none, or one, of the values shown.
Read syntax diagramSkip visual syntax diagram
   .-------.   
   V       |   
>>---+---+-+---------------------------------------------------><
     +-A-+     
     +-B-+     
     '-C-'     

Alternative values for an optional item. You can specify none, one, or more than one of the values shown, in any sequence.
Read syntax diagramSkip visual syntax diagram
   .-A-.   
>>-+---+-------------------------------------------------------><
   +-B-+   
   '-C-'   

Alternative values for an optional item, where there is a default value. A default value is shown above the main path. The remaining alternatives are shown below the main path. You can specify none, or one, of the values shown. A is the default value that is used if you do not specify anything.
Read syntax diagramSkip visual syntax diagram
>>-| Name |----------------------------------------------------><

Name

|--A--+---+-----------------------------------------------------|
      '-B-'   

A reference to a named fragment of syntax notation. This fragment is expanded below the main diagram.
Read syntax diagramSkip visual syntax diagram
>>-A=value-----------------------------------------------------><

A= denote characters that should be entered exactly as shown.

value denotes a variable, for which you should specify an appropriate value.

PARM Keywords appear in uppercase. They must be spelled as shown but can be specified in either uppercase or lowercase.
variable Variables appear in lowercase. They represent user-supplied names or values.
$  In the programming examples in this documentation, the dollar symbol ($) is used as a national currency symbol and is assumed to be assigned the EBCDIC code point X'5B'. In some countries, a different currency symbol, for example the pound symbol (£), or the yen symbol (¥), is assigned the same EBCDIC code point. In these countries, the appropriate currency symbol should be used instead of the dollar symbol.
Punctuation marks, parentheses, arithmetic operators, or such symbols You must enter these as part of the syntax.

Names of files and data sets

Notation Explanation
hlq Denotes the high-level qualifier of the CICS® TS data sets; for example, CICSTS54.CICS for CICS data sets and CICSTS54.CPSM for CICSPlex® SM data sets. The CICSTS54 part of the high-level qualifier is defined by the LINDEX parameter in the DFHISTAR installation job.


conventions.html | Timestamp icon Last updated: Sunday, 4 June 2017