~ntlgrajen~m lure 1 - dtic · retrieval or update ndml subtransaction against a codasyl -the...

10F~~ Co LUREA-Al18 2 I09 ~NTlGRAJEN~M 11 01j UOUJNK 5 l

UNCLASIIE IE LE VhN1 IR R ONU~t S- 11 F'G L2/3 ML

L 13

LAI-L8

AD-A 182 009

AFWAL-TR-86-4006Volume VPart 20

INTEGRATED INFORMATIONSUPPORT SYSTEM (IISS)Volume V - Common Data Model SubsystemPart 20 - NDML Preoompiler Generate Codasyl Request Processor

Product Specification

General Electric CompanyProduction Resources ConsultingOne River RoadSchenectady, New York 12345

Final Report for Period 22 September 1980 - 31 July 1985

November 1985

Approved for public release; distribution is unlimited.

*PREPARED FOR: >%iICp ELECTEMATERIALS LABORATORYAIR FORCE RIG T AERONAUTICAL LABORATORIES S JUL- 1910AIR FORCE SYSTEMS COMMANDWRIGHT-PATTERSON AFB, OH 45433-6533 E

87 6 30 1IS&

uncl~assified

gasua".V C6&63 01@&A'IOh 011" IINS Iam November 1985

REPORT DOCUMENTATION PAGE l14,001, 41aceWt'. 91,&23If caTsf 16 mm6,9674TVI AS4IfOS,

unclassified

36 usCWAaTV s&A116106CATae. AuW*ST011,1 3 MLLIs?@&;va-a,~ O R ~IApproved for public release;

2~ 54C.A8e~a~?,~4w#.6&5sh SONO~bIdi str ibutione is nal 31ted.

* a. 055WQskeoo% eftabaKaTIOA REPORT OuSWSO1 S. MQ%1TG@ait§ @m&AIOIZA?,Ost REPORT NuM69 A461

AFVAL-TR-36-4006 Vol V. Part 20

$a %,awl of PIsOGRAPues ONGasagAT~A Is Of P ICE SY61SOL I& %&MIK Of GIO~sIOTGAMSORmAWIL.A?.

Production Resources consultsa 7VLIUTGIL &DORA" fears Sanme lp Cabo IN ?DM. 13 aeoau OSale on SIP Cow#

selitiec47. M 11245 PAF3. ON 45433-6533

go NAME OF 0WsOmfGSeP@#SSUOA Off,5 IEsYMsso. S. P011CumiM""T 4018OMuUNT? lOSNIS6CA?,soe tgul a

Air rorce Systems Con, USAY *?VALME.Y t33615-40-C-1515

PROGRAM I POJOC? YASA WORK uWrrWiglit-Pttrsm Ar3. ftio 43433 LEINT00.01. NO.

ii.e?.8 ~f &U~ bw UOlI7500 62 01

(See Reverse)I

Apicella. H. L. and Bradley. v. J.1'IV P& Of 64PORT Ia ts e COVERED t.. DAY aaO MPOI r'.. ^j.. jbv to. PAGE COusrrts&) "Cucal 8uoel, 32 Sp% 3WO - a 1 hI, 29411 1985 move" 72

WS SPPiASA flai OVATION The computer software 008t~aiaed herein are 11booretical and/orac" Prje "lei*ty *act ,~trnlce tati Inao way rectt Air Toroe-evaed or -developed

I. - dtmaP Iena u~as oviow ms ar a ,s okft6 M ~ass

Thenerocen In pro essorodsctisycifdat o eq estfaishngSth date s e./L

~ts.9*eiiN1S WT D~ 6RI WWS Unclassified

*&MeA~ OP &990000806 010eC5 soA To3 VhapselE ftU so pp Ica SWUNSO

00 FORM 14738 APR sip?*% 6 S-AhSS-f 155a Y5W. unclassifitedhgCeUIT a&.AaPICATIO16c OfI ?esG

I * I 55 - I -:

11. Title

Integrated Information Support System (IISS)Vol V - Common Data Model SubsystemPart 20 - NDHL Precompiler Generate Codasyl Request

Processor Product Specification

Accession For

DTIC TABUnannounced 0Justifioation

Distribut ion/

Availability CodesAvail and/or

Dist Spooal

1h-?,,

PS 6201412551 November 1985

PREFACE

This product specification covers the work performed underAir Force Contract F33615-80-C-5155 (ICAM Project 6201). Thiscontract is sponsored by the Materials Laboratory, Air ForceSystems Command, Wright-Patterson Air Force Base, Ohio. It wasadministered under the technical direction of Mr. Gerald C.Shumaker. ICAM Program Manager, Manufacturing TechnologyDivision, through Project Manager, Mr. David Judson. The PrimeContractor was Production Resources Consulting of the GeneralElectric Company, Schenectady, New York, under the direction ofMr. Alan Rubenstein. The General Electric Project Manager wasMr. Myron Hurlbut of Industrial Automation Systems Department,Albany, New York.

Certain work aimed at improving Test Bed Technology hasbeen performed by other contracts with Project 6201 performingintegrating functions. This work consisted of enhancements toTest Bed software and establishment and operation of Test Bedhardware and communications for developers and other users.Documentation relating to the Test Bed from all of thesecontractors and projects have been integrated under Project 6201for publication and treatment as an integrated set of documents.The particular contributors to each document are noted on theReport Documentation Page (DD1473). A listing and descriptionof the entire project documentation system and how they arerelated is contained in document FTR620100001, Project Overview.

The subcontractors and their contributing activities wereas follows:

TASK 4.2

Subcontractors Role

Boeing Military Aircraft Reviewer.Company (BMAC)

