Home News Version 1 Tech Support Pubs S2K Site Map

SYSTEM 2000 Quick Reference Guide System-Wide Commands

Changing Processors
COMMAND FILE IS
DATA FILE IS
DELIMITER IS
ECHO
ENTRY TERMINATOR IS
EXIT
IF...THEN...ELSE
Inserting Comments
LOOKUP IS
MESSAGE FILE IS
PROMPT IS
REPORT FILE IS
SEPARATOR IS
SHOW
TIMING

Changing Processors

The CONTROL, DEFINE, and QUEST commands call the CONTROL, DEFINE, and QUEST processors respectively, so that you can issue commands specific to that processor.

Syntax

CONTROL :

DEFINE :

QUEST : (or ACCESS :)

Example

USER, DEMO:
DBN IS EMPLOYEE:                  (automatically calls QUEST)
   .
   .  (QUEST commands)
   .
CONTROL:                                      (calls CONTROL)
   .
   .  (CONTROL commands)
   .
QUEST:                                          (calls QUEST)
   .
   .  (QUEST commands)
   .
EXIT:                      (closes database and ends session)

Rules

Some commands automatically call a specific processor after execution: DATA BASE NAME IS calls QUEST, RESTORE calls QUEST, NEW DATA BASE IS calls DEFINE, MAP calls QUEST, and GENERATE calls QUEST.
You cannot issue the commands CONTROL, DEFINE, or QUEST from the REPORT processor or during a QUEUE/TERMINATE session.
You must be in the QUEST processor to issue the REPORT and QUEUE commands.
You must be using the master password to call the DEFINE processor.

COMMAND FILE IS

Immediately switches the software to start reading commands from an alternate Command File.

Syntax

[LOCAL] COMMAND FILE IS |INPUT    :
                        |fileref

LOCAL: directs the software to look for the Command File in your TSO region or CMS machine.
fileref: is the DDname of your alternate Command File. Do not use reserved file names. See Reserved File Names in Appendices .

Examples

COMMAND FILE IS MYCOM:

LOCAL COMMAND FILE IS COM1:

Rules

The Command File is set to INPUT (which is your terminal or some other input device) at the beginning of each session. You can let SYSTEM 2000 allocate the default file (S2KCOMD) dynamically instead of specifying it in a CLIST. An S2KCOMD DD statement must be included in batch JCL.
An alternate file must be described with a DD statement.
Only one Command File can be open at a time, but you can change to a different one at any time and as often as necessary.
The Command File and the Data File cannot be set to the same physical file simultaneously. For both to be used, as in loading, one must be an alternate file. You cannot set the Command File to the Message File or the Report File.
If the software does not find another COMMAND FILE IS or EXIT command at the end of an alternate Command File, it automatically exits the session.
The Command File must contain fixed-length records, which cannot exceed 250 characters.
If the alternate Command File is a nonlabeled file, include LABEL=(,NL) and a DCB parameter with LRECL, BLKSIZE, and RECFM in the DD statement for the file.
Alternate file names must be unique in a Multi-User environment.
The LOCAL option requires the SYS2KTPI interface to Multi-User software.

DATA FILE IS

Tells the software to read data from an alternate Data File.

Syntax

[LOCAL] DATA FILE IS |INPUT    :
                     |fileref

LOCAL: directs the software to look for the Data File in your TSO region or CMS machine.
fileref: is the DDname of your alternate Data File. Do not use reserved file names. See Reserved File Names in Appendices .

Examples

DATA FILE IS MYDATA:

LOCAL DATA FILE IS DATA1:

Rules

