View
228
Download
0
Category
Preview:
Citation preview
King Saud UniversityCollege of Computer and Information Sciences
Information Technology Department
IT322Software Engineering I
SSSSoftware Requirements Specification SRS
Prepared byGroup#:3- Grade: Group Email/Wiki: http://swsw1.wordpress.com/ Group members:Arwa Rashed Al-Issa 429202044, LeaderAl-Hanouf Sultan Al-Dayle 429202031, Analysis 1Amna Mohammad Al-Shyban 429202582, Analysis 2Latifa Fawaz Al-Masaad 429202600, Analysis 3Sara Abdulaziz Al-Romaih 429200921, Analysis 4
Software Requirements Specification SRS
Supervised byL. Najwa AlGhamdi
Second Semester 1432 - 1433Spring 2011 / 2012
2
Software Requirements Specification SRS
REVISION TABLE:
Page# Section# Reviewer Corrected by( Reviewer, Author)
1-64 1 to 7.3Arwa, Al-Hanouf ,Amna, Latifa Sara
Arwa
65,66 7.3.1 Arwa, Amna Al-Hanouf ,Amna
66,67 7.3.1 Arwa, Al-Hanouf Latifa, Sara
68 7.3.1 Arwa,, Sara Arwa , Latifa
3
Software Requirements Specification SRS
TABLE OF CONTENTS
1. Introduction..........................................................................................................................................3
2. Scope.......................................................................................................Error! Bookmark not defined.
3. User Characteristics..............................................................................................................................6
4. Requirements Determination................................................................................................................7
4.1.literature review..................................................................................................................................7
4.1.1. literature review summary…………………………………………………………………………………………….8
4.2.Interview..............................................................................................................................................9
4.2.1. Interview summary ……………………………………………………………………………………………………….12
4.3.Questionnaire....................................................................................................................................13
4.3.1. Summary of Questionnaire………………………………………………………………….……………………………17
5. Specific Requirements........................................................................................................................ 18
5.1. User Requirements.............................................................................................................. 18-25
5.2. System Requirements........................................................................................................... 18-25
5.3. Non Functional Requirements....................................................................................................26
6. Use Cases............................................................................................................................................28
7. System Models....................................................................................................................................29
7.1. Use Case Diagram.......................................................................................................................29
7.2. Sequential Diagrams...................................................................................................................29
7.3. Conceptual Diagram...................................................................................................................61
7.4. Collaboration Diagram....................................................................................................................
7.5. Class Diagram................................................................................................................................ .
6. Glossary …………………………………………………………………………………….……………………………………………..………42
4
Software Requirements Specification SRS
1. INTRODUCTION
The focus of this project is to implement a web based system developed for the
Student Scientific Symposium at king Saud University which simplifies the way of
handling, collecting and reviewing scientific research submitted by the students that was
managed by the Student Partnership Program (SPP).The SPP is a kind of coordination
group that manage the initiatives of the students in king Saud University and also take all
the responsibility of the SSS. For every year the students who want to participate in the
SSS have to deliver their researches to the University in a limit of time, following that
step the Technical chair (TC) will do a lot of manual work in order to deal with these
researches and select the winner depending on the grades. Web-based system is a
necessary strategy to help SSS achieve this goal, that is why our projects Student
Scientific Symposium (SSS) will be provide to avoid wasting effort and time. In addition,
The SSS system has the capability to organize these processes in accuracy and reliability
way.
The purpose of this document is to present a detailed description of the Student Scientific
Symposium System. It will explain the purpose and features of the system, what the
system will do and the constraints under which it must operate. This document is intended
for both the stakeholders and the development team of the system and their supervisors
and will be proposed to the administration of King Saud University for its approval.
The next section describes briefly the system scope and boundaries. The third section of
this document describes the general characteristics of the intended users their educational
level, experience, and technical expertise. The fourth section shows the rescore of the
requirement which were determined by the interview and questioner. The fifth section
shows the whole system requirements in details. The sixth section shows the whole SSS
system use case. The seventh section has a subsection that shows the use case diagrams in
more details.
This document is organized in a logical manner and is easy to follow. Reader could refer
to the table of contents if looking for something in specific.
5
Software Requirements Specification SRS
2. PROJECT SCOPE
SSS is Arabic/ English web based system that covers all the processes
from registering the student in the SSS till the announcement for the winners. The System
will make the registration easy for the students by uploading their works to a personal
account contains their specific information. It also will be a useful way to know the result.
The registration is closed for the King Saud University student. Also, it will benefit the
Technical Chair (TC) by providing a better way for collection the researches, making
them blind and dividing them to the appropriate reviewers according to the type of the
research. Also it needs to know the number of the reviewers to divide the tasks so also the
reviewers have an account with their complete information. The System responsibility is
to send the grades and comments to the student who has a grade above 70% only then ask
him to send the manuscripts according to the reviewers' comments before the camera-
ready version deadline. Then, the student will be passing the first round of revision in SSS
system.
The second round of revision in SSS system is also for helping the TC to
implement the symposium schedule which will include the allocation of the oral
presentation slot time and judges for every work in the symposium agenda with respect to
the contest track. The schedule will have the date, time and the recourses that help the
student to complete his presentation. The system will announce to the students about their
oral presentation date and time with full information. It also provides a way to calculate
the finale grade for all students after the judgers enter the oral presentation grade in order
to select the winner. The selection criterion is the highest total grade based on the total
first round revision grade and the oral presentation grade. Another point is that the SSS
system will be responsible for logistics issues which includes the registration symposium
attendees and resources management which was done before by the Steering Chair (SC).
6
Software Requirements Specification SRS
Any person was register in symposium before the opening ceremony of the symposium;
he/she can get his/her symposium's proceeding and the abstracts of each manuscript and
attendance certificate at the end of the symposium.
At the end, the SSS system will publish the winner research on the system with the
student. Moreover The SSS system does not accept any research after the submission
deadline. Also there is no paper submission in this system and students are not allowed to
know the reviewers or communicate with them.
7
Software Requirements Specification SRS
3. USER CHARACTERISTICS
The system is for the Student Partnership Program (SPP) who has these intended users
with high educated academic particularly for King Saud University. It will provide an
easy way for the technical chair, the steering chair, reviewers, judgers and students who
are most likely has the experience of using such similar systems and used to deal with
different kinds of software.
The technical chair has experience in managing a huge work and dealing with each type
of KSU members. The steering chair can deal with statistical information and resources.
The reviewers and judgers usually are the KSU faculty member so they are familiar with
the researches and grading. The students may be attendee or participator. Participator is a
student in KSU so she have the writing and searching skills. Attendee can be the
participator or any student in KSU would like to benefit from the symposiums.
We support an Arabic / English interface which may help users with different nationality
(often the reviewers) deal with it. They are almost familiar with this domain since this is
not the first SSS.
8
Software Requirements Specification SRS
4. REQUIREMENTS DETERMINATION:
4.1. LITERATURE REVIEW
Features
http://www.confious.com/index.php?p=portfolioThe Conference
Nous
http://project.liquidpub.org/how-to-participate
LIQUID PUBLICATIONS
http://www.umt.edu/ncur2010 /
24th National
Conference on
Undergraduate Research
(NCUR)
http://www.conferencealerts.com/Conference
Alerts
http://conf-
submission.aina2010.debii.curtin.edu.au/
openconf.php
AINA 2010 Conference Research Papers
Website
registration √ √
Research Categorization √ √ √
Sitemap √ √
Help √ √
News and events √ √ √ √
Contact √ √ √ √
Closed system √ √
Way with a consistent colors √ √ √ √
The interface supports more than one language.User interaction √
Designed in a
clear√ √ √ √ √
9
Software Requirements Specification SRS
4.1.1 LITERATURE REVIEW SUMMARY
BASED ON THE WEBSITES EVALUATION, THE RESULT WILL BE AS FOLLOWS :
All websites are in English, they do not support other languages.
40% of the websites support :- Website registration- Help- Site map- Closed system
80% of the website have introducing the News and events also they do having the contact
form.
Only one web site has user interaction such as sign-in for attendance.
Our system features: It is designed for student in King Saud University only.
Support two language interfaces.
Provide user interaction (sign-in for attendance).
Support the Website registration for the student.
Have the News and symposium summary on the website.
Designed the System in clear and with a consistent colour to confirm usability.
10
Software Requirements Specification SRS
4.2.1 INTERVIEW.
4.2.1 INTERVIEW'S TRANSCRIPT.The interview was held with Mis Nawal Al-motairi on Monday 14-March, This interview
took place at King Saud University in the Information Technology building in Room number
38. It lasted for one hour and discussed the following questions:
1. Is the registration open for people outside KSU?
No, it’s a closed system for KSU student.
2. What would you like the interface language to be?
Arabic/English interface.
3. What should the home page contain?
It shall contain a Registration field, latest research that include search box, About SSS that
include summary, Contact Us, Participation Policy, Help.
4. Is it important to add a summery after each SSS event?
Yes I shall prefer this feature.
5. Do you like to have a comment on the system?
No, it is not necessary.
6. Can the participated student modify her research?
Yes she can modify it if she uploads it to her account before the deadline.
7. Is it accepted if the student participates in more than one research?
Yes she can also in different field.
11
Software Requirements Specification SRS
8. Are the research categorized by the levels (Bachelor's, master)?
Yes they have to.
9. Who have the right to have an account in the system?
The reviewer, Judges, student, TC, SC.
10. What are the specifications for the student's account?
It shall be categorized into 1-participation and 2- attendance.
And if she chooses to participation, it will require the student name in (Arabic & English),
ID, gender, mobile number, Email, password, education level, and major.
After that she can upload the research she must fill the required field: research title and
research type (i.e. IT, Science, Physics etc.).
The announcement will be delivering to her by the e-mail account.
On the other hand if she choose attendance a specific schedule about the symposium slot
with full information will appear to her then she can choose one or more in a different time
and register by given her full name, ID, research field and time.
11. What if the user forgot her password, what is the action taken?
SSS should provide remember-me function. If the user forgot his password, SSS should
send an email with random password to her.
12. Do you want a reminder system that reminds the student a one day before the
symposium?
No, I don’t want this feature.
13. What is the TC responsibility that you want us to automate?
Collect the researches, assign them to the specific reviewers according to the faculty,
collect the reviewer's grades and comments of each submission, and send the result to the
student. After the student has a grade above 70% The TC will require her manuscript for
the second round. He will create a schedule for the symposium for each field and at the end
12
Software Requirements Specification SRS
of the symposium he will collect the grades of contents oral presentation and finally select
the winner.
14. What is the SC responsibility that you want us to automate?
He needs to gather the Information about the attendees’ registration to send the proceeding
to them for the symposium and the ceremony and print their attendance certificate for the
symposium attendees and an abstract book of each manuscript for the ceremony.
15. What is the difference between the proceeding, certificates and the abstract book?
The proceeding will be printed for the attendance in the symposium and the ceremony put
the certificates are only for the symposium and the abstract book are only for the ceremony.
16. Where do you prefer to have your announcements for registration or symposium and
anything related?
I shall have them on the home page.
17. Dose the researches will be published on the site?
Of course they will be published on the SSS site with the student name and major.
18. Who's response for enter the grades in oral presentation?
The judgers will enter the grade after the student finished her oral presentation.
19. The student account will be temporary or permanent?
The will be permanent for the students.
13
Software Requirements Specification SRS
4.2.2 INTERVIEW SUMMARY:
There are other feature that user would like to have it after the Interview, the features at conclusion are:
The SSS system will be closed for King Saud university students with Arabic /English interface.
Providing a home page with the many materials.
After each symposium there should be a summary.
Giving the students the chance to modify their researches after they upload it and before
deadline.
Main categorization will be based on educational level.
Registration system will give each of the students, TC, SC and reviewers a special
account with different functions.
Taking in consecration if users forget their password.
The time schedule will be released once without second reminder.
Gathering all the TC and SC responsibility and jobs to automated them.
Facility the judgers job by giving them the ability to grad the competitors during the oral
presentation.
14
Software Requirements Specification SRS
4.3 QUESTIONNAIRE.
The survey is prepared in order to gather some information about the system we are aiming to develop Student Scientific Symposium for the Student Partnership Program (SPP).
It was a paper based survey and the sample space was 10 students from the Student Partnership Program (SPP) in King Saud University who will use the SSS system.
4.3.1 QUESTIONNAIRE ANALYSIS TABLE.
1. Receive an E-mail from the website about the latest event.
a. Agree 70%
b. Neutral 20%
c. Disagree 10%
2. Summary and glossary after each conference service.
a. Agree 30%
b. Neutral 60%
c. Disagree 10%
3. When you want to attend a symposium these information about an event will be enough for you, event Topic, overview, location, Time, who judge.
a. Agree 100%
b. Neutral 0%
c. Disagree 0%
15
A.
B.
C.
Figure 4.3.1
A.
B.
C.
Figure 4.3.2
A.
B.
C.
Figure 4.3.3
Software Requirements Specification SRS
4. Do you want a search box for the previous researches?
a. Agree 10%
b. Neutral 30%
c. Disagree 60%
5. Searching by many possible key words will make you find what you are looking for faster.
a. Agree 0%
b. Neutral 20%
c. Disagree 80%
6. Any member can comments on symposium summery.
a. Agree 40%
b. Neutral 50%
c. Disagree10%
7. Messaging between registered members.
a. Agree 30%
b. Neutral 40%
16
Figure 4.3.6
A.
B.
C.
A.
B.
C.Figure 4.3.7
A.
B.
C.
A.
B.
C.
Figure 4.3.4
Figure 4.3.5
Software Requirements Specification SRS
c. Disagree30%
8. Member's email, password and phone number is private or shown for everyone.
a. Agree 70%
b. Neutral 20%
c. Disagree 10%
9. Do you want the reminder messages to be in a mobile?
a. Agree 70%
b. Neutral 20%
c. Disagree 10%
10. Do you want the reminder messages to be in an Email?
a. Agree 60%
17
A.
B.
C.
Figure 4.3.10
A.
B.
C.
Figure 4.3.8
A.
B.
C.
Figure 4.3.9
Software Requirements Specification SRS
b. Neutral 30%
c. Disagree 10%
18
Software Requirements Specification SRS
19
11. The admin has the right to access all members’ personal information such as email, phone number and other personal information.
a. Agree 70%
b. Neutral0%
c. Disagree 30%
12. The admin has the right to suspend un authorization people and any member who breaks the rules of the website.
a. Agree80%
b. Neutral 0%
c. Disagree 20%
13. The information that appears to the public about members is name, specialty.
a. Agree80%
b. Neutral 20%
c. Disagree 0%
A.
B.
C.
Figure 4.3.13
A.
B.
C.
Figure 4.3.12
A.
B.
C.
Figure 4.3.11
Software Requirements Specification SRS
4.3.2 SUMMARY OF THE QUESTIONNAIRE:
All of stackeholder are agree about the information that the system should provide it for
attendence any symposium and these information are event Topic, overview, location,
Time, who are the judger.
The member's personal information that administrator can access it are: name, email,
specialty, phone number and only name and specialty will visible for other users. Some of
the stakeholders suggested that the user can manage this option from his setting page.
Users agree to send reminder messages to her mobiles for events he registered in.
The System can contain the summary and glossary after each conference service.
Most of our stackeholder agreed that there is no need for the search box to the previous researches.
Registered members may also be able to send messages to other members.
20
Software Requirements Specification SRS
5. SPECIFIC REQUIREMENTS
5.1. USER REQUIREMENTS 5.2. SYSTEM REQUIREMENTS
1- The website for people who belong to KSU and it will be available in
both English and Arabic language.1.1. The system should be closed for the KSU girls only.
1.2. The system shall have the ability to validate that a new registered student is
belonging to current KSUs' student.
1.3. The system shall give the user an option to switch between the
English/Arabic interfaces.
2- The website shall contain a Registration field, announcements, about
SSS summary, Contact Us, Participation Policy, archive and Help.2.1. The system shall provide sing up function for new users in limited time.
2.2. The system shall keep new registered users' account and previous one even if
they are winner or not.
2.3. The system should provide sing in function in any time.
2.4. The system shall gather and display all new posted events and
announcements in the home page.
2.5. The system shall display the date, time of the post along with the post event
and announcements.
2.6. The admin should be able to remove or edit the post.
2.7. The system shall provide a summary after each event in the about section that
include (information about the attendance, number of attendance, summery about
researches type and the winner).
2.8. The system should include a tap describe general Participation Policy.
21
Software Requirements Specification SRS
2.9. The system shall include contact us page to handle advise, issue and problem
that may face the users.
2.10. The system shall allow any user even if she is not registered to access the
contact us page.
2.11. The users shall submit any issue by filling contact us form.
2.12. Contact us page shall give a form that include the following information
about issue which is include (name, e-mail and show description for the issue).
2.13. The system shall have a specific page contains table to collect submitted
issues from the contact forms.
2.14. The system shall provide help page that have description for main
functionally of the system.
2.15. The system shall hold the previous winner researches with the current
one in archive section. 2.16. The system shall order the researches by SSS version then education level.
3- The system administrator shall register the, TC, reviewer's and
judgers' faculty to access the system.3.1. The system administrator shall enter all TC, reviewer's and judgers' faculty
information to the system which is: (full name, KSU email, office phone number,
office number and location).
3.2. The system shall have the ability to validate that a new registered reviewer's and
judgers' are belonging to KSUs' members by their emails.
3.3. The system shall save member's information entered by system administrator.
3.4. The system shall send an activation link to the member email to activate his/her
registration.
4- The user has a permanent account as long as he belongs to King Saud
University.
4.1. The system shall recognize to the expired ID from the KSU database with the first
digit in the graduated student ID.
22
Software Requirements Specification SRS
4.2. The user account shell expired after the graduated time and shall be removed
automatically.
5- The reviewers, student, TC and SC shall have an account to manage
her some personal information.5.1. The system shall give the member an option to reset her password if she wants.
The system shall request the member to enter his old password and the new one.
5.2. The system shall allow the participator to make themselves as attendance in
another symposium.
5.3. The system shall allow the administrator to view the member's information which
is: (full name, occupation, email, phone number, and specialty).
6- The registration function shall have different requirement depending
in user's type.6.1. The system shall request the member for email and password.
6.2. If the password entered is incorrect, the system shall ask the member to re-
enter his password.
6.3. The system shall send a password resetting link to the member email in case
she forget the password.
6.4. The system shall redirect the member to his account page immediately as
she log in with the correct password and member name.
6.5. The system shall categorize the registration function into participation and
attendance.
6.6. The system shall require the following information for participator:
6.6.1. It shall require the student name in (Arabic & English), ID, mobile
number, Email, password, education level, and major.
6.7. The system shall require the following information for attendance:
6.7.1. The system shall require full name and ID for the attendance user.
23
Software Requirements Specification SRS
6.7.2. The system should display specific schedule about the symposium slot
with full information also an appropriate section for the ceremony
attendance.
6.7.3. The symposium schedule will contain the time, date, location and the
research title.
6.7.4. The ceremony section will have the time, date and the location.
6.7.5. The system gives the user the ability to choose different time slot.
6.7.6. The system shall make sure there is no conflict between chosen time slots.
7- The student should have the right to upload and modify their
researches before deadline.
7.1. The system shall allow student to upload their researches by themselves.
7.2. The system shall require the user to choose research type from a list box
and enter research title when the user attempts to upload her research.
7.2. The system should allow the participator to re-upload or delete researches.
7.3. The system should limit the student functionality once the deadline is met.
7.4. The system shall provide a note next to the upload section to warn the user that
any file with personal information will be discarded it should be blind.
8- The system shall support student participated in one or more
research in different field.8.1. The system shall provide a list box that includes all majors in KSU which will
help categorization function for the researches to work correctly.
8.2. The system shall not restrict students to participate with one research only.
9- After the students pass the 1st round, they have to send a manuscript. 9.1. The system shall enable the upload button for the manuscript.
9.2. The system shall enable the list of checkbox for the resources needs in the oral
presentation.
24
Software Requirements Specification SRS
10- The system shall automate TC responsibility in the system.
10.1. The system shall give an account to TC and she can access it by enter her KSU
email and the ID.
10.2. The system shall map all the student research in different tables depending on
the research specialty after the submission deadline.
10.3. For each mapped research a specific ID shall be assigned to it that will help the
TC to map between the owner and research.
10.4. The system shall organize all the available reviewers depending on their
specialty.
10.5. The system shall divide the reviewers into groups; and each group can contain 3
members for the minimum and 5 members for maximum.
10.6. The system shall give a choice to a TC to assign many researches to each group
of reviewers where each group has a determine amount of research that's can
accepted. (I.e. At most 10 researches, one group can accept reviewing them).
10.7. The system shall reject the researches that include any personal information.
10.8. The system shall have the ability to transmit the grades and the reviewer's
comments to the target student which is entered by one of the reviewers. The
TC will publish these results by clicking on publish result button after all the
reviewers finished.
10.9. The system should record all the grades coming from reviewers groups to a
specific grades table in SSS system database.
10.10 The system shall inform the entire participated student in the 1st round about
their results and comments by sending an email message.
10.11. The system shall have filter function which going to drop all participated
student with grades below 70%.
10.12. The system shall inform all the winners who have grade above 70% in the 1st
round by sending a congratulations email message and asking them to upload
their manuscript.
25
Software Requirements Specification SRS
10.13. The system shall create a schedule for all symposiums according to each track
in the 2ed round.
10.14. The system shall randomly divide the judders into groups. And each group can
handle a determined amount of research.
10.15. The system shall allow the TC to specify the start slot time for each schedule
and enter the location, the date, judger's group number and the research title.
10.16. The system shall inform the judgers about their schedule and the students about
their oral presentation time.
10.17. The system shall provide a modify option to the TC to be able to change
anything was done before by the system.
10.18. The system shall calculate the final results and show the winner for each major
to the TC.
10- The system shall automate SC responsibility in the system.
11.1. The system shall allow the student to register in the coordination teams with the
required information's (name in (Arabic & English), ID, mobile number, Email,
password, SC-Number, education level, and major).
11.2. The TC admin will give a SC-Number to any students who want to register in
SC group to help administration the SSS system.
11.3. The system shall calculate the symposium attendance number to specify the
number of the attendance certificate.
11.4. The system shall calculate the ceremony attendance number to specify the
number of the abstract book.
11.5. The system shall collect all resources wanted by the student with their research
title from each account and display it for the SC.
11.6. The system shall automatically collect the abstracts of each manuscript in order
to print the abstract book.
11.7. The system shall guarantee that the numbers of the abstract book needed are
equivalent to the number of ceremony attendance + the participated student.
26
Software Requirements Specification SRS
12- The website should provide a printable model of proceeding. 12.1. The system will provide to the user a print option to print her proceeding when
she registers in a symposium / ceremony.
12.2. The system shall open a separate page to show a "Print Preview".
13- The system shall give judge's ability to access the system while the
competitors oral presentation.
13.1. For each group of judgers, the system shall provide a list of the student's name
and the research title.
13.2. For each student listed in the judger interface, there is a field for the grade which
will be entered by the judgers during oral presentation time.
13.3. The system shall automatically calculate the final grades for each student.
14- The system shall have a search function on the archive section.14.1. The system shall allow the member to search for any research by choose one or
more of the keywords (research name, research author, research type).
14.2. The system should display the search result page that includes links to each
result.
14.3. The system should display the whole research once the user click in the link.
14.4. The search function shall search within the system database that contains the
winner researches.
15- The member should log out from the system before leaving the website the session will be ended after a certain time for the website security issue.15.1. The system shall end the session if the member hasn't made any action after
30 minutes.
15.2. The system shall provide a log out function.
27
Software Requirements Specification SRS
16- Users agree to send reminder messages to her mobiles for receiving the results.
16.1. The system shall make this function optional in the participated student account.
16.2. The user is required to enter her mobile number, and the enterprise.
16.3. The system will automatically send SMS massage to the user when it sends the
results in email.
28
Software Requirements Specification SRS
5.3. NON FUNCTIONAL REQUIREMENTS
5.3.1. PRODUCT REQUIREMENTS:
After two days of training and without any help options, users especially TC should be
familiar with all system's functions.
The system shall not exceed 1 second to sign the user in and make the function
available for her.
The system shall be developed for several browsers such as: Internet Explorer,
Firefox, Safari and Google chrome web browsers. This is a portability requirement
which affects the way in which the system may be designed.
The system interface should be simple, clear and easy to use that support the system
usability and it is better to reduce the pictures to prevent user distraction.
The system shall be available during the announcement of the results and the
symposium schedule for all users also for the user who are interested in symposium
attendance.
The system should be reliable in term of displaying correct information for student
results and comments also correct information about the symposium such as: research
name (topics), symposium location, start date, end date, the symposium summary on
the website …. Etc. in order to make all the users satisfied.
Help should be available for all tools. Command-line tools should print a helpful
message (if appropriate).
29
Software Requirements Specification SRS
5.3.2. ORGANIZATIONAL REQUIREMENTS:
The member interface for SSS shall be implemented using XHTML (eXtensible
Hypertext Markup Language) and styling with CSS.
The system shall be implemented using PHP language.
The system shall be delivered to IT department within 4 months.
The process model that shall be used in the system is Waterfall model.
The researches shall be published over the Internet (in the SSS website).
As a term of copyright protection, KSU logo and "all rights © reserved" should be
added to every page of the system.
5.3.3. EXTERNAL REQUIREMENTS:
Guaranty if system fall down to recover it and retrieve all the users' information.
The system's database should be backed up monthly.
The system shall end the session if one of the users hasn't made any action after 30
minutes to ensure privacy.
Support for History by archiving the researches.
Since the system contains private information for the TC, reviewers, students and SC
it should be highly secured.
30
Software Requirements Specification SRS
6. USE CASES
31
Software Requirements Specification SRS
7. SYSTEM MODELS
7.1. USE CASE DIAGRAM
7.2. SEQUENTIAL DIAGRAMS
TABLE 1
Alternative:
Line 1: The user open the registration page after the limited time / indicates a message that's inform her about the available next time for the registration.
32
Use Case 1: RegistrationActor: Student and KSU system
Purpose: Create an account to participate or attendance.
Overview: This use case begin when the student want to register for participating or attendance with specific information.
Type: Primary – essential
Cross Reference:
Functions: R6Precondition- :
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- The use case begin when the user want to register and open the
registration page.
2- The system ask the student to chose between participate or attendance .
3- the user choose a type of registration from a display list :
a- if participator registration, see section participator.
b- if attendance registration, see section attendance.
4- the system complete the registration then display a welcome message.
Software Requirements Specification SRS
Section: participator:
System responseActor action
2- The system views a specific fields to be complete.
1- The user selects a participator as a type of the registration.
2- The system checks the entered ID from the KSU system.
3- The user enter her name in (Arabic & English) ,ID , mobile number , Email , password , educational level and major in the system .
Alternative:
Line 3: The user enters an invalid Email, ask for a valid email.
Line 3: The user enters an expired ID, ask for a valid ID.
Line 3: the user doesn’t complete all fields / ask to full all fields.
33
Software Requirements Specification SRS
34
Figure 7.1
Software Requirements Specification SRS
35
Software Requirements Specification SRS
36
Software Requirements Specification SRS
Section: Attendance:
System responseActor action
1- The system views specific fields to be complete.
1- The user selects Attendance as a type of the registration.
2- The user enter her full name and ID in the specific fields.
Alternative:
Line 3: The user enters an expired ID, ask for a valid ID.
37
Software Requirements Specification SRS
38
Software Requirements Specification SRS
39
Software Requirements Specification SRS
TABLE 2
Use Case 2: Upload fileActor: Participator
Purpose: Uploaded the complete research to her account.
Overview: This use case begin when the student attempt to upload her research before the deadline.
Type: Primary – essential
Cross Reference:
Functions: R7.1Precondition: Login
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- This use case begins when the user select upload file in his account page.
2- The system display a list of research type also a note to warn the user that's "Any file with personal information will be discarded".
3- The user chooses a research type, select the file from his computer and enter the title of his research in the system.
4- The system adds the file to his account.
5- The system maps all the researches in different tables in TC account, depending on the research specialty after the submission deadline.
Alternative:
Line1: The user want to upload his file after the deadline / the upload button will be disabling.
40
Software Requirements Specification SRS
41
Software Requirements Specification SRS
42
Software Requirements Specification SRS
TABLE 3
Alternative:
Line5: if the research contain personal information of the student/ the TC will avoid this research.
43
Use Case 3: Assign the research to the reviewer.Actor: TC
Purpose: Assign number of researches for each group of reviewers.
Overview: TC start to divided research between reviewer groups, assign number of researches for
each group and make sure it’s not containing any personal information, by the end each
group received number of research.
Type: Primary – essential
Cross Reference:
Functions: R10.6Precondition: Organize the reviewer in group ,
The TC must have completed the Log In use case.
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- This use case begins when the TC received all research and starts to divide theme.
2- The system displays all research information and reviewer groups' number depending on their specialist to the TC.
3- The system will display the researchs orgnized in table and there is a coulmn to input the reviwer group number.
4- TC enters group number next to each research.
5- Select publish option to transmit each research to all members in the group.
Software Requirements Specification SRS
44
Software Requirements Specification SRS
45
Software Requirements Specification SRS
TABLE 4
46
Use Case 4: Transmit the grades with commentsActor: TC
Purpose: Transmit the grades with comments to the students.
Overview: TC views all research with its comments and grades after the reviewer entered it, and then
send it to the researcher.
Type: Primary – essential
Cross Reference:
Functions: R10.8.Precondition: Assign the research to the reviewer groupTC must have completed the Log In use case.
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- This use case begins when all the reviewers finish grading and enter them with comments to the system.
2- TC check the research result. 3- The system display all researches with grades, comment and researcher name.
4- TC now click transmit the results and the comments button .
5- The system transmits the results and the comments to the participator account according to the ID was assigned when submiting the researches.
6- The system sends email to inform
about results go to section: Send email to inform about results
Software Requirements Specification SRS
47
Software Requirements Specification SRS
TABLE 5
48
Use Case 5: Send email to inform about resultsActor: TC
Purpose: Send Email to the participated student in order to inform them about their result.
Overview: The TC user receives the grades and the comments for every participated reseach. And request from the system to send an appropriate email for them.
Type: Primary , essential
Cross Reference:
Functions: R10.10 , R10.12 Precondition: Transmit the grades with comments.
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1. This use case begins when the TC wants to inform the student about their results after 1st round.
2. The system show two form of messages the first for the student who above 70 and the second for the one who are below 70.
3. The TC chosse the send option after seeing the 2 forms.
4. The system will assigne the first form to student who are above 70 and the Second form for the one who below 70 then send the emails.
5. The system confirm sending the messages.
Software Requirements Specification SRS
TABLE 6
Alternative:
Line3: if the student doesn’t upload the manuscript / the system will exclude this research
49
Use Case 6: Collect manuscriptActor: TC
Purpose: To collect the manuscript when the deadline has reached.
Overview: When the due date of submiting the manuscript has been reached, TC will collect the manuscript from the participators who pass the 1st round then any manuscript after this due date will be reject.
Type: Primary , essential
Cross Reference:
Functions: R9 , R10Precondition: Send email to inform about results, Lunch the filter function.
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1. This use case begins when the deadline for uploading the manuscrip has reached.
2. The system checks that the final date for submiting has been reashed then disable the upload manuscript button.
3. The system prevent any modification to the manuscript.
4. TC request to view all the manuscript.
5. The system will gather all the manuscript from the participators account and display them to the TC.
Software Requirements Specification SRS
50
Software Requirements Specification SRS
TABLE 7
Alternative:
Line 4: fill the cell with tow research from one major. / display an error messages.
51
Use Case 7: Make schedule for presentations and ceremony.Actor: TC
Purpose: Create a schedule for all oral presentation and ceremony.
Overview: TC starts to create the schedule for presentations and ceremony by selecting appropriate
time, location and date for each one. The schedule will be created then inform students
and judgers about their time.
Type: Primary – essential
Cross Reference:
Functions: R10.15.Precondition: Collect manuscript
The TC must have completed the Log In use case.
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- The use case begins when the TC select create schedule option and give the start and end date.
2- The system display an empty schedule divided by the date and time, and display a list of research title, judgers group and available rooms.
3- TC selects any cell and fills it with research title or ceremony, room, and judger's names.
4- The system checks and prevents any conflict, if there are two researches from one major in the same cell.
5- TC select publish to confirm the schedule.
6- Select inform option to inform students and judgers about their time.
7- The system will display the whole schedule for the participator and judger to inform them about their time.
Software Requirements Specification SRS
52
Software Requirements Specification SRS
53
Software Requirements Specification SRS
TABLE 8
54
Use Case 8: Enter grades.Actor: Judger.
Purpose: Enter student’s grades for each oral presentation.
Overview: The judgers enter grades of the oral presentation for each student during the symposium.
Type: Primary – essential
Cross Reference:
Functions: R13.2.Precondition: at the symposium time.The judge must have completed the Log In use case.
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- This use case begins when the judger sign in his/her account and want to enter the participator grades.
2- The system display all researches belong to this judger with title of the research and the participator name.
3- Judger enters a grade next to the research’s title.
4- Judger select save option to transmit grades. 5- The system will save the grade and
add it to the first round result.
Software Requirements Specification SRS
TABLE 9
Alternative:
Line 2: if there 2 students with the same grades / display both of theme.
55
Use Case 9: View winner for each major.Actor: TC
Purpose: View the winner for each major in the 2nd round.
Overview: The TC display all winner with its major and grades.
Type: Primary – essential
Cross Reference:
Functions: R10.18Precondition: TC must have completed the Log In use case.
Typ
ical
cou
rse
of e
vent
s Actor action System responce
1- The use case begin when the TC want to display all winner.
2- The system displays all researches information for the highest grades in each major.
Software Requirements Specification SRS
56
Software Requirements Specification SRS
57
Software Requirements Specification SRS
TABLE 10
58
Use Case 10: Collect statistical information necessary for resources management.Actor: CS
Purpose: To collect all the recourse needed by the student in the oral presentation.
Overview: When the student submits the resource they need in oral presentation. The SC request to view all these resource and provide them before the oral presentation occurs.
Type: Primary , essential
Cross Reference:
Functions: R11.5
Precondition: Choose needed recourses, Upload a manuscript .
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1. This use case begins when the student pass the 1st round submit and chooses the resources they need for the oral presentation at the time she upload his manuscript.
2. The SC request to view all the resources wanted by the student.
3. The system display all the resources wanted by the student with their research title and the location for the oral presention .
4. The SC provide the resourse in the location before the oral presention begin.
Software Requirements Specification SRS
TABLE 11
59
Use Case 11: View the symposium attendance numberActor: SC
Purpose: Viewing the specific number of attendee in order to print the certificates.
Overview: This use case begin when the attendee finish in registering in the symposium then the SC wants to view the number of attendees are there to have the correct number of certificate.
Type: Primary – essential
Cross Reference:
Functions: R11.3 Precondition: Register in symposium or ceremony
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- This use case begin when the SC wants to know the number of attendance.
2- The SC can viwe the attendee by requsting the system to calculate them.
3- The system count the number of user register in the symposium then returning them back with the names of these atendees.
4- The SC can now specify the number of the printed certificates .
5- The SC can print the certificate with the atendees name.
Software Requirements Specification SRS
TABLE 12
Alternative:
Line3: if the manuscript does not contain an abstract, the SC should alert the TC about that.
60
Use Case 12: Collect the content of the abstract bookActor: CS
Purpose: View the student who pass the 1st round researches and collect the abstract from them.
Overview: This use case begin when the deadline of the manuscript is out, the SC can view the researches then take the abstract and the student name.
Type: Primary – essential
Cross Reference:
Functions: R9 , 11.4 , 11.6 , 11.7Precondition: Register in symposium or ceremony , Collect manuscript
Typ
ical
cou
rse
of e
vent
s
Actor action System responce
1- This usecase begin when the SC request to view the manuscript.
2- The system show all the collected manuscript.
3- The SC take out the abstract from each manuscript and the name of the student then enter it in the approprate field.
4- The system take the abstract and the name and orgnize them in an appropraite book.
5- The SC finishing from extract the abstracts book.
6- The system show out the complete book.
7- The SC now can print the book according to the number of the
cermony attendees. Go to section view the ceremony attendance
number.
Software Requirements Specification SRS
61
Software Requirements Specification SRS
7.3. CONCEPTUAL DIAGRAM
62
Contract CO4: Request For Transmit Result and Comment
Operation: Request For Transmit Result and Comment()Cross References: Use Cases: Transmit the grades with commentsPre-conditions:have completed the Log In use case.Post-conditions:
TC was associated with P (current Participator) (Association formed).
Contract CO2: Assigning Research To reviewer
Operation: Assigning ResearchToreviewer (int:Group#, String :RTitle)Cross References: Use Cases: Assign the research to the reviewerPre-conditions: the TC have complete log in and Reviewer Group was organized. Post-conditions:
RG was associated with the TC (Association formed). RG was associated with the Research instance R based on the specialty
(Association formed).
Contract CO5: Create Schedule
Operation: CreateSchedule ( String :Date , String :Time)Cross References: Use Cases: make schedule for presentation and ceremonyPre-conditions: None.Post-conditions:
A Presentation session instance PS was created (Instance creation). PS was associated with the TC (current TC) (Association formed). Attributes of PS were initialized (Attribute modification).
Contract CO6: Fill Schedule
Operation: FillSchedule (String :Rtitle, int : judgerG, int: room)Cross References: Use Cases: make schedule for presentation and ceremony Pre-conditions: Create Schedule transaction is underwayPost-conditions:
Software Requirements Specification SRS
7.3.1 CONTRACT
63
Contract CO1: Start Upload File
Operation: Startuploadfile (String :research, String :type)Cross References: Use Cases: UploadFilePre-conditions: The participator have complete log in. Post-conditions:
A Research instance RES was created (Instance creation). Attributes of RES were initialized (Attribute modification). R was associated with the participator (Association formed).
Contract CO3: Assigne Research Result
Operation: AssigneResearchResult(int: 1Cross References: Use Cases: Pre-conditions:Post-conditions:
Contract CO6: Fill Schedule
Operation: FillSchedule (String :Rtitle, int : judgerG, int: room)Cross References: Use Cases: make schedule for presentation and ceremony Pre-conditions: Create Schedule transaction is underwayPost-conditions:
Contract CO7: Inform About Time
Operation: InformAboutTime()Cross References: Use Cases: make schedule for presentation and ceremony Pre-conditions: Create Schedule transaction is underwayPost-conditions:
Judger group instance J was created (Instance creation). PS (current presentation session) was associated with the judger group J
(Association formed). PS (current presentation session) was associated with the participator P (Association
formed).
Contract CO8: Enter Grades
Operation: EnterGrade( int: 2Cross References: Pre-conditionsPost-conditions:
Attribute of G (current Grade) was modified G.2ndRound (Attribute modification). J(current Judger group) was associated with the G (Association formed).
Contract CO9: Trans and Save Grades
Operation: TransSaveGrades()Cross References: Use Cases: Enter GradesPre-conditions: Instance of grade G was created and 2st round attribute is already set.Post-conditions:
G (current Grade)was associated with the research M(current manuscript) (Association formed).
Software Requirements Specification SRS
64
Contract CO10 : View number of attendance
Operation: Viewnumberofattendance (int: symposiumNO )Cross References: Use Cases: View the symposium attendance numberPre-conditions: None Post-conditions:
SC (current SC)was associated with the PS (Association formed).
Contract CO11: Make Book
Operation: MakeBook (string: abstract, String: SName )Cross References: Use Cases: Collect the content of the abstractPre-conditions: None Post-conditions:
SC (current SC)was associated with the M (manuscript) . (Association formed).
Software Requirements Specification SRS
65
Software Requirements Specification SRS
6. GLOSSARY
SSS: Student Scientific Symposium.
TC: Technical Chair.
SC: Steering Chair.
Manuscript: It is the student research who gains grad above 70% after applying the reviewers' comments.
Abstract book: collection of the Manuscript.
66
Recommended