The command format consists of a field with the command name. All operands with their legal values are then listed. Operand values which introduce structures and the operands dependent on these operands are listed separately. The syntax of the command representation is explained in the following three tables.
Table 1 : Notational conventions
The meanings of the special characters and the notation used to describe command and statement formats are explained in table 1.
Table 2 : Data types
Variable operand values are represented in SDF by data types. Each data type represents a specific set of values. The number of data types is limited to those described in table 2.
The description of the data types is valid for the entire set of commands/statements. Therefore only deviations (if any) from the attributes described here are explained in the relevant operand descriptions.
Table 3 : Suffixes for data types
Data type suffixes define additional rules for data type input. They contain a length or interval specification.
The description of the data type suffixes is valid for the entire set of commands/statements. Therefore only deviations (if any) from table 3 are explained in the relevant operand descriptions.
Metasyntax
Representation | Meaning | Examples |
UPPERCASE LETTERS | Uppercase letters denote | HELP-SDF SCREEN-STEPS = *NO |
UPPERCASE LETTERS in boldface | Uppercase letters printed in boldface | GUIDANCE-MODE = *YES |
= | The equals sign connects an operand | GUIDANCE-MODE = *NO |
< > | Angle brackets denote variables | SYNTAX-FILE = <filename 1..54> |
Underscoring | Underscoring denotes the default | GUIDANCE-MODE = *NO |
/ | A slash serves to separate | NEXT-FIELD = *NO / *YES |
(...) | Parentheses denote operand values | ,UNGUIDED-DIALOG = *Y ES(...) / *NO |
[ ] | Square brackets denote operand | SELECT = [*BY-ATTRIBUTES](...) |
Indentation | Indentation indicates that the operand | ,GUIDED-DIALOG = *Y ES(...) *Y ES(...) SCREEN-STEPS = *NO / *YES |
A vertical bar identifies related | SUPPORT = *TAPE(...) *TAPE(...) VOLUME = *ANY (...) *ANY (...) ... | |
, | A comma precedes further | GUIDANCE-MODE = *NO / *YES ,SDF-COMMANDS = *NO / *YES |
list-poss(n): | The entry “list-poss” signifies that a | list-poss: *SAM / *ISAM list-poss(40): <structured-name 1..30> list-poss(256): *OMF / *SYSLST(...) / <filename 1..54> |
Alias: | The name that follows represents a | HELP-SDF Alias: HPSDF |
Data types
Data type | Character set | Special rules | ||
alphanum-name | A...Z | |||
c-string | EBCDIC character | Must be enclosed within single quotes; | ||
composed-name | A...Z | Alphanumerical string that can be subdivided | ||
date | 0...9 | Input format: yyyy-mm-dd yyyy: year; optionally 2 or 4 digits Only date specifications between 1.1.2000 and | ||
filename | A...Z | Input format fully qualified: ':<prefix>:<first-qual>.<filename>' Input format partially qualified: :<prefix>:<filename> :<prefix>: Optional specification of file organization; <first-qual> "first level qualifier" <filename> partially qualified file name; | ||
filename-prefix | A...Z | Input format fully qualified: ':<prefix>:<first-qual>.<partname>.' Input format partially qualified: :<prefix>:<partname>. <prefix> see filename partname Specifies the common first part of the | ||
integer | 0...9, +, - | + or -, if specified, must be the first character. | ||
name | A...Z | Must not begin with 0...9. | ||
number | 0...9 | Message number/return code | ||
partial-filename | A...Z | Input format fully qualified: ':<prefix>:<first-qual>.<partname>.' Input format partially qualified: :<prefix>:<partname>.
Specifies the common first part of the | ||
text | freely selectable | For the input format, see the relevant operand | ||
time | 0...9 | Time-of-day entry: hh: hours where leading zeros may be omitted Valid entries are between 00:00:00 and | ||
x-string | Hexadecimal: | Must be enclosed in single quotes; must be |
Suffixes for data types
Suffix | Meaning |
x..y | With data type "integer": interval specification |
x x is an (optionally signed) integer. | |
y y is an (optionally signed) integer. | |
x..y | With the other data types: length specification |
x | |
y | |
x=y |
Meaning of operands
After the format of each command there is a detailed description of all the operands, the possible value assignments and their functions.
Otherwise the same metasyntax is used in describing operands as in the representation of the command formats (see above).
The following characters are regarded as constants in describing the operands: "." (period), "(" (open bracket), ")" (close bracket), " ' " (single quote), "$" (dollar sign), and also the character combinations ":V:", ":L:", ":S:", ":O:" and ":E:" i.e. they must be specified when the command is entered. Where this occurs the syntactical components of the operand value must follow one after another without any gaps.
"±" has the usual meaning "+" or "-".
Example
Possible entries for the local operand FILE are as follows:
|
Key
(1) | Name of a PS data set |
(2) | Name of an absolute generation data set (PS data set) (this has the same syntax as the name of a normal PS data set, with the exception of the last partial name, which must have a special format) |
(3) | Name of a relative generation data set (PS data set) |
(4) | Name of a relative generation data set (PS data set), special case "current generation" (may only be a send file) |
(5) | Name of a VSAM file of the type "entry sequenced" |
(6) | Name of a PO or PDSE member |
(7) | Name of an entire PO or PDSE data set |
(8) | Pathname of an openEdition file (absolute and relative) |
More details on the syntax rules for file names, passwords, user IDs and account numbers in openFT can be found in the respective sections.
Variable %UNIQUE
If a file name ends with %unique or %UNIQUE, this string will be replaced by another string, which varies with each new call.
f the receiving system is a Unix or Windows system, a suffix may follow %unique or %UNIQUE separated by a dot, e.g. "file1%unique.txt". This suffix must not contain any dot.
Only the already converted file name is displayed in both the log and the messages.
In z/OS, openFT converts %UNIQUE into a string of the form xxxxxxxx.D<inst>, where xxxxxxxx stands for a randomly generated string, D for a letter and <inst> for the name of the openFT instance that is currently set.
%UNIQUE must be a separate part of the file name (separated by .) for the records of the normal z/OS file system. This can be followed by a maximum of one further name component.
%UNIQUE can also be specified for a member name of a PO or PDSE dataset. However, in this case only the name part to the left of the period (xxxxxxxx) is replaced.
In the case of openEdition files, %UNIQUE is expanded if:
it is at the end of the file name.
it is followed by a string which contains neither a percentage sign nor a period (unless the period immediately follows %UNIQUE).
%UNIQUE is recognized and correctly converted to:
receive file names, on initiation from the remote system with WRITE-MODE = *REPLACE-FILE or *NEW-FILE
receive file names of the NCOPY command withWRITE-MODE = *REPLACE-FILE or *NEW-FILE
file names in FTCREPRF or FTMODPRF to preset the receive file name in FTAC profiles