TWRS SE R i s k Management & Frank 9. Equip.lConponent. Yes. IEI Title or Description of Data. Management System Browser Software.

Transcription

1 To: 3. F r m : (Receiving Organization) R e l a t e d ED1 No.: N/A 6. Design A u t h o r i t y 1 Design Agentlcog. P r o j./prog./dept./div. : Engr.: D. D. TWRS a. ( O r i g i n a t i n g Organization) TWRS SE R i s k Management & Model ing Distribution o r i g i n a t o r Remarks: Frank 9. Equip.lConponent Document t r a n s m i t t e d f o r release. 11. Receiver Remarks: 11A. 7. Purchase Order No.: No.: 10. System/Bldg./Facility: Design Baseline Docunent? [] Yes [XI 1 Major Assm. Dug. No.: NO 13. P e r m i t l P e r n i t A p p l i c a t i o n No.: 1 IBI DocumontlDrawing No. NO WHC-SD-WM-SDR-011 I 0 I 1. Appmval Rslaars 3. Information Ssc.171 IGI R ~ I IJI Name. 1 nator Reason tor Trans-. mittal Originator Disposition N/A Requirements Management System Browser Software Requirements Specification I Desio. KEY Disposition IHI & Ill Review Post-Review 6.Dirt. (Receipt Acknow. Required1 1.Approved Approved wlcomment 3. Disapprovedwlcomment 17. SlGNATURElDlSTRlBUTlON I Rwiswsd nalmmmant Reviewed wlmmmant 6.Receipt acknowledged IKI Signature ILI Date IMI MSlN I I 101 IHI R ~ ~ DisD,. IJI Name IKI Signature ILI Data IMI MSlN QA Safety Env. I 19. la. dj%40)d Signature of EDT Originator Transmitted Approval lssa Appmval Designator far required agnaturobl I d2l I ~ IEI Title or Description of Data Reason for Tranmiffal IGI Appmval Dseignator IF1 E. S. (1. D or NlA 1s. WHC-CM-3- (F) DATA TRANSMITTED ID1 IC1 Rev' NO. NO. IAI q/so[?b Date I DOE APPROVAL ( i f required) C t r l. No. I1 Approved Authorized Rsprassntative Date tor Receiving Organization Cognizant Manager [I Approved u l c m n t s [I Disapproved u / c m n t s

2 WHC-SD-WM-SDR-011, Rev. 0 Requirements Management System Browser Software Requirements Specification D. D. Frank, B. C. Gneiting Westinghouse Hanford Company, Rich1 and, WA U.S. Department of Energy Contract DE-AC06-87RL10930 EDT/ECN: UC: 905 Org Code: Charge Code: DlMlM B&R Code: EW Total Pages: 13 Key Words: systems engineering, requirements management, RMSB, RMACS, browser, parser, SE tools. Abstract: The purpose of this document is to define the essential user requirements for the Requirements Management System Browser (RMSB) application. This includes specifications for the Graphical User Interface (GUI) and the supporting database structures. The RMSB application is needed to provide an easy to use PC-based interface to browse system engineering data stored and managed in a UNIX software application. The system engineering data include functions, requirements, and architectures that make up the Tank Waste Remediation System (TWRS) technical base1 ine. This document also covers the requirements for a software application titled "RMSB Data Loader (RMSB- DL)", referred to as the "Parser." The Parser is needed to read and parse a data file and load the data structure supporting the Browser. TRADEMARK DISCLAIMER. Reference herein to any specific cmrcial product, process, or service by trade name, tradenark, manufacturer, or otheruise, does not necessarity constitute or inply its endorsement, recmndation, or favoring by the United States Govermnt or any agency thereof or its contractors or subcontractors. Printed in the United States of America. To obtain copies of this docunent, contact: UHC/BCS DocMent Control Services, P.O. Box Mailstop H6-08, Richland UA 99352, Phone (509) ; Fax (509) Y Release Approval \ Approved for Public Release A (10/95) GEF321

3 WHC-SD-WM-SDR-011 Rev. 0 CONTENTS 1.0 INTRODUCTION... 0 PURPOSE AND SCOPE ABBREVIATIONS AND ACRONYMS REQUIREMENTS GENERAL PARSER FUNCTIONS DATABASE STRUCTURE GRAPHICAL USER INTERFACE General Main Window User Preferences Window Record Editing Window Element Relationship Window Change Window Search Window Add Relations Window Change History Window OTHER REQUIREMENTS OTHER CONSIDERATIONS REFERENCES ii

4 1.O INTRODUCTION Systems Engineering information for the Tank Waste Remediation System (TWRS) is currently stored and managed with the RDD-100' software application. The RDD-100 application manages data supporting the systems engineering process including functions, requirements, and architecture definitions for specifications. The RDD-100 application runs on a UNIX workstation, costs over S30K per license, and is not an open system. Therefore, a personal-computer (PC)-based system is needed to increase the ability of engineers and managers on-site to access and modify the information stored in the RDD-100 system. To provide a more open and cost-effective access to the RDD-100 data for a wide range of users, a relational database with a graphical user interface (GUI) is required for PC users running Microsoft Windows. This software application will be titled, "Requirements Management System Browser" (RMSB) or "Browser". The Browser data structure and interface design must closely mimic the RDD-100 data structure and terminology. The supporting database tables for the Browser shall match each element type in RDD-100 and the relationships between elements shall be recorded in a table named after the RDD-100 relationship. To transfer data from RDD-100 to the Browser, a PC-based GUI shall be developed with the title - RMSB Data Loader (RMSB-DL) or the "Parser". The Parser is required to read and parse an RDD-100.RDT file and load the RMSB database. 0 PURPOSE AND SCOPE The purpose of this document is to identify the software requirements for the RMSB application. This includes a specification of the database structures and the GUI. The description contains sufficient detail to describe the processes used by the software. This document does not include the RMSB installation software, or the RMSB updating software. Installation and update of the RMSB application is covered in the documentation for the TWRS Systems Engineering Tools generic installation program and generic automatic update software. Revisions of the software are covered by the draft TWRS Systems Engineering Software Configuration Management Plan (WHC-SD-WM-CSCM-034) for the TWRS Systems Engineering Tools. 'RDD-100 is a registered trademark of Ascent Logic Corporation 1

5 WHC-SD-WM-SDR Rev. 0 ABBREVIATIONS AND ACRONYMS The t a b l e below i d e n t i f i e s and d e f i n e s t h e a b b r e v i a t i o n s and acronyms used w i t h i n t h i s document. ERA GU I RMACS RMSB RMSB-DL SE SQL TWRS Element-Relation-Attribute, t h e database model used by RDD-100 Graphical User I n t e r f a c e Requirements Management and Assured Compliance System Requirements Management System Browser, t h e Browser RMSB Data Loader, t h e Parser Systems Engineering S t r u c t u r e d Query Language Tank Waste Remediation System 0 REQUIREMENTS The f o l l o w i n g s e c t i o n s i d e n t i f y software requirements f o r t h e development o f t h e RMSB a p p l i c a t i o n. The requirements are grouped i n t o f i v e s e c t i o n s : 1) o v e r a l l o r general requirements f o r t h e a p p l i c a t i o n ; 2) requirements f o r t h e u t i l i t y t h a t parses an RDD-100 data f i l e and loads t h e RMSB database; 3 ) requirements f o r t h e database s t r u c t u r e c o n t a i n i n g t h e data; 4) t h e g r a p h i c a l user i n t e r f a c e requirements organized by main f u n c t i o n a l i t y groups (windows); and 5) o t h e r requirements t h a t are n o t covered i n t h e o t h e r f o u r areas. 1 GENERAL T h i s s e c t i o n describes t h e h i g h - l e v e l f u n c t i o n a l requirements r e q u i r e d f o r t h e PC-based software system. The mission o f t h i s system i s t o p r o v i d e a c o s t e f f e c t i v e way f o r a wide spectrum o f users t o view t h e TWRS t e c h n i c a l b a s e l i n e d a t a s t o r e d i n RDD-100 and monitor changes between r e v i s i o n s. T h i s b r i d g e t o RDD-100 i n f o r m a t i o n should a l s o p r o v i d e a p l a t f o r m f o r o t h e r a p p l i c a t i o n s t o g a i n access t o t h e system engineering d a t a s t o r e d i n RDD The a p p l i c a t i o n must r u n on a PC and have a M i c r o s o f t Windows t y p e g r a p h i c a l user i n t e r f a c e t h a t operates e f f i c i e n t l y i n t h e windows environment. The i n t e r f a c e must use windows, buttons, menus, s c r o l l bars, mousec l i c k events, and o t h e r windows c o n t r o l s t o manipulate t h e user s view o f t h e data and t o navigate through t h e data, i. e., a simple, easy t o use, p o i n t - a n d - c l i c k i n t e r f a c e. The database engine s t o r i n g t h e RDD-100 data must support t h e S t r u c t u r e d Query Language (SQL) and t h e PC windows environment. 3. The system must be a b l e t o read an RDD-100 d a t a f i l e (.RDT f i l e ), parse o u t t h e r e q u i r e d data, and download t h e i n f o r m a t i o n i n t o a PC database s t r u c t u r e. 2

