This section describes all keywords and variables that are relevant when using direct commands in online or batch mode. Each keyword represents a parameter that is used to specify object selection criteria or set an option for the command being executed. If indicated, a variable value must be supplied with a keyword.
The symbols used in the syntax diagrams shown below correspond to the syntax symbols used for system commands which are explained in System Command Syntax in the System Commands documentation.
For the direct command syntax to which the keywords refer, including details on the where-clause and the with-clause mentioned in this section, refer to the object-type specific sections of the SYSMAIN Utility documentation.
This section also covers the following topics:
This section explains the keywords and corresponding variable values (if required) used in a direct command.
Keywords are listed alphabetically. Letters in italics represent variable values that must be supplied with a keyword. For each variable value, the Natural data format and length is indicated.
| Keyword | Value |
Natural Data |
Explanation | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | A9 | Only applies to programming objects.
The name of the object to be processed or a range of names (see also Specifying a Range of Names). Any saved (source) objects and/or cataloged objects are processed. |
|||||||||||||||||||||||||
AS
|
new-name |
A8 |
Not applicable to DL/I subfiles and DDMs.
The new name to be given to an object when it is renamed with the
Format/length A12 only applies to debug environments. |
||||||||||||||||||||||||
| new-number | N4 | For error messages:
The new number to be given to an error message, or the start number
of a range of new numbers to be given to a range of existing error messages
when using the |
|||||||||||||||||||||||||
CATALOGED
|
name | A9 | Only applies to programming objects.
The name of the cataloged object to be processed or a range of names (see also Specifying a Range of Names). |
||||||||||||||||||||||||
CIPHER
|
cipher | A8 | The Adabas cipher code of a source file and/or target system
file which is used in a where-clause.
For rules and DDMs: The corresponding
|
||||||||||||||||||||||||
DBID
|
dbid | N5 | The database ID (DBID) of a source or a target database.
The source database contains the system file where the object to be processed is stored. The target database contains the system file to which the object is to be copied or moved, or where the object is renamed (or in the case of an error message, renumbered) if relevant. Valid DBIDs are If no DBID or file number (FNR) is specified and SYSMAIN is
called with the system command For rules and DDMs: The corresponding
|
||||||||||||||||||||||||
| name | A32 | Only applies to DDMs.
The name of the DDM to be processed or a range of names. See also Specifying a Range of Names. |
|||||||||||||||||||||||||
| ddm-dbid | N5 | Only applies to DDMs.
The DDM database ID (DBID): All DDMs that were cataloged under the specified DBID are processed. Valid DDM DBIDs are |
|||||||||||||||||||||||||
| ddm-fnr | N5 | Only applies to DDMs.
The DDM file number (FNR): All DDMs that were cataloged under the specified FNR are processed. Valid DDM FNRs are |
|||||||||||||||||||||||||
DEBUG
|
name | A12 | Only applies to debug environments.
The name of the debug environment to be processed or a range of names. See also Specifying a Range of Names. |
||||||||||||||||||||||||
DIC
|
dbid |
A80 | Not applicable to error messages, profiles and DL/I subfiles.
Specifies the environment of the FDIC source and/or target system file: database ID (dbid), file number (fnr), Adabas password (password) and Adabas cipher code (cipher). For rules and DDMs: |
||||||||||||||||||||||||
| name | A8 | Only applies to DL/I subfiles.
The name of the DL/I subfile to be processed or a range of names. See also Specifying a Range of Names. |
|||||||||||||||||||||||||
ERROR
|
number | N4 | Only applies to error messages.
The number of the error message to be processed or the start number
of a range of numbers if |
||||||||||||||||||||||||
EXTEND
|
- | - | Only applies to programming objects and the
LIST
or FIND
command when being used in batch mode.
If If |
||||||||||||||||||||||||
| lib-name | A8 | For programming objects, debug environments and error messages:
Specifies a source library.
For profiles, rules, DDMs and DL/I subfiles: Introduces a where-clause. |
|||||||||||||||||||||||||
| date-from | A10 | Only applies to programming objects.
The start date of a time period: All objects which were saved or cataloged on or after the specified date are processed. If no end date is specified with
A date must be specified according to the setting of the
|
|||||||||||||||||||||||||
| time-from | A5 | Only applies to programming objects and if
FMDATE
is specified.
Specifies a start time: All objects which were saved or cataloged at or after the specified time (and date) are processed. A time must be specified in the format
HH:II
(HH = hours, II =
minutes), for example, |
|||||||||||||||||||||||||
FNR
|
fnr | N5 | The file number (FNR) of a source or a target system file
(FNAT, FDIC or FUSER).
The source system file contains the object to be processed. The target system file is the system file to which the object is to be copied or moved, or where the object is renamed (or in the case of an error message, renumbered) if relevant. Valid FNRs are If no database ID (DBID) or FNR is specified and SYSMAIN is called
with the system command For rules and DDMs: The corresponding
|
||||||||||||||||||||||||
| - | - | Activates online
selective
processing.
You can either include the keyword |
|||||||||||||||||||||||||
LANGUAGE
|
language | A9 | Only applies to error messages.
The code of the language of the error message to be processed. The languages can be specified using any combination of language codes. For information on which language code is assigned to which language, see Language Code Assignments in *LANGUAGE in the System Variables documentation. See also Specifying Languages. You can use an asterisk (*) to select all existing languages of the error messages to be processed. |
||||||||||||||||||||||||
| lib-name | A8 | Only applies to programming objects, debug environments and
error messages.
An optional keyword that indicates the name of a source or a target library. If you omit the keyword and respective value, the library where you logged on before you invoked SYSMAIN is used for processing. The source library contains the object to be processed. The target library is the library to which the object is to be copied or moved, or where the object is renamed (or in the case of an error message, renumbered). For system error messages, specify lib-name must be specified immediately
after the |
|||||||||||||||||||||||||
| - | - | Not applicable in batch mode.
Activates ( |
|||||||||||||||||||||||||
NAME
|
vsam-name | A8 | The DDNAME/FCT entry for the source or target file number. | ||||||||||||||||||||||||
| - | - | Not applicable in batch mode.
Enables ( |
|||||||||||||||||||||||||
| password | A8 | The Adabas password of a source file and/or target system file
which is used in a where-clause.
For rules and DDMs: The corresponding
|
|||||||||||||||||||||||||
PROFILE
|
name | A8 | Only applies to profiles.
The name of the profile to be processed or a range of names. See also Specifying a Range of Names. |
||||||||||||||||||||||||
RCOP
|
- | - | Specifies that a copy of the object being renamed is to be made. | ||||||||||||||||||||||||
REPLACE
|
- | - | Activates the replace option used in a
with-clause.
An object with the same name in the target environment is replaced by the object to be processed. Note: |
||||||||||||||||||||||||
RULE
|
name | A32 | Only applies to rules.
The name of the rule to be processed or a range of names. See also Specifying a Range of Names. |
||||||||||||||||||||||||
SAVED
|
name | A9 | Only applies to programming objects.
The name of the saved (source) object to be processed or a range of names. See also Specifying a Range of Names. |
||||||||||||||||||||||||
SEC
|
dbid |
A80 | Not applicable to profiles and DL/I subfiles.
Specifies the environment of the FSEC source and/or target system file: database ID (dbid), file number (fnr), Adabas password (password) and Adabas cipher code (cipher). |
||||||||||||||||||||||||
SETNO
|
set-number | N2 | The number of the retained Predict set created with the Predict
XRef save set option of the LIST XREF command. You
can apply all SYSMAIN processing functions to the objects included in this set.
If any valid number is specified, SYSMAIN assumes a Predict set. If no number is specified, normal object processing is assumed. |
||||||||||||||||||||||||
SETLIBRARY |
set-library | A8 | Activates the option to overwrite the library
specification for a Predict set as a part of the security for Predict files.
|
||||||||||||||||||||||||
SETUSER
|
set-user | A8 | Activates the option to overwrite the user-ID specification for
a Predict set as a part of the security for Predict files.
|
||||||||||||||||||||||||
| name | A9 | Only applies to programming objects.
The name of an object (or a range of names) for which the saved (source) and the cataloged object are to be processed (see also Specifying a Range of Names). Only an object that exists as both a saved object and a cataloged object is processed. The exceptions to this are copycode, text and recording, neither of which can be cataloged. However, they are included in processing when this option is specified. |
|||||||||||||||||||||||||
THRU
|
number |
N4 | Only applies to error messages.
The end number of a range of error message numbers to be processed
if a start number is specified with |
||||||||||||||||||||||||
TID
|
terminal-ID | A8 | Only applies to programming object.
A terminal ID: All objects that were saved or cataloged on the specified terminal are processed. |
||||||||||||||||||||||||
TO
|
lib-name | A8 |
For programming objects, debug environments and error
messages: For profiles, rules, DDMs and DL/I subfiles: Introduces a where-clause. |
||||||||||||||||||||||||
| date-to | A10 | Only applies to programming objects.
The end date of a time period: All objects which were saved or
cataloged on or before the specified date are processed. A start date can be
specified with
A date must be specified according to the setting of the
|
|||||||||||||||||||||||||
| time-to | A5 | Only applies to programming objects and if
TODATE
is specified.
The end time of a time period: All objects which were cataloged or saved at or before the specified time (and date) are processed. The time must be specified in the format
HH:II
(HH = hours,
II = minutes), for example, |
|||||||||||||||||||||||||
TYPE
|
type | - | The type of programming object, error message, profile, rule or DL/I subfile to be processed as listed in TYPE Specification below. | ||||||||||||||||||||||||
| user-id | A8 | Only applies to programming objects.
A user ID: All objects that were saved or cataloged by the specified user are processed. |
|||||||||||||||||||||||||
WHERE
|
where-clause | - | An optional keyword that indicates the start of a
where-clause.
The where-clause must always follow the
For details, see the direct command syntax in the object-type specific sections of the SYSMAIN Utility documentation. |
||||||||||||||||||||||||
WITH
|
with-clause | - | An optional keyword that indicates the start of a
with-clause.
The keywords and values of the with-clause can be specified in any order, and the with-clause can be placed in any location within the direct command string, except in the first three positions. For details, see the direct command syntax in the object-type specific sections of the SYSMAIN Utility documentation. |
||||||||||||||||||||||||
XREF
|
|
A1 |
|
||||||||||||||||||||||||
The following table lists all valid object-type codes for programming objects:
The following table lists all valid type codes for error messages:
| Code | Type |
|---|---|
S
|
Short error message |
E
|
Extended (long) error message |
A
|
All error message types: short and/or extended messages |
The following table lists all valid type codes for profiles:
| Code | Type |
|---|---|
E
|
Editor profile |
D
|
Device profile |
M
|
Map profile |
P
|
Parameter profile |
*
|
All profile types. |
The following table lists all valid type codes for rules:
| Code | Type |
|---|---|
A
|
Automatic rule |
F
|
Free rule |
AF
|
All rule types: automatic and/or free rules. |
The following table lists the valid type codes for DL/I subfiles:
| Code | Type |
|---|---|
D
|
NDBs and UDFs |
P
|
NSBs |
All SYSMAIN functions provide the option to specify either a name or a range of names for the objects to be processed. In addition, in menu mode, on a Find Selection or List Selection screen, you can specify a name or a range of names to limit the number of objects displayed. See also To shorten a selection list in Using a Selection List.
When using the find or the list function with programming objects, you can also specify a range of library names. The same applies when using the list function with debug environments or the find function with error messages. However, specifying library ranges may have a negative effect on the response time depending on how often the selection criteria occur.
The valid notations for name ranges are listed below where value denotes any combination of one or more characters:
| Input | Items Selected |
|---|---|
| * | All items. |
| value* | All items with names that start with
value.
Example: |
| value> |
All items with names greater than or equal to value.
Example: |
| value< |
All items with names less than or equal to value.
Example: |
