Sr sof orp
-
Upload
vijayeandra-parthepan -
Category
Technology
-
view
176 -
download
1
description
Transcript of Sr sof orp
Software Requirements SpecificationVersion 1.1
September 28, 2009
Online Repository of Publications
Vijayeandra ParthepanTorsak Rak-arom
Submitted in partial fulfillmentOf the requirements of
Research Methods
Table of Contents
Table of Contents...............................................................................................................................................iiTable of Figures.................................................................................................................................................iii1.0. Purpose..........................................................................................................................................................2
1.1. Introduction...................................................................................................................................................21.2. Scope.............................................................................................................................................................21.3. Glossary........................................................................................................................................................31.4. References.....................................................................................................................................................31.5. Document overview......................................................................................................................................3
2.0. Overall description.....................................................................................................................................52.1. System environment.....................................................................................................................................52.2. Functional requirements definitions.............................................................................................................62.3. Use cases.......................................................................................................................................................6
2.3.1. Use Case: Login Page............................................................................................................................72.3.2. Use Case: Menu Page............................................................................................................................82.3.3. Use Case: Search Page...........................................................................................................................92.3.4. Use Case: View Page...........................................................................................................................102.3.5. Use Case: Edit Publication Page..........................................................................................................11
2.4. Non-functional requirements......................................................................................................................123.0. Requirement specifications...................................................................................................................13
3.1. External interface specifications.................................................................................................................133.2. Functional Requirements............................................................................................................................13
3.2.1. Login Page...........................................................................................................................................133.2.2. Menu Page...........................................................................................................................................133.2.3. Search Page..........................................................................................................................................143.2.4 View Page.............................................................................................................................................143.2.5. Edit Publicaotioin Page........................................................................................................................15
3.3. Detailed non-functional requirements........................................................................................................153.4. System Evolution........................................................................................................................................16
4.0. Index.............................................................................................................................................................17
ii
SRS 04/13/23
Table of Figures
Figure 1 System Design...........................................................................................................................................4Figure 2 Login Page.................................................................................................................................................6Figure 3 Menu Page.................................................................................................................................................7Figure 4 Search Page...............................................................................................................................................8Figure 5 View Page.................................................................................................................................................9Figure 6 Edit Publication Page..............................................................................................................................10
iii
SRS 04/13/23
1.0. Purpose
1.1. Introduction
This Software Requirements Specification provides a complete description of all the
functions and specifications of the Western Kentucky University’s, Computer Science
Department website’s, Online Repository of Publications.
The expected audience of this document is the faculty of CSD, including the faculty who
will use this system, Dr. Guangming Xing and other committee members, and the developer.
It will also serve as a reference for future CSD students.
1.2. Scope
The Western Kentucky University CSD’s Web Accessible Publications Database
(CSDWAPD) is designed to run on the departmental server and to allow three different
categories of user’s,
Member’s can log in, search, submit/edit the publication details submitted by
them, comment or post their questions on other publications and reply to the
comments and questions on their publications and also post guidelines to the
perspective member’s who wish to publish their ideas in the future.
Visitors can log in, search and comment or post their questions under interested
publications.
Administrator will be assigned all the privileges to maintain the web page.
The data will be held in a MySQL database on the departmental server.
1.3. Glossary
Term Definition
1
SRS 04/13/23
JISC Join Information Systems CommitteeCETIS CEnter of Terrorism and Intelligence
StudiesDEST Department of Education Science and
Training CSD Computer Science DepartmentHtml Hyper text markup languageCSDWAPD CSD’s Web Accessible Publications
DatabaseLog in Form filled out and submitted by a user to
authenticate their identity on the CSDWAPD.
Web Browser A software application for retrieving, presenting, and traversing information resources on the World Wide Web.
Web Page A document or resource of information that is suitable for World Wide Web.
Web Site A place on the world wide webAdmin Administrator
1.4. References
http://www.studentshangout.com/
“Repository Management and Implementation”, a White Paper for alt-i-lab 2004 prepared on behalf of DEST (Australia) and JISC-CETIS (UK).
National Library of Australia, Managing Web Resources for Persistent Access http://www.nla.gov.au/guidelines/persistence.html
http://www.eprints.org/community/blog/index.php?/archives/162-Digital- Repository-Management-Practices,-User-Needs-and-Potential-Users-An-Integrated-Analysis.html
1.5. Document overview
The remainder of this document is two chapters, the first providing a full description of
the project for the owners of the CSD. It lists all the functions performed by the system. The
final chapter concerns details of each of the system functions and actions in full for the
2
SRS 04/13/23
software developers’ assistance. These two sections are cross-referenced by topic; to increase
understanding by both groups involved.
3
SRS 04/13/23
2.0. Overall description
The CSDWAPD encompasses numerous publication files and information from the
Publication Database, as well as login information of the different categories of user’s. This
system will be completely web-based, linking to CSDWAPD and the remote web server from
a standard web browser. An Internet connection is necessary to access the system.
2.1. System environment
Figure 1 System Design
The CSDWAPD web site will be operated from the web server. When an user connects
to the Web Server, the Web Server will then interact with the Database through database
connection, which allows the web page to transfer data to and from a database.
4
SRS 04/13/23
2.2. Functional requirements definitions
Functional Requirements are those that refer to the functionality of the system, i.e.,
what services it will provide to the user. Nonfunctional (supplementary) requirements pertain
to other information needed to produce the correct system and are detailed separately.
2.3. Use cases
The system will consist of CSDWAPD Home page with five selections.
The first selection is to login. This page requests the username and password to
authenticate the user.
The second selection is to explain the menu. According to the type of user, the menu
will display differently. The visitor user can only search and view the publications. The
member user can search and view the publications and edit and delete for his publications.
The third selection is to search the publications form the publications database
according to the keywords, such as publication name, author name, published date, the topic,
and the associate type of publication.
The fourth selection is to view the publication. Search criteria from the file database
and display it on web page.
The fifth selection is to edit the publication. Member users can upload and delete their
publications and change the information of the publications. Administrator users can edit all
publications and maintain the web page.
All pages will return Menu page.
5
SRS 04/13/23
2.3.1. Use Case: Login
Figure 2 Access Login Page
Brief DescriptionThe Web Server is waiting the user to login with their username and password.
Initial step-by-step descriptionFor this use case to be initiated, the user must be connected to the Internet and connected
to the Web Server.
1. The user connects to the Web Server.
2. The user types the username and password, or selects the visitor button on the Login page.
3. The Web Server passes the user to the Menu Page.
Reference SRS 3.2.1
6
SRS 04/13/23
2.3.2. Use Case: Menu
Figure 3 Menu Page
Brief Description:The Menu page shows the menu for the user to select.
Initial step-by-step description:For this use case to be initiated the user must be connected to the Internet and must be
logged in on the Menu Page.
1. The user selects the link on the menu. 2. The Web Server returns the corresponding web page to that user selection.
Reference SRS 3.2.2
7
SRS 04/13/23
2.3.3. Use Case: Search Page
Figure 4 Search Page
Brief Description:The user selects the search criteria or gives the keywords to search the publication from
the database.
Initial step-by-step description:For this use case to be initiated the user must be connected to the Internet and selected
search from the menu page.
1. The user selects the searching criteria from the list.
2. The user types the keywords for searching and click search.
3. The Web Server gets the keywords and searching criteria.
4. The Web Server connects to the database and gets the search lists.
5. The Web Server sends back the search list and display on the web page.
6. The user can sort the list according to the column name.
8
SRS 04/13/23
7. The table get sorted and displayed.
8. The user can select the publication to view the publication details by calling the View page.
Reference: SRS 3.2.3
2.3.4. Use Case: View
Figure 5 View page
Brief Description:The Web page displays the publication on the page.
Initial step-by-step description:For this use case to be initiated the user must be connected to the Internet and select the
publication from the list at the Search page.
1. The Web server retrieves the publication file’s address from the database.
2. The Web Server opens the publication file selected and displays on the web page.
Reference: SRS 3.2.4
9
SRS 04/13/23
2.3.5. Use Case: Edit Publication Page
Figure 6 Edit Publication page
Brief description: The user can edit the publication data on the database and upload or delete his files.
Initial step-by-step description:For this use case to be initiated the user must be connected to the Internet and must be the
member user or admin user and must have selected edit from the menu page.
1. The Web server displays the edit publication page.
2. The user can select either add or delete.
3. To add the publication, the user must enter the publication detail and upload publication.
4. The Web server gets the detail and stores the publication file.
5. To delete the publication, the user must select from the publication list.
6. The Web server deletes the publication selected from the database.
Reference: SRS 3.2.5
10
SRS 04/13/23
2.4. Non-functional requirements
11
SRS 04/13/23
3.0. Requirement specifications
3.1. External interface specifications
None
3.2. Functional Requirements
3.2.1. Login Page
Use Case Name: Login PagePriority EssentialTrigger Enter selectionPrecondition Alum is connected to the Internet and
username and password must be filled.Basic Path 1. Client sends the login details to the Web
Server.2. The Web Server checks for login
information from the database.Alternate Path N/APostcondition The user is on the Menu PageException Path If there is a connection failure the Web
Server returns to the Login page and show the incorrect password.
OtherReference SRS 2.3.1
3.2.2. Menu Page
Use Case Name: Menu pagePriority EssentialTrigger SelectsPrecondition The user is connected to the Internet and on
the Menu PageBasic Path 1. The user selects the selection menu.Alternate Path N/APostcondition The Web Server redirects the web page to the
selected destination page.Exception Path 1. If the connection is terminated before the
menu selected, the sessions are all cleared and the Web Server is returned to the Login page.
OtherReference: SRS 2.3.2
12
SRS 04/13/23
3.2.3. Search Page
Use Case Name: Search pagePriority EssentialTrigger search selectionPrecondition The user must be connected to the Internet
and on the search page.Basic Path 1. The user selects the criteria for search
and/or input the keyword.2. The user clicks on search button.3. The Web server returns the list of
publications from the database.4. The publications display on the table on
the page.5. The user can select any sorting methods
if desired.6. The user selects the particular publication
to view.Alternate Path N/APostcondition The Web server gets the user selection and
sends to view page.Exception Path 1. If the connection is terminated before the
search selected, the sessions are all cleared and the Web Server is returned to the Login page.
OtherReference: SRS 2.3.3
3.2.4 View Page
Use Case Name: View pagePriority EssentialTrigger N/APrecondition The Alum must be connected to the Internet
and click view publication selected from Search Page.
Basic Path 1. The Web server find the publication requested and display by sent to client.
Alternate Path N/APostcondition N/AException Path 1. If the connection is terminated before the
search selected, the sessions are all cleared and the Web Server is returned to the Login page.
2. If the database return the error or cannot find the publication file, the page will be
13
SRS 04/13/23
displayed the error message.OtherReference: SRS 2.3.4
3.2.5. Edit Publication Page
Use Case Name: Edit Publication PagePriority EssentialTrigger Upload or delete selectionPrecondition The user is connected to the Internet and
must be member user or admin user.Basic Path 1. The user select add publication from the
menu.2. The user has to enter the detail and
upload the file.3. The Web server stores the upload file and
saves the address of the file into database.4. The user select delete publication.5. The Web server deletes the publication
from the database.Alternate Path N/APostcondition N/AException Path 1. If the connection is terminated before the
search selected, the sessions are all cleared and the Web Server is returned to the Login page.
2. If the upload or delete file process has an error, Web Server will return the error popup.
OtherReference: SRS 2.3.5
3.3. Detailed non-functional requirements
Hardware: Web ServerOperation System Window 98 or aboveInternet Connection Existing telephone linesCode Standard The web pages will be coded in html by using PHP.
14
SRS 04/13/23
3.4. System Evolution
This would really benefit the prospective students. Although this project is for computer
science website, it can also be used for other departmental websites and also can be used as
an online project repository which can act as repository for the previous submitted projects.
15
SRS 04/13/23
4.0. Index
16