6 The database must be structured so that it mimics the RDD-100 schema and terminology to provide system commonality and ease of data transfer. The graphical user interface and database structure must support the user activities of browsing, sorting, searching (data queries), monitoring changes between data sets, and allowing electronic capture and upload of set of proposed data changes made by the user. 2 PARSER FUNCTIONS A software tool is required to initially convert the RDD-100 information, in the form of an.rdt file, into the database structure that will be used by the Browser (See Section 3). This tool, titled RMSB-DL or Parser is required to perform the following functions: 1. Create the database structure. Parse an.rdt file generated by RDD-100, including the ability to filter out and ignore those elements, relations, and attributes not defined for the TWRS database structure. 3. Parse the change history information in the.rdt file. Generate a record count report for all element and relation tables. Allow the user to enter a 250 character name or description for the data set being parsed. 3 DATABASE STRUCTURE The following requirements apply to the database structure for the Browser and the Parser applications. These requirements on the database structure conform to the schema used within ROD-100. RDD-100 uses an Element- Relation-Attribute (ERA) structure, where elements represent records of various types, the attributes are the "fields" or data values of each element record, and relations are used to identify links between elements. 1. There shall be one table for each element type used within RDD Elements of the same type shall be contained in a single table structure. Example of element types include Functions, Requirements, Architectures, and so on. Alternate (RMACS and RDD-100) nomenclature for the elements, attributes, and relations shall be provided. 3. All of the necessary attributes associated with each element type currently used within the RDD-100 database, including the element type (String, Integer) and size (bytes) shall be retained. 3

