ADD [ DICTIONARY 3000 ] MPE/iX 5.0 Documentation
DICTIONARY 3000
ADD
Adds an association between unlike entities.
Syntax
[option] ADD subcommand
A
Use the ADD command to associate an element, a file, or a procedure with
an unlike entity. The association is one of ownership. The subcommand
identifies the type of entity for which an association is made. For
example, ADD CATEGORY associates a data element with a category. In
other words, the data element now "belongs" to that category. Similarly,
ADD FILE-LOC associates a file with a physical location. The file now
"belongs" to that location.
Like entities (such as file to file) can not be associated through the
ADD command. (See the RELATE command to relate like entities.)
Data elements can be added to a file's primary format or as secondary
format. The primary list of elements associated with a file defines the
primary format for that file. This is the default format and is used by
the Dictionary utilities and HP Inform. Any number of elements can be
associated with the primary format of a file.
A secondary format is an alternate format for a file's storage area
(which contains the elements associated with the file). It is used by
the DICTCDE utility to generate the REDEFINE clause in a COBOL II data
division. (For more information on the DICTCDE utility, see Section 5 of
this manual.) A file may have multiple secondary formats, each one
represented by a single data element. Each element associated with a
secondary format should reflect the alternate format for the file. (For
instance, that element could be a parent element with several child
elements related to it.)
Elements cannot be associated with a parent entity (an entity that has
subordinate entities related to it) unless the parent entity is a
procedure. Elements may be associated with parent procedures which have
child procedures related to them.
When data elements are associated with an entity, they are added to that
entity's list of associations in the order in which they were associated.
(See the RESEQUENCE command to change this order.)
Subcommands
Any of the following subcommands can be used with the ADD command:
CATEGORY adds a data element to a category
CLASS adds a data element to a user security class
CLASS-FILE adds a file to a user security class
CLASS-GROUP adds a group to a user security class
FILE adds a data element to a file
FILE-LOC adds a file to a physical location
GROUP adds a data element to an HP Inform group
PROCEDURE adds a data element to a procedure
PROCEDURE-LOC adds a procedure to a physical location
Example
>ADD FILE
FILE> Orders Existing file.
PRIMARY/SECONDARY(P/S)?> P Indicates element is to be in
primary format.
ELEMENT> Customer1 Adds an element to a file.
ELEMENT ALIAS>
DESCRIPTION> Customer-account information used by Finance.
>
ELEMENT>
> New command prompt.
Subcommand Prompts
For the prompts shown with an asterisk (*), you must enter a response
other than [[RETURN]] in order to implement the command string. Two
asterisks (**) next to a prompt indicate that this prompt and those which
follow are repeated until [[RETURN]] is pressed in response to this
prompt.
You enter: You are prompted for:
SUB-
COMMAND COMMAND PROMPT
ADD CATEGORY * CATEGORY
** ELEMENT
ELEMENT ALIAS
DESCRIPTION
ADD CLASS * CLASS
** ELEMENT The following prompts are
* ACCESS CAPABILITY issued only if CLASS is not
DESCRIPTION an INFO type; otherwise CLASS
is reissued.
ADD CLASS-FILE * CLASS The following prompts are
** FILE issued only if CLASS is not
an INFO type.
ACCESS CAPABILITY Issued only if file type is
MAST, DETL, or AUTO.
DESCRIPTION
ADD CLASS-GROUP * CLASS
** GROUP
DESCRIPTION
ADD FILE * FILE
1. if FILE is MAST file
** ELEMENT Prompt is KEY ELEMENT if first
element added to MAST.
ELEMENT ALIAS
DESCRIPTION
2. if FILE is MPEF or MPER file
PRIMARY/SECONDARY(P/S)?
** ELEMENT
ELEMENT ALIAS
DESCRIPTION
3. if FILE is AUTO file
* KEY ELEMENT
ELEMENT ALIAS
DESCRIPTION
4. if FILE is DETL file
** ELEMENT
ELEMENT ALIAS
PATH MASTER FILE * If element is search item.
PATH SORT ELEMENT Issued if PATH MASTER FILE
responded to.
* If element's chain is to be
sorted.
PRIMARY PATH(N/Y) Issued if PATH MASTER FILE
responded to.
* If element defines the
primary path.
DESCRIPTION
5. if FILE is KSAM file
PRIMARY/SECONDARY(P/S)?
** ELEMENT
ELEMENT ALIAS
KEY ELEMENT (N/Y) Issued if element is being
added to the Primary format
and element TYPE is not B, S,
or *.
* If element is KEY element.
PRIMARY KEY(N/Y)? Issued if Y entered for KEY
ELEMENT and no primary key
exists.
DUPLICATES(N/Y)? Issued if Y entered for KEY
ELEMENT or for PRIMARY KEY.
DESCRIPTION
6. if FILE is FORM file
ELEMENT
ELEMENT ALIAS
FIELD NUMBER
DESCRIPTION
ADD FILE-LOC * LOCATION
** FILE
FILE ALIAS
FILE SIZE Issued only if file type is
MPEF, MPER or KSAM.
DESCRIPTION
ADD GROUP * GROUP
** ELEMENT
ELEMENT ALIAS
FILE
PARENT FILE Issued only if file belongs
to more than one database.
VALUE AS A LINK
DISPLAY ELEMENT ON MENU (Y/N)?
DESCRIPTION
ADD PROCEDURE * PROCEDURE
** ELEMENT
ELEMENT ALIAS
DESCRIPTION
ADD PROCEDURE-LOC * LOCATION
** PROCEDURE
PROCEDURE ALIAS
DESCRIPTION
Prompts
Depending on the subcommand used, one or more of the following prompts is
issued:
ACCESS CAPABILITY Enter the type of capability to be assigned to
the user security class for the file or element
as follows:
If the subcommand is:
CLASS-FILE - enter one of the following:
R = read only
W = read, write, modify
X = null read/write list "(/)"
CLASS - enter one of the following:
R = read only
U = read and update only
M = read, write and modify
X = null read/write list "(/)"
Refer to the IMAGE Reference Manual for a
detailed explanation of the user class access
capabilities.
CATEGORY Enter the name of an existing category (20
characters maximum).
CLASS Enter a numeric value which is the identifying
number of an existing user security class (0 to
9999).
To establish INFORM security, enter a numeric
value which is the identifying number of an
existing INFO type security class.
DESCRIPTION Enter the textual description which describes
the association between the entities (50
characters per line maximum, unlimited number
of lines).
DISPLAY ELEMENT ON MENU Enter a response to specify whether you want
(Y/N)? the element to be displayed for reporting on HP
Inform's Data Names Menu.
DUPLICATES(N/Y)? This prompt generates data that will be used by
the DICTCDE utility. Enter a Y or YES if this
key may have duplicate key values for this KSAM
file. Enter a N or NO if a duplicate key value
is not allowed.
ELEMENT Enter the name of an existing data element
which is the primary element (20 characters
maximum).
ELEMENT ALIAS Enter the name by which the data element is
known within the file. The maximum characters
allowed are:
15 for FORM
16 for MAST, AUTO or DETL
20 for MPEF, MPER or KSAM
60 for CATEGORY
20 for an HP Inform GROUP
16 for PROCEDURE
DEFAULT: If [[RETURN]] is pressed in response
to this prompt for an element, the alias
becomes the primary element name.
Note that HP Inform and HP Report will be
unable to retrieve the values of an element
from an IMAGE data set if the alias name
entered in response to the ELEMENT ALIAS prompt
of the ADD FILE command string is not the same
as the actual name of the data element in the
data set.
FILE Enter the name of an existing file (20
characters maximum). Enter the following file
names for the appropriate subcommand:
If the subcommand is:
FILE - the file type must be one of the
following:
MAST IMAGE manual master data set
AUTO IMAGE automatic master data set
DETL IMAGE detail data set
KSAM KSAM file
MPEF MPE sequential file
MPER MPE relative file
FORM VPLUS form
CLASS-FILE - the file type must be one of the
following:
BASE IMAGE database
MAST IMAGE manual master data set
AUTO IMAGE automatic master data set
DETL IMAGE detail data set
KSAM KSAM file
MPEF MPE sequential file
MPER MPE relative file
VPLS VPLUS forms file
FILE-LOC - the file type must be one of the
following:
BASE IMAGE database
KSAM KSAM file
MPEF MPE sequential file
MPER MPE relative file
VPLS VPLUS forms file
GROUP- the file must have at least one parent
(BASE) if it is type MAST, AUTO, or DETL and
the element must have previously been
associated with the file.
FIELD NUMBER Enter the field number of this element on the
VPLUS form.
FILE ALIAS Enter the name by which the file is known
within the location (8 characters maximum).
DEFAULT: If [[RETURN]] is pressed in response
to this prompt, the alias name becomes the
first 8 characters of the file name.
FILE SIZE Enter an integer value for the number of
records in the file in that location (0 to
999999999). DEFAULT is 0.
GROUP Enter the name of an existing HP Inform group
(20 characters maximum).
KEY ELEMENT Enter the name of an existing data element (20
characters maximum) that is as appropriate:
For an AUTO file, the search item and only item
for an IMAGE automatic master set.
For a MAST file, the first element added to an
IMAGE manual master set.
For a KSAM file, an element to be used as a key
for a KSAM file.
KEY ELEMENT(N/Y)? Enter Y or Yes if this element is to be a key
element for the KSAM file. DEFAULT is No.
LOCATION Enter the name of an existing location (20
characters maximum).
PARENT FILE Enter the name of the existing parent file (20
character maximum) of the database set
specified by the preceding FILE prompt. The
file type must be type BASE (IMAGE database).
PATH MASTER FILE Enter the name of an existing file (20
characters maximum) of type MAST or AUTO which
is the chain header for a detail set path.
DEFAULT: Pressing [[RETURN]] in response to
this prompt indicates that the element is not
to be a search item.
PATH SORT ELEMENT Enter the name of an existing data element (20
characters maximum) that is the sort item for a
sorted chain. This prompt is issued if a
master data set's name was given in response to
the prompt for PATH MASTER FILE. DEFAULT:
Pressing [[RETURN]] in response to this prompt
indicates that this is not a sorted chain path.
PRIMARY KEY(N/Y)? This prompt generates data that will be used by
the DICTCDE utility. Enter Y or YES if this
element is to be a primary key for the KSAM
file. This prompt will appear for each element
associated with the KSAM file until a primary
key is designated. Once an element is entered
as a primary key, the prompt will not appear
again for that file. DEFAULT is No. Note that
if you respond to this prompt with NO (or you
press [[RETURN]] as the default) then this
element is assumed to be an alternate key for
the KSAM file.
PRIMARY PATH(N/Y)? If the element is a search item, a Y indicates
that it is the primary path for the detail data
set.
Note that if a primary path has already been
specified during the current prompting cycle of
the ADD FILE command string, this prompt is not
issued. Next time the ADD FILE command string
is issued and the file is an IMAGE detail data
set, this prompt is issued again; however,
responding Y to this prompt now results in the
prompt PRIMARY ALREADY EXISTS, CONTINUE(Y/N)?.
The default response of Y makes this the
primary path and cancels the primary path
previously identified; responding N or No does
not make this the primary path and the primary
path previously identified remains active.
PRIMARY/SECONDARY (P/S)? Enter P if this element is to be added to the
Primary format for this file. Enter S if this
element is to be added as a Secondary format
for this file. DEFAULT is P (Primary format).
(See the discussion of the ADD command for more
information on Primary and Secondary formats.)
Note that Secondary formats are used for COBOL
II programs only.
PROCEDURE Enter the name of an existing procedure (20
characters maximum).
PROCEDURE ALIAS Enter the name by which the procedure is known
within the location (8 characters maximum). If
[[RETURN]] is pressed in response to this
prompt, the alias becomes the first 8
characters of the procedure name.
VALUE AS A LINK Enter -1, 0, or a positive integer to specify
the preferred elements to be used in linking
files. The numbers indicate the following:
-1 The element can not be used for
linking.
0 The element may or may not be
used for linking (DEFAULT).
1 or more The element should be used as a
link when possible; elements
assigned a positive value form a
prioritized list to be used when
it is necessary to link files
(the lower the positive integer,
the higher the priority).
MPE/iX 5.0 Documentation