Conventions

This document covers the following topics:

ADARPD Syntax

Utility control statements have the following format:

graphics/adarpd.png

where

ADARPD is the name of the utility that specifies the Event Replicator initialization parameters.
parameter is the name of the specific initialization parameter to be executed. For example, the following:

ADARPD DBID
ADARPD DESTINATION
ADARPD SUBSCRIPTION

subparameters

is a list of subparameters pertinent to the specified ADARPD parameter. Some subparameters are required.

Parameters in the list are almost always keywords with the format: 

subparameter=value

A subparameter may have one or more operands.

Most subparameters require that you select or otherwise specify an operand value. Some operands are positional (value1 , value2 ,..., valuex), meaning that the values must be in a certain order as described in the text. All subparameters must be separated by commas.

In the subparameter syntax descriptions in this documentation, subparameters are listed vertically (stacked) or are separated by vertical bars (|). Each list shows all possible subparameters, from which one or more can (or must) be specified. Although subparameters in the list must be separated by commas, these commas are omitted in the syntax statements when the subparameters are stacked.

Syntax Conventions

The following table describes the conventions used in syntax diagrams in this documentation.

Convention Description
uppercase, bold Syntax elements appearing in uppercase and bold font are Adabas keywords. When specified, these keywords must be entered exactly as shown.
lowercase, italic, normal font Syntax elements appearing in lowercase and normal, italic font identify items that you must supply.
mixed case, normal font Syntax elements appearing in mixed case and normal font (not bold or italic) identify values established by other Adabas control statements. This notation is usually used to identify how default values are determined for some parameters in Adabas syntax.
underlining

Underlining is used to identify default values, wherever appropriate.

vertical bars (|) Vertical bars are used to separate mutually exclusive choices.

Note:
In more complex syntax involving the use of large brackets or braces, mutually exclusive choices are stacked instead.

brackets ([ ]) Brackets are used to identify optional elements. When multiple elements are stacked or separated by vertical bars within brackets, only one of the elements may be supplied.
braces ({ }) Braces may be used to identify required elements. When multiple elements are stacked or separated by vertical bars within brackets, one and only one of the elements must be supplied.
indentation Indentation is used to identify subparameters of a parameter.
ellipsis (...) Ellipses are used to identify elements that can be repeated. If other punctuation is included before a ellipsis, the punctuation must be used to separate repeated elements.
other punctuation and symbols All other punctuation and symbols must be entered exactly as shown.

Control Statement Rules

The following rules apply for the construction of ADARPD control statements:

  1. Each control statement must contain the letters "ADARPD" in positions 1-6.

  2. The parameter name follows ADARPD, separated by at least one space.

  3. Subparameter entries and multiple values within subparameter entries must be separated by commas.

  4. No space is permitted before or after "=".

  5. The comma following the last subparameter entry of a parameter is optional.

  6. ADARPD control statement processing ends with position 72 or when a space is encountered after the beginning of the parameter list. Entries made in positions 73-80 are not processed.

  7. A statement that contains an asterisk "*" in position 1 is read as a comment and is not processed.

  8. ADARPD control statements are continued by specifying the extra parameters on a new statement following (and separated by at least one space from) the letters "ADARPD" in positions 1-6.

Parameter Values

Variable values actually specified following the equals "=" sign in parameters (represented by italicized labels in the preceding examples and elsewhere in this documentation) have the following syntax:

graphics/parmsynt.png

where value is as described in the following sections. Value-list is a variation of value, and is allowed either in place of or with value, depending on the individual parameter rules as described in the text.

value

Value may consist of a number or a string of alphanumeric or hexadecimal characters. In some optional subparameters, a default value is assumed if the subparameter is not specified.

Alphanumeric Values

Alphanumeric values are specified in one of the following ways:

If the value includes . . . Single quotes (') around it are . . .
only upper- or lowercase letters, numeric digits and minus (-) optional
any other characters, including a single quote itself (which must be entered twice) required

Numeric Values

Numeric values are specified as follows:

If the value represents . . . Specify . . .
a number of either blocks or cylinders the letter B must immediately follow the value if blocks are being specified; otherwise, cylinders are assumed:

SIZE=200B (200 blocks)
SIZE=200 (200 cylinders)

an Adabas file a one- to four-digit number (leading zeros permitted):

FILE=3
FILE=03
FILE=162

a device type a four-digit number corresponding to the model number of the device type to be used:

DEVICE=3380

a field name or descriptor a two-character field name corresponding to the field name or descriptor:

FIELD1=NA

Hexadecimal Values

Hexadecimal values are accepted if this is specified in the parameter description. Hexadecimal values must be specified within single quotes (') following the indicator "X". For example: 

X'0002DC9F'
value-list

'value,...' (alphanumeric values)

ADARPD  SFBAI='AA,BA,BB,BC,BD,CA,CB,CD,CE,CF.'
Positional Values

Subparameters may be positional if they relate to values specified on corresponding subparameters. For example: 

ADARPD DAIFILE=97,DAIDBID=190,DATDBID=133,DATFILE=22

For input file 97, this example identifies the input file's database ID (190) and its associated target database ID (133) and file (22) for replication. Subparameters (DAIDBID, DATDBID, and DATFILE) must be specified for each occurrence of DAIFILE.