D. Appleton Company Responsible for IDEF support,(DACOM) state-of-the-art literature

search.

General Dynamics/ Responsible for factory viewFt. Worth function and information

models.

iii t.

I

PS 6201412551 November 1985

Subcontractors Role

Illinois Institute of Responsible for factory viewTechnology function research (IITRI)

and information models ofsmall and medium-size business.

North American Rockwell Reviewer.

Northrop Corporation Responsible for factory viewfunction and informationmodels.

Pritsker and Associates Responsible for IDEF2 support.

SofTech Responsible for IDEFO support.

TASKS 4.3 - 4.9 (TEST BED)

Subcontractors Role

Boeing Military Aircraft Responsible for consultation onCompany (BMAC) applications of the technology

and on IBM computer technology.

Computer Technology Assisted in the areas ofAssociates (CTA) communications systems, system

design and integrationmethodology, and design of theNetwork Transaction Manager.

Control Data Corporation Responsible for the Common Data(CDC) Model (CDM) implementation and

part of the CDH design (sharedwith DACOM).

D. Appleton Company Responsible for the overall CDM(DACOM) Subsystem design integration

and test plan, as well as partof the design of the CDM(shared with CDC). DACOM alsodeveloped the IntegrationMethodology and did the schemamappings for the ApplicationSubsystems.

iv

I

PS 6201412551 November 1985

Subcontractors Role

Digital Equipment Consulting and support of theCorporation (DEC) performance testing and on DEC

software and computer systemsoperation.

McDonnell Douglas Responsible for the support andAutomation Company enhancements to the Network(McAuto) Transaction Manager Subsystem

during 1984/1985 period.

On-Line Software Responsible for programming theInternational (OSI) Communications Subsystem on the

IBM and for consulting on theIBM.

Rath and Strong Systems Responsible for assistance inProducts (RSSP) (In 1985 the implementation and use ofbecame McCormack & Dodge) the MRP II package (PIOS) that

they supplied.

SofTech, Inc. Responsible for the design andimplementation of the NetworkTransaction Manager (NTM) in1981/1984 period.

Software Performance Responsible for directing theEngineering (SPE) work on performance evaluation

and analysis.

Structural Dynamics Responsible for the UserResearch Corporation Interface and Virtual Terminal(SDRC) Interface Subsystems.

Other prime contractors under other projects who havecontributed to Test Bed Technology, their contributingactivities and responsible projects are as follows:

Contractors ICAM Project Contributing Activities

Boeing Military 1701, 2201, Enhancements for IBMAircraft Company 2202 node use. Technology(BMAC) Transfer to Integrated

Sheet Metal Center(ISMC).

V

!I

PS 6201412551 November 1985

Contractors ICAM Project Contributinf Activities

Control Data 1502, 1701 IISS enhancements toCorporation (CDC) Common Data Model

Processor (CDMP).

D. Appleton Company 1502 IISS enhancements to(DACON) Integration Methodology.

General Electric 1502 Operation of the TestBed and communicationsequipment.

Hughes Aircraft 1701 Test Bed enhancements.Company (HAC)

Structural Dynamics 1502, 1701, IISS enhancements toResearch Corporation 1703 User Interface/Virtual(SDRC) Terminal Interface

(UI/VTI).

Systran 1502 Test Bed enhancements.Operation of Test Bed.

vi

I

PS 6201412551 November 1985

TABLE OF CONTENTS

Page

SECTION 1.0 SCOPE .................................... 1-11.1 Identification ........................ 1-11.2 Functional Summary ................... 1-1

SECTION 2.0 DOCUMENTS ............................... 2-12.1 Reference Documents .................. 2-12.2 Terms and Abbreviations .............. 2-1

SECTION 3.0 REQUIREMENTS ............................ 3-13.1 Structural Description ............... 3-13.2 Functional Flow ....................... 3-23.3 Interfaces ............................ 3-33.3.1 Inputs/Outputs ...................... 3-43.4 Program Interrupts ................... 3-43.5 Timing and Sequencing Description .... 3-43.6 Special Control Features ............. 3-43.7 Storage Allocation ................... 3-43.7.1 Database Definition ................ 3-43.7.1.1 File Description ................. 3-53.7.1.2 Table Description ................ 3-53.7.1.3 Item Description ................. 3-53.8 Object Code Creation ................. 3-53.9 Adaptation Data ....................... 3-53.10 Detail Design Description ............ 3-53.10.1 Main Program List .................. 3-53.10.2 Module List ......................... 3-83.10.3 External Routines List ............. 3-103.10.4 Include File List .................. 3-123.10.5 Where Include File Used List ....... 3-143.10.6 Where External Routine Used List ... 3-203.10.7 Main Program Parts List ............ 3-233.10.8 Module Documentation ............... 3-253.10.9 Include File Description ........... 3-303.10.10 Hierarchy Chart ..................... 3-533.11 Program Listings Comments ............ 3-58

SECTION 4.0 QUALITY ASSURANCE PROVISIONS ........... 4-14.1 Introduction and Definitions ......... 4-14.2 Computer Programming and Test

Evaluation ........................... 4-1

vii

AL.

PS 6201412551 November 1985

SECTION 1

SCOPE

1.1 Identification

This specification establishes the design of FunctionPRE9.3, 4Generate CODASYL Request Processor , one of the majorfunctions of the Configuration Item (CI)A-'Precompiler"&to bebuilt and formally accepted by the ICAM Program Office. This CIconstitutes one of the subsystems of the Common Data ModelProcessor (CDMP).,

1.2 Functional Summary

