Dictionary/3000 HP 3000 MPE/iX Computer Systems Edition 4 Manufacturing Part Number: 32244-90001 E1287 U.S.A.
Notice The information contained in this document is subject to change without notice. Hewlett-Packard makes no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability or fitness for a particular purpose. Hewlett-Packard shall not be liable for errors contained herein or for direct, indirect, special, incidental or consequential damages in connection with the furnishing or use of this material.
Contents 1. Introducing Dictionary/3000 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What is a Data Dictionary? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to Use Dictionary/3000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to Use this Manual . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Adding Entities to an IMAGE Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 Adding Inform Groups to Inform Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Using Selection Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 Using Edit Description Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Subcommands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subcommand Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 6. The Dictionary DICTPDE Utility Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183 Initiating DICTPDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184 Changing Input, List and Output Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186 ALTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Subcommands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . >LIST ALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Discussion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents A. DICTDBM Error Messages USER Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282 PROG Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .283 SYSTEM Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284 TRAP Messages . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Glossary 9
Contents 10
Preface This manual describes the Dictionary/3000 software system that operates on HP 3000 computers. It is the reference document for all persons involved in creating and maintaining a dictionary database and an IMAGE/3000 data base. It assumes a working knowledge of the HP 3000 computer system, including the IMAGE/3000 subsystem.
Manual and Manual Part Number MPE Command Reference Manual 30000-90009 MPE Error Messages and Recovery Manual 30000-90102 Using Files 30000-90015 IMAGE/3000 Reference Manual 32215-90003 VPLUS/3000 Reference Manual 32209-90001 KSAM/3000 Reference Manual 30000=90079 30000-90079 Transact/3000 Reference Manual 32247-90001 HP Inform/3000 User's Guide 32246-90001 PASCAL/3000 Reference Manual 32106-90001 COBOL II/3000 Reference Manual 32233-90001 Self-Paced Course and Course Product Number Prog
1 Introducing Dictionary/3000 Overview Dictionary/3000 is a comprehensive set of programs that you can use to: • Create any number of data dictionaries • Create and maintain entries in the dictionary • Create and maintain an IMAGE/3000 database • Create HP Inform/3000 groups • Generate COBOL and PASCAL data definitions What is a Data Dictionary? A data dictionary is a directory of information about the definition, structure, and usage of data. It does not contain the data itself.
Introducing Dictionary/3000 Overview • Physical locations • Organizational structures • Application programs • Security for databases, files, and for HP Inform/3000 • Relationships between the entries • Formats used for COBOL programs DICTDBM is discussed in detail in Sections II and III of this manual. The DICTDBM commands and subcommands are discussed in Section IV. Dictionary/3000 also includes a comprehensive set of utilities.
Introducing Dictionary/3000 Overview Table 1-1. Dictionary/3000 Utilities Utility Function Manual Reference Database Load (DICTDBL) Loads data from tape or disk into IMAGE database files. DICTDBL allows selective loading of data set files. Chapter 5 Data Dictionary Cleanup (DICTDBM, UTIL) Performs periodic maintenance on the Dictionary. DICTDBM, UTIL removes superfluous information that may exist as a result of extensive DICTDBM use.
Introducing Dictionary/3000 How to Use this Manual How to Use this Manual This manual is divided into the following sections: Chapter 1 Introduces Dictionary/3000. Chapter 2 Describes the concepts behind and the use of DICTDBM — a program designed to create and maintain entries in the Dictionary. Chapter 3 Provides an explanation of the commands used to create and maintain entries for various structures. Chapter 4 Describes the DICTDBM commands used to create and maintain entries in the Dictionary.
2 How to Run Dictionary/3000 Overview Dictionary/3000 provides a Database Maintenance program (DICTDBM) to create and maintain entries in the Dictionary. This section describes how to run the program and use its HELP facility, describes the syntax for the commands in the program, defines the options that can be used with the commands, and lists all the commands and subcommands available in the DICTDBM program.
How to Run Dictionary/3000 Overview Whenever a choice between two options is given within parentheses, the first choice listed is the DEFAULT choice, unless otherwise specified; thus, just pressing RETURN is the same as entering that choice. After responding to the FORMS ENTRY prompt, DICTDBM issues a command prompt (>). You are now ready to use DICTDBM commands to create, manipulate, or maintain entries in the Dictionary.
How to Run Dictionary/3000 Command Syntax Command Syntax A DICTDBM command string has the following syntax: Syntax [option] COMMAND subcommand option A list of one or more command options which enhance or modify the action of the command. For example, REPEAT, SORT, etc. (See Options Used With Commands, described next, for an explanation of each option.) COMMAND Specifies the command action. For example, ADD, RELATE, etc. subcommand Specifies the target of the command's action.
How to Run Dictionary/3000 Command Syntax use for the REPEAT option is with the CREATE command when more than one data element is to be created. For instance, if you enter REPEAT CREATE ELEMENT, the prompt for ELEMENT is repeated, allowing you to create many data elements without re-entering the command. The ELEMENT prompt is repeated until you enter the terminating character.
How to Run Dictionary/3000 Special Character Options Special Character Options The following characters have special meaning when used in response to a DICTDBM prompt: ! In response to a prompt, terminates the prompting cycle within the command. It is equivalent to pressing RETURN to all subsequent prompts.
How to Run Dictionary/3000 Commands and Subcommands Commands and Subcommands The following is a list of the DICTDBM commands and subcommands, and their abbreviations, that can be used with the Dictionary. In Section IV, which describes the commands, each description includes a list of the subcommands that can be used with that command (see Section IV).
How to Run Dictionary/3000 Command Usage Chart Command Usage Chart The following chart indicates the order in which the Dictionary commands can be used. The HELP command can be issued any time during a command sequence as long as the command prompt (>) appears. CREATE RELATE ADD REPORT SHOW REPORT DISPLAY LIST SHOW RESEQUENCE RENAME REORDER UPDATE MODIFY CHANGE DELETE PURGE REMOVE SECURE The chart shows that entities must first be created in the dictionary through the CREATE command.
How to Run Dictionary/3000 Command Usage Chart The commands which follow the ADD command (REPORT, SHOW, RESEQUENCE, UPDATE, DELETE, and SECURE) can be used to display or modify entities which have been ADDed to other entities. For example, these commands can be used to display or modify an element which has been added to a file. Entities are always added to unlike entities - that is, an element is added to a file, but an element can not be added to another element.
How to Run Dictionary/3000 Command Usage Chart Chapter 2 25
How to Run Dictionary/3000 Command Usage Chart 26 Chapter 2
3 Using the DICTDBM Commands Overview The DICTDBM commands are used to create and maintain entries in the Dictionary. These entries define and describe data elements and structures. Each entry in the Dictionary is unique.
Using the DICTDBM Commands Using Commands to Define a Database Using Commands to Define a Database An IMAGE database can be defined in the Dictionary in two ways. For an existing IMAGE database, use the Database Definition utility program (DICTDBD) to transfer the database definitions from the database root file to the Dictionary. Refer to Section V of this manual for information on this utility. The second way is to use the commands provided by the DICTDBM program.
Using the DICTDBM Commands Using Commands to Define a Database Creating Elements and Files for a Database An element or a file must be defined in the Dictionary before it can be associated or related to another entry. The CREATE command is used to define an entry for a data element or a file. Either the command string CREATE ELEMENT or CREATE FILE is used to create the entry in the Dictionary. The name for the element or the file must be unique.
Using the DICTDBM Commands Using Commands to Define a Database Adding Data Elements to Data Sets The ADD command is used to associate the data elements with the data sets. Use the command string ADD FILE to define this association. An entry is defined that associates an element with a data set. Elements may not be associated with a BASE file directly. DICTDBM will not accept such an entry and will issue an error message. To display the association entries, use either the REPORT or SHOW commands.
Using the DICTDBM Commands Using Commands to Define a Database Creating a Database The Database Creation utility program (DICTDBC) can be used to create a schema file and a root file from the definition in the Dictionary. Note that the definition, associations, and relationships must already be defined in the Dictionary to use this utility. See Section V of this manual for a detailed description of this utility.
Using the DICTDBM Commands Using Commands to Define Other File Structures Using Commands to Define Other File Structures MPE files, MPER files, KSAM files and VPLUS forms files can also be defined in the Dictionary. The DICTDBM commands are used to create and define these files in the Dictionary. For MPE, MPER, and KSAM files, you define the record layout for the file. In the Dictionary, each field in the record is created as a data element with characteristics such as type, size, and so forth.
Using the DICTDBM Commands Using Commands to Define Other File Structures Creating MPE, MPER, KSAM, and VPLUS Elements and Files Creating files and data elements for these structures is similar to creating them for a database. An element or a file must be defined in your Dictionary before you can associate or relate it to another entry. To define the entries, use the command string CREATE ELEMENT or CREATE FILE. The name used for the element or the file must be unique.
Using the DICTDBM Commands Using Commands to Define Other File Structures Security for MPE, KSAM, and VPLUS Files Security as defined and used for IMAGE databases is not applicable to MPE files, KSAM files, and VPLUS forms files. For these files "lockwords" are used for protection. The CREATE command is used to define a security class for the lockword. In the Dictionary, the lockword for the file is called the PASSWORD.
Using the DICTDBM Commands Using Command to Define Procedures Using Command to Define Procedures The Dictionary can be used to capture the data processing environment for your company by defining all the application programs, the routines, the subroutines, and the variables used in the Dictionary. The Dictionary uses PROCEDURES to document this information. Each program, routine, or subroutine is a procedure in the Dictionary.
Using the DICTDBM Commands Using Command to Define Procedures Note that Dictionary/3000 will not allow you to document recursive procedures. That is, if a procedure has been documented as a CHILD of another procedure, Dictionary/3000 will not allow you to specify that other procedure as a CHILD of the first one. The following description outlines the steps involved when you use the DICTDBM commands to define procedures.
Using the DICTDBM Commands Using Command to Define Procedures Adding Data Elements to Procedures The ADD command is used to associate data elements with a procedure. Use the command string ADD PROCEDURE to define the association. An entry is defined that associates the element with the procedure. To display the entries, use either the REPORT command or the SHOW command. An association entry can be deleted by using the DELETE command or it can be changed by using the UPDATE command.
Using the DICTDBM Commands Using Commands to Define Locations Using Commands to Define Locations The Dictionary can also be used to document the physical locations where procedures and files are used. DICTDBM uses LOCATIONS to capture this information. The specific MPE group and account, and the machine on which the procedure or data file is used, can be identified. This information is helpful when a change to a procedure or file occurs because it tells you where the procedure or data file resides.
Using the DICTDBM Commands Using Commands to Define Categories Using Commands to Define Categories The Dictionary provides a way for you to identify functional areas in your business and to show how information flows from area to area. The Dictionary uses CATEGORY to define this information. Each functional area is a category in the Dictionary. The information may consist of departments, people, functions, documents, and so forth.
Using the DICTDBM Commands Using Commands to Define Categories Creating Elements and Categories To create data element and category entries, use the CREATE command. You use the command string CREATE ELEMENT or CREATE CATEGORY to define the entry. An element or a category must be defined in the Dictionary before it can be associated or related to other entries. The name you use for the category or the element must be unique. The created entries can be displayed using the LIST or DISPLAY commands.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups Using Commands to Define HP Inform/3000 Groups The Dictionary must be properly set up in order to produce the desired reports using HP Inform/3000. Usually this is the responsibility of the Database Administrator (DBA). HP Inform/3000 enables the user to define and create reports from data contained in IMAGE databases, MPE files, and KSAM files.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups Figure 3-5. Summary of Hierarchical Structure for Groups $MENU PARENT/CHILD group PARENT group GROUP GROUP ... CHILD group CHILD group GROUP GROUP ... PARENT/CHILD group data elements data elements GROUP ... CHILD group data elements $MENU is the top of the structure and is the PARENT group. Other groups are related to $MENU and are CHILD groups.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups After creating entries in the Dictionary, you can use the LIST or DISPLAY commands. If you want to delete an entry, use the PURGE command. To change an entry, use either the MODIFY or RENAME commands. The RELATE ELEMENT command string can be used to define CHILD elements (fields) within a PARENT data element.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups Adding Elements to Groups The ADD GROUP command string associates data elements with previously created groups. The data element must already exist in the data Dictionary. The Dictionary will prevent you from associating elements with a PARENT group by issuing an error message and reissuing the prompt for GROUP.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups • If only one of the elements can link all the files, then give it a high priority link value (1) and let the link values of the others default (0). * If more than one element is needed to link the files, give a link value of 1 to the one that should be tried first, 2 to the one that should be tried next, and so on. Use -1 if you never want the element to be used as a link and 0 (the default) if the element could be used if needed.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups • no other potential driving file has been designated which has a higher priority link value specified and contains an element requested for the report. Hence, if you respond to the FILE prompt and designate a link value of 1 for a particular element, the specified file will be accessed first whenever any element which exists in that file is requested in a report.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Groups Example >ADD GROUP GROUP> marketing ELEMENT> name ELEMENT ALIAS> employee name < < < FILE> ! < ELEMENT> date < ELEMENT ALIAS> date of hire FILE> empfile VALUE AS A LINK> < < < DISPLAY ELEMENT ON MENU (Y/N)?n DESCRIPTION> ELEMENT> Chapter 3 < 47
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security Using Commands to Define HP Inform/3000 Security HP Inform/3000 security prevents unauthorized persons from gaining read access to the Dictionary by limiting the names of the database files and Inform groups displayed on the Inform menus. When Inform security is set up in the Dictionary, Inform menus will display only the information granted a user via an Inform password.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security Note that the database file must be directly associated with the IMAGE class or Inform will not give you access to any of the database sets or elements. Each data set and element in the database must also be directly associated with the same IMAGE class as the database file or Inform will not give you access to that data.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security Depending on how Inform security is to be implemented, an Inform group or sub-group can belong to more than one Inform class. An element can also belong to more than one IMAGE class. Creating Inform Classes In the Dictionary, Inform classes are created as INFO type classes and are identified by an integer from 0 through 9999. Use the CREATE CLASS string to create an Inform class.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security To associate an element with an IMAGE class, use the ADD CLASS command string. To associate a file to an IMAGE class, use the ADD CLASS-FILE command string. You can also use the SECURE command to assign all the elements associated with a file to an IMAGE class. By using the SECURE FILE command string, you can avoid adding each individual element, one at a time, to an IMAGE class.
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security Example Defining Inform Security for a database >REPEAT CREATE CLASS CLASS> 101 To CREATE the INFO class NAME> TYPE> INFO PASSWORD> BOSS RESPONSIBILITY> DESCRIPTION> CLASS> 10 To CREATE the IMAGE class NAME> TYPE> PASSWORD> VP RESPONSIBILITY> DESCRIPTION> CLASS> >RELATE CLASS To RELATE the INFO class to the IMAGE class PARENT CLASS> 101 CHILD CLASS> 10 DESCRIPTION> CHILD CLASS> >SECURE FILE To SECURE the database, data sets,
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security FILE> DATASET1 ACCESS CAPABILITY> R DESCRIPTION> FILE> DATASET2 ACCESS CAPABILITY> R DESCRIPTION> >ADD CLASS To ADD elements to the IMAGE class CLASS> 10 ELEMENT> E1 ACCESS CAPABILITY> R DESCRIPTION> ELEMENT> E2 ACCESS CAPABILITY> R DESCRIPTION> ELEMENT> E3 ACCESS CAPABILITY> R DESCRIPTION> Defining Inform Security for Groups: Sales Group and Account Orders The elements for the Sales Group are Account, Sales Rep, and Address and
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security TYPE> PASSWORD> SAFE RESPONSIBILITY> DESCRIPTION> >RELATE CLASS To RELATE the IMAGE class to the INFO class PARENT CLASS> 100 CHILD CLASS> 301 DESCRIPTION> CHILD CLASS> 302 DESCRIPTION> CHILD CLASS> >ADD CLASS To ADD elements to the Image class CLASS> 301 ELEMENT> ACCOUNT ACCESS CAPABILITY> R DESCRIPTION> ELEMENT> SALES REP ACCESS CAPABILITY> R DESCRIPTION> ELEMENT> ADDRESS ACCESS CAPABILI
Using the DICTDBM Commands Using Commands to Define HP Inform/3000 Security FILE> SALESTAT DESCRIPTION> FILE> CLASS> 302 FILE> WARRANTY DESCRIPTION> FILE> CLASS> >ADD CLASS-GROUP To ADD groups to the INFO class CLASS> 100 GROUP> SALES GROUP DESCRIPTION> GROUP> ACCOUNT ORDERS DESCRIPTION> • If you define a password for Inform Security in upper or lower case characters, Inform expects it to be entered in the exact same way.
Using the DICTDBM Commands Using Selection Criteria Using Selection Criteria When using the DISPLAY or the LIST command string, you can dictate the listing you want to see by entering one of the Selection Criteria values in response to a prompt. A listing can be chosen based on character values, numeric values, or an expression of these values. In all cases, the type of listing is based on the subcommand used.
Using the DICTDBM Commands Using Selection Criteria must be enclosed in quotation marks as follows. If you need more than one line for a selection expression, end the first line with a connector, and another selection line prompt is issued. Examples The following are examples of using carets and connectors: PROD^ and ^NO Values that begin with PROD and end with NO are selected. ACCT^ or PROD^ and ^NO Values that begin with ACCT or values that begin with PROD and end with NO are selected.
Using the DICTDBM Commands Using Edit Description Commands Using Edit Description Commands Three commands allow text editing of a description: MODIFY, CHANGE, and UPDATE. The MODIFY command allows you to alter a description of an entity you entered with the CREATE command; the CHANGE command allows you to alter a description you entered with the RELATE command; the UPDATE command allows you to alter a description you entered with the ADD command.
Using the DICTDBM Commands Using Edit Masks Using Edit Masks You can define the output format for data elements in reports generated by HP Inform/3000, Report/3000, and Transact/3000. You do this by defining an edit mask for a data element to be formatted in a report. An edit mask is a string of characters describing how the data element should look when it appears in a report.
Using the DICTDBM Commands Using Edit Masks Table 3-2.
4 DICTDBM Commands Overview A set of commands is provided by the Dictionary's DICTDBM program, which are used to create and maintain entries in a data Dictionary. These commands are used with a subcommand to identify the entity that receives the action of the command. Each command-subcommand used, generates a series of interactive prompts which allows you to enter the necessary data for each entry.
DICTDBM Commands Overview Table 4-1. Summary of DICTDBM Commands COMMAND FUNCTION SECURE Assigns security for a file's data elements, for the file, or for a group. SHOW Shows hierarchical relationship and association entries. UPDATE Updates an association entry.
DICTDBM Commands ADD ADD Adds an association between unlike entities. Syntax [option] ADD subcommand 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.
DICTDBM Commands ADD 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.
DICTDBM Commands ADD COMMAND SUB-COMMAND PROMPT ** 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 ** KEY 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.
DICTDBM Commands ADD COMMAND SUB-COMMAND PROMPT 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.
DICTDBM Commands ADD 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).
DICTDBM Commands ADD 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).
DICTDBM Commands ADD 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.
DICTDBM Commands ADD 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; respondingNorNodoesnotmakethistheprimarypathandtheprimary 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.
DICTDBM Commands Change Change Changes the description of a relationship established with the RELATE command. Syntax < [option] CHANGE subcommand CHG Use the CHANGE command to change the description of a relationship or to change the attributes of a child entity in the relationship established with the RELATE command. A complete list of attributes which can be changed is given below under Subcommands. The subcommands are used to identify the type of parent entity that defines the relationship.
DICTDBM Commands Change 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.
DICTDBM Commands Change Prompts Depending on the subcommand used, one or more of the following prompts is issued: BLOCKMAX Enter a new maximum physical block length value (in words) for the child file within the parent file (128 to 2048). DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change. CAPACITY Enter a new value for the maximum number of entries for the child file (1 to 999999999). DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change.
DICTDBM Commands Change characters maximum). PARENT CLASS Enter a numeric value which is the identifying number of an existing INFO type security class (0 to 9999). PARENT ELEMENT Enter the name of an existing element that is the parent in the entry (20 characters maximum). PARENT FILE Enter the name of an existing file that is the parent in the entry (20 characters maximum). PARENT GROUP Enter the name of an existing HP Inform group that is the parent in the entry (20 characters maximum).
DICTDBM Commands Create Create Creates a new entity. Syntax [option] CREATE subcommand C Use the CREATE command to define a new entity in the Dictionary. A complete list of entities that can be created in the Dictionary is given below under Subcommands. The subcommand identifies the type of entity to be defined. For example, CREATE GROUP creates a new HP Inform group and CREATE ELEMENT creates a new element entry in the Dictionary. An entity must be CREATED before it can be used with any other command.
DICTDBM Commands Create Subcommand Prompts For the prompts shown with an asterisk (*), you must enter a response other than [[RETURN]] in order to implement the command string. You enter: You are prompted for: COMMAND SUBCOMMAND CREATE CATAGORY PROMPT * CATAGORY LONG NAME TYPE RESPONSIBILITY DESCRIPTION CREATE CLASS * CLASS NAME TYPE PASSWORD RESPONSIBILITY RESTRICT CLASS TO A FILE (N/Y) Issued only f CLASS type is not INFO. FILE * If Yes to RESTRICT CLASS; file type must be BASE.
DICTDBM Commands Create COMMAND SUBCOMMAND PROMPT RIGHT USTIFY (N/Y)? Issued only if TYPEX or U. SYNCHRONIZED (N/Y)? Issued only if TYPE I, J, or K. RESPONSIBIILTY DESCRIPTION CREATE FILE * FILE LONG NAME * TYPE RESPONSIBILITY DESCRIPTION CREATE GROUP * ADDITIONAL FILE ATTRIBUTES (N/Y)? Issued only if file type is KSAM, MPEF or MPER. RECORD FORMAT (F/V/U/S)? Issued only if file type is KSAM, MPEF or MPER. MINIMUM RECORD SIZE Issued only if file type is KSAM, MPEF or MPER.
DICTDBM Commands Create COMMAND SUBCOMMAND CREATE PROCEDURE PROMPT * PROCEDURE LONG NAME TYPE LANGUAGE RESPONSIBILITY DESCRIPTION Prompts Depending on the subcommand used, one or more of the following prompts is issued: ACCOUNT Enter the name for the MPE account associated with the location (8 characters maximum). ADDITIONAL FILE ATTRIBUTES (N/Y)? Enter Y or Yes to generate additional prompts ex which allow you to specify additional attributes for this file.
DICTDBM Commands Create DECIMAL Enter the integer value for the number of digits to the right of the decimal point (0 to 9999). Do not include a position for the decimal point itself. The largest value for each element type is as follows: For types Z, P, and 9, the largest value is 27 digits. For types I, J, and K, the largest value is 28 decimal digits. For types E and R, the largest value is 27 digits without a decimal and 28 digits with a decimal.
DICTDBM Commands Create FILE GROUP If the subcommand is: FILE enter the name for a new file (20 characters maximum). CAUTION: A base name can be up to 20 characters in the Dictionary. Dictionary accepts the full name such as BASE.GROUP.ACCOUNT as a valid name. DICTDBC, however, always uses the first 6 characters of the name as the base name. When DICTDBC encounters a base name in the Dictionary such as BASE.GROUP.ACCOUNT, your base name is created as “BASE.G” which is an invalid base name.
DICTDBM Commands Create MINIMUM RECORD SIZE This prompt generates data that will be used by the DICTCDE utility. Enter the minimum number of characters in the record. DEFAULT is 0. NAME Enter a textual name for the new security class (50 characters maximum). PASSWORD Enter a password for the new security class (8 characters maximum). PROCEDURE Enter the name for a new procedure (20 characters maximum). RECORD FORMAT (F/V/U/S) This prompt generates data that will be used by the DICTCDE utility.
DICTDBM Commands Create For type I, J, and k, the largest value is 29 digits. For type E and R, the largest value is 27 digits without a decimal and 28 digits with a decimal. For type X and U, the largest value is 9999 digits. STORAGE LENGTH (n) The system calculates the storage length in bytes and displays it as “n”. An over-ride value may be entered (1 to 9999), otherwise “n” is used. SYNCHRONIZED (N/Y)? This prompt generates data that will be used by the DICTCDE utility.
DICTDBM Commands Create KSAM KSAM file MPEF MPE sequential file MPER MPE relative file VPLS VPLUS forms file FORM VPLUS form CATEGORY, CLASS, GROUP, or PROCEDURE - enter up to four characters meaningful to you. Or, if this is a CLASS to be used for INFORM security, enter INFO as the class type. UNIT(R/C)? Chapter 4 This prompt generates data that will be used by the DICTCDE utility. Specify the unit used to determine the blocking factor with: R for RECORDS or C for CHARACTERS. DEFAULT is R.
DICTDBM Commands Delete Delete Deletes an association which was established with the ADD command. Syntax [option] DELETE subcommand DEL Use the DELETE command to delete an association between unlike entities established with the ADD command. Only the association is deleted, not the entities. A complete list of associations that can be deleted is given below under Subcommands. The subcommands are used to identify the entity from which an association is to be deleted.
DICTDBM Commands Delete 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.
DICTDBM Commands Delete association (20 characters maximum). FILE If the subcommand is: FILE FILE-LOC or CLASS-FILE enter the name of an existing file used in the association (20 characters maximum). enter the name of an existing file which is to be deleted from the association (20 characters maximum). GROUP Enter the name of an existing HP Inform group used in the association (20 characters maximum).
DICTDBM Commands Display Display Displays information about an entity established with the CREATE, ADD, and/or RELATE commands. Syntax [option] DISPLAY subcommand D Use the DISPLAY command to display the attributes of an entity and, if applicable, the direct relationships and the direct associations of that entity. A direct relationship is the relationship between the displayed entity and its parent entity.
DICTDBM Commands Display LOCATION displays attribute information for a physical location PROCEDURE displays attribute information for a procedure plus the directly associated and/or directly related entities Example > DISPLAY ELEMENT ELEMENT>; ACCOUNT ELEMENT: > TYPE: SIZE: DEC: LENGTH: COUNT: RESPONSIBILITY: ACCOUNT X 10 0 10 1 LONG NAME: MARKETING CUSTOMER ACCOUNT NUMBERS HEADING TEXT: CUSTOMER ACCOUNT NUMBERS ENTRY TEXT: CUSTOMER ACCOUNT NUMBER EDIT MASK: MEASUREMENT UNITS: RIGHT JUSTIFY: D
DICTDBM Commands Display Subcommand Prompts Enter the name for a specific entity or use SELECTION CRITERIA in response to a prompt. (Refer to Using Selection Criteria in Section III for more information.) Responding with an exclamation mark (!) or with [[RETURN]] will display information about all entities for the specified subcommand.
DICTDBM Commands Help Help Provides a brief description of each DICTDBM command and subcommand. Syntax [option] HELP [subcommand] H Use the HELP command to obtain information on: • all DICTDBM commands • any DICTDBM command and its subcommands. To review descriptions of all DICTDBM commands, use the HELP command without a subcommand. To obtain a description of a specific DICTDBM command and its subcommands, use the HELP command with one of the following subcommands listed below.
DICTDBM Commands Help LIST List information for entity/entities with subset of attributes MODIFY Modify attributes and/or description of an entity PURGE Purge entity and all references to it RELATE Establish hierarchical relationship between like entities REMOVE Remove relationships between entities established with RELATE RENAME Rename an existing entity REORDER Reposition entity within relationship established with RELATE REPORT Report a sorted listing of elements RESEQUENCE Reposition e
DICTDBM Commands List List Lists information for an entity or entities with a subset of the attributes. Syntax [option] LIST subcommand L Use the LIST command to see the attributes of: • a particular entity • all entities of a particular type • entities selected by using Selection Criteria (see Section III) A complete list of entities for which a listing can be generated is given under Subcommands. The subcommand identifies the type of entity for which a listing is generated.
DICTDBM Commands List Example > REPEAT LIST ELEMENT ELEMENT> PU^ < TYPE> ! < ELEMENT: TYPE: SIZE: DEC: LENGTH: COUNT: RESPONSIBILITY: PUB-DATE X 6 0 6 1 M. Sides PURCH-DATE X 6 0 6 1 M. Abear PURCH-NO U 6 0 6 1 R. Park PUBLISHER X 40 0 40 1 M. Sides 4 RECORDS FOUND ELEMENT> ^T < TYPE> ! ELEMENT: < TYPE: SIZE: DEC: LENGTH: COUNT: RESPONSIBILITY: CREDIT U 2 0 2 1 J. Smith SUBJECT X 40 0 40 1 M. Sides SQUARE-FEET X 8 0 8 1 R.
DICTDBM Commands List You enter: You are prompted for: COMMAND SUB-COMMAND PROMPT LIST CATEGORY CATEGORY TYPE RESPONSIBILITY LIST CLASS CLASS TYPE RESPONSIBILITY LIST ELEMENT ELEMENT TYPE LIST FILE ELEMENT REFERENCE Issued only if TYPE is “*”. SIZE Issued if TYPE is not “*”. DECIMAL Issued only if TYPE is numeric and TYPE is not “*”. STORAGE LENGTH Issued if TYPE is not “*”. COUNT Issued if TYPE is not “*”. RESPONSIBILITY Issued if TYPE is not “*”.
DICTDBM Commands List Prompts Depending on the subcommand used, one or more of the following prompts is issued. ACCOUNT Enter the name of the existing MPE account or Selection Criteria for which information is to be listed. CATEGORY Enter the name of the existing category or Selection Criteria for which information is to be listed. CLASS Enter the number of the existing security class or Selection Criteria for which information is to be listed.
DICTDBM Commands List PROCEDURE Enter the name of the existing procedure or Selection Criteria for which information is to be listed. RESPONSIBIILTY Enter the name of the person, department, or area, or Selection Criteria for which information is to be listed. SIZE Enter an integer value required to display an element (1 to 9999) or Selection Criteria for which information is to be listed. Include a position for a decimal point if there is one, but do not include one for a sign.
DICTDBM Commands Modify Modify Modifies the information for an entity which was created with the CREATE command. Syntax [option] MODIFY subcommand M Use the MODIFY command to change the attributes and/or the description of an entity created with the CREATE command. The edit description can also be modified with the prompt EDIT COMMAND. Refer to Using Edit Description Commands in Section III for a complete list of EDIT COMMANDs. The subcommand identifies the type of entity to be modified.
DICTDBM Commands Modify Subcommand Prompts For the prompts shown with an asterisk (*), you must enter a response other than [[RETURN]] in order to implement the command string. You enter: You are prompted for: COMMAND SUB-COMMAND MODIFY CATEGORY PROMPT * CATEGORY EDIT DESCRIPTION (Y/N)? EDIT COMMAND>> Issued only if Yes to EDIT DESCRIPTION. TYPE RESPONSIBILITY LONG NAME MODIFY CLASS * CLASS EDIT DESCRIPTION (Y/N)? * EDIT COMMAND>> Issued only if Yes to EDIT DESCRIPTION.
DICTDBM Commands Modify COMMAND SUB-COMMAND PROMPT LONG NAME HEADING TEXT ENTRY TEXT EDIT MASK MEASUREMENT UNITS MODIFY FILE * BLANK WHEN ZERO (N/Y Issued if TYPE is Z or 9. RIGHT JUSTIFY (N/Y)? Issued if TYPE is Z or U. SYNCHRONIZED (N/Y)? Issued if TYPE is I, J, or E. FILE EDIT DESCRIPTION (Y/N)? * EDIT COMMAND>> Issued only if Yes to EDIT DESCRIPTION. EDIT ATTRIBUTES (N/Y)? Issued only if Yes to EDIT DESCRIPTION.
DICTDBM Commands Modify COMMAND SUB-COMMAND PROMPT EDIT DESCRIPTION (Y/N)? * EDIT COMMAND>> Issued only if file type is EDIT DESCRIPTION. EDIT ATTRIBUTES (Y/N)? Issued only if file type is DESCRIPTION. TYPE RESPONSIBILITY LONG NAME MODIFY LOCATION * LOCATION EDIT DESCRIPTION (Y/N)? EDIT COMMAND>> Issued only if file type is EDIT DESCRIPTION. EDIT ATTRIBUTES (N/Y)? Issued only if file type is EDIT DESCRIPTION.
DICTDBM Commands Modify to 0. DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change. CATEGORY Enter the name of an existing category (20 characters maximum). CCTL(N/Y) This prompt generates data that will be used by the DICTCDE utility. Enter Y if the carriage control option for an output file is to be specified. DEFAULT: Pressing [[RETURN]] in response to this prompt indicates that no change is to be made.
DICTDBM Commands Modify DEFAULT: Pressing [[RETURN]] indicates no change is to be made. EDIT ATTRIBUTES (Y/N)? Enter an N if attribute prompts are not to be issued. EDIT COMMAND>> Enter one of the EDIT COMMANDS described under Using Edit Description Commands in Section III. EDIT DESCRIPTION (Y/N)? Enter an N if description text editing is not required. EDIT MASK Enter a new textual edit mask to be used to edit values when displayed for the data element (30 characters).
DICTDBM Commands Modify LONG NAME Enter a new, full textual name for the entity (50 characters maximum). DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change. MAXIMUM BLOCKING This prompt generates data that will be used by the DICTCDE utility. Enter the maximum blocking factor for the file. DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change. MAXIMUM RECORD SIZE This prompt generates data that will be used by the DICTCDE utility.
DICTDBM Commands Modify RECORDING MODE(A/B)? This prompt generates data that will be used by the DICTCDE utility. Enter A to change the recording mode of the file to ASCII. Enter B to change the recording mode of the file to BINARY. DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change. RESPONSIBILITY Enter a new name for the person, department, or area responsible for the integrity of the entity (20 characters maximum).
DICTDBM Commands Modify indicates no change. TYPE If the subcommand is: CATEGORY, CLASS, GROUP, or PROCEDURE enter a new user defined type (4 characters maximum). DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change.
DICTDBM Commands Modify UNIT(R/C)? 106 This prompt generates data that will be used by the DICTCDE utility. Specify the unit used to determine the blocking factor with R for RECORDS or C for CHARACTERS. DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change.
DICTDBM Commands Purge Purge Purges an entity which was created with the CREATE command from the Dictionary. Syntax [option] PURGE subcommand P Use the PURGE command to purge an entity and all references to that entity from the Dictionary. A subcommand is used to identify the kind of entity to be purged. For example, PURGE FILE purges the specified file and all references to the file from the Dictionary.
DICTDBM Commands Purge Example >PURGE ELEMENT ELEMENT> Element 1 < Identifies element DELETE ALL ENTRIES(N/Y)?> Y to be purged. ALL ENTRIES DELETED Confirms request to purge element. > New command prompt. > PURGE FILE FILE> Base1 < Identifies BASE file to be purged. DELETE ALL ENTRIES(N/Y)?> Y Confirms request to purge Base1. PURGE RELATED CHILD FILES(Y/N)?> Y Requests that all related child files be purged.
DICTDBM Commands Purge Subcommand Prompts For the prompts shown with an asterisk (*), you must enter a response other than [[RETURN]] in order to implement the command string. You enter: You are prompted for: COMMAND SUB-COMMAND PURGE CATEGORY PROMPT * CATEGORY DELETE ALL ENTRIES (N/Y)? PURGE CLASS * CLASS DELETE ALL ENTRIES (N/Y)? PURGE ELEMENT * ELEMENT DELETE ALL ENTRIES (N/Y)? PURGE FILE * FILE 1.
DICTDBM Commands Purge Prompts Depending on the subcommand used, one of the following prompts is issued: ANSWER YES OR NO You must respond to this prompt with Y, Yes, N or No. CATEGORY Enter the name of an existing category which is to be purged from the Dictionary (20 characters maximum). CLASS Enter the identifying number of an existing security class which is to be purged from the Dictionary (0 to 9999).
DICTDBM Commands Relate Relate Establishes a hierarchical relationship between like entities. Syntax [option] RELATE subcommand REL Use the RELATE command to establish a hierarchical relationship between entities. The relationship must be between entities of the same type. That is, only categories can be related to categories, files to files, and so forth. A complete list of entities that can be related is given below under Subcommands.
DICTDBM Commands Relate Example > RELATE ELEMENT PARENT ELEMENT> Emp-num < Name of parent element. CHILD ELEMENT> Emp-div < Name of child element. < Name by which the child CHILD ALIAS> Emp-num-id element is known in the relationship. GENERATE BYTE POSITION(N/Y)?> y < Calculates byte offset so that element will follow the last element related to parent element DESCRIPTION > The parent element describes the employee number < > and the child element describes the employee < > division number.
DICTDBM Commands Relate 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.
DICTDBM Commands Relate Prompts Depending on the subcommand used, one or more of the following prompts is issued: BLOCKMAX BYTE POSITION CAPACITY Enter the maximum physical block length (in words) for the file within the database file (128 to 2048). DEFAULT is 512. Enter a positive integer value for the starting position of the child data element field within the parent data element field. First byte position is 1. DEFAULT is 1.
DICTDBM Commands Relate DESCRIPTION Enter a textual description of the relationship (50 characters per description line allowed, unlimited lines). GENERATE BYTE PARENT CATEGORY This prompt generates data that will be used by the POSITION (N/Y)? DICTPDE and DICTCDE utilities. Enter Y or Yes to generate the byte offset for this child element so that it will immediately follow the last child element related to the parent element.
DICTDBM Commands Remove Remove Removes a relationship between entities which was established with the RELATE command. Syntax [option] REMOVE subcommand REM Use the REMOVE command to remove the relationship between entities which was established with the RELATE command. This command does not purge the entities themselves but the relationship between the entities. A complete list of the relationships that can be removed is given below under Subcommands.
DICTDBM Commands Remove 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.
DICTDBM Commands Remove PARENT CLASS Enter a numeric value which is the identifying number of the parent security class from which a relationship is to be removed. PARENT ELEMENT Enter the name of a parent element from which a relationship is to be removed (20 characters maximum). PARENT FILE Enter the name of a parent file from which a relationship is to be removed (20 characters maximum).
DICTDBM Commands Rename Rename Renames an existing entity which was created with the CREATE command. Syntax [option] RENAME subcommand REN Use the RENAME command to change the name of an entity. When an entity is renamed, every reference to the entity in the Dictionary is also changed. A complete list of the entities that can be renamed is given under Subcommands. The subcommand is used to identify the type of entity for which a change is to occur.
DICTDBM Commands Rename 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.
DICTDBM Commands Reorder Reorder Reorders an entity's position in the parent's list of relationships which was established with the RELATE command. Syntax [option] REORDER subcommand REO Use the REORDER command to change the position of a child within the parent's entry list of relationships. A complete list of entities that can be reordered is given below under Subcommands. The subcommand identifies the type of relationship for which an entity's position is to be reordered.
DICTDBM Commands Reorder Subcommand Prompts For the prompts shown with an asterisk (*), you must enter a response other than [[RETURN]] in order to implement the command string.
DICTDBM Commands Reorder PARENT ELEMENT Enter the name of an existing data element that is the parent in the relationship (20 characters maximum). PARENT FILE Enter the name of an existing file that is the parent in the relationship (20 characters maximum). PARENT GROUP Enter the name of an existing HP Inform group that is the parent in the relationship (20 characters maximum). PARENT PROCEDURE Enter the name of an existing procedure that is the parent in the relationship (20 characters maximum).
DICTDBM Commands Report Report Reports a sorted listing of data elements. Syntax [option] REPORT subcommand R Use the REPORT command to display an alphabetized list of data elements owned by an entity or by that entity's children. Note that any element that is owned by more than one entity is listed only once by the REPORT command. The subcommand identifies the entity to be listed. For example, REPORT CLASS lists the elements owned by the named user security class.
DICTDBM Commands Report Example > REPEAT REPORT FILE FILE> product < PRIMARY/SECONDARY(P/S)? < LIST OF PRIMARY FORMAT DATA ELEMENTS UNDER FILE: PRODUCT ELEMENT(PRIMARY): TYPE: SIZE: DEC: LENGTH: COUNT: DESCRIPTION X 30 0 30 1 PROD-NO U 8 0 8 1 FILE> sales < LIST OF PRIMARY FORMAT DATA ELEMENTS UNDER FILE: SALES ELEMENT(PRIMARY): TYPE: SIZE: DEC: LENGTH: COUNT: ACCOUNT X 10 0 10 1 DELIV-DATE X 6 0 6 1 DESCRIPTION X 30 0 30 1 PRICE P 11 0 6 1 PROD-NO U 8 0 8
DICTDBM Commands Report TOTAL P 11 0 6 1 ZIP X 10 0 10 1 FILE> < [[RETURN]] key pressed. > Subcommand Prompts For the prompts shown with an asterisk, you must enter a response other than [[RETURN]] in order to implement the command string.
DICTDBM Commands Resequence Resequence Resequences a data element within an association established with the ADD command. Syntax [option] RESEQUENCE subcommand RES Use the RESEQUENCE command to change a data element's position within an entity's list of associations which was established by the ADD command. A complete list of entities for which data elements can be resequenced is given below under Subcommands. The subcommand identifies the type of entity for which a resequencing is to occur.
DICTDBM Commands Resequence 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.
DICTDBM Commands Resequence this prompt places the resequenced data element at the end of the association list. PRIMARY/SECONDARY (P/S)? Enter P (or press [[RETURN]]) if the element to be resequenced is in the primary format for the file. Enter S if the element is in the secondary format. (See the discussion of the ADD command for more information on primary and secondary formats.) DEFAULT is P.
DICTDBM Commands Secure Secure Secures data elements, files and groups to a security class. Syntax [option] SECURE subcommand SEC Use the SECURE command to either assign all of the data elements associated with a file to one security class or to assign a group and all its child groups to one security class. When using the SECURE command to assign elements to a security class, you may also assign the file and all its child files, if any, to that security class.
DICTDBM Commands Secure Subcommand Prompts For the prompts shown with an asterisk (*), you must enter a response other than [[RETURN]] in order to implement the command string. You enter: You are prompted for: COMMAND SUB-COMMAND SECURE FILE PROMPT * FILE * CLASS * ACCESS CAPABILITY ELEMENTS WILL BE SECURED TO CLASS.
DICTDBM Commands Secure MPER MPE Relative File KSAM KSAM file FILE ACCESS CAPABILITY Enter the type of capability to be given to the user security class for the IMAGE file as follows: R = read only W = read, write, modify X = null read/write list “(/)” Refer to the IMAGE Reference Manual for a detailed explanation of the user class access capabilities. GROUP Enter the name of the INFORM group to be secured (20 characters maximum).
DICTDBM Commands Show Show Shows all the relationships for an entity and the associations for child entities. Syntax [option] SHOW subcommand S Use the SHOW command to display the hierarchical relationship for an entity and the association information for child entities. Relationships are established using the RELATE command and associations are established using the ADD command. The subcommand identifies the entity to be displayed.
DICTDBM Commands Show Example >SHOW FILE FILE> HOUSES < SHOW ALL FILE ELEMENTS(Y/N)?> y FILE: TYPE: RESPONSIBILITY: HOUSES BASE FILE(ALIAS): TYPE: FILE(PRIMARY): CAPACITY: CITY-MASTER MAST CITY-MASTER 101 ELEMENT(ALIAS): CITY-ABBR PROPERTIES: * CITYNAME ELEMENT(PRIMARY): U (4,0,4) CITY-ABBR U (20,0,20) CITYNAME FILE(ALIAS): TYPE: FILE(PRIMARY): CAPACITY: BATH-MASTER AUTO BATH-MASTER 31 ELEMENT(ALIAS): NUMBER-BATHS PROPERTIES: * ELEMENT(PRIMARY): X (4,0,4) NUMBER-BATHS FIL
DICTDBM Commands Show Subcommand Prompts For the prompts shown with an asterisk (*), you must enter a response other than [[RETURN]] in order to implement the command string. You enter: You are prompted for: COMMAND SUB-COMMAND PROMPT SHOW CATEGORY * CATEGORY SHOW CLASS * CLASS SHOW ELEMENT * ELEMENT SHIOW FILE FILE PRIMARY/SECONDARY(P/S)? SHOW GROUP * SHOW LOCATION * LOCATION SHOW PROCEDURE * PROCEDURE Issued if file type is KSAM, MPEF or MPER.
DICTDBM Commands Update Update Updates an association between entities which was established with the ADD command. Syntax [option] UPDATE subcommand U Use the UPDATE command to change the association for an element, a file, or a procedure established with the ADD command. A complete list of entities for which an association can be changed is given below under Subcommands. The subcommand identifies the type of entity association that is changed.
DICTDBM Commands Update 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.
DICTDBM Commands Update COMMAND SUB-COMMAND PROMPT 2. if file type is AUTO, MPEF, MPER or FORM: ELEMENT ALIAS FIELD NUMBER Issued if file type is FORM. 3. if file type is DETL: ELEMENT ALIAS PATH FILE SORT ELEMENT Issued if element is a search item. CANCEL PRIMARY PATH(N/Y)? Issued if element is a search item and the primary path.; PRIMARY PATH(N/Y)? Issued if element is a search item but is not the primary path. 4.
DICTDBM Commands Update COMMAND SUB-COMMAND PROMPT FILE ALIAS UPDAT GROUP * ** GROUP ELEMENT EDIT DESCRIPTION(Y/N)? * ELEMENT COMMAND>> Issued only if Yes to EDIT DESCRIPTION. EDIT ATTRIBUTES(Y/N)? Issued only if Yes to EDIT DESCRIPTION. ELEMENT ALIAS PARENT FILE Issued if file belongs to more than one database. VALUE AS A LINK UPDATE PROCEDURE * ** CHANGE ELEMENT TO DISPLAY(N/Y)? Issued if element is currently nondisplay.
DICTDBM Commands Update Prompts Depending on the subcommand used, one or more of the following prompts is issued: ACCESS CAPABILITY Enter a new type of capability to be given to the user security class for the file or element using one of the following: 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
DICTDBM Commands Update If the subcommand used is CLASS-GROUP, enter a numeric value (0 to 9999) which is the identifying number of the INFO type user security class. DUPLICATES (N/Y)? This prompt generates data that will be used by the DICTCDE utility. Enter Y or Yes to allow this key to have duplicate key values for this KSAM file. DEFAULT is N. EDIT ATTRIBUTES (Y/N)? Enter an N and the prompts to edit the attributes will not be generated (see Subcommand Prompts for which attributes can be changed).
DICTDBM Commands Update KSAM KSAM file MPEF MPE sequential file MPER MPE relative file VPLS VPLUS forms file FILE - enter the name of a file (20 characters maximum).
DICTDBM Commands Update indicates that the data element is no longer to be a search item in the DETL file. DEFAULT: Pressing [[RETURN]] in response to this prompt indicates no change. PRIMARY PATH (N/Y)? Enter a Y if the data element is to become the primary path. If another data element already exists as the primary path, a Y response automatically cancels it. PRIMARY/SECONDARY (P/S)? Enter P (or press [[RETURN]]) if the element to be updated is in the primary format for the file.
DICTDBM Commands Update 144 Chapter 4
5 Dictionary/3000 Utilities Overview Dictionary/3000 provides a set of interactive utilities that allow a Dictionary or database administrator to easily create and maintain entries in the Dictionary. The Dictionary utilities can be used to create, maintain or load IMAGE database entries and to create VPLUS forms file entries in the Dictionary. The utilities can also be used to clean the Dictionary of superfluous information that may accumulate after continued DICTDBM use.
Dictionary/3000 Utilities Overview Initiating the Utilities After logging on, any of the Dictionary utilities can be run. The utilities in this chapter assume that the Dictionary exists in the PUB group of your log-on account. If the Dictionary you wish to use exists in a different MPE group and/or account, you must first identify it by issuing a file equation before running the utility. The file equation should be as follows: FILE DICT.PUB=DICT.group.
Dictionary/3000 Utilities DICTDBA DICTDBA Database Audit Utility The Database Audit utility (DICTDBA) reports on the usage statistics and checks the linkages for an IMAGE database. The report can include information on synonyms and chains for master sets and chain statistics for detail sets. DICTDBA also checks for broken chains. This utility provides two reports, one at the terminal and one is also printed on the line printer.
Dictionary/3000 Utilities DICTDBA The following prompts are then issued to identify the database to be audited: BASE> BASE PASSWORD> MODE> Enter the name of the database in response to the BASE prompt, and enter a password that grants read access to the entire database in response to the PASSWORD prompt. If an incorrect password is entered, the prompt is reissued. Pressing [[RETURN]] in response to the prompt for BASE terminates the utility.
Dictionary/3000 Utilities DICTDBA NUMBER OF ENTRIES WITH SYNONYMS: 0 PO-MASTER A: 0/311 [0%] [0%] SET IS EMPTY ITEM-MASTER M: 44/311 [14%] NUMBER OF ENTRIES WITH SYNONYMS: 1 [2%] SHORTEST SYNONYM CHAIN LENGTH: 1 Detail information on synonym and chain; LONGEST SYNONYM CHAIN LENGTH: 1 synonym % = (synonym count 100)/entry count, in this case (1x100)/44 = 2%. END OF AUDIT RUN The following is an example of a CHAINS report. :RUN DICTDBA.PUB.SYS How to execute the utility.
Dictionary/3000 Utilities DICTDBA PO-MASTER A: 0/311 [0%] SET IS EMPTY ITEM-MASTER M: 44/311 [14%] NUMBER OF ENTRIES WITH SYNONYMS: 1 [2%] SHORTEST SYNONYM CHAIN LENGTH: 1 Synonym chain information for master set. ONGEST SYNONYM CHAIN LENGTH: 1 EXPLODE D: 397/1023 [38%] SEARCH ITEM: PRODUCT-NO Information at the search item level for detail data set. NUMBER OF CHAINS: 22 Chain information begins.
Dictionary/3000 Utilities DICTDBA ITEM-MASTER EXPLODE M: 44/311 D: 397/1023 [14%] ITEM-DETAIL COSTING [38%] D: 0/507 D: 0/1008 [0%] [0%] END OF PROGRAM The Line printer LINKS report is generated as follows: RUN MODE: LINKS Identifies run mode selected. BASE: SHPMGT.PUB.HOWE PRODUCT-MASTER Name of base to be audited. M: 22/101 (21%) Same information as terminal report.
Dictionary/3000 Utilities DICTDBA REVERSE CHAIN READ COUNT: 397 ITEM-DETAIL D: 0/507 (0%) SET IS EMPTY COSTING D: 0/1008 (0%) SET IS EMPTY END OF AUDIT RUN 152 Chapter 5
Dictionary/3000 Utilities DICTDBC DICTDBC Database Creation Utility The Database Creation utility (DICTDBC) creates a schema and a root file for an IMAGE database. Once the schema and root file are created, the database files can be created by using the IMAGE/3000 utility DBUTIL. Refer to the IMAGE/3000 Reference Manual for detailed information on how to use DBUTIL. DICTDBC prompts for information that identifies which database definition in the data Dictionary is to be used.
Dictionary/3000 Utilities DICTDBC by commas. LIST causes each source record of the schema to be printed on the listfile. NOLIST specifies that only source records with errors be printed on the listfile. ERRORS=nnn sets the maximum number of errors to nnn. nnn may have a value between 0 and 999, inclusive. If more than three errors are detected, the Schema Processor terminates. The default value is 100. LINES=nnnnn sets the number of lines per page on the listfile nnnnn.
Dictionary/3000 Utilities DICTDBC filename sends the listing to the existing or to a new disc file. Before over-writing an existing file, you are prompted to approve purging the existing file's contents. *filename sends the listing to the file identified in the back referenced file equation. Pressing [[RETURN]] in response to this prompt sends the listing to the terminal.
Dictionary/3000 Utilities DICTDBC 3 BUYER; 4 MANAGER; ITEMS: BUYER-NO, X2 (3/4); DESCRIPTION, X30 ; ITEM-NO, X8 ; LIST-PRICE, P12 ; PO-NUMBER, U4 ; PRODUCT-NO, U8 ; PURCHASE-COST, P8 ; PURCHASE-DATE, X6 ; PURCHASE-QTY, P8 ; QTY-ALLOCATED, P8 ; QTY-ON-HAND, P8 ; QTY-ON-ORDER, P8 (/2); QTY-REC, P8 ; REORDER-PT, P8 ; UNIT-COST, P12 (/3,4); VENDOR-NO, X8 (/3,4); SETS: NAME: PRODUCT-MASTER, ENTRY: PRODUCT-NO MANUAL (1,2/3,4); (1), DESCRIPTION, QTY-ON-HAND, Q
Dictionary/3000 Utilities DICTDBC REORDER-PT; CAPACITY: 311; NAME: ITEM-DETAIL, ENTRY: ITEM-NO DETAIL (/3,4); (!ITEM-MASTER ), VENDOR-NO, BUYER-NO; CAPACITY: 507; NAME: EXPLODE, DETAIL (1,2,3/4); ENTRY: ITEM-NO ( ITEM-MASTER ), PRODUCT-NO (!PRODUCT-MASTER ); CAPACITY: 1023; NAME: COSTING, ENTRY: ITEM-NO DETAIL (/2,3,4); ( ITEM-MASTER (PURCHASE-DATE (!PO-MASTER ), )), PURCHASE-DATE, PURCHASE-QTY, PO-NUMBER QTY-REC; CAPACITY: 1032; END.
Dictionary/3000 Utilities DICTDBD DICTDBD Database Definition Utility The Database Definition utility (DICTDBD) enters the definition for an existing IMAGE database into the Dictionary. DICTDBD creates the entries for the database, the data sets, and the data items by using the root file. The database is entered in the Dictionary as a BASE type file. The automatic, master and detail data sets are entered as AUTO, MAST, and DETL type files respectively. The data items are entered as elements.
Dictionary/3000 Utilities DICTDBD After accepting the password you entered, the utility prompts you to enter specific database identification information as follows: BASE> BASE PASSWORD> MODE> You respond to the prompt for BASE by entering the name of the database to be defined in the Dictionary for you. The BASE PASSWORD prompt should grant read access to the utility for the named database. The MODE prompt indicates the access mode to be used by the utility to open and read the database.
Dictionary/3000 Utilities DICTDBD If you enter a “Y”, the loading process continues. If you enter an “N” or [[RETURN]], you are prompted to rename the element as follows: NEW PRIMARY ELEMENT NAME> A unique name for the element must be entered. The name for the item in your database becomes the alias name for the item in the Dictionary.
Dictionary/3000 Utilities DICTDBD In the first example, the database is unique, and no renaming is required. The second example shows a database that is not totally unique and the prompts issued by the utility to resolve the definition transfer. Example The following example shows the use of DICTDBD, using a unique database name: :RUN DICTDBD.PUB.SYS How to execute this utility.
Dictionary/3000 Utilities DICTDBD *WARNING: DATA ELEMENT PO-NUMBER HAS NOT BEEN LOADED INTO DICTIONARY DEFINITION ALREADY IN DICTIONARY FOR SET PRODUCT-MASTER USE EXISTING DEFINITION(N/Y)?> Y "Y" to use existing definition. DEFINITION ALREADY IN DICTIONARY FOR SET ITEM-MASTER USE EXISTING DEFINITION(N/Y)?> [[RETURN]] pressed; existing definition not used.
Dictionary/3000 Utilities DICTDBU DICTDBU Database Unload Utility The Database Unload utility (DICTDBU) unloads the contents of an existing IMAGE database. The database can be unloaded and stored either to a disc file or to a tape file. Additionally, the database can be edited during the unload process. Editing the unload process allows you to selectively unload, that is, choose whether or not to unload a particular data set. When the unloading process is complete, an audit report is produced.
Dictionary/3000 Utilities DICTDBU After accepting your response to the prompt for LIST FILE, the utility requests the name of the database to be unloaded with the following prompt: BASE> Enter the name of the base in response to this prompt. If [[RETURN]] is entered, an error message is displayed and the program is terminated. Next, you are prompted to enter a password as follows: BASE PASSWORD> In response to this prompt, enter a password that grants read access to the named database.
Dictionary/3000 Utilities DICTDBU You can choose only one of the unload types. A description of each is as follows: Y which is short for YES, specifies that the data set is to be unloaded. (This is the default.) N which is short for NO, specifies that this data set is not to be unloaded. C which is short for CONTINUE, specifies that this data set and all remaining data sets are to be unloaded.
Dictionary/3000 Utilities DICTDBU SEARCH ITEM FOR CHAINED UNLOAD> ZONING-CODE Identifies the search item ZONING-MASTER of the detail data set. M:6/31 6 ENTRIES UNLOADED IN <1 CPU-SEC CITY-MASTER Identifies what is unloaded.
Dictionary/3000 Utilities DICTDBL DICTDBL Database Load Utility The Database Load utility (DICTDBL) reloads the contents of an IMAGE database. A comparison between the old and the new schemes is made before the loading process begins. If changes have been made, you are prompted to enter the changed information. Additionally, you can selectively reload the database, that is, you are given a choice to load or not to load a particular data set.
Dictionary/3000 Utilities DICTDBL RUN MODE(LOAD/EDIT/SHOW/EXIT)> In response to the prompt, you can choose one of four options, which have the following meaning: LOAD indicates the named database is to be loaded. EDIT indicates the named database is to be loaded and editing prompts issued for each data set. SHOW indicates the named database is not to be loaded, but the schema and set entry counts are to be displayed. EXIT indicates the utility is to be terminated.
Dictionary/3000 Utilities DICTDBL If you choose to continue the set load, the data entry in error is not loaded. If you choose not to continue, the utility allows you to continue loading the remaining sets in the database with the last prompt. Your response to MODE indicates the access mode to be used to open the database. Valid responses include 1, 2, 3, 4, and [[RETURN]]. Pressing [[RETURN]] indicates acceptance of the default mode, which is 3. (See the IMAGE/3000 Reference Manual for “Access Modes”.
Dictionary/3000 Utilities DICTDBL RUN MODE(LOAD/EDIT/SHOW/EXIT)> LOAD NEW BASE NAME> SHPMGT.DEMO BASE PASSWORD> LOAD selected. Changing the MPE group for base. MANAGER was the password used. MODE> 1 Opened for shared modify access. PRODUCT-MASTER PRODUCT-NO M 22/101 First data set to be loaded. : ITEM NOT FOUND, NEW ITEM NAME> PROD-NO 22 ENTRIES LOADED IN <1 CPU-SEC LOAD issues prompt when old and new schemes differ.
Dictionary/3000 Utilities DICTDBL ITEM-MASTER M 44/311 SET MODE(LOAD/EDIT/SKIP/CONT/EXIT)> LOAD 44 ENTRIES LOADED IN 1 CPU-SEC EXPLODE D 397/1023 Next data set to be loaded. No editing prompts generated by choosing LOAD. Next data set to be loaded. SET MODE(LOAD/EDIT/SKIP/CONT/EXIT)> LOAD PRODUCT-NO : ITEM NOT FOUND, NEW ITEM NAME> PROD-NO 397 ENTRIES LOADED IN 20 CPU-SECS LOAD causes prompts when old and new LOAD COMPLETED schemes differ.
Dictionary/3000 Utilities DICTDBM,UTIL DICTDBM,UTIL Dictionary Clean Utility As a result of continued DICTDBM use, a data Dictionary slowly accumulates superfluous information. This information can be periodically purged by using the Dictionary Clean Utility (DICTDBM,UTIL).
Dictionary/3000 Utilities DICTVPD DICTVPD VPLUS Forms File Definition Utility The VPLUS Forms File Definition utility (DICTVPD) enters the definition for an existing VPLUS forms file into the Dictionary. This utility creates the entries for the forms file, the forms in the forms file, and the data fields for the forms in the Dictionary. The forms file is entered in the Dictionary as a VPLS type file.
Dictionary/3000 Utilities DICTVPD levels of access.) This password will not be displayed on the terminal as it is entered. However, it must be entered correctly or an error will result and the prompt will be reissued. If [[RETURN]] is pressed as the only response to this prompt DICTVPD will terminate. After the password is accepted DICTVPD then prompts for the name of the forms file to be loaded into the Dictionary. FORMS FILE NAME> Enter the forms file name (20 characters maximum).
Dictionary/3000 Utilities DICTVPD VPLUS DICTIONARY/3000 TYPE FIELD LENGTH TYPE SIZE DECIMAL STORAGE LENGTH CHAR L X L O L NUM L (if L is 1) R 1 0 4 L (if L is 2, 3, 4, 5 or 6) R L-1 0 8 L (if L is 7 or greater) R L-1 0 8 L (if L is 1) I 1 n 2 L (if L is 2, 3, 4, or 5) I L-1 n 2 L (if L is 6, 7, 8, 9 or 10) I L-1 n 4 L (if L is 11 or greater) P L-1 n * (L + 1)/2 L (if L is 1, 2, 3, or 4) I+ L 0 2 L (if L is 5, 6, 7, 8 or 9) I+ L 0 4 L (if L is 10 o
Dictionary/3000 Utilities DICTVPD Dictionary converts type to R. Size is 1. Decimal is 0. Storage length is 4. NUM5 10 I(9,5,4) (n=5) Dictionary converts type to I. Size is 9 because the VPLUS field length is 10, and 10 - 1 is 9. Decimal is equal to n which is 5. Storage length is 4. NUM5 20 P(19,5,10) (n=5) Dictionary converts type to P. Size is 19 because the VPLUS field length is 20, and 20 - 1 is 19. Decimal is equal to n which is 5. Storage length is 10 because (20 +1)/2 = 10 (rounded down).
Dictionary/3000 Utilities DICTVPD After DICTVPD loads the forms file in the Dictionary, a reference list is generated which shows the loaded forms file, forms, and data fields. Also included in the reference list are the data names, aliases, data dispositions and data types as they were loaded in the Dictionary. This list can be a useful tool to ensure that the loaded forms and data are the correct ones and to provide future reference documentation.
Dictionary/3000 Utilities DICTVPD this forms file. This form will not have any data fields associated to it. Also, $REFRESH will not appear on the reference list for the forms file but will appear when the Dictionary is accessed by the program DICTDBM.
Dictionary/3000 Utilities DICTVPD Enter the new primary name for the data field being loaded in the Dictionary. Once again, the original name becomes the alias for the element.
Dictionary/3000 Utilities DICTVPD F5 NEW X ( 5, 0, 5) F10 NEW X (10, 0,10) F20 NEW X (20, 0,10) F2 NEW X ( 2, 0, 2) UNDER_SCORE_TO NEW X (14, 0,14) FORMB NEW FORM CHAR NEW X ( 5, 0, 5) NUMN NEW I ( 4, 3, 2) NUM NEW R ( 4, 0, 4) DIG NEW I+( 5, 0, 4) IMPN NEW I ( 4, 2, 2) IMP NEW I ( 4, 0, 2) MDY NEW X ( 5, 0, 5) DMY NEW X ( 5, 0, 5) YMD 180 Chapter 5
Dictionary/3000 Utilities DICTVPD Chapter 5 181
Dictionary/3000 Utilities DICTVPD 182 Chapter 5
6 The Dictionary DICTPDE Utility Overview DICTPDE, the PASCAL Definition Extract Utility, is an interactive, command-driven utility provided by the Dictionary. This utility extracts data and file definitions from the dictionary and generates the corresponding PASCAL declarations for the data definitions. The generated declarations are echoed to the terminal and written to an output file which can be used for PASCAL programs.
The Dictionary DICTPDE Utility Initiating DICTPDE Initiating DICTPDE DICTPDE can be initiated from within a session or from within a job stream. When initiated from within a session, DICTPDE can be executed to accept commands from a command file or DICTPDE can be run interactively (commands are entered at the terminal). When initiated from within a job stream, DICTPDE can be executed to accept commands from a command file or from the job stream itself.
The Dictionary DICTPDE Utility Initiating DICTPDE Table 6-1 lists the DICTPDE commands and gives a brief description of their function. Table 6-1. The DICTPDE commands COMMAND FUNCTION ALTER Changes an option for generating declarations. EXIT Terminates the DICTPDE utility. GENERATE Generates PASCAL declarations for element and file definitions in the Dictionary, and for the VPLUS COMAREA and IMAGE parameters. HELP Provides a description of the DICTPDE commands.
The Dictionary DICTPDE Utility Changing Input, List and Output Files Changing Input, List and Output Files DICTPDE uses the formal file designators DICTIN as the input file for DICTPDE commands, DICTLOG as the list file for the commands entered interactively, and DICTOUT as the output file for the generated source code. When DICTPDE is run interactively, DICTIN is the terminal (DICTPDE commands are accepted as they are entered at the terminal).
The Dictionary DICTPDE Utility Changing Input, List and Output Files The following is an example of how to run DICTPDE within a job stream. Note that in this example, DICTPDE will accept commands from the command file COMMANDS and write the generated declarations to the output file OUTPUT. !JOB CODEGEN, LYNN.ACCTS !FILE DICTIN = COMMANDS !FILE DICTOUT = OUTPUT !RUN DICTPDE.PUB.
The Dictionary DICTPDE Utility ALTER ALTER Changes an option used when generating data declarations from the Dictionary. Syntax ALTER subcommand A Use the ALTER command to change the default options for generating data declarations for the entities extracted from the Dictionary. The subcommand identifies the option to be changed. Each ALTER command-subcommand generates a prompt that allows you to specify how an option is to be changed, except for the ALTER ALL command-subcommand.
The Dictionary DICTPDE Utility >ALTER ALL >ALTER ALL Changes all the options used for generating PASCAL data declarations for the entities extracted from the Dictionary.
The Dictionary DICTPDE Utility >ALTER ALL If an invalid password is entered in response to this prompt, DICTPDE will issue an error message and reprompt for the Dictionary password. DICTPDE will continue to prompt for the Dictionary password until a valid password is entered or DICTPDE is terminated. When a new Dictionary name and valid password are entered, DICTPDE closes the previous Dictionary used and opens the new Dictionary to be used.
The Dictionary DICTPDE Utility >ALTER ALL GENERATE NAMES AS STRING CONSTANTS (N/Y)> Enter Y if PASCAL string constants are to be generated for the specified file names extracted from the Dictionary. DICTPDE assumes that string constants are not to be generated for the file names unless Y is entered in response to this prompt. Pressing [[RETURN]] in response to this prompt indicates that string constants are not to be generated.
The Dictionary DICTPDE Utility >ALTER DICT >ALTER DICT Changes the Dictionary that contains the data definitions to be extracted for code generation. Prompts The following prompts are issued when the command-subcommand ALTER DICT is entered: DICTIONARY NAME (current dictionary )> DICTIONARY PASSWORD> DICTIONARY NAME (current dictionary)> Enter the new Dictionary name, group and account to be opened and used for further code generation.
The Dictionary DICTPDE Utility >ALTER DICT Discussion ALTER DICT allows you to use a Dictionary other than the Dictionary in DICT.PUB of your logon account without using an MPE file equation to redefine the Dictionary. Therefore, file and element definitions can be extracted from different Dictionaries without terminating DICTPDE. Example >alter dict DICTIONARY NAME (DICT.PUB)> Enter the new Dictionary. dict.pub.howe DICTIONARY PASSWORD> mgr Enter the password for the specified Dictionary.
The Dictionary DICTPDE Utility >ALTER KIND >ALTER KIND Changes the kind of data declaration generated (either as VAR or TYPE) for the entities extracted from the Dictionary. Prompts The following prompt is issued when the command-subcommand ALTER KIND is entered: EXTRACT AS TYPE OR VAR (T/V)> EXTRACT AS TYPE OR VAR (T/V)> Enter T (or press [[RETURN]]) if the extracted data definitions are to be generated as TYPE data declarations.
The Dictionary DICTPDE Utility >ALTER NAME >ALTER NAME Changes the generated source code to include PASCAL string constants for the file names extracted from the Dictionary. Prompts The following prompt is issued when the command-subcommand ALTER NAME is entered: GENERATE NAMES AS STRING CONSTANTS (N/Y)> GENERATE NAMES AS STRING CONSTANTS (N/Y)> Enter Y if PASCAL string constants are to be generated for the specified file names extracted from the Dictionary.
The Dictionary DICTPDE Utility >ALTER OUTPUT >ALTER OUTPUT Changes the output file that the PASCAL data declarations will be written to. Prompts The following prompt is issued when the command-subcommand ALTER OUTPUT is entered: SOURCE OUTPUT FILE (current output file )> SOURCE OUTPUT FILE (current output file)> Enter the name of the file to redirect output to. This output includes the data declarations generated by DICTPDE and, if specified, the string constants generated for the entity names.
The Dictionary DICTPDE Utility >ALTER SHIFT >ALTER SHIFT Changes the type case of the code generated by DICTPDE. Prompts The following prompt is issued when the command-subcommand ALTER SHIFT is entered: LOWER OR UPPER CASE (L/U)> LOWER OR UPPER CASE (L/U)> Enter U if the generated code is to be written in UPPER CASE characters to the output file. Enter L if the generated code is to be written in LOWER CASE characters.
The Dictionary DICTPDE Utility >ALTER TEXT >ALTER TEXT Changes the generated code to include comments lines about the extracted entities. Prompts The following prompt is issued when the command-subcommand ALTER TEXT is entered: GENERATE COMMENTS (N/Y)> GENERATE COMMENTS (N/Y)> Enter Y to generate comment lines which describe the entities extracted from the Dictionary.
The Dictionary DICTPDE Utility >ALTER TEXT Example >alter text GENERATE COMMENTS (N/Y)> y >generate file FILE(S)> account var account_rec = record firstname : longreal; lastname : packed array[1..20] of char; address : record case integer of 0 : ( buffer : packed array[1..20] of char ); 1 : ( streetname : packed array[1..10] of ' '..'Z' ); 2 : ( city : packed array[1..10] of char ); end; phone : packed array[1..
The Dictionary DICTPDE Utility >ALTER VPLUS >ALTER VPLUS Changes the generated code to include PASCAL arrays for the fields in a VPLUS form. Prompts The following prompt is issued when the command-subcommand ALTER VPLUS is entered: GENERATE TABLES FOR VPLUS EXTRACTS (N/Y)> GENERATE TABLES FOR VPLUS EXTRACTS (N/Y)> Enter Y to generate PASCAL arrays for the fields in a VPLUS form in addition to the data declarations generated for the form.
The Dictionary DICTPDE Utility >ALTER VPLUS Example >alter vplus GENERATE TABLES FOR VPLUS EXTRACTS (N/Y)> y >generate file FILE(S)> forma Specifies a VPLUS form. type forma = record case integer of 0 : ( f5 : packed array[1..6] of char; f10 : packed array[1..10] of char; f20 : packed array[1..20] of char; f2 : packed array[1..2] of char; under_score_to : packed array[1..14] of char; ); 1 : ( forma_buf : packed array[1..53] of char ); end; forma_array = array[1..
The Dictionary DICTPDE Utility EXIT EXIT Terminates DICTPDE. Syntax EXIT E Note that no subcommands are used with the EXIT command. Discussion EXIT allows you to terminate DICTPDE.
The Dictionary DICTPDE Utility GENERATE GENERATE Generates PASCAL data declarations for the entities defined in the Dictionary. Syntax GENERATE subcommand G Use the GENERATE command to extract data definitions from the Dictionary and to generate the corresponding PASCAL data declarations. This command is also used to generate the data structures for the VPLUS defined COMAREA and the data structures for the IMAGE parameters.
The Dictionary DICTPDE Utility >GENERATE COMAREA >GENERATE COMAREA Generates the PASCAL data structures for the VPLUS COMAREA. Prompts GENERATE COMAREA does not issue any additional prompts. DICTPDE will begin generating the VPLUS COMAREA as soon as the GENERATE COMAREA command-subcommand is entered. Discussion GENERATE COMAREA allows you to generate the TYPE, CONST and VAR declarations for the VPLUS COMAREA.
The Dictionary DICTPDE Utility >GENERATE COMAREA Example >generate comarea type word = -32768..32767; vplus_comarea = record cstatus : word; language : word; comarealen Chapter 6 : word; usrbuflen : word; cmode : word; lastkey : word; numerrs : word; windowenh : word; multiusage : word; labeloptions : word; cfname : packed array[1..16] of char; nfname : packed array[1..
The Dictionary DICTPDE Utility >GENERATE COMAREA term_filen : word; skip10 : packed array[1..
The Dictionary DICTPDE Utility >GENERATE COMAREA skip6 : 0, skip7 : 0, skip8 : 0, numrecs : 0, recnum : 0, skip9 : #0#0#0#0, term_filen : 0, skip10 : #0#0#0#0#0#0#0#0#0#0, retries : 0, term_options : 0, environ : 0, usertime : 0, identifier : 0, labelinfo : 0, ]; var com_area : vplus_comarea; termfilename : packed array[1 .. 6] of char; message_buff : packed array[1 ..
The Dictionary DICTPDE Utility >GENERATE ELEMENTS >GENERATE ELEMENTS Generates PASCAL data declarations for element definitions in the Dictionary. Prompts The following prompt is issued when the command-subcommand GENERATE ELEMENT is entered: ELEMENT(S)> ELEMENT(S)> Enter the name(s) of the elements to be extracted from the Dictionary and for which the data declaration(s) will be generated.
The Dictionary DICTPDE Utility >GENERATE ELEMENTS ELEMENT = account ELEMENT-TYPE = I ELEMENT-LENGTH = 4 The code is generated as follows: > generate element Or G E could have been entered. ELEMENT NAME(S)> account The generated code is echoed to TYPE the terminal. ACCOUNT = INTEGER; The next example shows the code generated for elements that have ELEMENT-COUNTS in the Dictionary that are greater than 1. The two elements have no child entities related to them.
The Dictionary DICTPDE Utility >GENERATE ELEMENTS TYPE CUSTNAME = PACKED ARRAY[1..14] OF CHAR; CUSTNUM : CUSTNAME; The VAR declaration for the element CUSTNUM is generated as follows: TYPE CUSTNAME = PACKED ARRAY[1..14] OF CHAR; VAR CUSTNUM = CUSTNAME Note that the code for the ELEMENT-REFERENCE is generated first as a TYPE declaration. The next example shows the code generated for a parent element. (This element has child elements related to it.
The Dictionary DICTPDE Utility >GENERATE ELEMENTS ELEMENT-TYPE = X I ELEMENT-LENGTH = 12 4 The code for the parent element ADDRESS is generated as follows: >generate element ELEMENT(S)> address TYPE ADDRESS = RECORD CASE INTEGER OF 0 : ( BUFFER : PACKED ARRAY[1..48] OF CHAR; ); 1 : ( DUMMY0 : PACKED ARRAY[1..3] OF CHAR; STREET : PACKED ARRAY[1..12] OF CHAR; DUMMY1 : PACKED ARRAY[1..
The Dictionary DICTPDE Utility >GENERATE FILE >GENERATE FILE Generates the PASCAL declarations for the file definitions in the Dictionary. Prompts The following prompt is issued when the command-subcommand GENERATE FILE is entered: FILE(S)> FILE(S)> Enter the name(s) of the files to be extracted from the Dictionary and from which data declarations will be generated. More than one file can be entered in a command line as long as each file name is separated by a comma (,) or a space.
The Dictionary DICTPDE Utility >GENERATE FILE The file CUSTFORM is defined in the Dictionary as follows: FILE : CUSTFORM FILE-TYPE : FORM FILE-ALIAS : CUSTALIAS CUSTFORM has the following elements associated with it: ELEMENT : ACCOUNT ELEMENT-ALIAS : ACCOUNTALIAS ELEMENT-TYPE : I ELEMENT-LENGTH : 4 LAST-NAME FIRST-NAME CREDIT X X R 16 10 4 The code is generated as follows: >generate file FILES(S)> custform TYPE CUSTFORM = RECORD ACCOUNTALIAS : INTEGER; LAST_NAME : PACKED ARRAY[1..
The Dictionary DICTPDE Utility >GENERATE FILE ELEMENT-TYPE : I X R 16 10 4 ELEMENT-LENGTH : 4 X The file DATEFORM has the following elements associated with it: FILE : DATEFORM ELEMENT : DATE ELEMENT-ALIAS : ELEMENT-TYPE : X ELEMENT-LENGTH : 6 The file INVENTFORM has the following elements associated with it: FILE : INVENTFORM ELEMENT : STOCKNUM ELEMENT-ALIAS : ELEMENT-TYPE : X SUPPLIER BINNUM UNIT-COST BINNUMALIAS ELEMENT-LENGTH : 8 X R R 16 4 4 The code is generated fo
The Dictionary DICTPDE Utility >GENERATE IMAGEPARMS >GENERATE IMAGEPARMS Generates the PASCAL data structures for the IMAGE standard parameters. Prompts GENERATE IMAGEPARMS does not issue any additional prompts. DICTPDE will begin generating the IMAGE parameters as soon as the GENERATE IMAGEPARMS command-subcommand is entered. These parameters include the DB-STATUS array declaration, the eight MODE declarations, and the utility LIST declarations.
The Dictionary DICTPDE Utility >GENERATE IMAGEPARMS Example >generate imageparms type status_type = record c_word : -32768..32767; stat2 : -32768..32767; stat3_4 : integer; stat5_6 : integer; stat7_8 : integer; stat9_10 : integer; end; var 216 status : status_type; password : packed array [1..8] of char; dummy_list : packed array [1..2] of char; (*init '; '*) all_items : packed array [1..2] of char; (*init '@;'*) previous_list : packed array [1..
The Dictionary DICTPDE Utility HELP HELP Displays a description of the DICTPDE commands and subcommands. Syntax HELP subcommand H ? Use the HELP command to display information about each of the DICTPDE commands and their respective subcommands. Note that you can also enter “?” to invoke this command. The HELP command uses all the DICTPDE commands as its subcommands.
The Dictionary DICTPDE Utility LIST LIST Lists the entities that have been extracted by DICTPDE from the Dictionary. Syntax LIST subcommand L Use the LIST command to display the entities that have been extracted from the Dictionary. These are the entities for which data declarations have been generated.
The Dictionary DICTPDE Utility >LIST ALL >LIST ALL Displays all the entities extracted from the Dictionary. Prompts LIST ALL does not generate any additional prompts. This command-subcommand displays the element and file names as they were extracted from the Dictionary. (The entities identified as files are listed first. The entities identified as elements are listed after the files.
The Dictionary DICTPDE Utility >LIST ELEMENT >LIST ELEMENT Displays the elements extracted from the Dictionary. Prompts LIST ELEMENT does not generate any additional prompts. This command-subcommand displays the element names as they were extracted from the Dictionary. LIST ELEMENT also shows the kind of data declaration generated for each of the extracted elements and the output file each element declaration was written to.
The Dictionary DICTPDE Utility >LIST FILE >LIST FILE Displays the files extracted from the Dictionary. Prompts LIST FILE does not generate any additional prompts. This command-subcommand displays the file names as they were extracted from the Dictionary. LIST FILE also shows the kind of data declaration generated for each of the extracted files and the output file that each declaration was written to.
The Dictionary DICTPDE Utility DICTPDE Naming Considerations DICTPDE Naming Considerations When an entity is extracted from the Dictionary, DICTPDE checks that the entity name is compatible with PASCAL. If the entity name defined in the Dictionary is an illegal PASCAL name (for example, the name contains a hyphen) or the entity name is a PASCAL reserved word, an error message will be issued and DICTPDE will convert the names to legal PASCAL names.
The Dictionary DICTPDE Utility PASCAL Data Type Mappings PASCAL Data Type Mappings To be compatible with PASCAL, the data types for the extracted entities as defined in the Dictionary must be mapped to PASCAL data types. The following shows how the Dictionary data types are mapped to compatible PASCAL data types. Note that the PASCAL type occupies the same storage length as the data types defined in the Dictionary.
The Dictionary DICTPDE Utility PASCAL Data Type Mappings PACKED ARRAY[1..N] OF '0'..'9' (if N > 1) However, you must check that the minus sign doesn't appear in the data. Zoned decimal: If the entity is defined in the Dictionary as: ELEMENT-TYPE = Z ELEMENT-LENGTH = N The corresponding PASCAL data type will be generated: '+'..'}' (if N = 1) or PACKED ARRAY[1..N] OF '0'..'}' (if N > 1) The above mapping indicates that the zoned decimal consists of (N - 1) digits with a trailing overpunch.
The Dictionary DICTPDE Utility PASCAL Data Type Mappings The corresponding PASCAL data type will be generated: BOOLEAN Note that ELEMENT-LENGTH is not needed in this case. String: If the entity is defined in the Dictionary as: ELEMENT-TYPE = S ELEMENT-LENGTH = N The corresponding PASCAL data type will be generated: STRING[N] Note that the storage length is not the ELEMENT-LENGTH for string data types.
The Dictionary DICTPDE Utility PASCAL Data Type Mappings ELEMENT-LENGTH = 4 The corresponding PASCAL data type will be generated: REAL If the entity is defined in the Dictionary as: ELEMENT-TYPE = E (or R) ELEMENT-LENGTH = 8 The corresponding PASCAL data type will be generated: LONGREAL If the entity is defined in the Dictionary as: ELEMENT-TYPE = E+ (or R+) ELEMENT-LENGTH = 4 The corresponding PASCAL data type will be generated: REAL If the entity is defined in the Dictionary as: ELEMENT-TYPE
The Dictionary DICTPDE Utility PASCAL Data Type Mappings Chapter 6 227
The Dictionary DICTPDE Utility PASCAL Data Type Mappings 228 Chapter 6
7 The Dictionary DICTCDE Utility Overview DICTCDE, the COBOL Definition Extract Utility, is an interactive, prompt-driven utility provided by Dictionary/3000. This utility extracts data and file definitions from the Dictionary and generates the corresponding COBOL source code for the data definitions. When a parent entity is extracted from the Dictionary, DICTCDE also generates the code for any related child entities.
The Dictionary DICTCDE Utility Special Character Responses Special Character Responses The following characters have special meaning when used in response to a DICTCDE prompt: ] the previous prompt issued is redisplayed. It does not affect any source code that has already been generated. ]] the main prompt is reissued. This prompt allows you to generate code, change the program options, or exit DICTCDE. (This prompt is discussed later in this section.
The Dictionary DICTCDE Utility Initiating DICTCDE Initiating DICTCDE DICTCDE can be initiated from within a session or from within a job stream. The following describes how to execute DICTCDE interactively (from within a session). For information on how to execute DICTCDE from within a job stream, see Changing Input, List and Output Files discussed later in this section. DICTCDE assumes that the Dictionary resides in DICT.PUB of the logon account.
The Dictionary DICTCDE Utility Initiating DICTCDE Enter Y to create the specified copylib file. If N, ], ]], [[RETURN]], or [[CONTROL]] Y is entered in response to this prompt, DICTCDE will again prompt for the Copylib file name. Since a COBOL copylib is in KSAM file format, a key file must be associated with the KSAM copylib file.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt The DICTCDE Main Prompt When the copylib file is either accepted or created by DICTCDE, the main prompt used for generating source code and for changing the DICTCDE options is issued: File, Element, Parameters, Options, or Exit (F/E/P/O/EX)> The responses allowed for this prompt indicate the following: F begins the prompting cycle for generating source code for IMAGE, VPLUS, KSAM, MPEF and MPER file definitions.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt IMAGE Database Files. If the specified file is an IMAGE database, DICTCDE will issue the following message and prompts: File filename is an IMAGE database Define all data sets in one module (N/Y)> Enter Y if the generated source code for all the data sets is to be written to one copylib module. This module will also contain the source code for the IMAGE special parameters.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt If [[RETURN]] is pressed in response to this prompt, the source code for that data set is generated without a prefix assigned to the data items. The code is echoed to the terminal as it is written to the copylib module. After the code for this data set is generated, DICTCDE will continue to prompt for copylib modules and prefixes for the remaining data sets in the database.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt Enter Y to generate a field number table for each form in the forms file. The field number tables are useful in calls to some of the VPLUS intrinsics, such as VSETERROR. The tables provide the field numbers for each field in the form. Each field in the form is represented by a data item in the table. The data items are COMP variables initialized to the field number.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt the next form in the forms file. After the copylib module has been defined for a form, DICTCDE issues the following prompt: Prefix for data items in formname > Enter a prefix to be used in the COBOL identifier for the data item in the form. The prefix you choose can be up to 8 characters long and must begin with a letter to be a valid COBOL identifier.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt prefix is assigned to a data item, that data item can be referred to uniquely in a COBOL program without using the COBOL OF clause. If [[RETURN]] is pressed in response to this prompt, the source code for the form is generated without a prefix assigned to the data items. The code is echoed to the terminal as it is written to the copylib module. After the source code has been generated for the form, DICTCDE will return to the main prompt.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt (Therefore, this prompt is not issued for MPER files.) DICTCDE then issues the next prompt: Copylib module for WORKING-STORAGE record> Enter the copylib module for the WORKING-STORAGE record. The WORKING STORAGE record will contain the record layout for the file.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt Enter the copylib module for the code generated for the FILE SECTION entry. The FILE SECTION defines the file to be used in the program and is part of the DATA DIVISION for a program. The record layout for the file (the source code for the data items in the file) is also defined in this section. However, you may choose to generate the record layout for the file in WORKING-STORAGE, instead of in the FILE SECTION.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt Generating Code for Elements To generate source code for element definitions, enter E in response to the main prompt. DICTCDE will then prompt for the element name: Element name> Enter the name of the element to be extracted from the Dictionary. Only one element may be extracted at a time. (You may not enter more than 1 element name in response to this prompt.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt Generating Code for Standard Parameters DICTCDE allows you to generate source code for the IMAGE, VPLUS, and KSAM standard parameters. To generate this source code, enter P in response to the main prompt. The code for the standard parameters is generated in WORKING-STORAGE. DICTCDE will issue the following prompt: Copylib module for IMAGE standard parameters> Enter the copylib module for the code generated for the IMAGE standard parameters.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt Changing the DICTCDE Options DICTCDE provides a set of options which allows you to change the Dictionary used, the copylib used, and the DICTCDE defaults; and it allows you to run the COBOL copylib editor, COBEDIT. To change any of the options offered by DICTCDE, enter an O in response to the main prompt. DICTCDE will then issue a series of prompts which allow you to change any of the options.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt Prompt for record data item prefixes (Y/N)> allows you to suppress the prompts for prefixes for data items. Prompt for all sections of MPE/KSAM definitions (Y/N)> allows you to suppress the prompts for the ENVIRONMENT DIVISION and FILE SECTION. Prompt for VPLUS field types and number tables (Y/N)> allows you to suppress the prompts for selecting the VPLUS field types and the VPLUS field number tables.
The Dictionary DICTCDE Utility The DICTCDE Main Prompt DICTCDE will reopen the copylib file and continue prompting for the next option. If N is entered or [[RETURN]] is pressed in response to the COBEDIT option prompt, DICTCDE will also prompt for the next option as follows: List definitions on the terminal (Y/N)> Enter N to suppress the generated code from being displayed at the terminal (or printed in the job listing if DICTCDE is run from within a job stream).
The Dictionary DICTCDE Utility The DICTCDE Main Prompt generated. Using aliases as COBOL identifiers identifies the child entities by the names that are known by the parent entities. Regardless of whether the primary names or aliases are used as the COBOL identifiers, the constants used for passing data set and search item names to IMAGE will be generated using the aliases (if the aliases have been defined in the Dictionary).
The Dictionary DICTCDE Utility The DICTCDE Main Prompt If [[RETURN]] is pressed in response to this prompt, DICTCDE will continue to the next option: Prompt for all sections of MPE/KSAM definitions (Y/N)> Enter N to suppress the prompts for the copylib modules for the SELECT statement and the FILE SECTION entry for an MPEF, MPER, or KSAM file. (Only the copylib for the WORKING-STORAGE record will be prompted for.
The Dictionary DICTCDE Utility Changing Input, List and Output Files Changing Input, List and Output Files DICTCDE uses the formal file designators DICTIN for the input file, DICTOUT for the output file and DICTLOG for the response log file. The responses made to DICTCDE interactively are logged to the editor file DICTLOG. This file is session-temporary. An MPE SAVE command must be used to save this file as a permanent file (see example below).
The Dictionary DICTCDE Utility Examples of Generated Code Examples of Generated Code The following provides a description and example of the COBOL source code generated for the entities extracted from the Dictionary. IMAGE Database Definitions DICTCDE allows you to generate the definition for an entire database or for selected data sets.
The Dictionary DICTCDE Utility Examples of Generated Code 001300 001400 01 DS-CUST-M PIC X(7) VALUE "CUST-M ". 001500 001600 01 DATE-A-DATA. 001700 05 X-DATE PIC X(8). 001800 001900 01 DS-DATE-A PIC X(7) VALUE "DATE-A ". 002000 002100 01 INVOICE-M-DATA. 002200 05 DELETE-WORD PIC X(2). 002300 05 INVOICE-NUM PIC S9(8). 002400 002500 01 DS-INVOICE-M PIC X(10) VALUE "INVOICE-M ". 002600 002700 01 ITEM-M-DATA 002800 05 DELETE-WORD PIC X(2). 002900 05 ITEM-NUM PIC S9(6).
The Dictionary DICTCDE Utility Examples of Generated Code 005100 05 ITEM-SELL-PRICE PIC S9(8). 005200 005300 01 DS-LINE-ITEMS-D PIC X(13) VALUE "LINE-ITEMS-D 005600 01 DB-ORDERS PIC X(9) VALUE 005700 01 ORDERS-PWD PIC X(10) VALUE 005900 01 DI-CUST-NUM PIC X(9) VALUE "CUST-NUM ". 006000 01 DI-X-DATE PIC X(5) VALUE "DATE 006100 01 DI-INVOICE-NUM PIC X(12) VALUE 006200 01 DI-ITEM-NUM PIC X(9) VALUE 006300 01 DI-INVOICE-DATE PIC X(13) VALUE ". 005400 005500 " ORDERS "; ". ".
The Dictionary DICTCDE Utility Examples of Generated Code Example The following is an example of the code generated for a data set without prefixes assigned: 000100 000200 01 CUST-M-DATA. 000300 05 DELETE-WORD PIC X(2). 000400 05 CUST-NUM PIC S9(8). 000500 05 CUST-NAME PIC X(30). 000600 05 CUST-STREET PIC X(30). 000700 05 CUST-CITY PIC X(20). 000800 05 CUST-STATE PIC X(2). 000900 05 CUST-ZIP PIC S9(10). 001000 05 CUST-PHONE PIC X(12).
The Dictionary DICTCDE Utility Examples of Generated Code VPLUS Forms File Definitions DICTCDE allows you to generate the definition for an entire forms file or for selected forms. The code generated for the forms file includes the forms file name and the record layouts for all the related forms. The form records generated include the form name and their associated elements. The form name is generated as an 01-level identifier, and the fields are generated as 05-level identifiers.
The Dictionary DICTCDE Utility Examples of Generated Code 002700 05 PROD-NO-FIELDNO PIC S9(4) COMP VALUE 10. 002800 05 DESCRIPTION-FIELDNO PIC S9(4) COMP VALUE 11. 002900 003000 01 ADDSALE-DATA. 003100 05 ACCOUNT PIC X(10). 003200 05 PROD-NO PIC X(8). 003300 05 QUANTITY PIC 9(8). 003400 05 PRICE PIC X(12). 003500 05 TOTAL PIC X(12). 003600 05 PURCH-DATE PIC X(6). 003700 05 DELIV-DATE PIC X(6). 003800 05 PURCH-NO PIC X(6).
The Dictionary DICTCDE Utility Examples of Generated Code 001100 01 DELSALE-FIELDS 001200 05 ACCOUNT-FIELDNO PIC S9(4) COMP VALUE 11. 001300 05 PROD-NO-FIELDNO PIC S9(4) COMP VALUE 12. 001400 05 QUANTITY-FIELDNO PIC S9(4) COMP VALUE 13. 001500 05 PRICE-FIELDNO PIC S9(4) COMP VALUE 14. 001600 05 TOTAL-FIELDNO PIC S9(4) COMP VALUE 15. 001700 05 PURCH-DATE-FIELDNO PIC S9(4) COMP VALUE 16. 001800 05 DELIV-DATE-FIELDNO PIC S9(4) COMP VALUE 17.
The Dictionary DICTCDE Utility Examples of Generated Code MPE File Definitions DICTCDE allows you to generate source code for the ENVIRONMENT DIVISION and DATA DIVISION for an MPE file. For the ENVIRONMENT DIVISION portion, DICTCDE generates the SELECT statement for an MPE file as follows: 000100 000200 SELECT CUSTMPE 000300 ASSIGN "file-info " 000400 ORGANIZATION IS SEQUENTIAL.
The Dictionary DICTCDE Utility Examples of Generated Code The above parameters are generated from the following entries defined in the Dictionary for an MPE file: block-size BLOCKING(N/Y)? UNIT(R/C)? MINIMUM MAXIMUM recsize MINIMUM RECORD SIZE MAXIMUM RECORD SIZE alphabet-name DATA STORAGE TYPE(A/E)? recording-mode RECORD FORMAT(F/V/U/S)? Since the recsize parameter is generated from the RECSIZE entry in the Dictionary, not from a total of the storage sizes of the elements in the file, care should
The Dictionary DICTCDE Utility Examples of Generated Code When the record layout is generated in WORKING-STORAGE and no FD Statement is generated, the code will be generated as shown below: 000100 000200 01 CUSTMPE-DATA. 000300 05 CUST-NUM PIC S9(8). 000400 05 CUST-CREDIT-LIM PIC S9(8). 000500 05 CUST-BALANCE PIC S9(10). 000600 05 INVOICE-NUM PIC S9(8). 000700 05 INVOICE-TOTAL PIC S9(10). 000800 05 INVOICE-DATE PIC X(8). 000900 05 FILLER PIC X(971).
The Dictionary DICTCDE Utility Examples of Generated Code 000300 01 CUSTMPE-DATA. 000400 05 000500 01 CUSTMPE-DATA2. 000600 05 RECORD-LAYOUT-2-1 PIC X(40). 000700 05 RECORD-LAYOUT-2-2 PIC X(40). RECORD-LAYOUT-1 PIC X(80). If the record layout is to be generated in WORKING-STORAGE and the file has more than one record format, DICTCDE will use an explicit REDEFINES to define the multiple record layouts.
The Dictionary DICTCDE Utility Examples of Generated Code 001600 05 INVOICE-TOTAL PIC S9(10). 001700 05 INVOICE-DATE PIC X(8). 001800 05 FILLER PIC X(971). KSAM File Definitions DICTCDE allows you to generate source code for the ENVIRONMENT DIVISION and DATA DIVISION for a KSAM file.
The Dictionary DICTCDE Utility Examples of Generated Code Since the recsize parameter is generated from the entries in the Dictionary, not from a total of the storage sizes of the elements in the file, care should be taken when defining the file's record size in the Dictionary. Otherwise, the record size defined for the file may conflict with the record layout of the file. (Refer to Chapter 4, DICTDBM Commands, for more information on the above DICTDBM prompts.
The Dictionary DICTCDE Utility Examples of Generated Code When the record layout is generated in WORKING-STORAGE, and the FD Statement is also generated, the 01-level definition will appear in the FD Statement to serve as a buffer for READs and WRITEs to the file. The generated code is shown below: 000100 000200 FD KORDER 000300 RECORDING MODE IS F. 000400 01 KORDER-REC PIC X(52). 000500 000600 01 KORDER-DATA. 000700 05 CUST-NUM PIC S9(8). 000800 05 CUST-CREDIT-LIM PIC S9(8).
The Dictionary DICTCDE Utility Examples of Generated Code shown below. 000100 000200 01 KORDER-DATA. 000300 05 000400 01 KORDER-DATA2 REDEFINES KORDER-DATA. 000500 05 RECORD-LAYOUT-2-1 PIC X(40). 000600 05 RECORD-LAYOUT-2-2 PIC X(40). RECORD-LAYOUT-1 PIC X(80). You can also generate the KSAM FILETABLE parameter along with the WORKING-STORAGE record layout for the KSAM file. The FILETABLE parameter is the special parameter required by KSAM to be passed to each KSAM COBOL intrinsic.
The Dictionary DICTCDE Utility Examples of Generated Code Example The following is an example of the code generated for a KSAM file. (Note that the SELECT statement and FD statement have both been generated.) 000100 000200 SELECT KORDER 000300 ASSIGN "KORDER" 000400 ORGANIZATION IS INDEXED 000500 RECORD KEY IS CUST-NUM 000600 ALTERNATE RECORD KEY INVOICE-NUM 000700 ALTERNATE RECORD KEY INVOICE-DATE WITH DUPLICATES. 000800 000900 FD KORDER 001000 RECORDING MODE IS F. 001100 01 KORDER-DATA.
The Dictionary DICTCDE Utility Examples of Generated Code Compound Element Definitions DICTCDE generates an array declaration for an element if its sub-element count is defined in the Dictionary as greater than one. Since arrays cannot appear at the 01-level in COBOL, DICTCDE will generate an array as an 05-level identifier, with a FILLER as an 01-level identifier.
The Dictionary DICTCDE Utility Examples of Generated Code ELEMENT-TYPE = X ELEMENT-SIZE = 14 ELEMENT-LENGTH = 14 ELEMENT-COUNT = 1 the following code is generated: 000100 000200 01 FILLER. 000300 05 000400 ACCOUNT OCCURS 10. 10 ACCOUNT-MASTER PIC X(14). If both the element and the element reference have COUNTS greater than one, a multi-dimensional table is generated.
The Dictionary DICTCDE Utility Examples of Generated Code ELEMENT-SIZE = 36 ELEMENT-LENGTH = 36 ELEMENT-COUNT = 1 CHILD-ELEMENTS = NAME ADDRESS COST ELEMENT-TYPE = X X X ELEMENT-SIZE = 9 2 5 ELEMENT-LENGTH = 9 2 5 ELEMENT-COUNT = 1 1 5 ELEMENT-BYTE POSITION = 1 10 12 The code for the element ACCOUNT is generated as follows: 000100 000200 01 FILLER. 000300 05 000400 ACCOUNT OCCURS 10. 10 ACCOUNT-MASTER. 000500 15 NAME PIC X(9). 000600 15 ADDRESS PIC X(2).
The Dictionary DICTCDE Utility Examples of Generated Code The code for element SALES is generated as follows: 000100 000200 01 SALES. 000300 05 PRODUCT PIC X(12). 000400 05 PRICE PIC X(28). 000500 05 AMOUNT PIC X(10). Note that the COBOL record would be represented in storage as a memory array of a length of 50 bytes, with PRODUCT being from byte 1 to 12, PRICE from byte 13 to 40 and AMOUNT from byte 41 to 50.
The Dictionary DICTCDE Utility Examples of Generated Code Forced REDEFINES When the storage lengths and byte offsets for two child elements overlap each other within the parent element, the two child elements cannot be placed adjacently within the parent element record. DICTCDE generates these elements as a forced REDEFINES to insure they overlap exactly as defined in the Dictionary. For example, the element NAME has the child elements F-NAME and M-NAME.
The Dictionary DICTCDE Utility Examples of Generated Code Explicit REDEFINES Overlapping child elements can also be generated by DICTCDE as explicit REDEFINES as long as the record layout for the parent element was defined in the Dictionary using the dummy element $REDEFINES. All child elements added to the parent element's list of relationships before $REDEFINES make up the first record layout.
The Dictionary DICTCDE Utility Examples of Generated Code Edit Masks Display fields can be generated for elements defined with edit masks in the Dictionary. If the edit mask is enabled (see the Options response to the main prompt), DICTCDE will generate a PICTURE clause for the edit mask. Table 7-1 shows how the edit masks are generated as COBOL PICTURE characters. Table 7-1.
The Dictionary DICTCDE Utility Examples of Generated Code In the next table, the parent element PART-MASTER has the child elements PART1, PART2, PART3, PART4, PART5, and PART6 related to it. Table 7-2 shows the edit masks and the correct byte offsets as defined in the Dictionary for the child elements and the COBOL PICTURE clause generated for those elements. Table 7-2.
The Dictionary DICTCDE Utility Examples of Generated Code 001700 01 MODE6 PIC 9999 COMP VALUE 6. 001800 01 MODE7 PIC 9999 COMP VALUE 7. 001900 01 MODE8 PIC 9999 COMP VALUE 8. The VPLUS standard parameters include the VPLUS COMAREA definition and a character string which identifies the terminal. (The terminal ID is used for passing to VOPENTERM.) The VPLUS parameters are generated to the WORKING-STORAGE record as follows: 001800 001900 01 COMAREA. 002000 05 COM-STATUS PIC S9(4) COMP VALUE 0.
The Dictionary DICTCDE Utility Examples of Generated Code 004900 05 FILLER PIC S9(4) COMP VALUE 0. 005000 05 COM-NUMRECS PIC S9(9) COMP VALUE 0. 005100 05 COM-RECNUM PIC S9(9) COMP VALUE 0. 005200 05 FILLER PIC S9(4) COMP VALUE 0 005300 05 FILLER PIC S9(4) COMP VALUE 0. 005400 05 COM-TERMFILENUM PIC S9(4) COMP VALUE 0. 005500 05 FILLER PIC S9(4) COMP VALUE 0. 005600 05 FILLER PIC S9(4) COMP VALUE 0. 005700 05 FILLER PIC S9(4) COMP VALUE 0.
The Dictionary DICTCDE Utility DICTCDE Naming Considerations DICTCDE Naming Considerations When an entity is extracted from the Dictionary, DICTCDE checks that the entity name is compatible with COBOL. If the entity name defined in the Dictionary is an illegal COBOL name or the entity name is a COBOL reserved word, an error message will be issued, and DICTCDE will convert the names to legal COBOL names. Note that the names generated by DICTCDE will not be reflected in the Dictionary.
The Dictionary DICTCDE Utility COBOL Data Type Mappings COBOL Data Type Mappings To be compatible with COBOL, the data types defined in the Dictionary must be mapped to COBOL data types. The following shows how the Dictionary data types are mapped to compatible COBOL data types. Note that the COBOL data types occupy the same storage length as the data types defined in the Dictionary. However, some Dictionary definitions allow numbers larger than what COBOL will allow (for example, the integer data type).
The Dictionary DICTCDE Utility COBOL Data Type Mappings Zoned Decimal Suppose the entity is defined in the Dictionary as: ELEMENT-TYPE = Z+ ELEMENT-SIZE = 8 ELEMENT-DECIMAL = 2 ELEMENT-LENGTH = 7 the corresponding COBOL clause will be generated: PIC 9(5)V9(2) Suppose the entity is defined in the Dictionary as: ELEMENT-TYPE = Z ELEMENT-SIZE = 8 ELEMENT-DECIMAL = 2 ELEMENT-LENGTH = 7 the corresponding COBOL clause will be generated: PIC S9(5)V9(2) If the above entity is defined in the Dictionar
The Dictionary DICTCDE Utility COBOL Data Type Mappings Since this is an undefined COBOL type, DICTCDE will flag this element definition with a warning message. Real Number Suppose the entity is defined in the Dictionary as: ELEMENT-TYPE = E (or R) ELEMENT-SIZE = 7 ELEMENT-DECIMAL = 2 ELEMENT-LENGTH = 4 the corresponding COBOL clause will be generated: PIC X(4) Since this is an undefined COBOL type, DICTCDE will flag this element definition with a warning message.
The Dictionary DICTCDE Utility COBOL Data Type Mappings ELEMENT-SIZE = 5 ELEMENT-DECIMAL = 0 ELEMENT-LENGTH { PIC S9(10) COMP. = 8 (Ten digits used to force a 4-word integer.) Packed Decimal The data types defined in the Dictionary as P, are mapped to COBOL COMPUTATIONAL-3 data types. However, this data type is defined in COBOL to occupy the same storage length as specified in the Dictionary, regardless of digit length.
The Dictionary DICTCDE Utility COBOL Data Type Mappings VPLUS Data Items VPLUS forms only contain ASCII characters as storage format. Therefore, regardless of the data types defined in the Dictionary, all VPLUS fields are DISPLAY fields. You may choose to convert all VPLUS fields to PIC X (regardless of the data type defined in the Dictionary). You may also choose to define numeric fields as PIC 9. But you must ensure that non-numeric data (except for a sign) will not appear in those fields.
A DICTDBM Error Messages DICTDBM generates two types of messages on the user terminal - Error Messages and Information Messages. Information Messages are conditions that DICTDBM informs the user about, but are not errors. Both kinds of messages are found in this appendix or in the appropriate reference manual for the indicated subsystem.
DICTDBM Error Messages USER Messages USER Messages Error No. MESSAGE EXPLANATION AND/OR ACTION USER 1 ENTRY NOT NUMERIC Data item type is integer, floating point, or numeric ASCII and a non-numeric character has been detected in the data entry field. USER 2 INPUT FIELD LONGER THAN n Length of data entry exceeds the size (“n”) defined for the associated data item.
DICTDBM Error Messages PROG Messages PROG Messages Error No. MESSAGE EXPLANATION AND/OR ACTION USER 17 EXCEEDED MAXIMUM TREE DEPTH Recursive code has gone through too many performs to trace tree structure. Reduce the depth of the parent/child tree. USER 41 INCOMPATIBLE CODE FILE The IPDIC.PUB code file is not compatible with the version of DICTDBM currently executing. USER 42 INSUFFICIENT STACK FOR WORK SPACE RELOAD DICTDBM needs more data stack for a work | space reorganization.
DICTDBM Error Messages SYSTEM Master SYSTEM Master Error No. MESSAGE EXPLANATION AND/OR ACTION SYSTEM 1 SORT INITIALIZATION Error in call to System SORT Utility. The probable cause is insufficient disc space for SORT scratch file. SYSTEM 2 SORT FILE WRITE Error on releasing record to the System SORT Utility. If cause is not apparent to the resident System Programmer, contact the Systems Engineer. SYSTEM 3 SORT OUTPUT Error on requesting record from System SORT Utility.
DICTDBM Error Messages TRAP Messages TRAP Messages Error No. MESSAGE EXPLANATION AND/OR ACTION TRAP 3 WORKSPACE EMPTY Internal DICTDBM work space is empty. Please notify Systems Engineer. TRAP 5 EMPTY CODE FILE DICTDBM detected an empty code file. TRAP 6 UNEXPECTED EOF IN CODE FILE DICTDBM encountered an unexpected end-of-file while reading the code file. Please notify the Systems Engineer.
DICTDBM Error Messages DICT Messages DICT Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICT 1 CONFLICTING LINE NUMBER SEQUENCE Error messages of type DICT are usually due to an incorrect response to a prompt. After the message is issued, the prompt is reissued, allowing the user to respond to the prompt differently.
DICTDBM Error Messages DICT Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICT 17 SIZE CANNOT BE ZERO Error messages of type DICT are usually due to an incorrect response to a prompt. After the message is issued, the prompt is reissued, allowing the user to respond to the prompt differently.
DICTDBM Error Messages DICT Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICT 35 CHILD CATEGORY NOT FOUND Error messages of type DICT are usually due to an incorrect response to a prompt. After the message is issued, the prompt is reissued, allowing the user to respond to the prompt differently.
DICTDBM Error Messages DICT Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICT 56 FILE NOT IN LOCATION Error messages of type DICT are usually due to an incorrect response to a prompt. After the message is issued, the prompt is reissued, allowing the user to respond to the prompt differently.
DICTDBM Error Messages DICT Messages Error No.
DICTDBM Error Messages DICT Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICT 88 THIS ELEMENT IS CURRENTLY A CHILD ELEMENT Error messages of type DICT are usually due to an incorrect response to a prompt. After the message is issued, the prompt is reissued, allowing the user to respond to the prompt differently.
DICTDBM Error Messages DICT Messages Error No.
B UTILITY Error Messages Error messages are issued for all the Dictionary/3000 utilities. The utilities generate several types of messages on the terminal. Each type of message is found in this appendix or in the appropriate reference manual for the indicated subsystem. The types of messages are: 1. Errors *ERROR: error-message Errors are conditions that arise out of a user response or some operation during the utility process. A correct response or remedy for the error condition is required. 2.
UTILITY Error Messages DICTCDE Messages DICTCDE Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICTCDE 1 *ERROR: PASSWORD IS INVALID The password entered does not give access to the Dictionary. DICTCDE 2 *ERROR: FILE! IS NOT IN COPYLIB FORMAT The specified file is not in KSAM file format. DICTCDE 3 *ERROR: RESPONSE MUST BE ! CHARACTERS OR LESS DICTCDE *ERROR: RESPONSE MUST BE F, E, P, O, OR EX (? FOR HELP) The user must input one of the responses given in the prompt.
UTILITY Error Messages DICTCDE Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICTCDE 35 *ERROR: MPE ERROR IN COMMAND (CIERR !) MPE could not execute the command. DICTCDE 36 *ERROR: MPE CREATE PROCESS ERROR ! INVOKING COBEDIT DICTCDE is unable to run COBEDIT. Check the user/group/account for PH capability, and check to see that the program file COBEDIT.PUB.SYS exists.
UTILITY Error Messages DICTCDE Messages Error No. MESSAGE EXPLANATION AND/OR ACTION DICTCDE 51 *ERROR: CANNOT OPEN MESSAGE FILES FOR HP TOOLSET DICTCDE and Toolset/3000 communicate to each other through message files. These message files could not be opened. DICTCDE 52 *ERROR: INTERNAL ERROR IN HP TOOLSET INTERFACE DICTCDE could not read the message files used to pass information to and from Toolset/3000. DICTCDE 53 *ERROR: INTERNAL ERROR - An error internal to DICTCDE has occurred.
UTILITY Error Messages DICTCDE Messages Warnings MESSAGE EXPLANATION AND/OR ACTION *WARNING: FILE ! DOES NOT HAVE PARENT ! The user has specified a file name in the format 'child(parent)', and the child does not have the 'parent' specified. *WARNING: ! CANNOT HAVE A PARENT; IGNORING PARENT The user has specified a file name in the format 'child(parent)' and the file cannot have a parent, i.e., file types BASE, VPLUS, MPEF, MPER or KSAM.
UTILITY Error Messages DICTCDE Messages MESSAGE EXPLANATION AND/OR ACTION *WARNING: ELEMENT ! HAS NO SPACE FOR A SEPARATE SIGN If an elements size is completely taken up by the digits, then this warning message is issued to warn the user that there is no room for the separate sign. *WARNING: ELEMENT ! HAS MORE THAN 18 DIGITS An element of type P can have a maximum size of 18. *WARNING: ELEMENT ! HAS AN INVALID COMP STORAGE SIZE An element of type I can have a maximum size of 8 bytes.
UTILITY Error Messages DICTDBA Messages DICTDBA Messages Errors MESSAGE EXPLANATION AND/OR ACTION *ERROR: BASE NAME TOO LONG Data base name, including qualifiers, is greater than 24 characters. *ERROR: DATA BASE OPERATION: A data base error occurred when reading information. An IMAGE “DBEXPLAIN message block” is issued to explain the error condition. *ERROR: INVALID MODE Response to MODE prompt is a number other than 1 through 8.
UTILITY Error Messages DICTDBC Messages DICTDBC Messages Errors MESSAGE EXPLANATION AND/OR ACTION *ERROR: BAD PASSWORD The Dictionary data base cannot be opened because the password entered is incorrect. *ERROR: CANNOT OPEN DATA BASE DICT.PUB IMAGE error message The Dictionary data base cannot be opened. The error message returned by IMAGE is shown. *ERROR: DBSCHEMA PROCESSOR CANNOT BE ACTIVATED Utility has been unable to activate the DBSCHEMA program. Contact your system manager.
UTILITY Error Messages DICTDBC Messages MESSAGE EXPLANATION AND/OR ACTION *ERROR: LINE LONGER THAN 70 CHARACTERS The response to CONTROL LINE is longer than 70 characters. *ERROR: PASSWORD DOES NOT ALLOW A ACCESS TO ‘CLASS-PASSWORD' Password does not grant sufficient capability to create a data base. *ERROR: PASSWORD LONGER THAN 8 CHARACTERS Response to DICTIONARY PASSWORD prompt is greater than 8 characters.
UTILITY Error Messages DICTDBD Messages DICTDBD Messages Errors MESSAGE EXPLANATION AND/OR ACTION *ERROR: BASE ALREADY DEFINED IN DATA DICTIONARY The data base name is already in the Dictionary. The user is prompted as to whether the data base should be given a different name when loaded into the Dictionary. *ERROR: BASE NAME TOO LONG Data base name, including qualifiers, exceeds 24 characters. *ERROR: DATA BASE OPERATION A data base error occurred when reading information.
UTILITY Error Messages DICTDBD Messages Condition Prompts MESSAGE EXPLANATION AND/OR ACTION ENTIRE DEFINITION OF DATA BASE WILL NOT FIT IN DICTIONARY, PROCEED (N/Y)? Definition of data base will not fit in dictionary. Respond “N” to terminate utility; respond “Y” to continue until one of the data sets is full, then terminate.
UTILITY Error Messages DICTDBL Messages DICTDBL Messages Errors MESSAGE EXPLANATION AND/OR ACTION *ERROR: BAD DATA BASE NAME: base-name The utility has encountered an invalid base name format in the store file. Probably the store file has bad data in it. *ERROR: BASE LONGER THAN 6 CHARACTERS Base name exceeds 6 characters. *ERROR: BASE NAME TOO LONG Data base name, including qualifiers, exceeds 24 characters. *ERROR: DATA BASE OPERATION A data base error occurred during the load.
UTILITY Error Messages DICTDBL Messages MESSAGE EXPLANATION AND/OR ACTION *ERROR: ITEM NAME TOO LONG Data item name entered in response to the NEW ITEM NAME prompt is longer than 16 characters. *ERROR: PASSWORD LONGER THAN 8 CHARACTERS Response to the BASE PASSWORD prompt is greater than 8 characters. *ERROR: PRINT FILE CANNOT BE OPENED The print file for the listing cannot be opened. Enter a correct file name to the LIST FILE prompt.
UTILITY Error Messages DICTDBU Messages DICTDBU Messages Errors MESSAGE EXPLANATION AND/OR ACTION *ERROR: BASE LONGER THAN 6 CHARACTERS Base name exceeds 6 characters. *ERROR: DATA BASE OPERATION A data base error occurred. A “DBEXPLAIN message block” is issued to explain the error condition. *ERROR: DBINFO OPERATION The utility encountered an error when using a “DBINFO” call to IMAGE. A “DBEXPLAIN message block” is issued to explain the error condition.
UTILITY Error Messages DICTDBU Messages MESSAGE EXPLANATION AND/OR ACTION *ERROR: SEARCH ITEM NOT FOUND Named item is not a search item within the detail set when EDIT MODE used. *ERROR: STORE FILE CANNOT BE CLOSED The utility was unable to close the store file in either the permanent or temporary file domain. Contact your system manager. *ERROR: STORE FILE EXISTS AND CANNOT BE ACCESSED Accessing the named store file is a security violation. *ERROR: STORE FILE OPEN The store file cannot be opened.
UTILITY Error Messages DICTDBU Messages Condition Prompts MESSAGE EXPLANATION AND/OR ACTION CONTINUE SET UNLOAD(Y/N)?> After an error or a Control Y interrupt, this prompt allows the user to continue the operation or to terminate the utility program. CONTROL(Y) BREAK, CONTINUE(Y/N)?> User has entered Control Y during a data set unload. A response of “N” will terminate the utility program.
UTILITY Error Messages DICTPDE Messages DICTPDE Messages Errors MESSAGE EXPLANATION AND/OR ACTION *DICT ERROR: CANNOT CLOSE DICTIONARY! The Dictionary entered was not entered correctly or does not exist. Reenter with the correct Dictionary. *DICT ERROR: INVALID PASSWORD. CANNOT OPEN DICTIONARY! The Dictionary cannot be opened because the password entered is incorrect. Reenter with the correct password.
UTILITY Error Messages DICTPDE Messages MESSAGE EXPLANATION AND/OR ACTION *LANGUAGE ERROR: PREVIOUSLY GENERATED COMAREA The VPLUS COMAREA was already generated in the output file. *LANGUAGE ERROR: PREVIOUSLY GENERATED IMAGE PARAMETERS The IMAGE parameters were already generated in the output file. *LANGUAGE ERROR: ! IS ILLEGAL PASCAL NAME The entity name consists of characters which are not legal PASCAL identifiers. DICTPDE will convert the name to a legal PASCAL name.
UTILITY Error Messages DICTVPD Messages DICTVPD Messages Errors MESSAGE EXPLANATION AND/OR ACTION FAILURE TO OPEN DICT.PUB The Dictionary DICT.PUB does not exist, or has been directed to a Dictionary which does not exist. FAILURE TO OPEN FORMS FILE The forms file could not be opened. The forms file does not exist, or is opened for exclusive access by some other program. INCOMPATIBLE DICTIONARY/3000 VERSION This version of the Dictionary does not match the version the utility expects.
UTILITY Error Messages DICTVPD Messages Warnings MESSAGE EXPLANATION AND/OR ACTION *WARNING: DICTIONARY ALREADY CONTAINS FORM: # The form to be loaded already exists in the Dictionary *WARNING: ELEMENT HAS NOT BEEN LOADED INTO DICTIONARY DICTVPD skipped the specified element *WARNING: FORMS FILE ALREADY NAMED IN DATA DICTIONARY Forms file to be loaded already exists in the Dictionary.
C DICTIONARY/3000 Initialization Procedure Overview Once Dictionary/3000 software has been installed on your system, you must execute the program DICTINIT to create and initialize a data dictionary. This program allows you to customize the dictionary for your application and to define the security for the dictionary. It also allows you to re-initialize an existing dictionary when you want to change the passwords for access or to change the capacities of the data sets in the dictionary.
DICTIONARY/3000 Initialization Procedure Overview LEVEL ACCESS CAPABILITY WHO SHOULD USE DOCUMENTATION Can modify documentation entries and all entries below; cannot read/modify security entries. Anyone responsible for maintaining documentation entries in the dictionary (PROCEDURES, LOCATIONS, or CATEGORIES). REPORT Can modify NO entries; can read all entries except security entries. Anyone who needs to write can read all entries except reports about the contents of the dictionary.
DICTIONARY/3000 Initialization Procedure Overview USER PASSWORD > ACCOUNT PASSWORD >LOCKIT GROUP PASSWORD > #J33 END OF PROGRAM : If logon passwords were used, enter them in response to these prompts. They are used by the batch job that installs a temporary dictionary. Number of the STREAMed job which performs step one (initialization). End of step one. FROM//PLEASE RUN DICTINIT.PUB.
DICTIONARY/3000 Initialization Procedure Overview FILE-PATH will have capacity 400 FILE-SORT will have capacity 400 PROCEDURE-ELEMENT will have capacity 500 CATEGORY-ELEMENT will have capacity 500 Press RETURN to continue > Press RETURN to see the rest of the display; it fills more than one screen in this case.
DICTIONARY/3000 Initialization Procedure Overview final initialization job which actually creates the new dictionary. ACCOUNT PASSWORD >LOCKIT GROUP PASSWORD > #J34 Number of the final job. END OF PROGRAM End of customization step. The program is complete; your dictionary is initialized. FROM//DICTINIT IS COMPLETE This example demonstrates how to enter your own capacities and change them after they are displayed.
DICTIONARY/3000 Initialization Procedure Overview DATA-GROUP New capacity for has capacity 503 DATA-GROUP > 504 DATA-CLASS New capacity for has capacity 203 DATA-CLASS > 204 DATA-LOCATION New capacity for has capacity 203 DATA-LOCATION > LINK-FILE New capacity for has capacity 401 LINK-FILE > 402 LINK-ELEMENT New capacity for has capacity 401 LINK-ELEMENT > 402 LINK-DESCRIPTION New capacity for has capacity 2003 LINK-DESCRIPTION > 2004 DATA-REPORTLOC New capacity for has capacity 503 DATA-REPO
DICTIONARY/3000 Initialization Procedure Overview CLASS-CLASS New capacity for has capacity 500 CLASS-CLASS > 501 CLASS-ELEMENT New capacity for has capacity 3000 CLASS-ELEMENT > 3001 CLASS-FILE New capacity for has capacity 500 CLASS-FILE > 501 CLASS-GROUP New capacity for has capacity 500 CLASS-GROUP > 501 FILE-LOCATION New capacity for has capacity 500 FILE-LOCATION > 501 PROCEDURE-LOCATI New capacity for has capacity 200 PROCEDURE-LOCATI > 201 DESCRIPTION-TEXT New capacity for has capacity
DICTIONARY/3000 Initialization Procedure Overview FILE-PATH will have capacity 401 FILE-SORT will have capacity 401 Press RETURN to continue > PROCEDURE-ELEMEN will have capacity 501 CATEGORY-ELEMENT will have capacity 501 GROUP-ELEMENT will have capacity 1001 CLASS-CLASS will have capacity 501 CLASS-ELEMENT will have capacity 3001 CLASS-FILE will have capacity 501 CLASS-GROUP will have capacity 501 FILE-LOCATION will have capacity 501 PROCEDURE-LOCATI will have capacity 201 DESCRIPT
DICTIONARY/3000 Initialization Procedure Overview DESCRIPTION-TEXT will have capacity 5000 REPORT-LIST will have capacity 200 Are the capacities correct? (Y/N) >y Password for MANAGER access >DICTMGR Password for PROGRAMMER access > Entering RETURN indicates that there will be no access to the dictionary at these levels.
DICTIONARY/3000 Initialization Procedure Overview The present contents of the dictionary will be stored by DICTINIT, to be recovered into the new dictionary when it is created. This store file may be quite large, and you may not have the disk space to hold it. In this case, you may store it to tape. Otherwise, request DICTINIT to use a disk file, as in this example. #J46 END OF PROGRAM : FROM//PLEASE RUN DICTINIT.PUB.SYS,UPDATE End of step one. :RUN DICTINIT.PUB.SYS,UPDATE Execute step two.
DICTIONARY/3000 Initialization Procedure Overview USER PASSWORD > If log-on passwords were used, enter them in response to these prompts. ACCOUNT PASSWORD > GROUP PASSWORD > Dictionary store file on Tape or Disk(T/D) >d Indicates a disk file; must be answered as in step one. #J50 END OF PROGRAM : FROM//DICTINIT IS COMPLETE Appendix C The program is complete; your dictionary is now re-initialized.
DICTIONARY/3000 Initialization Procedure DICTINIT Error Messages DICTINIT Error Messages The DICTINIT error messages are divided into three groups. The first group corresponds to step 1 (initialization). The second group corresponds to step 2 (customization). The third group corresponds to the final initialization job stream at the end of step 2, which builds your permanent Dictionary.
DICTIONARY/3000 Initialization Procedure DICTINIT Error Messages MESSAGE EXPLANATION AND/OR ACTION FROM /your account file /file system error message FROM /your account / ERROR OCCURRED OPENING FILE MDSCH FROM /your account / ERROR OCCURRED WRITING FILE MDSCH FROM /your account / ERROR OCCURRED CLOSING FILE MDSCH You will receive the first line, which is an MPE file system error message detailing the error, and one of the next three lines, which will tell you what DICTINIT was trying to do at that time.
DICTIONARY/3000 Initialization Procedure DICTINIT Error Messages MESSAGE EXPLANATION AND/OR ACTION CAPACITY MUST BE A NUMBER CAPACITY MUST BE LESS THAN 2,147,483,647 RESPONSE MUST BE 10 CHARACTERS OR LESS CAPACITY MAY NOT BE ZERO All these messages come from invalid responses to the NEW CAPACITY prompt. (Note that the capacity should probably be MUCH less than 2,147,483,647.
DICTIONARY/3000 Initialization Procedure DICTINIT Error Messages Group 3 — Final Initialization Errors The error messages you might receive during the final initialization job at the end of phase 2 are as follows: MESSAGE EXPLANATION AND/OR ACTION FROM/your account / #DB ERROR: IMAGE database error message FROM/your account / ERROR OCCURRED OPENING MDIC FROM/your account / ERROR OCCURRED READING CLASS nn FROM/your account / ERROR OCCURRED REINITIALIZING CLASS nn FROM/your account / ERROR OCCURRED CLOSING
DICTIONARY/3000 Initialization Procedure DICTINIT Error Messages 328 Appendix C
D How HP INFORM Links Files to Generate Reports When generating reports using HP Inform/3000, the user selects the desired elements from HP Inform/3000's Data Names Menu. If the user has chosen to report from elements organized into an HP Inform/3000 group, these elements may exist in various files - MPE files, KSAM files, or IMAGE data sets. HP Inform/3000 needs to be able to link these files so that the desired lines of the report can be generated.
How HP INFORM Links Files to Generate Reports Direct Links Direct Links A link between two files, each of which contains the values of one or more elements needed for a report, is called a “direct link”. When two files are linked, the value of the link element is retrieved from the first file and is used to determine the correct record to retrieve from the second file.
How HP INFORM Links Files to Generate Reports Indirect Links Indirect Links If two files containing elements needed for a report are linked through other files which contain no elements needed for the report, the link is called an “indirect link”. There are only two indirect links which HP Inform/3000 allows and both apply only to data sets within the same database. These links are the following: 1.
How HP INFORM Links Files to Generate Reports Indirect Links &sigspace; LIST-PRICE-MSTR CITY-MASTER *list-price . . . . *city-abbr city-name . . . COMMERCIAL RESIDENTIAL *list-price occupied *city-abbr *list-price *search items Suppose the report requests the data element “occupied” from the detail set COMMERCIAL and the data element “city-name” from the master set CITY-MASTER. An indirect link can be formed by going through the detail set RESIDENTIAL.
How HP INFORM Links Files to Generate Reports Indirect Links • If no files meet these two criteria, then files which contain an element to be included in the report are considered in the following order: MPE files KSAM files IMAGE detail data sets IMAGE master data sets If more than one file exists in the highest possible category, the file with the most elements to be included in the report is chosen as the driving file. If there are two such files or more, one of them is arbitrarily chosen.
How HP INFORM Links Files to Generate Reports Linking Files Linking Files All elements in a group that have been assigned a positive link value form a prioritized list for use by HP Inform/3000's access algorithm when linking files. Elements which have been added to a group which will not be displayed on HP Inform/3000's Data Names Menu are included in this list if they have been assigned a positive link value. The following steps outline how HP Inform/3000 links files.
How HP INFORM Links Files to Generate Reports Default File Access Default File Access HP Inform/3000 provides defaults designed to maximize performance of the file accesses necessary during report production. One such default, which was explained in the discussion on the driving file, is that an MPE file will be used as the driving file whenever possible.
How HP INFORM Links Files to Generate Reports Default File Access Example Assume the following files: SALESTAT WARRANTY INVENTORY (ESAM file) (MPE file) (IMAGE detail) del-flag account account (KEY) owner address prod-no *prod-no *ship-date backorderflg unit cost descrip ytd-sales total sales-rep ship-date owner wrnty-mp Suppose we wish to create a group called ACCOUNT ORDERS. The purpose of the ACCOUNT ORDERS group is to generate reports about the orders of each account.
How HP INFORM Links Files to Generate Reports Default File Access HP Inform/3000 to link WARRANTY directly with other files to retrieve as many elements from the group as possible. The elements “account”, “prod-no”, and “ship-date” are our three possibilities. Since “ship-date” is not in the group, we will use “account” or “prod-no”.
How HP INFORM Links Files to Generate Reports Default File Access Assume the following database: LOCATION *branch city BORROWER CALL-NO *borrower phone *call-no CATALOG *call-no *borrower bor-date *branch SUBJECT AUTHOR TITLE *subject *author *title BOOK *title *author *subject *call-no pub-date publisher *search item Suppose we wish to create a group called BOOKS OUT. The purpose of the BOOKS OUT group is to generate reports about books that are checked out of the library.
How HP INFORM Links Files to Generate Reports Default File Access prompt when adding an element from the file CATALOG to the group. We would like to pick an element which will allow HP Inform/3000 to link CATALOG directly with other files to retrieve as many elements from the group as possible. The elements “call-no” and “borrower” are our two possibilities since they are search items.
How HP INFORM Links Files to Generate Reports Default File Access 340 Appendix D
E DICTDBM Quick Reference The following chart indicates the order in which the data dictionary commands can be used.
DICTDBM Quick Reference Command/Subcommand Guide Command/Subcommand Guide This is a quick reference guide for each command which shows what subcommands can be used and what the command/subcommand does.
DICTDBM Quick Reference Command/Subcommand Guide DELETE CATEGORY deletes an element to category association CLASS deletes an element to class association CLASS-FILE deletes a file to class association CLASS-GROUP deletes a group to class association FILE deletes an element to file association FILE-LOC deletes a file to location association GROUP deletes an element to HP Inform/3000 group association PROCEDURE deletes an element to procedure association PROCEDURE-LOC deletes a procedure to
DICTDBM Quick Reference Command/Subcommand Guide MODIFY CATEGORY modifies a category CLASS modifies a security class ELEMENT modifies a data element FILE modifies a file GROUP modifies an HP Inform/3000 group LOCATION modifies a physical location PROCEDURE modifies a procedure PURGE CATEGORY purges the category and all references to it CLASS purges the security class and all references to it ELEMENT purges the data element and all references to it FILE purges the file and all reference
DICTDBM Quick Reference Command/Subcommand Guide PROCEDURE removes the relationship between a child and a parent procedure RENAME CATEGORY renames an existing category CLASS changes the existing identifying number of a security class ELEMENT renames an existing data element FILE renames an existing file GROUP renames an existing HP Inform/3000 group LOCATION renames an existing physical location PROCEDURE renames an existing procedure REORDER CATEGORY reorders a child category within a par
DICTDBM Quick Reference Command/Subcommand Guide RESEQUENCE CATEGORY resequences a data element within a category CLASS resequences a data element within a security class FILE resequences a data element within a file GROUP resequences a data element within an HP Inform/3000 group PROCEDURE resequences a data element within a procedure SECURE FILE secures all data elements in a file and the file itself to a user security class GROUP secures a group to a user security class SHOW CATEGORY shows
Glossary A access capability The type of access to be given to a user security class for a file or element, as follows: R — allows the user identified by the security class to locate and read a file or an element; U — allows the user identified by the security class to read and update values in a file or an element, except search or sort elements; M — allows the user identified by the security class to read, update, add to, and delete from a file or an element; X — allows only the creator to access the dat
count The numeric value used to identify the number of sub-elements in a compound element. F D file A collection of logically related data elements; may be an IMAGE database or set, or a KSAM, MPE, or VPLUS file. decimal The number of decimal digits to allow for a numeric type data element. file-loc A data dictionary entity used to document the physical location of a file. DETL An IMAGE detail data set. file size The maximum number of records a file is allows to contain.
Inform/3000 for a report, which is formed by linking through one or more other files which do not contain elements needed for the report. K key element Used to identify a data element which is the key in a KSAM file KSAM Refers to a KSAM file. (See the KSAM/3000 Reference Manual.) L language The name of the implementation language used to write a program, procedure, or subroutine.
R relationship Ties together like entities such as a child file and a parent file. responsibility The name of the person, area, or department that is responsible for the integrity of an entity. RETURN A carriage return/line feed. S search element Used to identify an element which is a search item in an IMAGE master or detail data set T type The attribute for a data element (X, I, etc.), file type for a file (VPLS, MAST, KSAM, etc.), or a user-definable 4-character definition for other entities.