7 All of the relations currently used by RDD-100 shall be retained. Each relation shall be contained in its own table, and identify the source and target elements for the relation. The data and supporting structure shall be maintained in a database engine that runs on a PC in the windows environment. Element records shall be indexed by the "Name" attribute, or "Number" and "Name" attributes. Relation records shall be indexed by the source element type and name, and by the target element type and name. Change history information for elements, relations, and attributes shall be retained in the database structure. Change history information shall be indexed by the element type and element name. 4 GRAPHICAL USER INTERFACE 1 General The following are requirements for the overall design and development of the GUI for the Browser software. Because the Parser will not be distributed, these requirements do not apply to the Parser. The functional requirements are generally broken down into specific groupings of functions contained in an object called a window Any window within the software that contains text input fields shall have an "Edit" menu with the standard "Cut and Paste" capabilities. These functions shall exchange data with the Windows clipboard, which can then exchange the data with other Windows applications. Wherever possible, all menu items and controls (buttons, list boxes, check boxes, etc.) shall have keyboard equivalents. When possible, any non-trivial windows shall have resizing capabilities, so that the controls in those windows will be sized appropriately when the window is resized by the user. This will also scale the window and controls to fit on any size screen resolution. Resizable windows shall have a minimum size so that controls do not overlap and the window is still readable. Resizable windows shall initially be full screen for any screen resolution greater than or equal to VGA (640 by 480 pixels). All windows must be able to fit in a minimum size of a VGA monitor (640 by 480 pixels). 4

