Conventions used in the documentation

Tags for highlighting applicability

Tags are used in this documentation to highlight the applicability of information to a particular version of software or role.

For example, the Gradle tag identifies information for Gradle users.

In Version 6 documentation, 6.1 identifies information that applies only to users of CICS TS 6.1.

6.2 identifies information that applies only to users of CICS TS 6.2.

If there is no release-specific tag, the information applies equally to all releases in CICS TS Version 6. Highlighting tags are not shown in syntax diagrams but they are shown on the description of any affected option.

The release tags indicate functional difference between Version 6 releases. They do not imply applicability for Version 5 releases. Refer to Upgrading or the CICS TS Version 5 documentation for clarification.

Terminology

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

Syntax notation

Notation	Explanation
	A required item. Required items are shown on the main path.
	An optional item. Optional items are shown below the main path.
	Alternative values for a single required item. You must specify one (and only one) of the values shown.
	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.
	Alternative values for an optional item. You can specify none, or one, of the values shown.
	Alternative values for an optional item. You can specify none, one, or more than one of the values shown, in any sequence.
	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.
Name	A reference to a named fragment of syntax notation. This fragment is expanded below the main diagram.
	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.
Punctuation marks, parentheses, arithmetic operators, or such symbols	You must enter these as part of the syntax.

Symbols in programming examples

In the programming examples in this documentation, symbols in the following table are used and assumed to be assigned the EBCDIC code points shown in the table. In other countries that use different code pages, alternative symbols are assigned the same EBCDIC code point. In a country that uses a different code page, use the appropriate symbol.

For example, 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 other countries, the pound symbol (£), or the yen symbol (¥), is assigned the same EBCDIC code point.

Names of files and data sets

Messages

Some CICS messages have a suffix letter: for example, DFHAM4971E. CICS messages might referenced with no space before the suffix letter but have a space in output. For the definitive spacing, check CICS messages.

Inclusive language

IBM aims to promote the use of inclusive language in IT. While IBM values the use of inclusive language, terms that are outside of IBM’s direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.

Accessibility

Information about the accessibility of CICS can be requested at Accessibility reports. Information about the accessibility features of IBM Documentation can be found in the IBM Documentation help.