--,,The purpose of this Computer Program Configuration Item(CPCI) is to generate a COBOL program that will satisfy aretrieval or update NDML subtransaction against a CODASYL -

The following functions wily be perfored by this CPCI:.' 14

1. Generate the Data Division section of the RequestProcessor.

a) Generate file description and record layout if theNDML request resulted in a retrievalsubtransaction.

2. Generate the Working Storage section of the RequestProcessor. These working storage variables will beused for:

a) Conceptual/internal transformation of retrievalsearch parameters or update values.

b) Internal/conceptual transformation of retrieveddata fields.

c) DBMS status checks.d) Retrieved qualification variables.

3. Generate the Procedure Division section of the RequestProcessor. It will include all the code to access aparticular CODASYL database in order to satisfy theNDML request. This code will consist of:

a) Interface code to the Request Processor Main

1-1

PS 6201412551 November 1985

program at runtime.b) Code to transform the retrieval search parameters

or update values from conceptual to internalformat.

c) Code using DBMS specific calls to access thedatabase to retrieve data or update data.

d) Code to transform the retrieved data from internalto conceptual format.

e) Code to save the retrieved data on a sequentialfile.

f) Code to check DBMS status and report errors duringruntime execution.

1-2

PS 6201412551 November 1985

SECTION 2

DOCUMENTS

2.1 Reference Documents

1. ICAM Documentation Standards: IDS15012000A, 28December 1981.

2. D. Appleton Co., CDM Administrator's Manual;UM620141000. March 1984.

3. D. Appleton Co., CDMI-IDEF, Model of the Common DataModel; CCS620141000, 15 May 1985.

4. D. Appleton Co., Computer Program DevelopmentSpecification (DS) for ICAM Integrated Support System(IISS) Configuration Item: NDML Precompiler;DS620141200, October 1984.

5. D. Appleton Co., Embedded NDML Programmer's ReferenceManual; PRM620141200, March 1985.

6. Softech, Inc., NTM Programmer's Guide: UM620140001,July 1984.

7. Control Data Cor., Computer Program DevelopmentSpecification (DS) for ICAM Integrated Support System(IISS) Configuration Item: NDDL Command Processor:DS620141100, June 1985.

2.2 Terms and Abbreviations

Attribute Use Class: (AUC)

Conceptual Schema: (CS)

Common Data Model Processor: (CDMP)

Common Data Model: (CDM) Describes common data applicationprocess formats, form definitions, etc, of the IISS andincludes conceptual schema, external, internal schemas, andschema transformation operators.

Data Field: (DF) An element of data in the externalschema. It is by this name that an NDML programmer

2-1

PS 6201412551 November 1985

references data.

Database Management System: (DBMS)

Distributed Request Supervisor: (DRS) This IISS CDMsubsystem configuration item controls the execution ofdistributed NDML queries and non distributed updates.

Domain: A logical definition of legal attribute classvalues.

Domain Constraint: Predicate that applies to a singledomain.

External Schema: (ES)

Forms: Structured views which may be imposed on windows orother forms. A form is composed of fields where each fieldis a form, item, or window.

Forms Processor: (FP) A set of callable execution timeroutines available to an application program for formprocessing.

Internal Schema: (IS)

Integrated Information Support System: (IISS) A testcomputing environment used to investigate, demonstrate andtest the concepts of information management and informationintegration in the context of Aerospace Manufacturing. TheIISS addresses the problems of integration of data residenton heterogeneous databases supported by heterogeneouscomputers interconnected via a local Area Network.

Mapping: The correspondence of independent objects in twoschemas: ES to CS or CS to IS.

Network Transaction Manager: (NTM) Performs thecoordination, communication and housekeeping functionsrequired to integrate the application processes and systemservices resident on the various hosts into a cohesivesystem.

Neutral Data Manipulation Language: (NDML) A languagedeveloped by the IISS project to provide uniform access tocommon data, regardless of database manager or distributioncriteria. It provides distributed retrieved and single

2-2

PS 6201412551 November 1985

node updates.

ORACLE: Relational DBMS based on the SQL (Structured QueryLanguage, a product of ORACLE Corp, Menlo Park, CA). TheCDM is an ORACLE database.

Parcel: A sequential file containing section source codeof the input application program.

Request Processor: (RP) A COBOL program that will satisfya retrieval or update NDNL subtransaction against aparticular Database Management System.

User Interface: (UI) Controls the user's terminal andinterfaces with the rest of the system.

Virtual Terminal Interface: (VTI) Performs the interfacingbetween different terminals and the UI. This is done bydefining a specific set of terminal features and protocolswhich must be supported by UI software which constitutesthe Virtual Terminal Definition. Specific terminals arethen mapped against the Virtual Terminal software byspecific software modules written for each type of realterminal supported.

2-3

-|

PS 6201412551 November 1985

SECTION 3

REQUIREMENTS

3.1 Structural Description

A graphic portrayal of this CPCI is included in Section3.10. This chart shows the hierarchical relationships of eachmodule making up this CPCI.

This CPCI uses a number of lower level modules to handlespecific operations such as:

1. Generate conceptual schema data definitions forretrieved data fields (CDRFT).

2. Generate internal schema data definitions for runtimesearch parameters (CDPRN).

3. Generate internal schema data definitions for retrieveddata fields (CDRDF).

4. Generate conceptual schema data definitions for runtinesearch parameters or update values (CDMSG).

5. Generate working storage and procedure division codefor the conceptual schema to internal schematransformation of runtime search parameters or updatevalues (CDCI).

6. Generate working storage and procedure division codefor the internal schema to conceptual schematransformation of retrieved data fields (CDIC).