8 WHC-SD-WM-SDR-011 Rev For any n o n - t r i v i a l windows, a "Help" menu must be a v a i l a b l e w i t h i n f o r m a t i o n about general t o p i c s and t h e c u r r e n t window as well. 8. Windows t h a t c o n t a i n t a b l e s o f element records s h a l l have a "double-click'' event associated w i t h them t h a t w i l l d i s p l a y t h e d e t a i l e d i n f o r m a t i o n on t h e selected element record. 9. For any window w i t h n o n - t r i v i a l i n f o r m a t i o n, t h e a b i l i t y t o p r i n t t h e i n f o r m a t i o n must be provided. 2 Main Window The f o l l o w i n g requirements apply t o t h e main window o f t h e Browser. The main window s h a l l be t h e i n i t i a l window d i s p l a y e d by t h e a p p l i c a t i o n p r o v i d i n g t h e s t a r t i n g p o i n t f o r t h e software f u n c t i o n a l i t y. The Main window s h a l l : 1. D i s p l a y t h e "Number" and "Name" a t t r i b u t e s f o r t h e records o f a user-selected element t a b l e and p r o v i d e t h e user w i t h e t h e c a p a b i l i t y t o s e l e c t t h e element t y p e t o d i s p l a y from t h e main window. H i g h l i g h t element records i n t h e main window t a b l e t h a t have been added, modified, o r d e l e t e d u s i n g v a r i o u s c o l o r s. 3. Provide t h e a b i l i t ; t a b l e by t h e "Name D i s p l a y t h e d e t a i l e d r e c o r d i n f o r m a t i o n f o r any r e c o r d "doublec l i c k e d " i n t h e main window t a b l e. I f t h e r e c o r d i s one t h a t was deleted, a message box s h a l l d i s p l a y an e r r o r message t o t h e user. The i n f o r m a t i o n s h a l l be d i s p l a y e d i n a "Record E d i t i n g Window" described i n Section Provide t h e a b i l i t y t o open any Browser database f i l e. 6. Provide t h e a b i l i t y t o e x p o r t t h e c u r r e n t change i n f o r m a t i o n i n t o an.rdt f i l e readable by RDD-100, or t o an ASCII t e x t file. 7. Provide access t o a preferences window t h a t a l l o w s t h e user t o s e t v a r i o u s user preferences. a. t o s e l e c t whether t o s o r t t h e main window o r "Number" f i e l d. Provide a mechanism f o r e x i t i n g t h e program. 9. Provide a mechanism f o r accessing a r e l a t i o n t a b l e s window. 10 Provide a mechanism f o r accessing an o l d views window. 5

9 11. Have a mechanism for adding and deleting element records in the current tab1 e Have a mechanism for accessing various query windows. Have a mechanism for accessing a database changes windows. 1 Provide access to On-Line Help information. 1 Be resizable. 3 User Preferences Window A preferences window shall be used to set various user defined options for the software. The window must be accessible from the main window of the software The preferences window shall provide the user with the ability to: 1. Select and customize element views for the record editing wi ndow. Select the nomenclature (labels) used by the Browser as either RDD-100 or RMACS names. 3. Select when justifications for changes to the data are made. Cancel changes to the user's preferences. Save the user's preferences to an initialization (.INI) file when exiting the window. 6. Provide on-line help. 4 Record Editing Window A Record Editing Window shall be used to display the detailed information on an element record. This includes any and all of the attributes of the element, and any relations from the element to other elements. The user must be able to add, modify, and delete information from this window as well. Access to this window shall be by "double-clicking'' on an element record reference located in other windows, including the main and search windows. The record editing window shall: 1. Display all or a selected set of attributes for an element type as defined by the user in the Preferences window. Display any or all relations to other element records in the database. 3. Allow the user to modify and save changes to the attributes. 6

10 WHC-SD-WM-SOR-011 Rev. 0 Allow the user to add a new element of the same type or delete the current element record. Provide a mechanism that adds or removes relationship links to other elements. 6. Provide record navigation capabilities that navigate through records in the current element table Provide a method of canceling changes made to the attributes of the current element record. Provide a mechanism for returning to the previously viewed element. 9. Provide a mechanism for accessing an old views window. 10. Provide a mechanism for viewing the change history information for the current element Provide access to on-line help for the window and current element type. Be resizable. Element Relationship Window 5 An element relationship or relations window shall be used to display the records in any one of the relation tables in the data structure. The relations window shall be accessible from the program's main window and have the following functionality: 1. Display the element type, name, and number for the source and target elements for a user-selected relationship type. Provide a selection box for changing the relationship type being viewed. 3. Display the detailed record information for any source or target element "double-clicked" in the table. Have on-line help available for the window. Able to exit from the window. 6. Be resizable.

