Report Writer › NCL Interface › Notational Conventions › Interface Syntax

Interface Syntax

The precise syntax for each interface is defined in a box towards the top of each page. For example:

&CONTROL NOSHRVARS

-EXEC $RWCALL   OPT=STATUS
              [ USERID=userid ]

On the left is the interface name ($RWCALL), and to the right are the permissible operands. The syntax used observes the following guidelines:

• UPPERCASE characters
  Interface names or operands consisting of uppercase characters must be entered as shown, but can be entered in upper or lower case.
• Italic characters
  These are variables that show the kind of information, rather than the exact information that must be supplied. The actual entry replaces the italic description. Valid types of data are described for each interface within the operands section.
• Underscored values
  Indicates the defaulted value that is assumed for an operand if one is not specified in the interface.
• {Braces}
  These indicate the available options for an operand. One of the alternatives described must be selected. Do not include braces when entering a specification.
• [Square brackets]
  Indicate optional specifications. Do not include square brackets when entering a specification.
• The Or Sign |
  This separates options for an optional or mandatory specification. If a group of options is enclosed by square brackets, and each is separated by an Or sign, none of the options have to be chosen. If none are coded, the default value (underscored) is used.
• Commas and Equals signs
  Commas and equal signs must be entered as shown. If commas or equal signs appear within brackets, they are optional and used only if the accompanying optional operand is used.