7. Generate internal schema data definitions for qualifieddata fields (CDQDF).

8. Combine two work files into one file containing theRequest Processor program (CDCWF).

9. Generate macros with the proper substitution parameters(CDNACR).

3-1

PS 6201412551 November 1985

3.2 Functional Flow

This CPCI implements the logic defined in the DevelopmentSpecification for this CPCI. Details of inputs/outputs andrelationships between modules are to be found in Section 3.10.

This CPCI has been designated to operate in a batch orinteractive mode. It must operate in the system environmentestablished for IISS; that is, use of the Network Transactionmanager. It must use the ORACLE DBMS installed on a DEC VAXcomputer.

3-2

I

PS 620141255

1 November 1985

3.3 Interfaces

The following diagram depicts the interface of PRE9.3 withother CPCI's in the system.

--------------

I CDPI3 II PS41210 I

I PRE9.3 I+-------------------- +-----------------------

I ------------ II II II I

--------- +----+ +------------FILE I I SUPPORT I

I UTILITIES I I ROUTINES IPS41330 I I PS41260 I

+-------------+ ------------ +

3-3

-. ,-

PS 6201412551 November 1985

3.3.1 Inputs/Outputs

The following table depicts the inputs and outputs of thisCPCI. A detail description for each item can be found in the DSfor this CPCI.

Function: PRE9.3

INPUT OUTPUT

Database Identification Number Source Code File NameDatabase Name Function StatusDatabase Schema Name Database Sub-Schema NameDatabase Location Library NameTarget Host Current HostRequest Processor Name Current SubtransactionInternal Schema Action List Internal Schema Qualify ListConceptual Schema Action List Conceptual Schema Qualify

ListResult Field Table Generic CODASYL Command TableRecord Key Table AP Information TableORACLE Logon Data Area Error File Name

3.4 Program Interrupts

Not applicable to this CPCI.

3.5 Timing and Sequencing Description

This CPCI is called upon by the Request Processor ControlModule, CDP13, for every CODASYL subtransaction identified bythe current NDXL request being precompiled.

3.6 Special Control Features


3.7 Storafe Allocation

3.7.1 Database Definition

The database used by this CPCI is the Common Data Model(CDM) database. This model is defined by the CDMl. the IDEF-1model of the CDM, Reference Document Number 3. The database wasconstructed using the ORACLE DBMS.

3-4

- W

PS 6201412551 November 1985

3.7.1.1 File Description

No permanent files have been defined for this CPCI. Ituses temporary scratch files for the generated program sourcecode.

3.7.1.2 Table Description

All tables used by this CPCI have been defined by theDevelopment Specification for this CPCI.

3.7.1.3 Item Description


3.8 Object Code Creation

The object code for this CPCI will be created by the systemintegration test team by using defined IISS SoftwareConfiguration Management procedures. This CPCI will use theCOBOL language compilers.

3.9 Adaptation Data

This CPCI has been coded using ANSI COBOL, FORTRAN and a"standard" subset of the "C* languages. The intent was toprovide a transportable system. Any system environmentsupporting these languages, a virtual memory management scheme,the COMM and NTM subsystems of IISS and the ORACLE DatabaseManagement System should be able to support this CPCI. Everypossible attempt has been made to localize and identify anymachine or environment dependent modules through the originaldesign of the IISS and application of Configuration ManagementProcedures.

3.10 Detail Design Description

The following sections have been computer generated forthis CPCI.

3.10.1 Main Program List

The following is a list of all "Main Programs" whichare modules that are not called by any other module beingdocumented here. These modules are either program entry points

-

3-5

Ii'

PS 6201412551 November 1985

or, if they are hooked into another set of programs viasubroutine calls, they are the points the external programs cancall and therefore enter through. To differentiate between thetwo types of entry points, look at the individual ModuleDocumentation (section 3.10.8) and look at Nodule Type for eachof the Main Program modules listed. Note whether the routineis a Program, Subroutine, or Function. If it is a Program, itIs truly a main program entry point. If not, then it is merelycalled by other programs not being documented here.

3-6

PS 6201412551 November 1985

GENERATE CODASYL RP Main Program List

Nodule Name Purpose

CDQPC GENERATE REQUEST PROCESSOR FOR CODASYLDATA BASE

3

3-7

