DEFINE Command [ HP SYSTEM DICTIONARY XL COBOL DEFINITION EXTRACTOR Reference Manual ] MPE/iX 5.0 Documentation
HP SYSTEM DICTIONARY XL COBOL DEFINITION EXTRACTOR Reference Manual
DEFINE Command
The DEFINE command opens the System Dictionary. You must open the
dictionary before you can generate COBOL source with the GENERATE
command. You can generate COBOL source code with the STANDARDS-PARM
command without opening the dictionary. When opening the dictionary for
the first time, the scope-name and scope-password are required.
Syntax
DEFINE [;DICTIONARY = dictionary-filename]
[;SCOPE = scope-name]
[;PASSWORD = [scope-password]]
[;DOMAIN = [domain-name]]
[;VERSION = [version-name]]
[;STATUS = version-status]
[;OPEN-MODE = open-mode]
[;NAME-MODE = name-mode]
{.}
Parameters
dictionary- Specifies the name of the dictionary to be opened. The
filename initial default for the DICTIONARY parameter is SYSDIC.
After the dictionary is opened, the default is the
currently opened dictionary.
scope-name Specifies the name of the scope from which to retrieve
definitions. The SCOPE parameter is required when
opening the dictionary for the first time.
scope-password Gives access to the scope. Any characters are allowed
in a password. If a character in the password is not
valid in other System Dictionary names (that is, on the
restricted list), you must enter the password within
quotes to allow recognition of the "restricted"
characters.
If you specify the SCOPE parameter and not the PASSWORD
parameter, you will be prompted for the password. For
security reasons, the echo is turned off and you are
given three chances to enter the correct password. If
you are in session mode and the correct password is not
entered after three tries, the DEFINE command terminates
and the command prompt (>) is displayed. If you are in
batch mode and the correct password is not entered after
three tries, the program terminates. The password is
always read from $STDINX.
domain-name Specifies the name of the dictionary domain in which the
dictionary is to be opened. The initial default for the
DOMAIN parameter is the common domain. After the
dictionary is opened, the default is the current domain.
If you are in another domain and you want to get back to
the common domain, specify "DOMAIN=;" with no value.
version-name Specifies the name of the version under which the
dictionary is opened. When the VERSION parameter is
blank, the value of the STATUS parameter opens the
latest version of the current status. The default
version is blank.
version-status The value of the STATUS parameter opens the latest
version of this status. Options are:
TEST Uses the version status TEST.
Dictionary definitions in a version of
TEST status can be modified.
PRODUCTION Uses the version status PRODUCTION.
Dictionary definitions in a version of
PRODUCTION status can only be read.
ARCHIVAL Uses the version status ARCHIVAL.
Dictionary definitions in a version of
ARCHIVAL status can only be read.
The STATUS parameter is effective only when the value of
the VERSION parameter is blank. If you specify both the
VERSION parameter and the STATUS parameter with the
DEFINE command, only the VERSION parameter is used.
SDCDE issues a warning message indicating that the
STATUS parameter was ignored. The initial default for
the STATUS parameter is PRODUCTION. After the dictionary
is open, the default is the current status value.
open-mode Specifies the mode in which to open the dictionary.
Options are:
READ-ALLOW- Allows you to read System Dictionary
READ data definitions, but does not allow
definitions to be created when the
UPDATE-DICT option of the COPYLIB
command is ON. Others can access the
dictionary only for reading.
READ-ONLY Allows you to read System Dictionary
data definitions, but does not allow
definitions to be created when the
UPDATE-DICT option of the COPYLIB
command is ON. Others can also access
the dictionary.
SHARED-UPDATE Allows you to read definitions and
create definitions when the UPDATE-DICT
option of the COPYLIB command is ON.
Others can also access the dictionary.
EXCLUSIVE- Allows you to read definitions and
UPDATE create definitions when the UPDATE-DICT
option of the COPYLIB command is ON. No
one else can access the dictionary.
The initial default is to open the dictionary in
SHARED-UPDATE mode.
name-mode Specifies which group of names (internal or external)
you wish to use. Options are:
INTERNAL Uses internal names. Internal names
can never change.
EXTERNAL Uses external names. External names
are fully customizable and localizable.
The default for the first open is EXTERNAL.
Example
The following example opens the dictionary SYSDIC using the scope MANAGER
in SHARED-UPDATE open mode. The password MGR* allows access to the
scope.
>DEFINE DICTIONARY=SYSDIC;
>>SCOPE=MANAGER;
>>PASSWORD=MGR*;
>>OPEN-MODE=SHARED-UPDATE.
>
MPE/iX 5.0 Documentation