The Data File is set to INPUT (which is your terminal or some other input device) at the beginning of each session. You can let SYSTEM 2000 allocate the default file (S2KCOMD) dynamically instead of specifying it in a CLIST. An S2KCOMD DD statement must be included in batch JCL.
An alternate file must be described with a DD statement.
Only one Data File can be open at a time, but you can change to a different one at any time and as often as necessary.
The Data File and the Command File cannot be set to the same physical file simultaneously. For both to be used, as in loading, one must be an alternate file. You cannot set the Data File to the Message File or the Report File.
The Data File must contain fixed-length records, which cannot exceed 250 characters.
If the alternate Data File is a nonlabeled file, include LABEL=(,NL) and a DCB parameter with LRECL, BLKSIZE, and RECFM in the DD statement for the file.
Alternate file names must be unique in a Multi-User environment.
The LOCAL option requires the SYS2KTPI interface to Multi-User software.

DELIMITER IS

Changes the where-clause delimiter. The where-clause delimiter encloses a value in any where-clause condition for QUEST commands, for the DEFINE language MAP command, and for the REPORT language GENERATE command.

Syntax

DELIMITER IS delimiter :

delimiter: is a single special character to be used as the where-clause delimiter. The delimiter cannot be used in values, and it cannot be the same as the current system separator or the command terminator. See Special Characters in Appendices .

Example

DELIMITER IS $:
   .
   .
   .
PRINT ENTRY WHERE C303 EQ $CHURCH AND SCHOOL$:
   .
   .
   .
DITTO WHERE C303 GT $SCHOOL/UNIVERSITY$:

Rules

The default is the slash; it is set at the beginning of each session.
Once the delimiter is changed, it stays in effect until changed again or until the end of the session.
You cannot use a where-clause delimiter in a QUEUE language where-clause.
In a Multi-User environment, avoid conflicting delimiters by establishing rules with all users of a database.

ECHO

Writes comments or commands to the Report File and directs the software to write input commands to the Message File.

Syntax

ECHO |ON                   :
     |OFF
     |delimiter string delimiter

delimiter: is a single special character to be used as the ECHO string delimiter. The delimiter cannot be the same as the current system separator or the command terminator. See Special Characters in Appendices .
string: defines a string of characters not containing the character used for the delimiter. The maximum is 249 characters. You can issue as many ECHO string commands as needed.

Examples

ECHO ON:

(echoes commands and results)

ECHO OFF:

(echoes results only)

ECHO/MAP:COMMAND FILE IS INPUT:/:

(writes MAP:COMMAND FILE IS INPUT: on the Report File)

ECHO/THIS IS A COMMENT/:

(writes THIS IS A COMMENT on the Report File)

Rules

