and System Software Requirements Definition (SSRD)
Data Mining PubMed Results
Team 5
Team Members PROJECT MANAGER: CONCEPT: REQUIREMENT: ARCHITECT: PLAN: PROTOTYPE: IV&V: IV&V: Srikanth Ranganamyna Dinesh Siddhareddy Eric Johnson Kris Wiseley Christina Khachatryan Sri Ram Bathina Maria Biadoma Martin Freihofer
SSRD_LCA_F05_T5_v2_5.doc
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version # 2.5
Version History
Date 9/28/05 Author Eric Johnson, Sri Ram Bathina Version 1.0 Changes made Original template for use with LeanMBASE Version 1.0. Update references, TOC PR-9,PR12(old), new table PR-12. Rationale Document began.
9/29/05
Eric Johnson, Sri Ram Bathina
1.1
10/9/05
Eric Johnson
2
10/11/05 Eric Johnson
2.1
Created: CR 1B, 1C, 4B, 6B, 8B, 9A, 9B. PR 21, ER 3 Updated: Status of SSRD, glossary of terms, refererences, TOC, TOT, LS1, Table 32B, PR12, PR19 *note some table names and requirements numbers now have sub headings A,B,C etc. The A are the original requirements of that number. Updated: TOF, Agile internal TOT, PR and CR review, professor numbering suggestions to
ii
Felt need to be more specific and perform another grammar check. We wanted to fix all the little errors we could find in the document and include group feedback IIV report on our LCO reported some several inconsistencies. This new version has removed all cited those inconsistencies. Verified all Win Win cases traced into SSRD.
SSRD_LCA_F05_T5_v2_5.doc
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) systems(got rid of a,b,c sub notation), sections 1.1, 2.1, 2.2, 2.3, 2.4, glossary terms. Minor grammar changes, Deleted : IR2 Updated Tables.
Version # 2.5 our through email. group an
10/18/05 Eric Johnson
2.2
10/23/05 Eric Johnson, Sri Ram Bathina
2.3
Updated: CR 1316, PR PR16, PR25, Table of contents and table of tables Deleted PR9.
Small minor changes needed to be made. Ir-2 should have been deleted it is no longer a viable requirement. In CR13- 16 some cases were in off nominal that were nominal. In PR 9 that is a decision not a requirement for a language. Removed ambiguous language. For review of LCO Package For package LCA
11/9/05
Eric Johnson, Sri Ram Bathina
2.4
11/20/05 Eric Johnson, Sri Ram Bathina
2.5
Updated: TOT, TOC, sections 1.2,2.2.1,2.2.4, 2.3, 3, 4, 5, 7 Updated TOT, TOC cleared up issues from LCO
SSRD_LCA_F05_T5_v2_5.doc
iii
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version # 2.5
Table of Contents
SYSTEM AND SOFTWARE REQUIREMENTS DEFINITION (SSRD).............................I VERSION HISTORY..........................................................................................................II TABLE OF CONTENTS...................................................................................................IV TABLE OF TABLES.........................................................................................................V TABLE OF FIGURES......................................................................................................VII A.1. Introduction.....................................................................................................................1 A.1.1 Status of the SSRD...................................................................................................1 A.1.2 References................................................................................................................1 A.2. Project Requirements......................................................................................................2 A.2.1 Budget and Schedule................................................................................................2 A.2.2 Development Requirements.....................................................................................3 .2.2.1 Tools Requirements .............................................................................................3 .2.2.2 Language Requirements .......................................................................................5 .2.2.3 Computer Hardware Requirements.......................................................................5 .2.2.4 Computer Software Requirements .......................................................................7 .2.2.5 Computer Communication Requirements ............................................................9 .2.2.6 Standards Compliance Requirements...................................................................9 A.2.3 Deployment Requirements ......................................................................................9 A.2.4 Transition Requirements........................................................................................10 A.2.5 Support Environment Requirements......................................................................10 A.3. Capability Requirements ...............................................................................................12 A.4. System Interface Requirements ....................................................................................20 A.4.1 User Interface Standards Requirements ................................................................20 .4.1.1 Graphical User Interface Standards ...................................................................20 .4.1.2 Command-Line Interface Requirements.............................................................21 .4.1.3 Diagnostics Requirements .................................................................................21 A.4.2 Hardware Interface Requirements ........................................................................21 A.4.3 Communications Interface Requirements .............................................................21 A.4.4 Other Software Interface Requirements.................................................................21 A.5. Level of Service (L.O.S.) Requirements.......................................................................21 6. Versions, States and Modes..............................................................................................22 7. Evolution Requirements....................................................................................................22 8. Appendices ......................................................................................................................23
SSRD_LCA_F05_T5_v2_5.doc
iv
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
Table of Tables
TABLE 1: PROJECT BUDGET.............................................................................2 TABLE 2 - SYSTEM SCHEDULE..........................................................................3 TABLE 3 - RATIONAL ROSE FOR UML..............................................................3 TABLE 4 DART FOR RISK MANAGEMENT.....................................................3 TABLE 5 EASY WIN WIN TOOL FOR WIN WIN NEGOTIATIONS .................4 TABLE 6 EFFORT REPORTING SYSTEM TO TRACK OF TEAM EFFORT. . .4 TABLE 7 COCOMO II FOR MAN HOUR ESTIMATION....................................4 TABLE 8 MICROSOFT PROJECT PLAN FOR SCHEDULING.........................5 TABLE 9 RATIONAL ROSE FOR UML MODELING.........................................5 TABLE 10 - 32 BIT COMPATIBILITY....................................................................5 TABLE 11 - MINIMUM RAM REQUIRED BY USER.............................................6 TABLE 12 - MINIMUM HARD DRIVE SPACE......................................................6 TABLE 13 - MINIMUM PROCESSOR SPEED......................................................6 TABLE 14 - STAND ALONE PC............................................................................7 TABLE 15 - PRINTER............................................................................................7 TABLE 16 - WINDOWS 2000 OR BETTER..........................................................7 TABLE 17 - BROWSER SUPPORT......................................................................8 TABLE 18 - MICROSOFT EXCEL.........................................................................8 TABLE 19 - APACHE FOR WEB SERVER..........................................................8 TABLE 20 - NETWORK COMMUNICATION........................................................9 TABLE 21 - LEANMBASE REQUIREMENTS ......................................................9
SSRD_LCA_F05_T5_v2_5.doc
v
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
TABLE 22 - STAND ALONE SYSTEM..................................................................9 TABLE 23 - INSTALLATION...............................................................................10 TABLE 24 MAINTENANCE REQUIREMENTS................................................10 TABLE 25 - ONLINE DOCUMENTATION...........................................................10 TABLE 26 - JAVA ENVIRONMENT....................................................................11 TABLE 27 PROJECT SUPPORT.....................................................................11 TABLE 28 IMPORT XML.....................................................................................12 TABLE 29 LARGE DATASETS........................................................................12 TABLE 30 IMPORT SPECIFICATION..............................................................13 TABLE 31 - DATA ANALYSIS............................................................................13 TABLE 32 - RANK RESULTS.............................................................................14 TABLE 33 ANALYSIS PERFORMED................................................................14 TABLE 34 ANALYSIS COUNTING CITATIONS.................................................15 TABLE 35 - XML VALIDATION...........................................................................15 TABLE 36 - DISPLAY RESULTS........................................................................16 TABLE 37 - DISPLAY RESULTS........................................................................16 TABLE 38 - USE A DATABASE..........................................................................17 TABLE 39 USER INSTRUCTIONS...................................................................17 TABLE 40 SYSTEM OUTPUT..........................................................................18 TABLE 41 SYSTEM OUTPUT..........................................................................18 TABLE 42 SYSTEM OUTPUT..........................................................................19 TABLE 43 - ERROR MESSAGE..........................................................................20 TABLE 44 - USER FRIENDLY.............................................................................20
SSRD_LCA_F05_T5_v2_5.doc
vi
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
TABLE 45 - SYSTEM AVAILABILITY.................................................................21 TABLE 46 - SYSTEM AVAILABILITY MARS.....................................................22 TABLE 47 - DOWNLOAD ARTICLE...................................................................22 TABLE 48 - LARGER DATASETS......................................................................22 TABLE 49 ARTICLE INDEXING.......................................................................23
Table of Figures
None.
SSRD_LCA_F05_T5_v2_5.doc
vii
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
A.1. Introduction
A.1.1 Status of the SSRD
Currently this is the LCA package draft version of our SSRD and contains all the required fields. It has been decided to abandon the thought of the web version and just implement the stand alone version of the product, however the requirements for the web version are still located in the document because they were captured during the win win negotiation. Furthermore this is a design decision that has been made and will be more clearly reflected in the SSRD. In addition, the choice of either a database or XML analyzer has been decided to use the XML analyzer unless performance issues arise and then we ill use the Database. Since the Win Win negotiation our client has added a few requirements or made things a bit more specific. For instance in the case of a generally good office computer, she forwarded us the specs to another system she works with and that was taken into account (see PR 7-13). As a result of our latest critique from IV team this document has undergone several changes. These can be seen in the version history of this document. Since there were so many changes it has been decided to make this a version 2 instead of a version 1.2. PR4- PR8 do not have an associated Win Win case number to trace back to because this was not discussed and included during that session. However, the professors recent comments suggested this be added hence the reason why it has been added.
A.1.2 References
LeanMBASE Guidelines Version 1.4 URL:
http://greenbay.usc.edu/csci577/fall2005/site/guidelines/LeanMBASE_Guideline_V1.4.pdf
LeanMBASE Version 1.0 Templates SSRD URL:
http://greenbay.usc.edu/csci577/fall2005/site/guidelines/LeanMBASEtemplates/LeanMBASE _v1.0_templates_for_SSRD.doc
Fall 2005 CSCI 577a Team 5 Client Meeting Minutes
URL: http://greenbay.usc.edu/csci577/fall2005/projects/team5/mminutes.html
Fall 2005 CSCI 577a Team5 Home Page URL:
http://greenbay.usc.edu/csci577/fall2005/projects/team5/index.html
Fall 2005 CSCI 577a Team 5 OCD URL:
http://greenbay.usc.edu/csci577/fall2005/projects/team5/LCO/OCD_LCO_F05a_T05_V0.1.4 .pdf
Fall 2005 CSCI 577a Team 5 LCO Prototype
1
SSRD_LCA_F05_T5_v2_5.doc
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) URL:
Version no 2.5
http://greenbay.usc.edu/csci577/fall2005/projects/team5/LCO/Prototypes/INITIAL_PROTOT YPE_LCO_Prototypes_F05a_T05.pdf
Fall 2005 CSCI 577a Team 5 Easy Win Win Report URL:
http://greenbay.usc.edu/csci577/fall2005/projects/team5/LCO/EWW_LCO_F05a_T05.pdf
NLM DOCLine Minimum system Requirements URL:
http://www.nlm.nih.gov/docline/system_requirements.html
Information for Publishers PubMed DTD URL:
http://www.ncbi.nlm.nih.gov/entrez/query/static/publisher.html
Fall 2005 CSCI 577a Team 5 project description URL:
http://greenbay.usc.edu/csci577/fall2005/site/projects/description/project5.htm
Fall 2005 CSCI 577a Team LCA URL:
http://greenbay.usc.edu/csci577/fall2005/projects/team5/LCA/
A.2. Project Requirements
A.2.1 Budget and Schedule
Budget:
Table 1: Project Budget Project Requirement: Description: Priority: Win-Win Agreement(s): PR-1: Project Budget. There is 500.00$ allocated budget for this project. Money to be used where the team sees fit in order to develop this product. M. W1.
SSRD_LCA_F05_T5_v2_5.doc
2
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
Schedule:
Table 2 - System Schedule Project Requirement: Description: Priority: Win-Win Agreement(s): PR-2: Development Schedule. 24 weeks will be required to new this product. 12 weeks (Fall 2005) will be allotted for coming up with architecture. 12 weeks (Spring 2006) will be allotted for the development phase. M. W2.
A.2.2 Development Requirements
.2.2.1 Tools Requirements
Table 3 - Rational Rose for UML Project Requirement: Description: Priority: Win-Win Agreement(s): PR-3: Rational Rose for UML. Rational Rose will be used for the creation of UML diagrams. This will provide visual representation of the system. M. W5.
Table 4 Dart for Risk Management Project Requirement: Description: Priority: PR-4: Dart tool for risk management. The Dart tool will be used for to help our team manage risk. This tool will help us mange the risk through tracking and voting systems. M.
3
SSRD_LCA_F05_T5_v2_5.doc
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Win-Win Agreement(s):
Version no 2.5
Table 5 Easy Win Win Tool for Win Win Negotiations Project Requirement: Description: Priority: Win-Win Agreement(s): PR-5: Easy Win-Win Tool for Win Win Negotiations. The Easy Win Win tool will be used to help the team to determine our Win Win cases. This tool will also help to manage and dispute issues. M.
Table 6 Effort Reporting System to Track of Team Effort Project Requirement: Description: Priority: Win-Win Agreement(s): PR-6: Effort Reporting System to keep track of team effort. Effort Reporting System will be used to keep track of team effort put forth during project. Can help to help estimate similar projects later. M.
Table 7 COCOMO II for Man Hour Estimation Project Requirement: Description: Priority: Win-Win Agreement(s): PR-7: COCOMO II for man hour estimation. COCOMO II tool will be used to help team estimate the amount of time each stage will take to complete based on current skill level. M.
SSRD_LCA_F05_T5_v2_5.doc
4
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
Table 8 Microsoft Project Plan for Scheduling Project Requirement: Description: PR-8: Microsoft Project Plan for scheduling. Microsoft Project Plan will be used to help team budget time for this project. We can use this tool to plan the development schedule with the associated milestones to ensure project is delivered according to schedule. M.
Priority: Win-Win Agreement(s):
Table 9 Rational Rose for UML Modeling Project Requirement: Description: Priority: Win-Win Agreement(s): PR-9: Rational Rose for UML Modeling. Rational Rose will be used to help aid with UML modeling. UML will help show the interactions of the system M.
.2.2.2
N/A
Language Requirements
.2.2.3
Computer Hardware Requirements
Table 10 - 32 bit Compatibility
Project Requirement: Description:
PR-10: 32 bit Compatibility. The system should work on 32 bit computers. No need to optimize
5
SSRD_LCA_F05_T5_v2_5.doc
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) for 64 bit computers. M. W9.
Version no 2.5
Priority: Win-Win Agreement(s):
Table 11 - Minimum RAM required by user Project Requirement: Description: Priority: Win-Win Agreement(s): PR-11: Minimum RAM Required by User. This system should be able to run on a user's system with a minimum of 128 MB of RAM. M. W9.
Table 12 - Minimum Hard drive Space Project Requirement: Description: Priority: Win-Win Agreement(s): PR-12: Minimum Available Hard Drive Space Required by User. The user shall have at least 200MB of free space on the hard drive due to possibility of large datasets. M. W9.
Table 13 - Minimum Processor Speed Project Requirement: Description: Priority: Win-Win PR-13: Minimum Processor Speed Supported by system. The user shall have a minimum of a 450 MHz Pentium 2 class processor or better (or comparable if by different vendor). M. W9.
6
SSRD_LCA_F05_T5_v2_5.doc
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Agreement(s):
Version no 2.5
Table 14 - Stand Alone PC Project Requirement: Description: Priority: Win-Win Agreement(s): PR-14: Stand Alone PC. The new system will be run on a stand alone PC. See PR 7-10 for other computer requirements. M. W9, W34.
Table 15 - Printer Project Requirement: Description: Priority: Win-Win Agreement(s): PR-15: Printer. This system may have a printer attached to the stand alone PC in case the user would like to have a print out of the results. C. W20, W22.
.2.2.4
Computer Software Requirements
Table 16 - Windows 2000 or Better
Project Requirement: Description: Priority: Win-Win Agreement(s):
PR-16: Windows 2000 or better. This system shall be able to run on system running Windows 2000 or better i.e. Windows 2000, XP. M. W10, W4.
SSRD_LCA_F05_T5_v2_5.doc
7
Version 11/20/2005
System Date and Software Requirements Definition (SSRD)
Version no 2.5
Table 17 - Browser Support Project Requirement: Description: Priority: Win-Win Agreement(s): PR-17: Browser Support. This system shall support browsers as specifies by National Library of Medicine. Currently the browsers supported are Internet explorer 6.0 and Netscape 7.0 M. W6.
Table 18 - Microsoft Excel Project Requirement: Description: Priority: Win-Win Agreement(s): PR-18: Microsoft Excel. This system shall be able to support Microsoft Excel. M. W10
Table 19 - Apache for Web server Project Requirement: Description: Priority: Win-Win Agreement(s): PR-19: Apache for the Web server. Apache will be used in this system to perform operations and maintain the web server. W. W3.
SSRD_LCA_F05_T5_v2_5.doc
8
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
.2.2.5
Computer Communication Requirements
Table 20 - Network Communication
Project Requirement: Description: Priority: Win-Win Agreement(s):
PR-20: Network Connection. The user shall have a stable Internet connection (56K or faster connection). M. W9, W11.
.2.2.6
Standards Compliance Requirements
Table 21 - LeanMBASE Requirements
Project Requirement: Description: Priority: Win-Win Agreement(s):
PR-21: LeanMBASE guidelines for software development. The system will be developed using Lean Based Software Engineering (LeanMBASE) approach. M.
A.2.3 Deployment Requirements
Table 22 - Stand Alone System Project Requirement: Description: PR-22: Stand Alone system. The system shall be deployable on single stand along computers. It must be available for download, and installing. Computer should be a "generally general office (see appendix for definition)" computer. M. W9, W34.
Priority: Win-Win Agreement(s):
SSRD_LCA_F05_T5_v2_5.doc
9
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Table 23 - Installation Project Requirement: Description: Priority: Win-Win Agreement(s): PR-23: Installation.
Version no 2.5
The system shall be installed on user computer in order to run program in the stand alone model. C. W34.
A.2.4 Transition Requirements
Table 24 Maintenance Requirements Transition Requirement: Description: Priority: Win-Win Agreement(s): PR-24: Maintenance requirements. Upon completion of project the developers will provide client with documentation of system and instruct client on some basic training in solving frequently asked questions and maintenance. M.
A.2.5 Support Environment Requirements
Table 25 - Online Documentation Project Requirement: Description: PR-25: Online documentation. There shall be an online tutorial for system users that provide common FAQ's for trouble shooting purposes. The tutorial shall be written in a clear and concise way so that users of all skill levels can decipher the system. M. W12, W37.
Priority: Win-Win Agreement(s):
SSRD_LCA_F05_T5_v2_5.doc
10
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
Table 26 - Java Environment Project Requirement: Description: Priority: Win-Win Agreement(s): PR-26: Java Environment. The system shall have Java Runtime Environment installed on it in the case of stand alone approach. C. W7.
Table 27 Project support Project Requirement: Description: Priority: Win-Win Agreement(s): PR-27: Project Support period. The system shall be supported for the duration of at least one year after the completion of the project. The support will be supplied by the client. C. W15.
SSRD_LCA_F05_T5_v2_5.doc
11
Version Date 11/20/2005
System and Software Requirements Definition (SSRD)
Version no 2.5
A.3.Capability Requirements
Nominal requirements: Table 28 Import XML Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): CR-1: Import XML file. M. The system must enable a user to upload an XML file rather than copy the text into the tool. A valid XML file. User e.g. librarian, students etc. Message saying "Successfully upload XML file". The XML file is entered in to Data Analyzer. 1. XML file should be available. The XML file is obtained from the PubMed website. 2. The XML file should be valid. 3. The file should contain less than 300,000 records The XML file is inside the system and is passed onto the data analysis tool. W16.
Post condition(s): Win-Win Agreement(s):
Table 29 Large datasets
SSRD_LCA_F05_T5_v2_5.doc
12
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-2: Handling large datasets.
Version no 2.5
M. The system shall be able to import and process a very large dataset. Large is considered to be anywhere from 5,000 to 300,000 records. A valid XML file. User e.g. librarian, students etc. Message to report the result of the import either failed or successful. The XML file is entered in to Data mining tool. 1. XML file should be available. The XML file is obtained from the PubMed website. 2. the XML file should be valid. The XML file is inside the system and is passed onto the data analysis tool. W35.
Table 30 Import Specification Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-3 Handling input according to DTD. M. The system shall be able to import and process data received in the DTD format Go to www.ncbi.nlm.nih.gov/entrez/query/static/publisher.html . An XML that adheres to the DTD format. PubMed. Message to report the result of the import either failed or successful. The XML file is entered in to Data mining tool. 1. XML file should be available. The XML file is obtained from the PubMed website. 2. The XML file should adhere to the DTD format. The XML file is inside the system and is passed onto the data analysis tool. W36. Table 31 - Data Analysis
SSRD_LCA_F05_T5_v2_5.doc
13
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-4: Data analysis.
Version no 2.5
M. The system should provide the user with an interface where he/she can enter parameters for analyses. For e.g. he/she should be able to find all the institutes supporting research on various heart diseases. Parameters to analyze the data. User e.g. librarian, students etc. Analysis results. Web browser/ excel sheet/ word document. A valid XML file as input. The user is provided with the analyzed data. W43, W23, W40.
Table 32 - Rank Results Capability Requirement: Priority: Description: CR-5: Rank the results. S. The system should rank the results of the data analysis according to the fields specified by the user. The fields could be for e.g. top 10 popular institutes funding research on heart diseases or 50 most popular authors on specific topics etc. The parameter according which the analyzed results (output of CR2) should be ranked. Data analysis tool used in the system. The ranked results displayed as a web page which can be printed or saved as an excel spreadsheet. Web browser/ excel sheet/ word document. The results from CR-2. Ranked results are provided to the user. The system allows the user to further rank the results with different parameters. The ranking must be recursive with changing ranking parameters. W33.
Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s):
Table 33 Analysis Performed
SSRD_LCA_F05_T5_v2_5.doc
14
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Capability Requirement: Priority: Description:
Version no 2.5
CR-6: Tailoring analysis to contain one or more search criteria. W. The system shall allow user to perform several different analysis based on one or more fields for analysis. All the analyzable fields shall be displayed in a neat orderly fashion to allow user to easily make selections. A search string like Dr. Zhivago or USC health center. User e.g. librarian, students etc. All the documents that have the search string in their citation. Web browser/ excel sheet/ word document/ranking module (CR-3). Valid XML document loaded into system Analysis performed according to selected analyzable fields W38, W39.
Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s):
Table 34 Analysis Counting Citations Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-7 Counting journal citation. M. The system shall be able to count the number of times each journal appears in the imported dataset. Valid XML file. Data analyzer. Listing of occurrences. Web browser/ excel sheet/ word document/ranking module (CR-3). Valid XML document loaded into system Accurate count of records has been completed notifying of the # of journals imported W17.
Table 35 - XML Validation
SSRD_LCA_F05_T5_v2_5.doc
15
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-8: The XML file should be validated.
Version no 2.5
C. The schema of the XML files obtained from PubMed has a DTD. They could be validated before querying the data. DTD for the XML files from PubMed. PubMed Website. 1. Boolean result whether the XML is valid or not 2. If the XML file is invalid then a suitable error message. Computer screen. XML file and DTD should be available. If the XML is valid it is forwarded to the data analysis tool. Else an error message is displayed. W16, W42.
Table 36 - Display Results Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-9: Display results in a human readable format. M. The results should be a neatly formatted document which can be read by any user (technical/non technical). The data analysis results in XML. Data analysis tool. Neatly formatted human readable document. Web browser/ excel sheet/ word document. User enters parameter for analysis and is waiting for results. The user has the information in readable format. W41. Table 37 - Display Results
SSRD_LCA_F05_T5_v2_5.doc
16
Version Date 11/20/2005
System and Software Requirements Definition (SSRD) Capability Requirement: Priority: Description: CR-10: Display results of journal title and count.
Version no 2.5
Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s):
M6. The system shall display the results of the journal count and include: title, ISSN, and number of occurrences of the journal title (I.E. the number of articles). How many times a journal or author appears in a given dataset. Valid XML file. Data analysis tool. Neatly formatted table of results. Web browser/ excel sheet. Criteria to select the fields to display. I.E display by ISSN etc. The user has the information in readable format. W17, W18, W19, W32.
Table 38 - Use a Database Capability Requirement: Priority: Description: Input(s): Source(s): Output(s): Destination(s): Precondition(s): Post condition(s): Win-Win Agreement(s): CR-12: Use a database. C. The input XML file can be parsed and all the data could be uploaded onto a database. A valid XML file. User e.g. librarian, students etc. A database with all the information stored in it which could be used for querying. Database e.g. MySQL etc. A database and a valid XML file. A database...