11 6 Change Window A change window shall be developed to display a summary of the changes for elements, relations, or attributes. Detailed information windows shall be developed to display the specifics for each type of change. Note that this is different from the change history windows, which shall show the history of changes to the master RDD-100 database. The windows that are used for displaying the change information shall be accessible from the main window. The change window(s) shall: 1. Allow the user to select which changes to display in the table, either elements, relations, or attributes. 3. Provide the ability to "double-click'' on any change record in the main change window and display the detailed information for the selected change record. The window used to display this information will depend on the change table being viewed. Allow the user to modify only the justification field in the detailed change windows; all other fields shall be automatically entered when the change is made. Allow the user to exit each window. Provide on-line help. 6. Allow the user to resize the main change window. 7 Search Window The browser software shall provide one or more windows for searching through the various element tables based on the values of the attributes or relations. The user shall be able to select an instance from the search result and view the detailed information. The search windows shall be accessible from the main window of the software. The search window(s) shall: 1. Allow the user to query on records in a selected element table based on the attributes and/or relations associated with the el ement s. Display a summary of all of the records found for the current search criteria. 3. Display the detailed element record information when a user "double-cl icks" on that record of the results. Provide a method of clearing the search results and starting over. 8

12 Provide a mechanism for exiting the windows. 6. Provide On-line help. 8 Add Relations Window An add relations window shall be developed that provides the user the ability to select and add relations from a source element to one or more target elements. The add relations window shall be accessible from the record editing window. The add relations window shall: Allow the user to select a target element type for adding re1 at i ons. Allow the user to select a specific relation when more than one relation is used between the current element type and the selected target element type. Allow the user to select one or more elements to add as the targets of the selected element relationship. Provide a means of canceling a relationship addition. Provide a means of exiting the window and adding a relation. Have on-line Help. Be resizable. 9 Change History Window Change history windows shall be developed to display any of the changes associated with an element record. The change history will be an archive of all of the changes made to the master RDD-100 baseline since the first revision. The windows shall allow the user to compare various versions of text attributes and identify the differences. Note that this is different from the change windows, which display only the changes to the current data set. The change history windows shall be accessible from the record editing window. The change history window(s) shall: 1. Display all of the element, attribute, and relation changes to a current element record. Allow the user to select any versions of an attribute value from the history for comparison. 9

13 3. Display "redline" formatted text to identify the differences between previous versions of the,,data set for text values. The user must be able to print this redline" text information. Have a mechanism for exiting the windows. Have on-line Help information available. 6. Be resizable. 5 OTHER REQUIREMENTS This section contains miscellaneous requirements that do not fall into one of the four categories above Changes to the database information shall be verified for correctness before they are allowed. Example: A "Name" attribute may not be blank, a "Number" attribute must be in the correct form for a hierarchical number. When exporting or saving to a file that already exists, the user must give permission before the file is overwritten. Database errors must be trapped and error messages displayed to the user. Example: Field too long or a string entered when a numeric value is expected. The minimum platform for the application will be a 386 PC running Windows with at least 8 MB of memory. The on-line help must provide a point-of-contact for problems that are not solved by the on-line help. The software shall provide a mechanism for identifying the current program and data versions. The on-line help shall provide information on each non-trivial windows in the application. The on-line help shall provide information about the underlying database structure. The software shall provide a way for identifying the user making proposed changes to the baseline data by querying for and storing a user name during first time use. 10

14 0 OTHER CONSIDERATIONS This section presents other considerations and requirements that are typically addressed separately in WHC-CM-3-10, Software Practices, Appendix F. Functional Requirements: Section 4 above. The functional requirements are covered in External Interface Requirements: There are no additional hardware, software, or communication interfaces for the Browser or Parser software. Performance Requirements: As mentioned in Section 5, Requirement 4, the software must run on a 386 PC running Windows with 8 MB of memory. This was chosen as the "lowest common denominator" for PCs onsite. Design Constraints: None. Attributes: None. Other Requirements: Testing and Acceptance criteria and documentation requirements are 1 isted in the Configuration Management Plan. Training will be addressed as needed. Other sections in Software Practices manual for defining potential requirements are not considered applicable. 6.0 REFERENCES WHC-CM-3-10, Software Practices, Revision 0, Appendix F, "Software Requirements Specifications, 'I Westinghouse Hanford Company. WHC-SD-WM-CSCM-034, TWRS Systems Engineering Software Configuration Management Plan, Draft Revision, dated September

15 To Distribution Project Title/Work Order From SE Risk Management & Modeling Requirements Management System Browser Software Requirements Specification Page 1 of 1 Date 9/26/96 EDTNo ECN No. Text Text Only Attach./ Name MSlN With All Appendix Attach. Only EDT/ECN Only - RL D. J. Francis - Other Central Files (Original) Log Book (D. 0. Frank) K6-51 X A3-88 X H6-35 X (01/93)!&Fob7