The default for a batch job is ECHO ON. The default for an interactive session is ECHO OFF. The defaults are set at the beginning of each session.
If a string is specified, all characters are written to the Report File. The string is written in 80-character lines.
If you specify stored strings or functions in an ECHO string, they are not expanded unless they are later read and processed as a Command File. Characters are written to the Report File exactly as encountered.
If an ECHO string is null (that is, ECHO //:), nothing is written to the Report File.

ENTRY TERMINATOR IS

Changes the entry terminator word. The entry terminator word signals the end of data for a data tree in a loader stream or in an update command.

Syntax

ENTRY TERMINATOR IS word :

word: is a name to be used as the entry terminator word. The name can be from 1 to 4 alphanumeric characters with no blanks. If you use a special character, it must be only one character, and it cannot be the same as the current system separator or the command terminator. See Special Characters in Appendices .

Example

ENTRY TERMINATOR IS FINI:
   .
   .
   .
IT C120*1*1*1 EQ 121*06/30/91*FINI* WH C1 EXISTS:

Rules

The default entry terminator word is END.
If the master password holder changes the entry terminator word, it is changed for all users of that database. The current setting is stored in the database.
If a secondary password holder or the DBA password holder changes the entry terminator word, it is changed only for that database in that session.
The only reason to change the entry terminator word is for readability. No conflict occurs if END is a value in a value stream.

EXIT

Closes the database and ends the session.

Syntax

EXIT :

Example

EXIT:

Rules

Issue EXIT as the last command in a session.
In interactive mode, you must issue EXIT.
In batch mode, if EXIT is not included or not contained in an alternate Command File, the software automatically issues an EXIT command.
If you should need to exit a session right after invoking SYSTEM 2000, you can issue EXIT as the first command in a session before issuing the USER command. That is, the first command in a session must be either the USER command or the EXIT command.

IF...THEN...ELSE

Conditionally executes any sequence of CONTROL, DEFINE, or QUEST commands, and tests system variables.

Syntax

IF expression THEN commands ...

                [ELSE commands ...]

                ENDIF :

expression

|condition
|NOT expression
|(expression)
|expression [AND expression]
|expression [OR expression]

condition

|COMPLETE
|WARNING [OCCURRED]
|ERROR [OCCURRED]
|MESSAGE [NUMBER] binary-operator message
|MESSAGE [NUMBER] ternary-operator message * message
|[SELECTED] RECORDS binary-operator integer
|[SELECTED] RECORDS ternary-operator integer * integer
|DATA BASE CYCLE binary-operator integer
|DATA BASE CYCLE ternary-operator integer * integer
|PASSWORD binary-operator password
|PASSWORD ternary-operator password * password
|MASTER PASSWORD

binary-operator

LT, LE, NE, EQ, GT, or GE

ternary-operator

EQ, SPANS, or NE

message

is a Self-Contained Facility message number.

integer

is a positive number.

password

is a password of 1 to 4 alphanumeric characters with no blanks.

commands

are Self-Contained Facility commands. Each command must end with a command terminator.

Examples

IF MSG = 502 THEN RESTORE MYDATA FROM SAS1234:
              ENDIF:

IF W AND MSG EQ 81 THEN ...

IF COMPLETE THEN ...

IF WARNING OCCURRED THEN ...

IF E THEN ...

IF MESSAGE NUMBER EQ 507 THEN ...

IF MSG SPANS 300* 310 THEN ...

IF MSG > 799 THEN ...

IF SELECTED RECORDS =< 100 THEN ...

IF RECS EQ 4 THEN ...

IF MPW THEN ...

IF PASSWORD = ABC THEN ...

IF DB CYCLE GT 375 THEN ...

Rules

Abbreviations:

     COMPLETE = C
     DATA BASE = DB
     ERROR = E
     MASTER PASSWORD = MPW
     MESSAGE = MSG
     PASSWORD = PW
     RECORDS = RECS
     WARNING = W

IF...THEN...ELSE statements can be nested up to 32 levels.
Use the SHOW command to write the system variables to the Message File. See SHOW .
In a Multi-User environment, IF-ENDIF blocks must be completely contained in a single segment.
You can also use symbols for the following operators:
```
     Operator       Symbol

     EQ              =
     GE              >= or => or ^< or !<
     GT              >
     LE              <= or =< or ^> or !>
     LT              <
     NE              ^= or !=
     AND             &
     OR              |
     NOT             ^ or !
```
Without symbols, the software reads a blank on either side of an operator to separate it from other syntactic units. However, with symbols, blanks are not required for separation. Any blanks encountered following a symbol are considered part of the value.
If you change the system separator to be any of the symbols, syntax errors could occur if you were to specify that symbol in IF...THEN...ELSE logic.

Inserting Comments

A comment can be inserted after any CONTROL, DEFINE, QUEST, QUEUE, or REPORT language command. For example, comments can explain job streams or serve archival purposes.

Syntax

delimiter comment delimiter

delimiter: is a single special character to be used as the comment delimiter. The delimiter cannot be the same as the current system separator or the command terminator. Also, the beginning and ending delimiter must be the same. See Special Characters in Appendices .
comment: defines a string of 1 to 250 characters. It cannot contain the delimiter.

Examples

1*EMPLOYEE NUMBER (INTEGER 9999): &MUST BE FOUR DIGITS&

PRINT C1, C5:
   .
   .
   .
$NEXT COMMAND COMMENTED OUT FOR TEST RUN$
$MESSAGE FILE IS ABCCMT:$

Rules

ECHO ON must be in effect to write comments to the Message File.
Consecutive blanks are counted as one blank toward the 250 character maximum, but single blanks are counted individually.
You can insert a comment anywhere after a command terminator and before the next command.
A comment can span line boundaries like a Self-Contained Facility command.

LOOKUP IS

Provides you some flexibility in changing from one processor to another. If processor lookup is activated and you issue a command that is not valid for the current processor, the software will try to switch you to the appropriate processor.

Syntax

LOOKUP [IS] |OFF :
            |ON

Examples

LOOKUP IS ON:

LOOKUP IS OFF:

Rules

ON activates processor lookup. OFF (the default) disables processor lookup.
Processor lookup switches to the appropriate processor only if the first keyword in a command is unique to one processor. That is, if you issue PRINT SIZE (a CONTROL processor command) from the QUEST processor, you will remain in QUEST because PRINT is a valid keyword for the QUEST processor.
Processor lookup functions only while you are using the QUEST or CONTROL processor. The DEFINE, REPORT, and QUEUE processors accumulate commands over the course of a session, so it would not be appropriate to lose any accumulated (but unexecuted) commands because of a change in processors.
You must explicitly invoke the CONTROL processor in order to issue the RELEASE command. This prevents your releasing a database inadvertently from the QUEST processor.
Your site can enable or disable processor lookup with the execution option OPT045=YES/NO. The default setting at installation time is OPT045=NO, which disables lookup.

MESSAGE FILE IS

Tells the software to write messages and echoes of commands to an alternate Message File.

Syntax

[LOCAL] MESSAGE FILE IS |OUTPUT   :
                        |fileref

LOCAL: directs the software to look for the Message File in your TSO region or CMS machine.
fileref: is the DDname of your alternate Message File. Do not use reserved file names. See Reserved File Names in Appendices .

Examples

MESSAGE FILE IS MYMSG:

LOCAL MESSAGE FILE IS S2KMSG:

Rules

The Message File is set to OUTPUT (which is your terminal or some other output device) at the beginning of each session. You can let SYSTEM 2000 allocate the default file (S2KMSG) dynamically instead of specifying it in the JCL or CLIST.
An alternate file must be described with a DD statement.
If any other SYSTEM 2000 commands appear on the line with this command, the other commands are sent to the current Message File.
Only one Message File can be open at a time, but you can change to a different one at any time and as often as necessary.
The Message File cannot be the same file as the Command File or the Data File.
The Message File must contain fixed-length records, which cannot exceed 140 characters.
Alternate file names must be unique in a Multi-User environment.
The LOCAL option requires the SYS2KTPI interface to Multi-User software.

PROMPT IS

Allows you to choose another system prompt during a session. Instead of the standard three dashes (- - -), the system prompt can be the name of the current processor. Or you can turn the prompt off.

Syntax

PROMPT [IS] |DASH      :
            |PROCESSOR
            |OFF

Example

---
USER, DEMO:
---
DBN IS EMPLOYEE:
---
PROMPT IS PROCESSOR:
QUEST>
LIST C1, C2, C3, C4 WHERE C4 GT 01/01/1988:
   (command output)
QUEST>
PROMPT IS OFF:
DESCRIBE:
   (command output)
PROMPT IS ON:
---

Rules

Abbreviations and Synonyms:

   DASH = DASHES, DASHS, ON, or -
   PROCESSOR = PROC

PROMPT IS DASH (the default) activates the standard prompt of three dashes. OFF suppresses the system prompt. PROCESSOR means that the prompt is the name of the current processor, for example, CONTROL, DEFINE, REPORT, or QUEST.
The ECHO command determines whether the prompt is displayed.
Your site can reset the system prompt with the execution option OPT044=YES/NO. The default setting at installation time is three dashes (OPT044=NO).
If you have written programs that read SYSTEM 2000 output files and the default prompt at your site was changed to be the processor name, you can change the prompt in your jobs to the standard prompt (- - -) with the PROMPT IS command. This will make SYSTEM 2000 output compatible with your programs.
For Multi-User batch jobs, the prompt is always three dashes.

REPORT FILE IS

Immediately switches the software to start writing retrieval command output to an alternate Report File.

Syntax

[LOCAL] REPORT FILE IS |OUTPUT  :
                       |fileref

LOCAL: directs the software to look for the Report File in your TSO region or CMS machine.
fileref: is the DDname of your alternate Report File. Do not use reserved file names. See Reserved File Names in Appendices .

Examples

REPORT FILE IS MYREPORT:

LOCAL REPORT FILE IS RPTOUT:

Rules

The Report File is set to OUTPUT (which is your terminal or some other output device) at the beginning of each session. You can let SYSTEM 2000 allocate the default file (S2KMSG) dynamically instead of specifying it in the JCL or CLIST.
An alternate file must be described with a DD statement.
If any other SYSTEM 2000 commands appear on the line with this command, output from those commands is sent to the current Report File.
Only one Report File can be open at a time, but you can change to a different one at any time and as often as necessary.
The Report File must contain fixed-length records, which cannot exceed 250 characters.
Alternate file names must be unique in a Multi-User environment.
The LOCAL option requires the SYS2KTPI interface to Multi-User software.

SEPARATOR IS

Changes the system separator. The system separator separates labels from values and also marks the end of a value.

Syntax

SEPARATOR IS symbol :

symbol: is a single special character to be used as the system separator. The system separator cannot be used in values, and it cannot be the same as the current where-clause delimiter or the command terminator. See Special Characters in Appendices .

Example

SEPARATOR IS $:
   .
   .
   .
REMOVE TREE ENTRY $ 4:

PRINT ENTRY WHERE C1 SPANS 1100 $ 1251:

Rules

The default is the asterisk.
If the master password holder changes the system separator, it is changed for all users of that database. The current setting is stored in the database.
If a secondary password holder or the DBA password holder changes the system separator, it is changed only for that database in that session.

SHOW

Writes system variables to the Message File.

Syntax

SHOW SYSTEM VARIABLES :

Example

SHOW SYS VARS:

Rules

Abbreviations:

     SYSTEM = SYS
     VARIABLES = VARS

The system variables are: completion code, message number, database cycle number, and number of selected records.
You can issue SHOW within or outside an IF...THEN...ELSE statement. See IF...THEN...ELSE .

TIMING

Reports statistics about I/O requests and CPU utilization for commands.

Syntax

TIMING |OFF :
       |ON

Examples

TIMING ON:

TIMING OFF:

Rules

At the beginning of each session, timing is set to OFF.
Timing statistics are written to the Message File.

Resources

SYSTEM 2000 Quick Reference Guide System-Wide Commands

Changing Processors

Syntax

Example

Rules

COMMAND FILE IS

Syntax

Examples

Rules

DATA FILE IS

Syntax

Examples

Rules

DELIMITER IS

Syntax

Example

Rules

ECHO

Syntax

Examples

Rules

ENTRY TERMINATOR IS

Syntax

Example

Rules

EXIT

Syntax

Example

Rules

IF...THEN...ELSE

Syntax

Examples

Rules

Inserting Comments

Syntax

Examples

Rules

LOOKUP IS

Syntax

Examples

Rules

MESSAGE FILE IS

Syntax

Examples

Rules

PROMPT IS

Syntax

Example

Rules

REPORT FILE IS

Syntax

Examples

Rules

SEPARATOR IS

Syntax

Example

Rules

SHOW

Syntax

Example

Rules

TIMING

Syntax

Examples

Rules