[t '

PS 6201412551 November 1985

3.10.2 Nodule List

The following is a list of all the modules beingdocumented here along with their purpose. Each module has aunique name, no matter what language it was written in.

3-8 4Y

PS 6201412551 November 1985

GENERATE CODASYL RP Module List

Module Name Purpose


3-9

PS 6201412551 November 1985

3.10.3 External Routines List

The following is a list of all routines or functions notdocumented here that are called by modules that are documentedhere. The first caller, in alphabetical order, is listed aswell. The specification in which any module is documented maybe found in the Nodule Documentation Index (Document NumberCM 620100001). See section 3.10.6 for a list of the modulesthat call each of these external routines.

3-10

PS 6201412551 November 1985

GENERATE C0DASYL RP External Routines List

Module Name First User

-- -- -- - ---------

CDCVF CDQPCCDC CDQPCCDCR CDQPCCDMSGR CDQPC

CDPRM CDQPCCDQDF CDQPCCDQPOP CDQPCCDRDF CDQPCCDRFT CDQPCERRPRO CDQPCGENFIL CDQPCRPTERR CDQPC

PS 6201412551 November 1985

3.10.4 Include File List

The following is a list of all include files called inby modules being documented here. Each include file has aunique name regardless of the language being used. The purposeof each include file is listed as well. A more completedescription of each include file is given in section 3.10.9.The purpose listed is the one that is in the source code of theinclude file.

A purpose of "**** PURPOSE NOT FOUND BY STRIPPER *indicates that a purpose statement was not written into theinclude file itself. The most common reason for this is thatthe include file comes from system libraries that were notdeveloped by the project, such as 'C' libraries that areprovided with the 'C' compiler.

See section 3.10.6 for a set of lists which show allthe modules which call in each of these include files.

4

3-12

PS 6201412551 November 1985

GENERATE CODASYL RP Include File List

File Name Purpose

APGC GENERIC CODASYL COMMAND TABLEAPINFO ACCESS PATH INFORMATION TABLEAPRK TABLE OF RECORD KEYS FOR CODASYL ACCESS PATHSCOBLINE COBOL SOURCE CODE LINE DESCRIPTIONCOBOLOP WORKING STORAGE VARIABLES OPERATOR TRANSLATIONCONFLD WORKING STORAGE FOR CONVERSION OF VARIABLESCOPGEN **** PURPOSE NOT FOUND BY STRIPPER **

CSAL CONCEPTUAL SCHEMA ACTION LISTCSQUAL CONCEPTUAL SCHEMA QUALIFY LISTERRCDM IISS ERROR STATUS CODES FOR CDMP MODULESERRORST WS DEFINITION FOR ERROR STATUSERRPRO PROCESS ERROR INCLUDE FILEFILSTAT VARIABLE DEFINITION FOR FILE STATUSINSTTBL TABLE CONTAINING ALL GENERIC CODASYL COMMANDSISAL INTERNAL SCHEMA ACTION LISTISQUAL INTERNAL SCHEMA QUALIFY LISTORCLEDA WS DEFINITION FOR THE ORACLE LOGIN AREAQPGO2 WS FOR REQUEST PROCESSOR GENERATORQPG2FD WS DEFINITIONS FOR A FILE DESCRIPTIONQPGCMIN CALLS THE MACRO COPY FACILITYRFTABLE THE RESULT FIELD TABLESBSTLST WS DEFINITION FOR THE SUBSTITUTION LIST TABLETMVALUE WS DEFINITION FOR TEMPORARY VALUE

3-13

PS 620141255

1 November 1985

3.10.5 Where Include File Used List

The following lists each include file from 3.10.4 andall the modules documented in this specification which includethem. The purpose of each module is listed as well.

3-14

-

PS 6201412551 November 1985

GENERATE CODASYL RP Where-include-file-used List

Include Module ModuleFile Name Purpose

APGC


APINFOCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

APRKCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

COBLINECDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

COBOLOPCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

GONFLD)CDQPC GENERATE REQUEST PROCESSOR FOR GODASYL

DATA BASE

3-15

PS 6201412551 November 1985



COPGENCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CSALCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CSQUALCDQPC GENERATE REQUEST PROCESSOR FOR OODASYL

DATA BASE

ERRCDMCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

ERRORSTCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

ERRPRO

3-16

•I

PS 6201412551 November 1985

GENERATE COflASYL RP Where-include-file-used List


CDQPC GENERATE REQUEST PROCESSOR FOR GODASYLDATA BASE

FILSTATJCDQPC GENERATE REQUEST PROCESSOR FOR GODASYL

DATA BASE

INSTTBLCDQPC GENERATE REQUEST PROCESSOR FOR GODASYL

DATA BASE

I SALCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

ISQAL CDQPC GENERATE REQUEST PROCESSOR FOR CODASYLDATA BASE

ORCLEDACDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

3-17

Af

PS 6201412551 November 1985


Include Module ModuleFile name Purpose

QP02 CDQPC GENERATE REQUEST PROCESSOR FOR GODASYLDATA BASE

QPG2FDCDQPC GENERATE REQUEST PROCESSOR FOR GODASYL

DATA BASE

i

QPGNINCDQPC GENERATE REQUEST PROCESSOR FOR CODASYLDATA BASE

RFTABLECDQPC GENERATE REQUEST PROCESSOR FOR CODASYh

DATA BASE

SBSTLSTCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

TM VALUE

3-18

[ PS 6014125

PS 6201412551 November 1985

*GENERATE CODASYL RP Where-include-file-used List

Include Module Module*File Name Purpose


3-19

PS 6201412551 November 1985

3.10.6 Where External Routine Used List

The following lists each external function or routinelisted in 3.10.3 and all the documented modules which call it.The purpose of each module is listed as well.

3-20

I

PS 6201412551 November 1985

GENERATE CODASYL RP Where-external-routine-used List

System Module ModuleModule Name Purpose

CDCICDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDCWFCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDICCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDMACRCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDMSGCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDPRMCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDQDFCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

3-21

PS 6201412551 November 1985

GENERATE CODASYL RP Where-external-routine-used List

System Module ModuleModule Nme Purpose

--------------- ------ -------

CDQPOPCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDRDFCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

CDRFTCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

ERRPROCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

GENFILCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

RPTERRCDQPC GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASE

3-22 4

PS 6201412551 November 1985

3.10.7 Main Program Parts List

The following lists each Main Program listed in 3.10.1and all the modules which are called either by that moduleitself or by any of the documented modules which it calls. Itis possible for a non-main module to be listed more that onceif it is called by multiple modules. The called modules, inthis case known as program parts, are marked as to whetherthey are documented here. If so, the phrase "well-definedmodule" appears by the module name, if not it is an "external"routine". The Purpose of the Main Program module is listedas well.

3-23

.. ..... .. .. .. . . I. d ,-..-- .w I "

PS 6201412551 November 1985

GENERATE GODASYL RP Main Program Parts List

Main Pg Module ModuleName Name Type

CDQPC Purpose--)GENERATE REQUEST PROCESSOR FORCODASYL DATA BASE

