Enter the indlvid.d’s own., tttl. of the orga.izat,.n, or entity (e.g., Disttibutio.1 that fha EDT isbelno tmnmmtf.d t..
Enter the title of the mg.nization .ari.ainatina and tmnsrnimi.o the EDT.
Enter EDT numbers which relate to the d,ta being transmitted.
Enter tha fio@ct/RoaramlD.p.timntl~.ismn titlo m Pr.ieetl!%.ormn ..ronvm c.. %.@tiNumber, Work Order Number. , Otganizmicm cod..
Enter the name of the indiwd.al ld.ntifi.d m bein~ responsible for .oordinati”g disposition ofthe EDT,
Enter related Purchase Order IP. O.) Number, If available,
Enter special or addmond comments concerning transmittal, or ‘Key” retrieval words may beentered.
Enter .quimmentl.ornponent numb.! of affected item, if appropriate.
Enter applicable system, b.!lding or Iacilny number, if appropriate.
Enter SP.C,.I or additional comments c.ncernin.a tr.nsmittat.
Enter apphcable drawing numb., of major assembly, if appropriate.
Enter appfic.ble permit ., permit application number, if appropriate.
Enter the date . response Is required from i.d,vid.ds identified in Block 1?13gnat.re/D,strib.ti. nl.
Enter sequential number, b%!inn,n.a with 1, of the information Wed . . EDT.
Enter the .nqu. identification number assigned 1. the document w drmwino being transmitted.
Entsr the sheet number of the (nformatic.n being transmitted. If no sheet number, leave blank.
Enter the ra.tsion number .1 the mfornmtion being tmn.mitted. If no revision ..mb.r, leaveblank.
Enter the title of the docurne.t or draw!rw or a brief descriptic.” of the subject if . . title is,dentified,
Enter the expropriate Approval D.stonatm 101.ack 15). Also, Indicata the .ppmpri.te approvals for each,twn fisted, i.e., S0, ESQ, etc.
Enter the acwropdat. code to identify the p.m... of th. d.t. tra..mitid [s.. Block 16),
Enter the appropriate disp.aition cod. Is.. Block 16).
Enter the appropriate disposition code (8.. Block 16).
Number codes used in completion of Blocks 15 (G), (H), and [1), and 17 (G), (H)(Si,ln.t.relm%trbbutlonl.
Enter the cod. cd the r..... for transmittal (mock 1+3I
Enter ma code for the dmpo.iti.n (Mock 16).
Enter the signature .1 tlw Individual completing the Disposition 17 [H) and the Transmittal,
Enter data .I.anat.m IS .abtm.ed.
Enter MSIN. Note If Distribution Sheet is used, show entire di.trib.tio. Ii.cludina thatindi. ated cm Pc-ae 1 of the EDT) on the Dktrib.ti.. Sheet.
Enter the dgnat.r. .nd date 01 the individual .rioinatiw the EDT [entered prior t. tr.nsmlttalto Recmvino Organlzati.anl, If the EDT orioinat.r i. the [email protected] enoinetm, sign bothBlocks 17 and 18.
Enter the Sm”at.re a“d date of the individual identified by the Receiving Organization asauthorized to approve disposition of the EDT and .Ccept.n-oe of the d.t. tra..mitmd, a.applicable
Ent.r the ei.anat.re and date of the cc.onizant rn...ger. (This .iwmt.m 1. .uthmiz.tiom fmrel. me )
E.t.~ D,OE approval let req.lr.dl by .ianature m control number th.t tracks the approval to . .I.an.tum.and ,md!cat. DOE actmn
Asterisk denote the required minimum item. ch-ack by configuration D..um.ntatran prior to ret-..; these are the minimum release req.ir.ment.,
+5
HNF-SD-WM-SDD-065, Rev. O
System Design Description For MasterEquipment List, Phase I
J. D. SandovalFluor Daniel NorthwestP. O. Box 1050Richland, WA 99352U.S. Department of Energy Contract OE-ACO6-87RL1O93O
EDT/ECN: 615552 UC: 605Org Code: 77820 Charge Code: N12A4B&R Code: EW3120071 Total Pages: y /6?’
A’dKey Words: System Design Description
Abstract: Approval and release for the Master Equipment List (MEL)Phase 1, for the System Design Description (SDD)
TRADEMARK DISCLAIMER. Reference herein to any speclflc coimnerclal product, process, orservice by trade name. trademark, manufacturer, or otherwise, does not necessari lY
constitute or IMPIY lts endorsement, recommendation, or favoring by the United StatesGovernment or any agency thereof or Its contractors or subcontractors.
Printed In the United States of Anerlca. To obtain COP1es of thls document, contact:WHC/BCS Document Control Services, P O. BOX 1970, Ma]1stop H6-08, Rlchland WA 99352. Phone
(509) 372-2420; Fax (509) 376-49B9.
.m~’t,lj199
HANFORD
STA~~ FEMME 10
.,s?44%t2._4i #/,/@c21
Rel<ase Approval Date Release Stamp
Approved for Public Release
A-6400-073 (10/95) GEF321
THIS PAGE INTENTIONALLYLEFT BLANK
HNP-SD-WM-SDD-065Revision O
Page 1
SYSTEM DESIGN DESCRIPTION
FOR
MASTER EQUIPMENT LIST PHASE I
Revision O
Prepared by:
Data Automation Engineering & ServicesFluor-Daniel Northwest, Inc.
SYSTEM DESIGN DESCRIPTION FORMASTER EQUIPMENT LIST PHASE I
1.0 INTRODUCTION
1.1 PURPOSE
This System Design Description (SDD) is for the Master Equipment List Phase I (MEL),It has been prepared following the WI-IC-CM-3-1O, “Sotlware Practices,” (Ref. 6), This SDDdescribes the internal design for implementation of the MEL Phase I.
1.2 SCOPE
The MEL Phase I application includes features to;
o
0
0
0
0
0
0
Enable users to view a variety of information about equipment in various datatables using a ‘folder’ metaphor.
Provide data search features to quickly locate information about the equipment.
Provide query timctions for locating key data about the equipment,
Provide the ability to generate standard reports of folder information.
Maintain MEL Phase I user IDs and passwords.
Provide the ability to edit existing data, enter new data, and delete data based uponpredefine privileges to do so.
Provide audit trail information for monitoring and logging data entry and change.
HNF-SD-WM-SDD-065Revision O
Page 5
1.3 OVERVIEW
The remainder of this SDD is divided into four main sections
Section 2, “Database” contains data models, entity relationship diagrams, physical models,and a data dictionary.
Section 3, “Programming” contains platform information, screen views of the userinterface, startup and execution parameter definitions, and detailed information regardinginstallation
The final section, Section 4, “References”, contains the references for this document.
1.4 DEFINITIONS AND ABBREVIATIONS
The following are definitions of abbreviations and terms used in this document:
ASCII American Standard Code for Information InterchangeDAES Data Automation Engineering & Services
DCA Data Collection ApplicationERD Entity Relationship Diagram
EP Engineering Practices
MEL Phase I Master Equipment List Phase IHLAN Hanford Local Area Network
Pc Personal Computer
SDD System Design Description
SRS System Requirements SpecificationSTD State Transition Diagram
UA User Application
ASCII--Astar-dad used to representtextand controlcharactersin a computeren~ronment. TheASCII format relates hexadecimal numbers to these text and control characters.
Erwinee rine Practic@ --supporting document management manual WHC-CM-6- 1 thatestablishes the manner and order for performance of common configuration management practicesrelating to engineering tasks.
HNF-SD-WM-SDD-065Revision O
Page 6
Entity--subpiece, recognizable, with a distinct function within the MEL Phase I project.
ER!2--diagrrrm showing systenr/environment entities and relationships.
MEL Phase 1--The project being performed by DAES to provide a means of locating andquerying information about equipment in Tank Farms. See WHC-SD-WM-SDP-O 12 (Ref. 4) forthe work plan for this system.
val De- --defined in WHC-CM-3-5, “Document Control and Records ManagementManual,” Section 12.7 (Ref. 7).
Module--subsystem of the MEL Phase I system that encompasses attributes of the systemincluding hardware and software.
MD--diagram showing controlsequence for the systerdenvironment
Syste m Design Description--documentation of essential and implementation design that givesdescriptions of entities and attributes of the design.
Syste m Reau ire~--the documentation of essential requirements (functions:performance, design constraints and attributes) of the computer soflware and its externalinterfaces.
HNF-SD-WM-SDD-065Revision O
Page 7
2.0 DATABASE
2.1 DATA MODEL
The following data model show the relationships of the data for the MEL.
HNF.SD.WM-SDD-065
Revision OPage 8
Rect*.gle ,.pr.s..t .“tiiles
- R.”nddd rectanol.s r.Pras.nt reta:k’hk.a- Conne=lciC with %x’ numbers mw.=.t cardo..1W. F.. .r.mol. lIw r.1.t!onshtw between ,Pcintw Dam, and TJaatar El Na;.-rc.ad a’” mibawa.
‘Pointer 0.- Is Id.nt !!%d by 1 t. 1 (.”W *) MaSt.r El N-.nd
‘A Master E IN unlqudy kk.ttWs 0 t. m (maw) Pdnl.r Data-.
Thts ..MY .oI.15 t. anydata edntabta by III. user
1
Master Equipment List, Phase I“#d=+e
Setnantio Data Model
HNP-SD-WM-SDD-065Revision O
Page 9
2.2 ENTITY RELATIONSHIP DIAGRAM
The following entity relationship diagrams show the relationships of the MEL
The following physical model diagram shows the data and lookup tables for the MELPhase I and field links.
HNF-SD-WM-SDD-065Revision O
Page 13
us,=..M8nfud No 1A’,.
W?n..#—
[U1 A,o
—PRoEcT..
mw=d. !~lz.w.%. IA,o.kmLmekn. IIR-,UD
[
s-m...
*?KmTam
?“.I,”z”.dm ,-Mester Equipment List, Phase 1, version 2 Datebase Tables
HNP-SD-WM-SDD-065Revision O
Page 14
2.4 DATA DICTIONARY
This Data Dktionary (DD) provides a detailed description of the data structures and theirelements which will compose the MEL Phase I application. The DD does not define explicitrelationships between structure entities - those are better illustrated in Section 2.2 “EntityRelationship Diagram” of this document.
This Data Dictionary is organized into two major parts;
o Structures that support the user interface and the data gathered in its use,
o Structures that support the system as a whole - including tables used during reportsgeneratio~ change log tables, session tables, and general system support tables.
These parts each contain a list of table structures. Because the number of these structures isrelatively small, they are presented in the order that follows their application to the MEL Phase I
application. An alphabetical ordering does not seem usetid for this application,
Each structure is divided into its component data elements or fields. Fields are listed in the orderthat presents key fields first (as required in a Paradox implementation). Each field will bedescribed in terms ofi
- Field Name The field’s reference name.- Type & Size The data we and size (see description below).- Key An asterisk (*) next to the type& size indicates a key field.- Required Data that is required (per customer requirement or design) is indicated by
‘True’.- Example Example of a typical data entry.- Restriction Any special restrictions or condhions regarding the data,
- Description Textual description of the data.
Type and size formats are typically shown with the shorthand of a single character type which issometimes followed by a number indicating the number of bytes reserved to hold the data value,The types are defined as:
A = Alphanumeric (with limited reserved space)N = Numeric (floating point)I = Long integer (4 bytes)S = Small integer (2 bytes)D = Date (Paradox internal format)
HNF-SD-WM-SDD-065Revision O
Page 15
M = Memo (with limited reserved base table space and virtually unlhnited memo table space)L = Logical (boolean value, True or False)+ = Autoincrement (small integer value, incremented automatically with each new record)
Alphanumeric (A) formats always include a number - e.g. A25 represents a 25 byte alphanumericdata field. In this example, 25 bytes are reserved in the table for each record.
For memos (M), the number represents the bytes reserved in the base table (the named tablestructure) although the fidl memo length is virtually unlimited with the use of so auxiliary memotable. The number is importmt since a form field will display the memo data I the base tablewithout accessing the memo table (this saves time). The memo table is accessed only when thecomplete memo is required. Typically, form fields should be sized to match the base size of thememo - e.g., M120 represents a memo field of 120 bytes immediately accessible in the base tableeven though the actual memo length is as long as necessary to contain the complete memo data.
Restriction formats are usually made up of alphanumeric characters that represent certain values,The types are defined as:
a = my alphanumeric character
n = Number (O-9)
[] = AIIY character(s) surrounded by brackets are optional,Lookup = The value must be selected from a pre-defined list
A restriction format maybe made up of a combination of alphanumeric characters, numbers, andliteral values. For example, a restriction format for a H- 14 drawing would be represented by thefollowing:
H- 14-nnnnnn
Therefore, H-14-0 12345, would be considered a v~ld vrdue, while H- 14-ABC 123 would not.
HNF-SD-WM-SDD-065Revision O
Page 16
2.4.1 USER INTERFACE TABLES
EIN_INFO.DB This table identifies all the EINs entered
EN_CcdeSize & Type: A12*
Required FalseFoldecExample: EINCHWOOC033Restriction.Intbrmatiom This record identii% will b generated automatically by the system, It is a counter used to grant a
unique ID for each EIN rwxd.
EINSize & T~e: A23Required TrueFolder Equipment Identification Number block.Example: ANOOO-AS-AOD-1001Restrictions: aa[aaaa]-aa[aaa]-aa[aaa] -nnn[a]Information: This field is a concatenation of the Fium Facility, System, Component, and Number fields. R is
generated automatically by the system.
systemSize & T~e: A5Required TrueFolder Equipment Mentitication Number block.Example CHMARestrictions lookupfnfonnatiom This field forces a value fmm the SystenmDB, S@em field,
ComponentSize & Type ASRequired TmeFolder Equipment Identification Number blcck.Example AODRetictions: I.cokupInformation: This field forces a value thn the Comp_Des.DB, Component field.
Fann_FacilitySize & Type: A6Required TrueFolder Location block.Example ANoooRestrictions LookupInformation: This field forces a value from the Fac_Farrn.DB, Farm_Facility field.
HNF-SD-WM-SDD-065RevisionO
Page 17
NumberSize & Type: A4Required TrueFoldm Equipment Identication Number blwk.Example: 1001Restrictiorw nnn[na]Information This field is tbe unique part of tbe EIN.
Nom_Name 1Size & Type: A32Required TmeFcddec Equipment Identiticaticm Number blcck.Example XMITTERRestrictions: I-e&upInfcmnaticm This field provides a lookup to noun names from similar EINs. However, a typed value maybe
entered.
Nour_Name2Size & Type A32Requiwt TrueFolder Equipment Identitlcation Number block.Example XMITTERRestrictions: LookupInformation: This field provides a lcokup to noun names from similar EINs. However, a ty@ value may be
entered.
statusSize & Type A3RequirextFoldec Equipment Mentitlcation Number block.Example 1Restrictions:Infonnatimu Ilk field provides a lookup to number representing a status.
Cmp_FuncSize & Typz MORequired: TmeFolder Equipment Identification Number block.Example HORIZONTALRestrictions IcmkupMomation ~s field is used as a lii to tbe Comp_Typ.DB, Cmp_Func field. ‘Ibis is a lookup value that forces
a seldion tlom the list.
HNP-SD-WM-SDD-065Revision O
Page 18
LoMDSize & TyTWIRequiredFolderExample 1Restrictions:Information This is the identifier for the lock session. This data is used interndy by tie system.
LcckRecSize & Type: IRequtiFolder:Example 1RestrictionsInformation This is the identifier for the record being moditied. This data is used internally by the system.
RecordlDSize & Type+RequiredFoldwExample: 1RetictionsInformation This is a record identifier used internally by the system
EQP_INFO.DB This table contains the equipment information for each EIN entered
EII_CcdeSize & Type: A12*Required TrueFolderExample EINOCJOWC033RestrictionsInformation This record identifier will be generatd automatically by the system. It is a counter used to grant a
unique ID for each EIN record.
Lcop_Seq_NoSize & Type AlRequiredFoldec PointezExample: AN212-IRestrictions armnn-nInformation This field is used as the key field in CBRS (Component Based Recall System). ‘Ilis is the refaenw
sollrw for historical d8ta.
HNF-SD-WM-SDD-065Revision O
Page 19
BarCOde_NoSize & TWe: A9RequiredFoldec PointerExample: SOO0120WTRestrictionJnfonnatiom Barcode Number. Unique identifier assigned to tbe equipment that resideshnctions in the ElN
LocatiOILused for developing equipment history information (cradle to grave tracking) versusfunctional location history information.
Property_NoSize & Type: AlORequiredFolder: PointerExample: WC42029Restrictionsinformation Pmp@y Number. Unique identitk (Barcode) that property assigns to equipment for tracking
purposes in the Property Management System.
Vendor_Wo_NoSize & Type Al 1RequiredFoldw. PointerExample 0022574-004Restrictions —-mmInformation Vendor Infomnation Number. Used as the key field in the Certitied Vendor information System (Soil
Reporting).
~g_Vndr_NameSize & Type A25RequiredFold.sc PointerExample Ingersoll-RandRestrictims:Information: Mmufacti or Vendor Name.
Mfg_Vndr_NoSize & Type: A25RequiredFoldec PointerExample: 37F427X484RestrictionsInformation Manufacti or Vendor Number. Unique identitie-rManufacOxer/Vendor assigns to equipment.
RequiredFolder PointerExample 30T-714984RestrictionsInfonnatiow Serial Number. Unique identit% that Manufacturer assigns to equipment.
LockmSize & TyTXZIRequired:FoldecExample 1Retictions:hfomratiom This is the identit% for the lock session. This dats is wed internally by the systam.
LockRecSize & Type: IRequiredFolderExample 1Restrictionsbfonnatiom This is the identifier for tbe record being mcditiexl. This dats is used internally by the system
RecordH3Siz & Type +Require&FolderExample: 1Retictions:Information This is a rexord identifier used internally by tbe system.
SPECS.DB This table contains the specification information for each EIN as applicable.
information: This record identifier will be generated automatically by the system. It is a counter used to grant aunique ID for each EfN record.
Design_PressSize & Type A15RequiredFolder SpecificationsExample PSIRestrictions:information Design Pressure Range. Typical units of measure in the indu.s&y.
Design_TempSize & Type: A15RequiredFolder SpecificationsExample: 80-100 FRestrictionsinformation Desi~ Temperature Range. Fahrenheit will be the unit of mea.wre
Design_OutputSize & Type A15Required:Foldec SpecificationsExample pphReshictions:fnfonnation: Design Output Range.
Desi@_TolemnceSize & Type: A15RequiredFoldec SpecflcatiomExample: 23%Restrictionsfnfonnatiom Desi~ Accuracy. Units could be % or (+/-).
HNF-SD-WM-SDD-065Revision O
Page 22
Design_S&_PtSize & Type A15RequiredFolder: SpeciticatimlsExsmple: 12RestrictionsInformation Desi~ Set point. Sipgle numeric value, or a rsnge (all units).
Operating_TernpSize & Twe: A15RequiredFoldm specificationsExample: 8O-1OOFRestrictionInfonnatiom Dssign Temperature Rsmge. Fahrenheit will be the unit of measure.
operating_fnputSize & Type A15RequiredFolder SpecflcationsExample: pphRestrictions:Information: Operating Input Range,
op@irlg_outputSize & Tpe: A15Required:Folder SpexsiticatiomExample CtillRestrictionsInformation Operating Output Range
Operating_Set_PtSize & Type A15RequiredFolder SpecificationsExample 12Restrictions:Information Operating Set point. Single values or a range (all units)
LocklD
HNF-SD-WM-SDD-065Revision O
Page 23
Size & Type IRequiredFolderExample 1Restrictions:Infonnatiom This is the identitk for the lock session. ‘flis data is used intemmlfyby the system.
LdRecSize & TWe: IRequiredFtiExampk 1RestrictionsInfomnatiom This is the identifier for the record being moditied. This data is UWI internally by the systsm
RecordR3Size & Type:+RequiredFoldecExample: 1Restrictiomxinformation Tbis is a record identitk used internaUyby the system
SAFETY.DB This table contains the safety information for each EIN as applicable.
EIN_CcdeSize & Type A12*Required TmeFolderExample EfNOOOOOO033Reshictions:Information This record identitk will be generated automatically by the system. It is a counter used to grant a
fique ~ fm ewh EfN ~rd.
OSRSize & Type: AlRequired TmeFolder Classification block.Example: YRestrictions Y or N Information:This field is a boolean value repr.wnted by either a Y (Yes) or N (No)
EnvimmnsntdSize & Type AlRequired TrueFolden Classification blcck.Example YRestrictions: Y or Nfntonnation: This field is a boolean value represented by either a Y (Yes) or N (No).
HNF-SD-WM-SDD-065Revision O
Page 24
QASize.& Type: AlReqnirdFolder Cla.ssfication blnck.Example YRestrictions: Y or NInformation ‘his field is a bonleen value represented by eitlmxa Y (Yes) m N (No).
criticalSize & Type AlRequire& FalseFolder SafetyExample: YRestrictions Y,N,] ,2,3,4Information This is the critical A.sstication.
sati_systemSize & Twe A25RequiredFolder SafetyExnmple:RestrictionsInfnnnatimx Safety system
HNF-SD-WM-SDD-065Revision O
Page 25
Surv_FreqSize & Type AlORequiredFoldec SafetyExmnple weeklyRestrictionsInformation: Surveillance Frequency. Frequency at which equipment is inspected.
Cal_FreqSize & Type: AIORequinxkFolde.c safetyExample: weeklyRestrictionsInformation Calibration Frequency. Frequency at which the equipment is calibrated
LOckfDSize & TvDeReauired;’Fol~.ecExample 1Restrictions:Information: This is the identitk for the lock session. This data is used internally by the system.
LcckRecSize & Type IRequiredFolderExample: 1RestrictiomxInformation This is the identitler for the record being moditkd. This data is used internally by the system
RecordII)Size & Type:+RequiredFoldecExample 1Restrictionsfnfonnatiom This is a record identifier used internally by the system.
HNF-SD-WM-SDD-065Revision O
Page 26
MOTORDB This table contains the motor information for each EIN as applicable
EIN_CcdeSize & Type: A12*Required TrueFolderExample EINOOOOOO033Restrictions:Information: This record identitkr will be generated automatically by the system. It is a counter used to grant a
unique ID for each EIN record.
Input_vOltSize & Type AlORequiredFolder NameplateExample: 120ACRestrictions AC or DCfnfonnatiom Input voltage. Volts will be the unit of measure
PhasesSize & TyPe A5RequiredFoIdec NameplateExample 1Restrictions 1,2,3Infonnatiom Phases.
Motor_SizeSize & Type AlORequiredFolder NameplateExample: 25 HPRestrictions nnmumfnformatiom Motor size. Horsepower will be the unit of measure
Motor_SpeedSize& Type AlORequiredFolder NameplateExample 500 RPMRestrictions mmnn Information:Motor speed. RPM will be the unit of measure
HNF-SD-WM-SDD-065Revision O
Page 2’7
Frame_SizeSize & Type A15RequiredFolder NameplateExample: 2S4TRestrictiomxInformation Frame size.
Full_Load_AmPsSize & Type: AIORequiredFoldec NameplateExample: 12Restictiow. nnInfonnatiom Full Load Amps. AMPS will be tbe unit of measure.
Locked_Rotor_CcdeSize & Type AIORequiredFolder NameplateExample:RestrictionsInformation Lcxked Rotor Code.
Serviw_FactorSize & Type A20RequiredFolder NameplateExample .5Restrictions: O-=m<lInformation: Desigm Service Factor. No unit of measure.
LocklDSize & Type: IRequiredFolderExample 1Restrictions:Information: This is the identifier for the lock session. This data is used internally by the system
HNP-SD-WM-SDD-065Revision O
Page 28
LockRecSize & Type IRequiredFoldecExample: 1RestrictionsInformation: This is the identitkr for tbe record being mcdfled. This data is used internally by the system.
RecordlDSW& Type: +RequiredFolderExamPls 1Restrictions:Information This is a rscord identifier used internally by the system.
ELECTIUC.DB This table contains the motor information for each EIN as applicable.
EN_CodeSize & Type A12*Required TmeFolderExamPlti EINOOOOOC033RestrictionsInformation This record identifier will be generated automatically by the system It is a countex used to gnmt a
unique ID for each EIN record.
Power_SuPPly_BkrSize & Type A26RequiredFolder NameplateExample:RestrictionsInformation Power Supply Breaker.
Bkr_Trip_SettingSize & Type AZORequiredFolder: NameplateExamPle 100AMPsRestrictionsInfonnatiom Breaker Trip Settiig. AMPS will be the unit of measure.
HNF-SD-WM-SDD-065Revision O
Page 29
Fuse_Siz.eSiz & Twe AlOReqtiFolder NameplateExample 100 AMPsRestrictionsInfonnatiom Fuse Size. AMPS will be tbe unit of measure.
Mg_OvedO&SizeSize & Type A20RequiredFolder NameplateExampleRestrictiomwInfonnatiou Manufacturer Overload Sue.
LccklDSize & TyPe IRequiredFolderExamplel 1Reshictions:fntonnation: This is the identifier for the lock session. Tlus data is used internally by the system
LockRwSize & Type: IRequiredFolderExample: 1RestrictionsInformation This is the identiier for the record being mcdiied. This data is used internally by the system.
RecordfOSize & Type +RequiredFoIdeEExamPlti 1RestrictionsInformation This is a record idendtier used internally by tbe system.
HNF-SD-WM-SDD-065Revision O
Page 30
MECHANIC.DB This table contains the mechanical information for each EIN as applicable
EIN_CcdeSize & TWe: A12*Required TrueFoldezExample ElNOOOOOO033Restrictions:Information This record identitkr will be generated automatically by the system It is a counter used to grant a
unique ID for each EIN record.
Bearings_Sea14_FSize & T~e: A15RequiredFolder NameplateExample: YRestrictions Y or NInformation Front Bearing Sealed. ‘Ilis field is a bcmleanvalue represented by either a Y (Yes) or N (No).
Bearings_Sealed_RSize & Type AISRequiredFolden NameplateExmnplK YRestrictions Y or NInfonnatiom Rear Bearing Sealed. This field is a boolean value represented by either a Y (Yes) or N w.)
Bearings_Vndr_No_FSire & Type: A20RequiredFold.z NameplateExampleRestrictionInfonnatiom Front Bearing Number,
Bearings_Vn&_No_RSire & Type A20RequiredFolder NameplateExampleRestrictionInformation: Rear Bearing Number.
HNF-SD-WM-SDD-065Revision O
Page 31
IJarLrSize & Type IRequiredFolder: 1ExampleRetictiom:Information:
This is a record identifier used internally by the system.
This table contains 1 to many preventative maintenance records for each EIN asapplicable.
EIP_CcdeSize & Type A12*Required TrueFoldecExample: EINOOOOOO033RestrictionsInformation This record identifier will be generated automatically by the system It is a counter used to grant a
unique ID for each EIN record.
PMS_NoSize & Type A8*Required TrueFolder PointerExample: 9X-OOO03Restrictions aa-mmnnInformation Unique number JCS assigns to a specitic job or activity.
HNP-SD-WM-SDD-065Revision O
Page 32
LcckIDSize & TypexIRequiredFoldecExampleRestrictions:Information: This is the identifier for the lock session. This data is used internally by the system.
LOckRecSize & Type: IRequired:FolderExampleRetictions:Infonnatiom This is the identifier for tie record being modified This data is used internally by the system.
RecordIllSize & TWC +RequiredFolderExampIe:RestrictionsInfonnatiom This is a record identifier used internally by the system
PROCED.DB This table contains 1 to many procedure records for each EIN aa applicable.
EIt_CcdeSue & Type A12*Required: TmeFolderExample: EINOOOOOO033Resh’ictionsInformation This record identifier will be generated automatically by the system. It is a counter used to gmmta
unique ID for each EIN record.
Pmxdure_NoSize & Type A12*Required TrueFold~ RetkmncesExample 6-TF-058-2ERestrictionsfnfonnation: Procedure Number. Unique identifier for pmcexiures, operating procedures, maintenance prmedures,
Test procedures, etc.
HNF-SD-WM-SDD-065Revision O
Page 33
LoddDSize & Type: IReqnirdFoldecExampleReshictionsInfennatiom This is the identit%r for the lock session. This data is used internally by the system
LcckRecSize & Type: IRequiredFolderExample:RestrictiorwInfonnatiom This is the identitk for the record being mcditkd. This data is used internally by the system
RecnrdlDSize & Type: +RequiredFoIdecExampleRestrictions:Information: This is a record identifier used internally by the system
PROJECT.DB This table contains 1 to many project records for each EIN as applicable.
EIN_CndeSize & Type: A12*Required TrueFoldmExanmle EINOOQOOC033Restrictions:fnfonnation: This record identifier will be generated automatically by tie system. It is a countm used to grant a
unique R) for each EIN record.
Projec_NoSize & Type: AlO*Require& TrueFolder PointerExample B-534ARestrictions:Information: Unique identifier assigned to every Hanford Project
HNF-SD-WM-SDD-065Revision O
Page 34
LOckmSize & Type IRequiredFolderExample:RestrictionsJnfonnatiom This is the identifier for the Icck session. This data is used internally by the system
LcdRecSize & Type 1RequiredFolderExample:Restrictiom$Information This is the identifier for the record being modified. This data is used internally by the system.
RecordIDSize & Twe +RequiredFoldexExample:Restrictions:Intmnmtiom This is a record identifier used internally by the system
SYS_DWG.DB This table contains 1 to many system drawing records for each EIN asapplicable.
EII’-_CodeSize & Type: A12*Required TmeFolderExample EINOOOO04W33RestrictionsInfonnatiou This remrd identier will be generated automatically by the system R is a counter used to gmnt a
unique ID for each EIN record.
DrawinKNoSize & Type: All*Required TrueFolder ReferencesExample H-14-01 1733Restrictiorm H-14-Infonnation System Drawing Number Unique number assigned to the H-14 O&M system drawing.
HNF-SD-WM-SDD-065Revision O
Page 35
SheetsSize & Type A3*Required TrueFolder ReferencesExmPle 001Restrictions mJnfonnation System Drawing Sheet Number. Unique number assigned to the different sheets of the same System
Drawing Number.
RevsSize & Type: A3Required TrueFolder ReferencesExmnPle 001Res6ictions mmInformation: System Drawing Rewision Number. A unique number used to track the revision of a System
Drawing.
zonesSize & Type: A2RequiredFoldec ReferencesExample: AlRestrictions: Au-MIInformation: System Drawing Zone Lccation. zone area where the EIN appears on the System Drawing.
System Drawing XYZ Coordinate Lccation. AutoCAD XYZthe Syskm Drawing.
Size & Type: A3RequiredFolderExampleRehctionx lookupInfonnaticm This is a li to the Dwgstxt.DB, Status Description field.
Coordinates where the EIN appeam on
HNF-SD-WM-SDD-065Revision O
Page 36
LcWLlSize & Type: IRequiredFoldexExampleRestrictionsInformation This is the identifier for the lock session. ‘flis data is used internally by the system
LockRecSim & Type IRequiredFoldecExampleRestrictionsInformation This is the identifier for the record being mcdiied. This data is wed internally by the system.
RexmniIDSize & Type+RequiredFolderExample:Re&ctionsInformation ‘his is a record identifier used internally by the system
REF_DWG.DB This table contains 1 to many reference drawing records for each EIN asapplicable.
EIN_CodeSize & Type: A12*Required TmeFolderExample EINOOOOOO033Restrictions:fnfornmtion: This record identifier will be generated automatically by the system. It is a counter used to grant a
unique IO for each EIN record.
Old_IOSize & Type: A20*RequiredFold=. ReferencesExample WFT-03C-2Restrictionsinformation Afks or old identifmtion number.
HNF-SD-WM-SDD-065Revision O
Page 37
Reference_SourceSize & Type: A20*Required TrueFoldec ReferencesExample: H-14-O1O112Restrictions: H-14-Infonnation: System Omwing Number. Unique number assigned to the H-14 O&M System Drawing.
SheetrSize & Type: A3Required TrueFolder ReferencesExample 001Restrictions: mmInformation Reference Drawing Sheet Number. Unique number assigned to the dii%rent sheets of the same
Reference Drawing Numben
RewSize & Type A3Required TrueFolder ReferencesExample 001Restrictions: mmInbnnation: Reference Drawing Revision Number. A unique number used to track the revision of a System
Drawing.
ZonerSize & Type: A2RequiredFoldec ReferencesExample: AlRestrictions: An-HnInformation: Reference Drawing Zone Location. Zone area where the EIN appears cmthe Reference Drawing.
xYz_cOOrdmaterSize & Type: A20RequiredFolder RefmencesExample: 26.97521 .39S CKI.000RestrictionsInformation: Reference Drawing XYZ Coordinate Location. AutoCAD XYZ. Coordinates where the EIN appears
on the Reference Drawing.
HNP-SD-WM-SDD-065Revision O
Page 38
LeckIDSize & Type IRequiredFcddecExample:RestrictionsInfonnatiom This is the idmtitier for the leek session.
LockRecSize & Type IRequidFoldenExmnrdcx
This data is used internally by the system
Information This is the identitk for the record beiig moditied. This data is used internally by the system.
RecordIDSize & Type+RequiredFolderExample:RestrictionsInformation This is a record identifier used internally by the system.
SAFE_SRC.DB This table contains 1 to many safety source document records for each EIN asapplicable.
EIF_CodeSize & Type A12*Required TmeFolderExample EINOOOOOO033Retictionskfonnation This record identitk will be generated automatically by the system. R is a counter used to grant a
unique ID fm each EIN record.
Sourw_DocSize & Type: A25*Required TmeFolder SafetyExampleRestrictions:Information: Safety Source Document. Source documents are used to determine Safety Class.
HNF-SD-WM-SDD-065Revision O
Page 39
SOurce_SecSize & Type AlO*Require& TrueFolder: SatetyExampleRestrictions:Infonnatiom Safety Source Document Section
Source Document Section used to determine Safety Class.
Information This is the identifier for the lock session. This data is used internally by the system.
Lo&RexSize & Type: IRequiredFolderExampleRestrictionsInformation This is the identier for the rexmrdbeing moditied. This data is used internally by the system
RecordIllSize & Type:+RequiredFold.scExampleRestrictionsinformation Tlus is a record Identier used internally by the system
SAFI.TNK.DB This table contains 1 to many tank records for each EIN as applicable.
EIN_CcdeSize & Type A12*Required TrueFoldecExample EINOOOOOO033Restrictions:Information This record identitkr will be generated automatically by the system. It is a counter used to grant a
unique ID for each EfN record.
HNF-SD-WM-SDD-065Revision O
Page 40
Tanl_mSize & Type: AlO*Required TrueFoldec safetyExample:Restrictionsfnfmmatimx Tank Identitlcation. Associated tanks.
L’ddDSize & Type IRequiua.+FolderExample:RestrictionsInformation This is the identifier for the Icxk session. This data is used internally by the system.
L4wkRecSize & Type IRequiredFolderExample:Res&ictionxInfonnatiorx This is the identifier for the record being modified. This data is used integrally by the system
ReccmUDSize & Type:+RequiredFoldcExampleRestrictionsInformation This is a record identifier used internally by the system
SPR_PRTS.DB This table contains 1 to many spare parts records for each EIN as applicable.
This record identifm will be generated automatically by the systemunique fD for each EIN record.
Itisacmmterusdt ogranta
HNF-SD-WM-SDD-065Revision O
Page 41
Sp_Par@_NoSize & TyF AlO*Requirext TmeFoId.er PointerExample 6167-1411-11Restrictions nnnn-nnnn-Infonnation: Spare Part Number. Unique identitk used as the key fieId in the Spare Parts system.
LwkfDSie & Type 1RequiredFoldmExample:Restrictionsinformation This is the identitk for the lock session. This data is used internally by the system
L.dRecSize & Type IRequiredFolderExarnPleRestrictions:Information: This is the identifier for the record being mcditkd. This data is used internally by the system
RecordIDSize & Type:+RequiredFolderExample:RestrictionsInformation This is a record identifier used internally by the system
ECN.DB This table contains 1 to many procedure records for each EIN as applicable
EIT_CcxieSize & Type A12*Required TrueFoldecExample EfNOOOOOO033RestrictionsInformation This record ide.ntitk will be generated automatically by the system. It is a counter used to grant a
unique ID for each EIN record.
HNF-SD-WM-SDD-065Revision O
Page 42
ECNSize & Type AlO*Require& TmeFolder: ReferencesExample: 60S038RestrictionsInfonnatiom ECN Number. Unique identifier for ECNS.
IO&IDSize & TyTe IRequired:FolderExamPle:RestrictionInformation lhis is the identitk for the lock session. This data is used internally by the system
LOckRecSize & Type IRequired:FolderExample:Restrictions:fnformatiom This is the identier for the record being moditld This data is used internally by tie system.
RecordlDSize & Type +RequiredFolderExample:RestrictionsInformation This is a record identikr used internally by the system.
SYSTEMS.DB This table contains the lookup values for the various systems
systemSize & TWC AS*Required TmeFoldec Utility f Detiitions t EIN $5tms
Example: CHMARestrictionsInformation This is the unique link field for the system value. It is an abbreviation of the system name.
HNP-SD-WM-SDD-065Revision O
Page 43
Systen_NameSize & Type: A30Required TrueFolder Utility /Definitions / EIN SyskrnsExample FUEL OILReshictionsbfonnation System Name.
Systa_NumberSize & Type AZReqti TrueFolder Utility /Definitions / EIN SystemsExample 10Restrictions: nnInformation: system Number.
COMl_DES.DB This table contains the lookup values for the various components.
ComponentSize & Type: AS*Required TrueFoldec Utility / Ddnitions / EIN ComponentsExampIe: AODRestrictionInformation This is the unique link field for the componsnt value. It is an abbreviation of tbe componsnt name,
Comp_NameSize & Type A55Required TrueFoldm Utility / Detiniticms / EIN Componen@Example BATTERYRestrictions:fnfomratiom Component Name.
FAC_FARM.DB This table contains the lookop values for the various farm facilities,
Fam_FacilitySize & Type: A5*Required TrueFolder: UtiMy / Dehitions / Farm/FacilitiesExample. 242ARestrictionsInformation This is the unique link field for tbe farm facility value.
HNF-SD-WM-SDD-065Revision O
Page 44
Stictie_DescriptionSize & Type: A65Required: TmeFolder Utility / Detlnitions / Farm/FacilitiesExample This is the AN Farm.Retictions:Information: Description of tbe stmcture.
EINSTAT.DB This table contains the lookup values for the varioua EIN statuses
statusSize & Type A3*Required: TrueFolder Utility / Detiitions / EIN StatusesExample 1Restrictions:Jnfonrration: This is tbe unique link field for the status value.
Stahx_DescriptionSize & Type: A30Required TrueFolder Utility /Deftitions / EIN StatusesExample Label MadeRestrictions:Jnfonnation Status Description
Default_Initid_StatusSize & T~e: LRequired TrueFoldex Utility I Detinitiom I EIN StatusesExample:Restrictions:Infonnatiom Default Initial Status, boolean value
NOUN_ABB.DB This table contains the lookup values for the various noun names
Noun Name_AbbreviationS~e & Type: AIO*Required: TrueFolder Utility /Definitions /Noun Name AbbreviationsExample ADJRestrictions:Information: This is the unique link field for the noun name value
HNF-SD-WM-SDD-065Revision O
Page 45
Abbreviation_DefinitionSize & Type A45RequiredFolder UtiMy / Definitions /Noun Name AbbreviationsExample ADJUSTRestrictionsInformation Definition of tie noun name.
Eqtip_Sys_NameSize & Type: A30RequiredFoldec Utility /Definitions /Noun Name AbbreviationsExample: IA REGRestrictionsInformation Equipment System Name.
COMP_TYP.DB This table contains the lookup values for the various component types
COmp_CwleSize & Type: A2Required TrueFoldec Utility /Definitions / Component FunctionsExample: 04Res&ictiorw rmInformation This is the unique Iink field for the component type value
DWGSTAT.DB This table contains the lookup values for the various drawing statuses.
statusSize & Type: A3*Required TrueFoldec Utility / De.6nitions / Drawing StatusesExample: 1RestrictionsInformation This is the unique link field for tbe status value.
HNF-SD-WM-SDD-065Revision O
Page 46
StatusDesaiptionSize & Type A30*Reqti TmeFoldec UtiMy / Definitions /Drawing StatusesExample: Label MadeRestrictions:Information Status Description
USERDB This table contains the MEL users and related information
Flanford_NoSize & Type A12*RequireA TrueFoldec Admin I Access ControlExample HO068719Restrictions HnmmnnnInformation Hsnford JD. Unique link field.
NameSize & Type A40Require& TrueFolder Admin I Access ControlExample: Doe, J,D,RestrictionsJnfonnation User mune.
PrivilegeSize & Type A8Required TrusFolder Adrnin I Access ControlExample 11111111Restrictions: —Information: User privilege. Automatically generated by the system
HNF-SD-WM-SDD-065Revision O
Page 47
PasswordSiie & Type A1ORequiredFolder Admin I Access ControlExamPle TESTERRestrictions:Information: User password.
KEASONS.DB This table contains the values for the various reasons for data editing.
LockUserSize & Type: A40Information User name of individual locking data for mcdiilcation
LockDateSize & Type: A20Information Date of lock session
LockTimeSize & Type: AZOinformation Time of lock session.
LockReasmSize & TWC A30Infonnatiom Reason for locking data
LockDoculnentSize & TFC A25Information: Document related to lock session.
CHANGLOG.DB This table logs all data modifications.
SessiOnlD
Size & Type: 1*Information: Identifer for change session
SessionRelesseNoSize & Type: I*Infonnatiorr IdentiOer for the release number.
SessiOnRecSize & Type: I*Information Identifk for chsnged record
HNF-SD-WM-SDD-065Revision O
Page 50
EINSize & Type: A23*Information Mcditied EIN.
ChangsdTabIeSize & Type A12*Information: Name of tsble containing change
ChangedFieldSize & Type A25*Information Name of field containing change.
ActionSize & Type: A6Information Type of chmge
NewValueSize & Type A30Information: New value
OldValueSize & Twe A30Information: Old value.
LOCKDATA.DB This table logs the data relevant to a lock session,
LockIllSizs & Type: I*Information Lti field ~ the Lock information in Locks.DB
LOckRecSize & TYIE I*fnformatiom Identifier for the locked record,
EINSize & Type A23*Information: Lccked EIN
LockedTableSize & Type A12*Information Locked TabIe.
LockedFieldSii & Type: A25*Information Locked Field
HNP-SD-WM-SDD-065Revision O
Page 51
ActionSize & Type: A6Information Reason for locking data
PendingValueSize & Type: A60Information New data value pending verification
CumentValueSize & Twe: A60Information Data value before leek.
QRYFLDS.DB This table contains field information associated with a que~,
OrderSize & Type I*Information Order of table records.
TableNameSize & Type A12Information: Name of table
FieldNameSize & Type A25Information: Name of field.
DataOroupSize & Type A15Information: Name of data gToup.
DataTypeSize & Type: AlInformation: Type of data
LookupTableNameSize & Type: A12Information Name of lookup table
LcokupFieldNameSize & Type: A25Information Name of lookup field.
DisplayNameSize & Type A25Information: User-friendly display name.
HNF-SD-WM-SDD-065Revision O
Page 52
EditMaskSize & Type A75Information: System compatible field mask identiijing required and optional character specifications
DisplayMaskSize & Type A60Information: User-fiendly version of the edit mask used for user help.
HNP-SD-WM-SDD-065Revision O
Page 53
3.1 PLATFORM
The MEL Phase I will operate on the user’s desktop PC under the current Hanford End UserOperating Environment (ESOE). Currently, this includes Whdows Version 3.11 (Whdows forWorkgroups) and DOS Version 6.22 and Wlndows95. Users that do not operate under thisconfiguration will be unable to execute the MEL system.
All MEL data will be stored in Borland Paradox for Windows Version 5.0 data tables, These arebinary files that may only be read using a database table interpreter or “engine”.
Borland Delphi Version 1,0 will be used as the application development tool for the MEL system,Delphi is a fourth generation object oriented programming language (4GL) that provides thedeveloper with the flexibility needed to satis~ all the MEL requirements in the most efficient andcost-effective manner,
Several third-party component packages will be used in building the MEL system. A componentis a single binary file that maybe dkectly integrated into the Borland Delphi developmentenvironment. Although these components are transparent to the common user, they provide thedeveloper with enhanced programming capabilities. Components used in the MEL includeInfoPower Version 1.0 and Crystal Reports Component Version 7,0. Infopower is a package ofcomponents which provide the developer with enhanced data aware modules, while CrystalReports Component is a single component which allows the integration of custom reports.
Installation of the MEL will be accomplished using the OnDemand WIN,Stall Version 5.0program, This application has the flexibility to be configured specifically for the needs of theMEL system. The WINStall program files specific to MEL will be maintained on the MELfileserver.
Crystal Reports Version 4.5 by Seagate Inc. will be used for the development of the MEL reports,Crystal Reports is a separate program that is flexible enough to support multiple types ofdatabases and progr anmring languages. These reports will be integrated into the MEL system
using the Crystal Reports Component dkcussed above.
The MEL database tables will be stored on a fileserver using Windows NT Version 3,51 as theoperating system. This configuration allows the fileserver administrator to setup “user groups”which are groups of indkiduals allowed access the MEL data.
HNF-SD-WM-SDD-065Revision O
Page 54
3.2 USER INTERFACE
3.2.1 PROGRAM UNITS
The MEL system, written in Borland Delphi 1.0, is compiled into a single executable filewhich is placed on the users desktop PC during the MEL installation process. However, thesingle executable tile is actually made up of several Pascal tiles (Paacal tiles end with a pasextension). Pascal files contain the actual source code and are native to Borland Delphi, sincePascal was used in the development of Delphi.
Pascal tiles (which are referred to as “units” in Delphi) will be strategically designed for the MELsystem. A description of each is as follows:
ABOUT.PAS - This unit contains the source code for the “About” dblog screen.
ADDEIN.PAS - This unit contains the source code for the “Add New EINs” dialogscreen.
CHG_ACTV.PAS - This unit contains the source code for the “Change Control Activity”dialog screen,
CHGPNDG.PAS - This unit contains the source code for the “Changes Pending” dialogscreen.
EDITVIEW.PAS - This unit contains the source code for the edhiew (folders) screen,
FIND.PAS - This unit contains the source code for the find dialog screen,
INSPNDG,PAS - This unit contains the source code foe the new records dhlog screen.
JUSTIFY.PAS - This unit contains the source code for the edit reason dialog screen,
LOGON. PAS - This unit contains the source code for the “Logon” dialog screen
MAIN.PAS - This unit contains the source code for the MEL Phase I main screenThis includes the navigation tools, main menu and control buttons.
PRNTFILE.PAS - This unit contains the source code for the “Export File Type” dialogscreen.
PRNTLOCK,PAS -
QRY_RES.PAS -
QRYWAIT.PAS -
QUERY,PAS -
REPORTS.PAS -
SPLASH.PAS -
STDDEFS.PAS -
USERS. PAS -
HNF-SD-WM-SDD-065Revision O
Page 55
This unit contains the source code for the “Print Data Locks” dlslogscreen.
This unit contains the source code for the “Query Results” dialog screen.
This unit contains the source code for the “Preparing your report, pleasewait” dialog screen.
This unit contains the source code for the “Query” dialog screen,
This unit contains the source code for the “Reports” dialog screen,
This unit contains the source code for the MEL splash scree~ which isvisible at startup.
This unit contains the source code for the “Standard Data Definitions”dkdog screen.
This unit contains the source code for the ‘{User Information” dialogscreen.
3.2.1.1 EDITVIEW UNIT
The complexity of the Editview unit requires that it be documented in explicit detail, Other unitsin the MEL are not as comple~ and are therefore self-documenting,
Below is a list of the procedures and functions in the fimEditView unit for the MEL, phase I,version 2.0. The list contains routine declarations as they appear (and in the same order they
appear) in the unit’s source file, EDITVIEW.PAS, Where useful, a brief description of theroutine’s function is provided. Also, they are cross-referenced to the MEL, Phase I Data EdhingStructure Charts. One or more numbers in square brackets, e.g., [2, 4], indicate the structurechart pages that illustrate the function or procedure,
This handler is fired (by the Post or UpdateRecord methods of a dataset) when the currentrecord is about to be updated in the database. This event occurs early enough that an actualpost can be canceled.
procedure grdKeyDown (Sender TObject; var Key: Wor~Shift: TslriftState);
Capture attempts to insert and delete records. These operations must be performed via thepop up menu.
Pop up menu invocation and function setup support..,
The pop up menu of options for data fields is always accessible to the user when a rightbutton mouse click is made on an edit box or grid. Upon right click, the following processesare invoked.
This handler is attached to all TDBEdit components used to edit MEL data fields. If themouse click is on the right button, this save the associated table and data source and callinvoke the pop up menu, popEditor. Although it would seem more direct to specifi the popup menu in each of the TDBEdh components (which is then automatically invoked by a right-click on the edit box), this prevents the table and data source associated with the edit boxfi-om being identified,
This handler is attached to the TwwDBGrid components used to edit MEL data and servesthe same purpose as the edMouseDown handler but for grids.
procedure popEditPopup (Sender: Tobject);[1]
This handler is attached to the popEditor pop up menu component,
HNF-SD-WM-SDD-065Revision O
Page 58
When called, thisprocedure determines the current user session conditions and enables or disables the individualmenu items appropriately.
After this handler executes, the pop up menu is displayed to the user. Processes aresuspended until the user makes a menu selection or moves off the menu and activates anotherhandler elsewhere (effectively canceling the menu).
When the pop up menu is displayed, the user may select an enabled menu item or clickelsewhere on the display. Each menu item has it’s own event handler named ‘piXXXClick’where XXX is the name of the selected item.
Pop up menu item handlers...
procedure piChangesClick (Sender: Tobject);[2]
The user has requested to view the changes pending for the selected table, record, and field,Make sure any edits in progress are cleaned up, get the pertinent ioformatio~ then display thedialog for changes pending. If the user is the owner of the dat% we’re in edit mode, and thechanges pending do not represent a deletion, allow edking within the dialog. Updatedisplayed data accordingly upon return.
procedure piNewRecordsCtick (Sender: Tobject);[2]
The user has requested to view all new records (insertions) for the selected table. Display thedialog for new records pending.
procedure piLockCtick (Sender: Tobject);[3]
Lock the selected table & record for the user, Do not enable for editing.
procedure piEditClick (Sender: Tobject);[3]
The user wants to edh the selected table& record. Lock the record for the user and enableediting. If the selected field is in the E~71NF0 table, all dependent records in the othertables must be tlee or owned by the edltmg user.
HNF-SD-WM-SDD-065Revision O
Page 59
procedure piPostC1ick (Sender: Tobject);[4]
The user wants to post any changes pending for the single selected record. Cordirm post withuser.
procedure piCanceIClick (Sender: Tobject);[6]
The user wants to cancel any changes pending for the single selected record. Contirmcancellation with user.
procedure piDeleteClick (Sender: Tobject);[7]
The user wants to mark the selected record for deletion. Get confmnation, clean up edits,lock the record, and mark it for deletion.
procedure piNewClick (Sender Tobject);[8]
The user wants to insert a new record, Cleanup any open edhs. Initialize a new record forthe table, lock it, enable editing, etc. Note - the record will later be deleted atler field entriesare recorded.
Data operations access support...
function IsPrivileged ( pIdx: integer ): Boolezwy[1]
Return true only if the session user has correct privilege to edit the folder indexed by thegiven index,
fimction IaOwner ( lockID: integer): Boolea~[1]
Return true if the session user owns the selected record,
This handler fires whenever the LockID in the EIN_Info table changes as the result ofnavigating records or changing the current record’s lock status. Every edit box associatedwith the table must be updated separately.
This handler fires whenever the LockIll in the Eqp_Info table changes as the result ofnavigating records or changing the current record’s lock status. Every edit box associatedwith the table must be updated separately.
HNP-SD-WM-SDD-065Revision O
Page 61
procedure MotorLockIDChange (Sender: Tobject);[2]
This handler fires whenever the LocklD in the Motor table changes as the result of navigatingrecords or changing the current record’s lock status. Every edh box associated with the tablemust beupdated separately,
TMshmdler fires whenever the Loc~inthe Electtic table chmges asthe resultofnavigating records orchrmging thecurrentrecord’s lock status. Every edhbox associatedwhhthet ablemustbeupdated separately.
procedure MechanicLockIDChange (Sender Tobject);
[2]
Tkshmdler fieswhenever the Loc~~the Electric table chmges asthe result ofnavigating records orchanging thecurrentrecord’s Iockstatus. Every edkbox associatedwiththe table rnustbeupdated separately.
Savethe cumentrecord forthegiven table, 'tb~, in LOC~ATAwith the given’action’, Atttispoint, thetblis already pokttig totherecord ofkterest, thecurrent field values havebeensaved inthevRcdValues TSringList, rmd the field names have beencopied intothevRcdFields TstringList.
Savethe vduesofchanged fields forthecument record of the@ventable, ‘tbl’, inLOCKDATA. Atthispoint, thetblis rdready pointing tothe record ofinterest, theori@ralfield values have been saved inthevRcdVahres TSringList, andthefield names have beencopied into thevRcdIlelds TstringList,
The correct LOCKDATA record is already pointed at by tbtLockData, Change the pendingvalue, current value, and action as given.
function LocateLockDataRecord (ein, tName, fNsme: string[1,2,7,9]
10cIcID, lockRec: integer): Boolean;
Given the match parameters required, locate the LOCKDATA record and leave thetblLockData pointing at the record, Return true if the match is successfid, false if not found,
Remove the lock on the given table and record and remove the associated LOCKDATAentries. Remove the LOCKS entry if appropriate. Return true if successful, false if not,
tlmetion CancelEINChangesPending ( 10cIcID:integeq ein string): Boolea~[6]
Remove the locks on all records in all database tables for the given EIN, Then remove theassociated LOCKDATA and the LOCKS entry if appropriate. Return true if successful, frdseif not,
HNF-SD-WM-SDD-065Revision O
Page 65
function CancelSessionChangesPending ( lockID: integer ): Boolean;
Cancel all locks and changes made in one session by a specific user. Return true if successful,false if not,
timction CancelUsersChangesPending ( user string): BooleaK
Cancel all locks and changes made in any sessions by a specific user. Return true if successtlrl,false if not.
function CancelAllChangesPending: Boolean;
Cancel all locks and changes pending. Return true if successtld, false if not,
function UnlockDatabaseRecord ( locklD, lockRec: intege~[6]
einCode, tName: string ): Boolean,
Remove the LockIll and LockRec from a single data table record. Return true if successful,false if not.
If the table is not ElN_Info, delete the single record. If it is the EIN_Info table, delete therecord and all associated records in all of the other data tables (matchmg EW_Codes).Return true if successful, frdse if not.
If the table is not EIF_Info, insert a new record in the table and fill it with the values inLOCKDATA. If the table is EIP_Info, a new EIN_Code must be created. Return true ifsuccessfid, false if not.
Modifi the fields in the single tablekecord which have ‘Change’ action LOCKDATA records.Leave ‘Lock’ed fields unchanged. Return true if successful, false if not.
Turn off the auto-edit property for the data source.
procedure CheckForEdits;[34678]>>>>
HNF-SD-WM-SDD-065Revision O
Page 69
If a table is open for editing, call Detour to record and cleanup
fimction GetNewEINCode: String;[5,8]
Open the EII’_No.DB table to obtain the next available number to be applied to anE~_Code. Build the new EIN_Code value. If successtld, post the new value back to theE~_No.DB.
Data EditingStructureCharts 1 dtigfrtnEditViaw. Page4
pPwXlbk
E L+z@!z
CheckFo~dh MlDataTables
tMtoul
(S*, )
[.1GetEINCde
E EIN_lnb
rGetSe66imReleaseNo
a.,nwresee Page5
ss_lwkwsd1049S mwt
HNF-SD-WM-SDD-065Revision O
Page 74
MEL, Phase IData EditingStructure Charts
frmEditView. Page 6(Mnthuedfrc.mW4]
nP@stCha~esP@hgRc-x#d
J
r)Rwvc
einJternc14e
fehw
r!Y2!J ‘“”
/7(seepage6)
E‘==bA===”&&
Ss.ldwd
10+% M
HNF-SD-WM-SDD-065Revision O
Page 7’5
MEL, Phase IData EditingStructureCharts
frnsEditWew. Page6
Userselects‘CancerLXTXIp
menu tern.
i
EziE?Ec
R&shN
J
\ r ) r ) ( ) ( ) ( \ (tMtoul GetHNCcde tWeEIN UnlcckHN Clem!pLwks Unlcckfmtdbast Ceiekbwmta
bxkData tnlabaseRec@ Rsord Lock%c
(sec~ge9) (s00Page4)
I
(wePage5) (seePage5)
B LcckLMa TableNames [JDS.T*M=
=-IW mdm-w nw,i
HNF-SD-WM-SDD-065
Revision OPage 76
MEL, Phase IData EditingStruclure Charts
frnsEditView- Page 7
.&=( )
ChcckForEdb loMINRexfd
(seePage3) (seePa* 3)
\ drCcde\
Iable\
ElC+qRWrd
F
Lcdelww U@elctWRKord Record
(seePage3]
N m Tables W.lwksmdt?-+% ml
HNF-SD-WM-SDD-065Revision O
Page 77
MEL PhaseIData EditingStructureCha*
frmEditView - Page 8
Bzz!zzN
Userselects’NatiPpup
msnu tern,
E
(seePage3) (9wPage3)
dLwkDatass-lwks md
10.4.% M
HNF-SD-WM-SDD-065Revision O
Page 78
MEL, Phase IData EditingStructure Charts
frnsEditView. Page 9
0
CheciForEdS$
‘dsU@ateOata’ is sailed
whenevers database table is
aiwl to be updated. The
update ia intercepted by
‘Wow’ so that changes san
be resotiad as ‘tian~s
pending’ in the LockOats
table. ‘CheckforEdW is
called by several routines
whenever e signklcant change
occurs,
bble
=
(seePage2)
IcckRtc~
fi+anwJ
Lccnte@mRecod
5s_kck5 M
W4M mt
HNF-SD-WM-SDD-065Revision O
Page 79
3.2.2 FOLDERS
The MEL system divides its data into five major categories. These categories arerepresented in the application by “folders”. A folder is a single page of data contained on a screenwith a tab-lie index feature. The folders in the MEL include Pointer, References, Nameplate,Specifications, and Safety. Each folder contains data grouped specific to these topics.
HNP-SD-WM-SDD-065Revision O
Page 80
3.2.3 SCREENS
The following sections contain pictures of the actual MEL user interface screens. Anydata displayed is purely for example ordy.
3.2.3.1 DATA VIEW - POINTER FOLDER
Revision OPage 81
3.2.3.2 DATA WEW-REFERENCES FOLDER
HNF-SD-WM-SDD-065
Revision OPage 82
3.2.3.3 DATA VIEW - NAMEPLATE FOLDER
HNF-SD-WM-SDD-065
Revision OPage 83
3.2.3.4 DATA VIEW - SPECIFICATIONS FOLDER
HNF-SD-WM-SDD-065
Revision OPage 84
3.2.3.5 DATA VIEW -SAFETY FOLDER
HNF-SD-WM.SDD-065Revision O
Page 85
3.2.3.6 QUERY
HNP-SD-WM-SDD-065Revision O
Page 86
3.2.3.7 REPORTS
HNF-SD-WM-SDD-065Revision O
Page 87
3.2.3.8 LOCKS AND CHANGES PENDING
HNF-SD-WM-SDD-065Revision O
Page 88
HNF-SD-WM-SDD-065Revision O
Page 89
3.2.3.10 STANDARD DATA DEFINITIONS
HNF-SD-WM-SDD-065Revision O
Page 90
3.2.3.11 CHANGE LOG
HNF-SD-WM-SDD.065Revision O
Page 91
HNF-SD-WM-SDD-065Revision O
Page 92
3.2.3.13 ABOUT
HNF-SD-WM-SDD-065Revision O
Page 93
3.2.4 MENUS
The following sections provide detail regarding the functionality of the MEL menus.
3.2.4.1 MAIN MENU
The MEL has several functions accessible through the menu aligned access the top of theMEL application main screen. This menu haa the following option> File, Edit, Dat~ View,Utility, Admin.., and Help. These menu items have specific options available once the useraccesses them, They are as follows:
File / Exit
Edit / Find
Edit / Find Next
Data /Data View
Data /Data Edit
View / Folders
View I Queries
View / Reports
View I Locks
View I Hint Boxes
Utility / Create EINs
This option allows the user to exit the MEL application
This option allows the user to perform a search for a specitic EIN bya secondary field.
Allows the user to automatically search for the next vahre matching
the previously defined search criteria.
This function puts the database into view mode, posting any changes.
This timction puts the database into edit mode, prompting the userfor an edit reason.
This fimction allows the user the ability to view folder data.
This function allows the user the ability to perform a query,
This function rdlows the user the ability to print a report
This function allows the user the ability to view and dispositionlocked dat~ if privileges are applicable.
This fimction toggles the view of the yellow hint boxes providing userinformation when the mouse is held over certain fields.
This fimction allows the user to create new EINs
Utility / Definitions -
Utility / Change Log -
Admin. / Access Control -
Help / About
HNF-SD-WM-SDD-065Revision O
Page 94
This function allows the user to add, modifi and remove master data
definitions.
This timction allows the user to view the change log table.
This fimction allows the user to corrilgure the MEL users list andaccess control.
This function allows the user to view the release informationregarding the current version of the MEL.
3.2.4.2 QUERY MENU
The menu on the “Query” page has the following option$ File, Query, and Help. These menuitems have specific options available once the user accesses them. They are as follows:
File / New Query
File / Open Query...
File / Save Query
File / Save Query As
File / Delete Query
Query I Execute
Help
This option allows the user to create a new query.
This option allows the user to open an existing query.
This option allows tbe user to save a query.
This option allows the user to save a query with a different name
This option allows the user to delete an existing query.
This option allows the user to execute the current query.
This option displays help regarding the use of the query page.
3.2.4.3 LOCKS AND PENDING CHANGES MENU
The menu on the “Locks and Pendhg Changes” page has the following option% View,Disposition, and Help. These menu items have specific options available once the user accessesthem. They are as follows:
View /By User - This option aUows the user to view locked data by user name.
HNF-SD-WM-SDD-065Revision O
Page 95
View I By EINs
View I Show All
View / Cancel Session
View / Cancel EIN
View / Cancel User
View / Cancel All
View / Post Session
View / Post EIN
View /Post User
View /Post All
Help
- This option allows the user to view locked data by EIN.
- This option allows the user to view all the data records, as opposed
to only ones representing changes.
- This option allows the user to cancel the data for the selected session,
- This option allows the user to cancel the data for the selected EIN
- This option allows the user to cancel the data for the selected user
- This option allows the user to cancel all the selected data,
- This option allows the user to post the data for the selected session,
- This option allows the user to post the data for the selected EIN.
- This option allows the user to post the data for the selected user,
- This option allows the user to post all the selected data.
- This option displays help regarding the use of the query page.
3.2.5 REPORTS
The MEL Reports screen is built to accommodate several specific timctions. First, the usermay select to print data from one or many folders. Secondly, the user has the option to choosewhich EINs to report on by selecting them from a list. The user may also choose to print EINsgenerated from previously executed queries. Finally, the user may opt to print the report to theScreen or Printer.
The user may opt to print the following reports: Label Datq Pointer Datr+ References Data,Nameplate Dat~ Specifications Dat~ Safety Data, All Folders Data. Each report provides datafrom the respective folder. Report Examples are included in the following sections.
HNF-SD-WM-SDD-065Revision O
Page 96
3.2.5.1 LABEL DATA
9/25/96 Master Equipment List (Label Info)
m ~atatmaakuwsa En2crit. QAQsRLabdco&ZZZ-ALC-2CF3 CAUSTIC PUMP 10 GENERIC (D1O) EcN Y YYY YYZZZ-ALC-2(M COND 11 GENEHIC (D1O) 031 Y YYY YYZZZ-ALC-2M3 ~USH K 12 GENERIC (D1O) 111 Y YYY YY
Page 1
HNF-SD-WM-SDD-065Revision O
Page 97
3.2.5.2 POINTER DATA
9/25/96 Master Equipment List (Pointer Info)
FarmWacility AN FARM EIN CHEMS-VFD-1OO Component Function VERTICALNoun Name: CAUSTIC XFER PMP SPf3ED COtiT
status:m safety Cla.s.w3 OSR N Envirmmwntak Y Qtk Y Criticak Y
Vendor Info # LOOp\seq BarCodelie. PropertyNo. ModI$No m V.dor No. ManufacturerVFD
serial f%. Spare Parts mm No. FrOject No.cAusmc XF lCO
FarmWwili@ ANFARM EIN cHEMS-VFD-1OO Component Function VERTICALNoun Name: CAUSTIC XPER PMP SPEED CONT
status:cm saf@y claw 3 OSR N Envirwunentak Y QA Y Critbh Y
VMdor Jnfo # LQOp\seq Sar CodeNo. Ropeq No. Modef Ne Mfg Vmdor No. Mmmfactnrer W No. Spare Farb 3t%f/SNQ. Pmjed N..
Fann!lk~ty ANFARM EIN ~EMS-VFD-100 Component Function VERTICALNoun Name CAUSTIC xf33R PMP SPEED CONT
Stsltw 006 safeiy claw 3 OSR N Envimnmentak Y QA Y Critksk Y
Fmdl?acility AN FARM EN CHEMB-VFD-1OO Component Function: VERTICALNoun Nanhx CAUSTIC XFER PMP SPESD CONT
ststlw 006 Safety Cl&s.w3 OSRN Envirmunentak Y QA Y Criticak Y
Page 1
HNF-SD-WM-SDD-065Revision O
Page 102
3.2.6 PRIVILEGFX
Every MEL user has a set of prc-defmed privileges. This information is stored in the
user table (user.db). Each record in this table includes the user’s name, H@oNI ID,password, and privilege. The privilege field is a string of eight characters, in which eachindividual chamcter represents access to a different data group. Each character is either a “O”
or a “1”, where a “O” represents no access, and a” 1” allows access. The data groups arerepresented as follows:
1st Character =Pointer data
2nd Character =
Refemxe data3rd Character =
Name data4th Character =
SPecitlcations data5th Character =
Safety data6th Character =
not used7th Chamcter =
L&l data8th Character =
System Administrator
3.2.7 ACCESS CONTROL
Access to the MEL system and its different functions are controlled according to pre-defincd privileges. These privileges are setup and maintained by the system administrator (seethe “privileges” section for more information).
Access for a user depends on the privilege code, which is applied to the MEL system. Uaeraonly have write access to those data groups of the application which an?. represented in their
respective privilege code. Any data group in which access is not allowed is automatically actto read-only. The privilege code is checked after user logon, and write access to the differentparts of the system are set at that time.
HNF-SD-WM-SDD-065Revision O
Page 103
3.2.8 CHANGES PENDING & CHANGE LOG
3.3 LAUNCHER
The MEL system contains an executable ffle which is used to start or “launcIf the main
program. This ffle is needed not only to start the client application, but to handle networkcomections as well.
Since the MEL is a multiple user database, the data must be centrally located on a commonfdeserver. Connections to this fileserver must occur prior to stardng the MEL. Fmthermorc,these connections need to be closed once the user terminates the MEL. These tasks are allaccomplished by the MEL launcher application.
The MEL launcher has settings con@red witbirr an initialization (INI) ffle to launch a
specit%d version of the application. This INI fde is communicated to the launcher on theWindows command line. For example, “C:\WINAPPSIMEL\LAUNCH. EXEMELBETA.INI” would tell the launcher to initiate the Wa version of the MEL.
After determination of the version, the launcher attempts to make a cormcztion to everyfdeserver that the MEL requires. If these connections cannot be made, the user is notitled andthe session is terminated. Otherwise, the MEL application is initiated. Once the MEL has
been started, the launcher waits in the background until the user terminates the session, at thispoint, the launcher dkcomects the MEL network comections and returns the user to theWindows environment. The DAES Launcher Application User Manual can be found in theDAES technical library.
3.4 DISTRIBUTION / INSTALLATION
3.4.1 RELEASE AREAS & VERSIONS
The MEL system has several release areas associated with it. These include Alpha, Beta,
Altl, and Production. They me defined as follows:
Alpha Release Area - This area contains the most recent development work. The sourcecode is untested and contains data which may be discarded at anytime. It is for developer’s use only, and available only to selectedusers for testing proposes.
HNF-SD-WM-SDD-065Revision O
Page 104
Beta lleleaae k
Altl Release Area
Production Release Ama
This area contains the version of the MEL that is currently in the
process of acceptance testing. Soume code for this area must bekept under configuration control, with a copy being maintained bythe software custodii. Access to this area is available to selectedbeta testers only.
This mva is a temporary holding area for a tested copy of theMEL application. In this mea, the application has been
acceptance tested, however, the system may still need datatransferred in from other sources, or may need operational testing.Data in this area will not be removed without the systemadministrators confiiation.
This area houses the production veraion of the MEL. This is the
am in which the ~ is used by only authorized users and datais strictly maintained. Them should be no testing in this area,since the data is quality affecting.
Besides having separate release mess, each area may have a different version of the MEL. For
example the production Release Area might contain Version 1.0. However, the Beta ReleaseArea might have Version 2.0, and the Alpha Release * might be on Version 3.0.Nevertheless, a user may always fmd out what release and version they are current running bylooking in the Help/ About section of the application.
3.4.2 INSTALLATION
The Installation process for the MEL system involves several functions. First, theinstallation program or “Installer” is a third-party softw,we package called “WINStall”
developed by OnDemand softwme. This program, which is the Hanfoni Site standard fornetwork installations, places ffles from a network fdeaerver to a location on the client machine.These ffles and subdiitories include
MEL_PHSl .BXE - MEL executable fdeLAUNCH.EXB - MEL LauncherMBL*.INI - MEL Initialization ffieMBL1*.VBR - MEL Veraion FileMEL.ICO - MEL IconLOC_DATA subdiitory - Subdiitory for temporary fdes, reports, local tablesPREFS Subdilwtory - Subdiitmy for user preferences
HNF-SD-WM-SDD-065Revision O
Page 105
All ffles am located on the client machine in the directory C:\WINAPPS\MEL\RELEASENAME, where release name is the name of the installed release. The MELl *.VER fdedepends on the installed release. The* character is ~laced with a xrpesentation of therelease type.
Each release contains a *.ver fde which is used for version identifkation. If a user has notinstalled the most ~ent version of a Elease, they an? prompted to install the new versionbefore continuing. The comparison is performed by using the date and time stamp of the *.verfdes, with the most recent one being available on the network fdesexver.
3.4.3 USER COMPUTER RESOURCE REQ~S
Tbe following conilguration is recommended for user computers:
. 486 or higher IEM-Compatible Personal Computer (PC).
● A h~ disk drive con@md as “C:”.
● At least 8 megabytes of RAM, 16 megabytes is recommended.
. At least 30 megabytes fme disk space on “C:”.
● Hanford End System Operating Environment (ESOE).
