About This Guide

Overview of Contents

The guide is divided into the following sections:

Conventions Used in This Guide

Notational conventions that may be used in this guide are explained below.

Standard Keyboard Keys

Keys that appear on the standard keyboard are identified in boldface, for example, Enter, Shift, Ctrl+S (a key combination), or Ctrl S (a key sequence).

The commands, instructions, procedures, and syntax illustrated in this guide presume that the keyboards at your site are mapped in accordance with the EBCDIC character set. Certain special characters are referred to in this documentation, and you must ensure that your keyboard enables you to generate accurate EBCDIC hex codes. This is particularly true on keyboards that have been adapted to show local or national symbols. You should verify that

  • $ is mapped to x'5B'.

  • # is mapped to x'7B'.

  • @ is mapped to x'7C'.

If you have any questions about whether your keyboard is properly mapped, contact your system administrator.

Preconfigured PFKeys

Many commands are preconfigured to specific keys or key combinations. This is particularly true with regard to numbered PF keys, or pairs of numbered PF Keys. For example, the END command is preconfigured to, and indicated as, PF03/PF15. To execute the END command, press either the PF03 key or the PF15 key.

Instructions to enter commands may include:

  • Only the name of the command, such as, enter the END command.

  • Only the PF keys, such as, press PF03/PF15.

  • Or both, such as, press PF03/PF15, or enter the END command.

Command Lines and Option Fields

Most screens contain a command line, which is primarily used to identify a single field where commands, or options, or both, are to be entered. These fields are usually designated COMMAND, but they are occasionally identified as COMMAND/OPT or COMMAND/OPTION.

Option field headings appear in many screens. These headings sometimes appear in the screen examples as OPTION, or OPT, or O.

Names of Commands, Fields, Files, Functions, Jobs, Libraries, Members, Missions, Options, Parameters, Reports, Subparameters, and Users

The names of commands, fields, functions, jobs, libraries, members, missions, options, parameters, reports, subparameters, users, and most files, are shown in standard UPPERCASE font.

Syntax Statements

In syntax, the following additional conventions apply:

  • A vertical bar ( | ) separating items indicates that you must choose one item. In the following example, you would choose a, b, or c:

    Copy 
    a | b | c

  • An ellipsis ( . . . ) indicates that you can repeat the preceding item or items as many times as necessary.

  • Square brackets ( [ ] ) around an item indicate that the item is optional. If square brackets ( [ ] ) are around a group of items, this indicates that the item is optional, and you may choose to implement any single item in the group. Square brackets can open ( [ ) and close ( ] ) on the same line of text, or may begin on one line of text and end, with the choices being stacked, one or more lines later.

  • Braces ({ }) around a group of items indicates that the item is mandatory, and you must choose to implement a single item in the group. Braces can open ( { ) and close ( } ) on the same line of text, or may begin on one line of text and end, with the choices being stacked, one or more lines later.

Screen Characters

Copy 
All syntax, operating system terms, and literal examples are presented in this typeface.

This includes JCL calls, code examples, control statements, and system messages. Examples of this are:

  • Calls, such as:

    Copy 
    CALL 'CBLTDLI'

  • Code examples, such as:

    Copy 
    FOR TABLE owner.name USE option, . . . ;

  • Control statements, such as:

    Copy 
    //PRDSYSIN DD * USERLOAD PRD(2) PRINT

  • System messages are displayed on the screen, such as

    • Stand-alone messages:

      Copy 
      You are not logged on to database database_name

    • Messages embedded in text:

      Copy 
      You are not logged on to database database_name

Variables

Variables are identified with italic text. Examples of this are:

  • In syntax or message text, such as:
    Specify database database_name

  • In regular text, such as:
    replace database database_name1 with database database_name2 for the current session

  • In a version number, such as:
    EXTENDED BUFFER MANAGER for IMS 4.1.xx

Special Elements

This guide includes special elements called Notes and Warnings.

Notes provide additional information about the current subject.

Warnings alert you to situations that can cause problems, such as loss of data, if you do not follow instructions carefully.

Information New to This Version

Additional information that is new to this version is described in the INCONTROL for z/OS Installation Guide: Upgrading and the What’s New section of the INCONTROL for z/OS Release Notes.

Related Publications

INCONTROL for z/OS Installation Guide

A step-by-step guide to installing, customizing, maintaining, and upgrading INCONTROL products using the INCONTROL Customization and Installation Engine (ICE) application.

The guide is divided into the following volumes:

INCONTROL for z/OS Messages Manual

A comprehensive listing and explanation of all IOA and INCONTROL messages.

INCONTROL for z/OS Administrator Guide

This guide provides information for system administrators about customizing and maintaining INCONTROL products.

INCONTROL for z/OS Utilities Guide

A detailed description of the utilities designed to perform specific administrative tasks that are available to INCONTROL products. The guide contains an alphabetized reference of all utilities for each INCONTROL product.

User Guides

Product-specific guides containing comprehensive information about the operation and implementation of each INCONTROL product.