OIXd External routineGDCVF External routineGDIC External routineGDMACR External routineGDMSG External routineCDPRM External routineCDQDF External routineCDQPOP External routineCDRDF External routineCDRFT External routineERRPRO External routineGENFIL External routine

RPTERR External routine

3-24

Q A --

PS 6201412551 November 1985

3.10.8 Module Documentation

The following documentation describes informationwhich is specific to each individual module being documentedin this specification as listed in section 3.10.2. Itprovides a compact way of getting information that would beotherwise buried within each module's source code.

The specific items in this module documentation have the

following meanings:

NAME: Name of program Module.

PURPOSE: Purpose of Module as detailed in thesource code.

LANGUAGE: Programming language source code iswritten in.The choices are:

VAX-11 FORTRAN

C (I/S-1 Workbench 'C')VAX-11 COBOL

MODULE TYPE: Whether a Program, Subroutine, orFunction.

SOURCE FILE: Name of Source File from filespecification.

SOURCE FILE TYPE: Source File Extension from filespecification.

HOST: Whether this is a host-dependentroutine (VAX or IBM) or blank ifhost-independent.

SUBSYSTEM: IISS sub-system this file resides in.

SUBDIRECTORY: Sub-directory of that subsystem inwhich this file resides.

DOCUMENTATION GROUP: Name of documentation group of whichthis source file is a member.

DESCRIPTION: A description of the module as otained

3-25

I\

PS 6201412551 November 1985

from the source code.

ARGUMENTS: The arguments with which this routine

is called if it is a Subroutine or aFunction.

INCLUDE FILES: A list of all the files that are

included into this module as well astheir purposes.

ROUTINES CALLED: Subroutines or Functions, eitherdocumented or external, called bythis module, if any.

CALLED DIRECTLY BY: The documented routines which call

this module, if any.

USED IN MAIN PROGRAM(S): The documented Main Programs which

contain this module in their partslist according to the list in section3.10.7.

The Module Documentation is arranged alphabetically accordingto Module Name.

3-26

I

PS 6201412551 November 1985

GENERATE CODASYL RP Module Documentation

NAME: CDQPCPURPOSE: GENERATE REQUEST PROCESSOR FOR CODASYL

DATA BASELANGUAGE: VAX-11 COBOLMODULE TYPE: SUBROUTINESOURCE FILE: CDQPCSOURCE FILE TYPE: .COBHOST:SUBSYSTEM: CDMSUBDIRECTORY:DOCUMENTATION GROUP: PS41255

DESCRIPTION:

- CDQPC IS THE PROGRAM WHICH GENERATES THE ACTUAL COBOLCODE FOR CODASYL LIKE QUERY PROCESSOR NEEDED.THIS IS A SEPARATE PROGRAM STARTED BY THECDM PRECOMPILER WHEN A CODASYL QUERY PROCESSOR CAN BEGENERATED. IT PRODUCES AN OUTPUT FILE WHICHMUST BE COBOL COMPILED ON THE CORRECT MACHINETHE GENERATED SOURCE CODE WILL INCLUDE COPY STATEMENTS.

ARGUMENTS:

QPGC-DBID - DSPLY [9(5)]QPGC-DBMS-NAME - DSPLY [X(30)]DB-SCHEMA - DSPLY [X(30)]DB-SUB-SCHEMA - DSPLY IX(30)]DB-LOCATION - DSPLY [X(30)]DBMS-LIB - DSPLY [X(30)]HOST - DSPLY IX(3)]MY-HOST - DSPLY [X(3)]QPGC-QPID - DSPLY [X(IU)]QPGC-SUBTRANS = DSPLY [999]IS-ACTION-LIST - RECRDIS-QUALIFY-LIST - RECRDCS-ACTION-LIST - RECRDCS-QUALIFY-LIST - RECRDRFT - RECRDGC-TABLE - RECRDRECORD-KEY-TABLE - RECRD

3-27

PS 620141255

1 November 1985

AP-INFO-TABLE = RECRDORACLE-LDA = RECRDERRO-FILE - DSPLY [X(5)]GEM-FILE-NAME = DSPLY [X(30)]RETURN-STATUS = DSPLY IX(5)]

INCLUDE FILES:

QPG02 - WS FOR REQUEST PROCESSOR GENERATORERRCDM - IISS ERROR STATUS CODES FOR CDMP MODULESFILSTAT - VARIABLE DEFINITION FOR FILE STATUSINSTTBL - TABLE CONTAINING ALL GENERIC CODASYL COMMANDSQPG2FD - WS DEFINITIONS FOR A FILE DESCRIPTIONCOBLINE - COBOL SOURCE CODE LINE DESCRIPTIONCONFLD - WORKING STORAGE FOR CONVERSION OF VARIABLESCOBOLOP - WORKING STORAGE VARIABLES OPERATOR TRANSLATIONERRORST - WS DEFINITION FOR ERROR STATUSTMVALUE - WS DEFINITION FOR TEMPORARY VALUESBSTLST - WS DEFINITION FOR THE SUBSTITUTION LIST TABLEORCLEDA - WS DEFINITION FOR THE ORACLE LOGIN AREAAPINFO - ACCESS PATH INFORMATION TABLEAPGC - GENERIC CODASYL COMMAND TABLEAPRK - TABLE OF RECORD KEYS FOR CODASYL ACCESS PATHSCSAL - CONCEPTUAL SCHEMA ACTION LISTCSQUAL - CONCEPTUAL SCHEMA QUALIFY LISTISQUAL - INTERNAL SCHEMA QUALIFY LISTISAL - INTERNAL SCHEMA ACTION LISTRFTABLE - THE RESULT FIELD TABLEQPGCMIN - CALLS THE MACRO COPY FACILITYCOPGEN - **** PURPOSE NOT FOUND BY STRIPPER ****ERRPRO - PROCESS ERROR INCLUDE FILE

ROUTINES CALLED:

GENFILCDRFTCDCWFCDQDFCDMSGCDRDFCDPRMCDMACRCDCICDICCDQPOP

3-28

PS 6201412551 November 1985

RPTERRERRPRO

3-29

PS 6201412551 November 1985

3.10.9 Include File Descriptions

The following list contains a purpose and description ofeach include file listed in 3.10.4 as specified in the sourcecode. The language it is written in is also given.

3-30

w

PS 6201412551 November 1985

GENERATE CODASYL RP Include File Description

FILE NAME: APGCPURPOSE: GENERIC CODASYL COMMAND TABLELANGUAGE: VAX-li COBOL

DESCRIPTION:

HOLDS THE GENERIC CODASYL DML COMMANDS FOR ANACCESS PATH OF A NDML REQUEST

3-31

I

PS 6201412551 November 1985


FILE NAME: APINFOPURPOSE: ACCESS PATH INFORMATION TABLELANGUAGE: VAX-11 COBOL

DESCRIPTION:

THIS IS A COLLECTION OF INFORMATION STORED IN ANUMBER OF VARIOUS TABLES USED BY THE ACCESS PATH TABLE

AND THE GENERIC ODASYL TABLE. SEE CDMP SPEC, PRE6

APINFO.INC

3-32

. ' ~~~I "I - II I

PS 6201412551 November 1985


FILE NAME: APRKPURPOSE: TABLE OF RECORD KEYS FOR CODASYL ACCESS PATHSLANGUAGE: VAX-11 COBOL

DESCRIPTION:

CONTAINS INFORMATION FOR THE KEYS OFRECORDS CONTAINED IN THE CURRENT ACCESSPATH

l4

I

PS 6201412551 November 1985


FILE NAME: COBLINEPURPOSE: COBOL SOURCE CODE LINE DESCRIPTIONLANGUAGE: VAX-11 COBOL

DESCRIPTION:

THIS WORKING STORAGE DESCRIPTION IS USEDIN GENERATING COBOL SOURCE CODE

3-34

PS 6201412551 November 1985

GENERATE GODASYL RP include File Description

FILE NAME: COBOLOPPURPOSE: WORKING STORAGE VARIABLES OPERATOR TRANSLATIONLANGUAGE: VAX-1i COBOL

DESCRIPTION:

3-35

PS 6201412551 November 1985


FILE NAME: CONFLDPURPOSE: WORKING STORAGE FOR CONVERSION OF VARIABLESLANGUAGE: VAX-li COBOL

DESCRIPTION:

3-36

PS 6201412551 November 1985


FILE NAME: CSALPURPOSE: CONCEPTUAL SCHEMA ACTION LISTLANGUAGE: VAX-Il COBOL

DESCRIPTION:

TABLE TO HOLD CONCEPTUAL DATA ABOUT THE REQUEST

THE CONCEPTUAL SCHEMA ACTION LIST

3-37

PS 6201412551 November 1985

GENERATE cODASYL RP Include File Description

FILE NAME: CSQUALPURPOSE: CONCEPTUAL SCHEMA QUALIFY LISTLANGUAGE: VAX-li COBOL

DESCRIPTION:

CONTAINS CONCEPTUAL SCHEMA INFORMATION FORTHE REQUESTS QUALIFICATION

THE CONCEPTUAL SCHEMA QUALIFY LIST

3-38

-AIL

PS 6201412551 November 1985


FILE NAME: ERRCDMPURPOSE: IISS ERROR STATUS CODES FOR CDMP MODULESLANGUAGE: VAX-li COBOL

DESCRIPTION:

CONTAINS ALL ERROR CODES USED BY CDMP *

MODULES FOR ERROR HANDLING *

3-39

PS 6201412551 November 1985


FILE NAME: ERRORSTPURPOSE: WS DEFINITION FOR ERROR STATUSLANGUAGE: VAX-il COBOL

DESCRIPTION:

ERROR STATUS VARIABLE

3-40

I4

PS 6201412551 November 1985


FILE NAME: ERRPROPURPOSE: PROCESS ERROR INCLUDE FILELANGUAGE: VAX-li COBOL

DESCRIPTION:

3-41

PS 6201412551 November 1985


FILE NAME: FILSTATPURPOSE: VARIABLE DEFINITION FOR FILE STATUSLANGUAGE: VAX-lI COBOL

DESCRIPTION:

FILE USAGE FILE STATUS PARAMETER

FILSTATFILE USAGE FILE STATUS PARAMETER

SIZE AND THE 88 VALUE ARE PROBABLY MACHINEDEPENDENT

(THIS IS FOR VAX-l1 COBOL)

3-42

PS 6201412551 November 1985


FILE NAME: INSTTBLPURPOSE: TABLE CONTAINING ALL GENERIC CODASYL COMMANDSLANGUAGE: VAX-1i COBOL

DESCRIPTION:

DECODE FOR THE GENERIC CODASYL COMMANDS

3-43

PS 6201412551 November 1985


FILE NAME: ISALPURPOSE: INTERNAL SCHEMA ACTION LISTLANGUAGE: VAX-li COBOL

DESCRIPTION:

CONTAINS INTERNAL SCHEMA INFORMATION ABOUT ANNDML REQUEST

THE INTERNAL SCHEMA ACTION LIST

3-44

Ake-&

PS 6201412551 November 1985


FILE NAME: ISQUALPURPOSE: INTERNAL SCHEMA QUALIFY LISTLANGUAGE: VAX-Il COBOL

DESCRIPTION:

CONTAINS INTERNAL SCHEMA INFORMATION FOR ANNDML QULIFICATION

4r

4 -

3-45

-AI

PS 6201412551 November 1985


FILE NAME: ORCLEDAPURPOSE: VS DEFINITION FOR THE ORACLE LOGIN AREALANGUAGE: VAX-l1 COBOL

DESCRIPTION:

THE ORACLE LOGON DATA AREA

3-46

PS 620141255

1 November 1985


FILE NAME: QPG02PURPOSE: WS FOR REQUEST PROCESSOR GENERATORLANGUAGE: VAX-il COBOL

DESCRIPTION:

3-47

I

PS 6201412551 November 1985


FILE NAME: QPG2FDPURPOSE: WS DEFINITIONS FOR A FILE DESCRIPTIONLANGUAGE: VAX-i COBOL

DESCRIPTION:

3-48

......... . .- A

PS 6201412551 November 1985


FILE NAME: QPGCMINPURPOSE: CALLS THE MACRO COPY FACILITYLANGUAGE: VAX-11 COBOL

DESCRIPTION:

3-49

PS 6201412551 November 1985


FILE NAME: RFTABLEPURPOSE: THE RESULT FIELD TABLELANGUAGE: VAX-11 COBOL

DESCRIPTION:

CONTAINS CONCEPTUAL SCHEMA INFORMATION ABOUTTHE RESULTS OF AN NDML REQUEST

THE RESULT FIELD TABLE

WHEN CHANGING THE STRUCTURE OF THIS TABLEBE SURE TO CHANGE THE LAYOUT IN THELINKAGE SECTION OF THE DRS (CDS01)

WHICH WAS COPIED FROM THIS.

3-50

PS 6201412551 November 1985


FILE NAME: SBSTLSTPURPOSE: WS DEFINITION FOR THE SUBSTITUTION LIST TABLELANGUAGE: VAX-li COBOL

DESCRIPTION:

SUBSTITUTION-LIST REPRESENTS THE INPUT TABLEOF SUBSTITUTION PARAMETERS FOR THE CDMACRMACRO EXPANSION SUBROUTINE

3-51

PS 6201412551 November 198E


FILE NAME: TMVALUEPURPOSE: WS DEFINITION FOR TEMPORARY VALUELANGUAGE: VAX-1l COBOL

DESCRIPTION:

-- -- ---------

PS 6201412551 November 1985

3.10.10 Hierarchy Chart

The following hierarchy charts show the relationshipsbetween all of the modules mentioned in the above documentation.A module may call a subroutine several times within its code,but the call will only be shown once as a single relationship onthis hierarchy chart. All modules shown at the top of the firstpage are considered Main Programs as described in section 3.10.1above.

There is an internal paging scheme as marked by the numbersin the upper right corner of each page. An index after the lastpage of the chart shows where a routine and its calls are firstdefined. If a routine has no page reference, it either makes nocalls or is an external routine. A continuation box on the endof a tree limb shows where that the tree continues on the pagenumbered mentioned. A number in a box with a routine namepoints to the page where the routine is further defined withinthe hierarchy tree. If there is no number in a box, the routineeither makes no calls or is an external routine.

3-53

& -

PS 6201412551 November 1985

1

I CDQPC I

+---------- ------------ --------- +-

IGENFILI ICDRFTI ICDCWFI ICDQDFI ICDMSGI I(CON'r)i+---- ------ ------ ------ +----- ------ 2+

3-54 V

PS 6201412551 November 1985

2

I CDQPC I

+----------- -------------------- +-

I(CONT)I ICDRDFi ICDPRHI ICDMACRI ICDCII I(CONT)I+---- 1+ - ----- ------ +---- ------ +---3

3-55

PS 620141255

1 November 1985

:3

I CDQPC I

+---------------- ----------

I I I I I+---+---+ +-+--+ +-------- -------- --------

(CONT)I ICDICI ICDQPOPI IRPTERRI IERRPROI+ ---- ---- -- --- --- ----- ---

3-58

PS 620141255I November 1985

CDCICDCWFCDI CCDMACRCDMSGCDPRMCDQDFCDQPC ....1CDQPOPCDRDFCDRFTERRPROGENFILRPTERR

3-57

PS 6201412551 November 1985

:.11 Program Listing's Comments

This information is contained in the Module Descriptions insection 3.10.

3-58

PS 6201412551 November 1985

SECTION 4

QUALITY ASSURANCE PROVISIONS

4.1 Introduction and Definitions

"Testing" is a systematic process that may be preplannedand explicitly stated. Test techniques and procedures may bedefined in advance, and a sequence of test steps may bespecified. "Debugging" is the process of isolation andcorrection of the cause of an error.

"Antibugging" is defined as the philosophy of writingprograms in such a way as to make bugs less likely to occur andwhen they do occur, to make them more noticeable to theprogrammer and the user. In other words, as much error checkingas is practical and possible in each routine should beperformed.

4.2 Computer Programming Test and Evaluation

The quality assurance provisions for test consists of thenormal testing techniques that are accomplished during theconstruction process. They consist of design and codewalk-throughs, unit testing, and integration testing. Thesetests are performed by the design team. Structured design,design walk-through and the incorporation of "antibugging"facilitate this testing by exposing and addressing problem areasbefore they become coded "bugs."

4-1U S.Government Prlntlnq Office: 1987 - 748-061/60927