Example for SDS document in Software engineering

This is a example documentation of SDS (Software Design Specification). This will help you to get a brief idea about your final year project proposal.

1. Student Registration
System

Software Design Specification

2. 1 | P a g e




Table of Content


1. Introduction……………………………………………………………………………………………………………………… ……04

1.1 Purpose………………………………………………………………………………………………………… .…….……..04
1.2 Scope……………………………………………………………………………………………………………… .….…......04
1.3 Glossary…………………………………………………… ……………………………………………………… ..………..05
1.4 References……………………………………………………………………………………………………… ..…….......05
1.5 Overview…………………………… ……………………………………………………………………………….…… ….06

2. Architectural Design…………………………………………………………………………………………………… .………...06

2.1 High level component and their interaction………………………………………………… .……….06
2.1.1 Components……………………………………………………………………………………………… ..07
2.1.2 Interfaces…………………………………………………………………………………………………… ..08
2.2 Architectural Styles/patterns……………………………………………………………………… ….….……09
2.2.1 MVC architecture styles…………………………………………………………………... ….……....09
2.2.2 Three tier client server architecture………………………………………………... …………..09
2.2.3 Different process and their communications…………………………………... ………....10
2.3 Physical arrangement of devices and Communication & installed
software components on devices…………………………………………………………………………. .11
2.4 Design decisions applied whole application……………………………………………….…. ..…....13
2.4.1 Object oriented software development methods…………………………..…………. ..13
2.4.2 Three tier client server architecture……………………………………………..…. …….........13
2.4.3 MVC architectural patterns …………………………………………………………… ..….……....13

3. Component and Detail design……………………………………… …………………………………………..……. ….14

3.1 Design patterns and other design techniques used……………………………………… …..…..14
3.1.1 Abstract factory Pattern………………………………………………… …………………….…..… 14
3.1.2 Singleton Pattern…………………………………………………… ……………………… …….....…..14
3.1.3 Observer Pattern……………………………………………… ………………………… ………....…....14
3.1.4 Adapter Pattern…………………………………………… …………………………….……………..…15
3.1.5 Techniques used………………………………………………… ………………….…………...……....15
3.2 Class Diagram……………………………………… ……………………………………………. ……..……..…….16

3. 2 | P a g e





3.3 Sequence Diagram……………………………………………………………………… .……….…………..……17
3.3.1 Sequence Diagram 01: Login into the system. …………….….…………….…..……17
3.3.2 Sequence Diagram 02: Change user password……………..…….……...…………..18
3.3.3 Sequence Diagram 03: Add users……………………… …………….……...….……..……19
3.3.4 Sequence Diagram 04: Remove users……………………… ……....……………………..20
3.3.5 Sequence Diagram 05: Manage users………………………… .......……………………..21
3.3.6 Sequence Diagram 06: Edit profile information……………..………...……………..22
3.3.7 Sequence Diagram 07: Remove subjects from student's selection..……..…23
3.3.8 Sequence Diagram 08: Create new subjects……………………………… …..……….24
3.3.9 Sequence Diagram 09: Edit existing subjects……………………………… .…………25
3.3.10 Sequence Diagram 10: Delete subjects……………………………… ……….………..26
3.3.11 Sequence Diagram 11: Create new subject lists…………………………… .…......27
3.3.12 Sequence Diagram 12: Make adjustment of credits per subject…….…….28
3.3.13 Sequence Diagram 13: Subject combination tool……………………….………..29
3.3.14 Sequence Diagram 14: Publish time table……………………………… ….………...30
3.3.15 Sequence Diagram 15: Update time table………………………………….…………31
3.3.16 Sequence Diagram 16: Current subjects by subject vice………………………32
3.3.17 Sequence Diagram 17: Past subject selections by subject vice…………….33
3.3.18 Sequence Diagram 18: View the past, present subject selections of a
student………………………………… ………………………… 34
3.3.19 Sequence Diagram 19: Edit student's profile……………………………… ………..35
3.3.20 Sequence Diagram 20: Select subjects……………………………… …………………36
3.3.21 Sequence Diagram 21: Remove subjects from the list…………………………37
3.3.22 Sequence Diagram 22: Save………………………………………………………………… 38
3.3.23 Sequence Diagram 23: View previous semester information……………….39
3.3.24 Sequence Diagram 24: View Notices……………………………… ……………………39
3.3.25 Sequence Diagram 25: Guest view of the student's profile………………….40
3.3.26 Sequence Diagram 26: Super user confirmation……………………………… ….41
3.3.27 Sequence Diagram 27: Access Control Matrix……………………………… ………42

3.4 Algorithm Design………………………………………………………………………………………………… …43
3.5 Database Design…………………………………………………………………………………………………… .51
3.5.1 Relational Model……………………………………………………………………….………………. ..51
3.5.2 Normalization/DE normalization…………………………………………………… .…………..52
3.5.2.1 Anomalies………………………………………………………………………………… .…..52
3.5.2.2 Normalization in our systems………………………………………………… .…….53
3.5.3 Data Types Identification…………………………………………………………………… .………54
3.5.3.1 Indexes………………………………………………………………………………… .……….54
3.5.6 Triggers………………………………………………………………………………………………… .……58

4. 3 | P a g e





3.6 User interface design……………………………………………………………………………………… .……..59
3.6.1 Rules and guidelines for user interface designing……………………………………… .59
3.6.1.1 User input validation methods……………………………………………… .……...59
3.6.1.2 Guidelines for error messages, warnings and tips……………….…...…...60
3.6.1.3 Guideline for interface designing……………………………………………… .....61
3.6.1.4 Guidelines for error messages warnings and tips………………….…..…..64
3.6.2 User interface for each use case……………………………………………………… ....….…...65
Interface 1 : Login into the system…………………………………… ..…..……………..65
Interface 2 : Change user password………………………………… ..…..………………66
Interface 3 : Add users…………………………………………………… ..…..…………….….67
Interface 4 : Remove users………………………………………………… ..…..…………….68
Interface 5 : Manage users……………………………………………… ..…..……...……....69
Interface 6 : Edit profile information……………………………… ..…..………………..70
Interface 7 : Remove selected subjects from student's selections....…......71
Interface 8 : Create new subjects………………………………………………… .…..……72
Interface 9 : Edit existing subjects………………………………………… ..….………….73
Interface 10 : Delete subjects………………………………………… ………..…..…………..74
Interface 11 : Create new subject lists…………………………………… ..…..…………..75
Interface 12 : Make adjustment of credits per subject…………..…..…………….76
Interface 13 : Subject combination tool ……………………………… ..…..…………….77
Interface 14 : Publish time table………………………………………………… ..…..……...78
Interface 15 : Update time table……………………………………………………… ..….....79
Interface 16 : Current subjects by subject vice…………………………… ..…..……..80
Interface 17 : Past subject selections by subject vice…………………..…..………81
Interface 18 : View past & present subject selections of a student…..…..…82
Interface 19 : Edit student's profile…………………………………………… ..……..…….83
Interface 20 : Select subjects……………………………………………… .…………..………84
Interface 21 : Remove subjects from the list……………………………… .………..…85
Interface 22 : Save……………………………………………………………………… .………..…86
Interface 23 : View previous semester information……………………..………..…86
Interface 24 : View Notices……………………………………… .……………………… .…….87
Interface 25 : Guest view of the student's profile……….……………………… .…..88
Interface 26 : Super user confirmation………………………… .…………………….…..89
Interface 27 : Access Control Matrix……………………………… .……………………....90

5. 4 | P a g e




1. Introduction


1.1 Purpose


This software design specification is made with the purpose of outlining the software architecture and
design of the Student Registration System in detail. The document will provide developers an insight
in meeting client’s needs efficiently and effectively. Moreover the document facilitates communication
and understanding of the system by providing several views of the system design.


1.2 Scope


The Software design document would demonstrate how the design will accomplish the functional and
non- functional requirements captured in the Software Requirement specification (SRS). The docu-
ment will provide a framework to the programmers through describing the high level components
and architecture, sub systems, interfaces, database design and algorithm design. This is achieved
through the use of architectural patterns, design patterns, sequence diagrams, class diagrams, rela-
tional models and user interfaces.


1.3 Intended audience


This document is mainly for the developers and the technical and academic staff of Rajarata university
of Sri Lanka and student representatives of the University.

6. 5 | P a g e




1.4 Glossary



Term Description
Algorithm Design Specific method to create a mathematical process in solving
problems
Architectural Design Establishing the overall structure of software system
AS Applied Science
Compatible Capable of orderly efficient integration and operation with
other elements in a System with no modification
Database A collection of stored related data
Encapsulate To express or show the most important facts about something.
ER diagram Entity Relationship Diagram; Data model for describing a data
base in an abstract way
HPT Health Promotion Technology
ICT Information & Communication Technology
Instantiate To represent (an abstract concept) by a concrete or tangible
SDS System Design Specification
Sequence Diagram An interaction diagram that shows how process interact with
one another and in what order
SRS Software Requirements Specification




1.5 References



 Software Requirements Specification (SRS) of the Student Registration System
 Golden rules of user interface design by Theo Mandel
 Internet

7. 6 | P a g e



1.6 Document Overview


The next chapter of the document has described architectural design of the Student Registration Sys-
tem. The high level components and their interactions, suitable architectural patterns, physical ar-
rangement of components and design decisions applied to the whole system.

The 3
rd
and final chapter of the System Design Specification is on Component and detailed design.
Includes design patterns, sequence diagrams, class diagrams, database design in detail and user in-
terface design with screen shots of the interfaces.

8. 7 | P a g e



2. Architectural Design


2.1 High level components and interfaces


2.1.1 Components


 Student component

This is one of the key components of the Student Registration System. This is where the student
subject selection option is implemented. This also includes the result preview, semester preview and
profile functions.

 Authentication and user management component

This is the major sub system that is responsible for the security of the Student Registration system. It
authenticate users and also handles the user management activities such as creating new user ac-
counts, removing accounts from the system etc. Furthermore this component Implements the “control
access privilege matrix”.

 Subject component

This is the key component that implements the functions related to the subject operations of admin-
istrator such as adding a new subject, editing credits of an existing subject and removing subjects etc.
Subject component is also responsible for displaying the available subject list for every semester.



 Publish component

Publish component is the component responsible for publishing notices created by the administrator
and also the time tables. This component has the ability to publish multiple notices and time tables
at the same time.

 Public component

This is a relatively small subsystem compared to the other components of the Student Registration
System. This is the component which is responsible for the guest viewer (public) to view student re-
sults.

9. 8 | P a g e




2.1.2 Interfaces

Student component

studentSelectSubjects: This interface will provide the available subject list for the semester. This
allows the student to choose the subjects, hence a busy interface. This
interface is the bridge between the student component and the subject
component.
studentProfile: This interface is used for the student to view and edit personnel infor-
mation.

Authentication and user management component

authenticateUser: This is the interface that allows the users to login to the system. This will
guide the user to the relevant home page.

Subject component

newSubject: This interface is where administrator adds new subjects to the courses
offered. The Subject and student components are connected.
editSubject: In this interface the administrator edit existing subjects. The Subject and
student components are connected.

Publish component

Getnotice: This is the interface where the notifications are published. It is connected
with the subject component
Gettimetable: This is the interface where the time table is published. This is connected
with the subject component.

Public component

viewResults: This is the interface which shows the results of a student to a Guest user,
therefore connected with the Student component.

10. 9 | P a g e



2.2 Architectural Styles / Patterns


The Student Registration System will be developed under two main architectural styles/ patterns. De-
velopment of the project will be done in MVC architectural style and also 3 tier Client/Server Archi-
tecture. Client can browse the internet and access the Student Registration System provided within
the local area network of the University.


2.2.1 MVC Architecture Style (Model – View – Controller)


MVC Style separates presentation and interaction from the system data. The system is structured into
three logical components that interact with each other.

 The Model component -Manages the system data and associated operations on that data.
 The View component- Defines and manages how the data is presented to the user.
 The Controller component- Manages user interaction and passes these interactions to the View
and the Model. .

We will use this MVC Style for the Student Registration System because, there are multiple ways to
view and interact with data. Also used when the future requirements for interaction and presentation
of data are unknown. In some software systems the code between the process logic and interface are
mixed. This will reduce the modularity of application and make the system more difficult to maintain.
To avoid this problem we have decided to use MVC architectural style to separate the application
logic with the interface. The main advantage of this is style allows the data to change independently
of its representation and vice versa. Support presentation of the same data in different ways with
changes made in one representation shown all of them.


2.2.2 Three-Tier Client Server Architecture


In a client server architecture, the functionality of the system is organized into services, with each
service delivered from separate server. Clients are users of these services and access servers to make
use of them.
We will use this 3- Tier Client Server Architecture because, when data in a shared database has to be
accessed from a range of locations. Because servers can be replicated, may also be used when the
load on a system is a variable.

11. 10 | P a g e




 Data Tire

The data tire maintains the applications data such as Users’ data , Departments’ data , subjects’
data , courses’ data , time tables’ data and the SQL queries . It stores these data in a relational
database management system (RDBMS). All the connections with the RDBMS are managed in
this tier.

 Middle Tire

The middle tier ( web / application server ) implements the business logic , controller logic and
presentation logic to control the interaction between the applications’ clients and data. Business
rules enforced by the business logic dictate how clients and cannot access application data
and how applications process data.

 Client Tire

The client tire is the applications user interface connecting data entry forms and client side
applications. It displays data to the user. User interact directly with the application through user inter-
face. The client tier interacts with the web/ application server to make requests and to retrieve
data from the database. It then displays to the user the data retrieved from the server.

Example of the 3-tier architecture in the Student Registration System

If a student needs to view his current semester subject combination, first he has to login to the system.
Then he has to click “User” option, after he has to login “Summary” option. Then system will display
the information. In this process, Login screen, users’ main screen and Subject combination summary
screen are defined into the Client tier, data for login information and profile information and SQL
queries for those information are maintained into the Data tier and controller logic for login process
and loading profile information from the database are defined in Middle tier.


2.2.3 Different process and their communication

In the Student Registration System, there are number of different processes, such as database server
process, web server process, connections between above servers likewise. When sending mails there
should run a mail server. HTTP protocol is using to communicate with web servers, SMTP protocol is
using to communicate with mail servers. They should communicate each other well to perform the
functions of whole application.

12. 11 | P a g e



2.3 Physical arrangement of devices and Communication and installed software
Components on devices.




The Student Registration System deals mainly with hardware devices and installed software compo-
nents on devices. The System performs many tasks. It consists of web based system used by Super
Users, Administrators and Students of the university. The system helps to record students’ personal
details, publish time table, preview student result, select subjects for the semester. Therefore the web
based part is expected to run on various operating system platforms. The client server architecture of
the system requires to remotely connecting with client and server through the internet connection.
The system has two nodes such as the Web server and Clients. The nodes can represent specific in-
stances (workstations) or a class of computers (web server), which is a virtual machine. The applica-
tions of the system will run on the web server connected to the database server.

Internet is the worldwide interconnection of all smart communication devices that have a valid IP.
There should be installed browser software to access internet. If the user accesses the system, directly
through the internet connection the user has to install dongle or modem or relevant device and Wi-
Fi or etc… to connect with the system. If the user accesses the system through the intranet connection,
the server should install the relevant software. Most of intranet accessing modes refer to the website
of the organization which can only be accessed by its employees who have a user name and password.
So, considering that type of security purposes, it is better to access this Student Registration through
the intranet, but it should be accessed through the internet directly also.

When generating reports such as students’ result and subjects details there should be installed the
crystal report software. And also to print the generated reports the user machine should be installed
the software relevant to its connected printer.

13. 12 | P a g e



Physical arrangement of devices in a typical network.

In this diagram , it shows that , the only software a client need is to access this system is a browser.








Arrangement of devices and serves

Our University Student Management System needs some specific set of servers and devices. Such as:
Server to host web applications and web service applications.
Database server to store and manage data.
Personal computer, note book, smart phone etc… to access the website.
Modem/ router/ switch/ hub/ Wi-Fi network/ cable network etc… and also need an Internet
Service Provider to have the internet connectivity.

14. 13 | P a g e



Communication among components

Above devices are communicating with each other. Personal computer communicates with web server
and the database server through HTTP protocol. It communicates with mail server through SMTP
protocol. Cable network or Wi-Fi network is also a communication method using in connecting dif-
ferent network components.



2.4 Design decisions applied whole application


2.4.1 Object oriented software development methods


Reasons:
 Improved software maintainability.
 Faster development
 Lower cost development
 Improved software development productivity
 Higher quality software


2.4.2 Three-Tier Client Server Architecture


Reasons:
 As more users access the system a three-tier solution is more scalable than the other
solutions because you can add as many middle tiers as needed to ensure good
performance.
 Security is also the best in the three-tier architecture because the middle layer protects
the database tier.

2.4.3 MVC Architectural Pattern


Reasons:
 It should interact with other machines or users effectively.
 For more efficient interaction system should have flexible interfaces.
 MVC can be taken as for a popular and easy to handle web application development
style that has the feature of separating the presentation, Business & intermediate logics.
 Ease to coding and provide well defined interfaces within each logic.

15. 14 | P a g e





3. Component and Detailed Design

3.1 Design Patterns and Techniques used

3.1.1 Abstract factory Pattern

Abstract factory pattern is creational design pattern that provides a way to encapsulate a group of
individual factories that have a common theme without specifying their concrete classes. Abstract
factory pattern offers the interface for creating a family of related objects without explicitly specifying
their classes.

Applications:
The design pattern will be applied in creating different user accounts which are the different factories.
It will also be used to keep the system


3.1.2 Singleton Pattern

This is a creational design pattern and is one of the simplest patterns in the field of software engi-
neering. It involves only one class which is responsible to instantiate itself, so that it creates no more
than one instance. The singleton pattern is useful when access to limited resource needs to be con-
trolled.

Applications:
In the student registration system this pattern will be used for database manager.

3.1.3 Observer Pattern

The observer pattern is a behavioral pattern which defines a one-to-many dependency between
objects where a state change in one object results with all its dependents being notified and updated
automatically. This pattern may be used in all situations where more than one display format for state
information is required and where it is not necessary for the object that maintains the state
information to know about the specific display formats used.

Applications:
Observer pattern will be used in the Student Registration system for the operations of the system
users.

16. 15 | P a g e



3.1.4 Adapter Pattern


The adapter pattern is a structural pattern that translates one interface for a class to a compatible
interface. This will convert the interface of a class in to another interface that the user expects. Adapter
gives the opportunity for the classes with incompatible interfaces to work together.

Application:
This pattern will be used in the Student Registration system when displaying information from the
database.


3.1.5 Techniques Used


Prototyping

In designing the Student registration System prototyping will be used to demonstrate underpinning
concepts of the designing and for user interfaces. This technique will provide the opportunity for the
system users to experiment the software to a certain extent during the development process.

17. 16 | P a g e



3.2 Class diagram

18. 17 | P a g e



3.3 Sequence diagrams


3.3.1 Sequence diagram 1: Login into the system

19. 18 | P a g e



3.3.2 Sequence diagram 2 : Change user password

20. 19 | P a g e



3.3.3 Sequence diagram 3: Add users

21. 20 | P a g e



3.3.4 Sequence diagram 4: Remove users

22. 21 | P a g e




3.3.5 Sequence diagram 5: Manage users

23. 22 | P a g e




3.3.6 Sequence diagram 6: Edit profile information

24. 23 | P a g e



3.3.7 Sequence diagram 7: Remove selected subjects from student's selections

25. 24 | P a g e



3.3.8 Sequence diagram 8: Create new subjects

26. 25 | P a g e



3.3.9 Sequence diagram 9: Edit existing subjects

27. 26 | P a g e




3.3.10 Sequence diagram 10: Delete subjects

28. 27 | P a g e




3.3.11 Sequence diagram 11: Create new subject lists

29. 28 | P a g e



3.3.12 Sequence diagram 12: Make adjustment of credits per subject.

30. 29 | P a g e




3.3.13 Sequence diagram 13: Subject combination tool

31. 30 | P a g e



3.3.14 Sequence diagram 14: Publish time table

32. 31 | P a g e




3.3.15 Sequence diagram 15: Update time table

33. 32 | P a g e




3.3.16 Sequence diagram 16: Current subjects by subject vice

34. 33 | P a g e





3.3.17 Sequence diagram 17: Past subject selections by subject vice

35. 34 | P a g e




3.3.18 Sequence diagram 18: View the past & present subject selections of a student

36. 35 | P a g e




3.3.19 Sequence diagram 19: Edit student's profile

37. 36 | P a g e




3.3.20 Sequence diagram 20: Select subjects

38. 37 | P a g e



3.3.21 Sequence diagram 21: Remove subjects from the list

39. 38 | P a g e



3.3.22 Sequence diagram 22: Save

40. 39 | P a g e




3.3.23 Sequence diagram 23: View previous semester information









3.3.24 Sequence diagram 24: View Notices

41. 40 | P a g e



3.3.25 Sequence diagram 25: Guest view of the student's profile

42. 41 | P a g e




3.3.26 Sequence diagram 26: Super user confirmation

43. 42 | P a g e





3.3.27 Sequence diagram 27: Access Control Matrix

44. 43 | P a g e




3.4 Algorithm Design


Login

1. Get Username and Password
2. If user name is equal to the entered Username & the password is equal to the entered
Password
3. Then login successful
4. Else login failed
5. End If.

Get Username Get Password
IF FILE EXIST THEN
READ Password FROM FILE
IF FILE. Password == Entered Password
Login successful
ELSE
PRINT “incorrect Username or password “
END IF
ELSE
PRINT “incorrect Username or password “
END IF


Student - Edit Profile

1. Student login to account
2. Select student personal details option
While Edit Profile
{
Add details
Remove details
}
Save changes
EXIT

45. 44 | P a g e



Student - View Previous Semesters Information

1. Student login account
2. Select exam details option
3. Then view previous semester result preview
4. EXIT


Student select & remove subjects

1. Student login account
2. Select student subject option
3. Select academic year and the semester
4. Then user selects subject from the appeared list as preferred
IF wrong selection
Remove Subjects
ENDIF
Confirm selections
EXIT

Guest - Student Performance Preview

1. Guest login account
2. Enter relevant Index number and Password
3. IF Index number is equal to the entered Index number and the Password is equal to
entered Password
4. Then preview student performance
5. ELSE Print incorrect password or index
6. Back to step 2
7. EXIT

46. 45 | P a g e




Administrator - Subject Operation


1. Admin login to account
2. Select admin selection option
3. Then go to subject managing tool



IF required privileges given
{
Select relevant course, year, and the semester
While {
Viewing relevant subject information
Edit Subject
Remove Subject
}
Select update information
}
ELSE
Print privileges not given
EXIT

47. 46 | P a g e



Administrator Account Operations


1. Admin login to account
2. Select login management tool


IF required privileges
{
IF exiting account
{
IF select remove user
{
Confirm
}
ELSE select Manage User
}
IF Suspend account
{
Enter relevant details
Confirm
}
ELSE

{
Select login Issuing Tool
Select stream and year

Enter default and unique option details
Create account
}
}
ELSE
Print “Required Privileges not given “
EXIT

48. 47 | P a g e




Administrator - Time Table Publishing


1. Admin login account
2. Select admin selection option

IF required privileges given
{
Then go to Time Table Preview page
Select course name, academic year and semester
View relevant time table
IF already
Exit a time table
Then update as admin prefer
ELSE
Create new time table
}
ELSE
Print “Required Privileges not given”
EXIT

49. 48 | P a g e



Administrator - View Student Choices


1. Admin login to account
2. Select admin selection option


IF Required privileges given
{
Then go to student choices page
Enter relevant index number and registration number
IF change subjects
{
Edit subject choices
Save
}
ELSE
{View past and present subjects}
}
ELSE
{Print “Privileges not given”}
EXIT

50. 49 | P a g e



Administrator - View Users’ Profile


1. Admin login to account
2. Select login management option

IF required privileges given
{
Enter user’s registration number
View users profile
}
ELSE
{
Print “Privileges not given”
}
EXIT




Super User privilege Access Control Matrix


1. Super user login to system
2. Select privilege access control matrix

IF select edit
{
Edit privileges
Save changes
}
ELSE
Selected view matrix
EXIT

51. 50 | P a g e




Super user - Account Operation


1. Super user login to system
2. Select account operations

IF select remove user
{
Enter user type
Enter relevant ID or Registration number
Go to relevant user profile
Confirm removal
}
ELSE select add user
{
Select user type
Enter details
Create account
}
EXIT

52. 51 | P a g e




3.5 Database design


3.5.1 Relational model

53. 52 | P a g e




3.5.2 Normalization / DE normalization


Database normalization is the process of organizing the fields and tables of a relational database to
minimize data redundancy and dependency. Normalization usually involves dividing a database into
two or more tables and defining relationships between the tables. The objective is to isolate data so
that additions, deletions, and modifications of a field can be made in just one table and then
propagated through the rest of the database via the defined relationships.

There are three main normal forms, each with increasing levels of normalization:

 First Normal Form (1NF): Each field in a table contains different information. For example, in a
Student list, each table would contain only one email field.

 Second Normal Form (2NF): Each field in a table that is not a determiner of the contents of
another field must itself be a function of the other fields in the table.

 Third Normal Form (3NF): No duplicate information is permitted. So, for example, if two tables
both require an email field, the email information would be separated into a separate table,
and the two other tables would then access the email information via a password field in the
student table. Any change to a email would automatically be reflect in all tables that link to the
student table.

3.5.2.1 Anomalies


When there are too many attributes it is called as anomalies.

For example,

STUDENT (Reg-no,Index no,Fname,Lname,Mobile,Dept-name,Course name,Password,E-mail)

There are basically three types of anomalies.

1. Deletion anomalies – Deletion anomalies occur when we delete data from flawed schema.
2. Insertion anomalies – Insertion anomalies are occur when we try to insert data into flawed
Table.
3. Update anomalies – Update anomalies occur when we change data in a flawed schema.

54. 53 | P a g e




3.5.2.2 Normalization in our System



In this table it is satisfied requirements which should have for the first normalization. In second
Normalization tables have changed as following.

Subject table has normalized in two tables as “subject” and “subject-credits”.

 Subject (sub-code, Sub-name)
 Subject-credits (Sub-code,Semester,Year,Credit)

Student table has normalized in to three tables as “Student”, “Student-course name” and “student
year”.

 Student (Reg-no,Index-no,Fname,Lname,Mobile)
 Student-year (Reg-no,Course name,Password,Email,User name)
 Student-year (Index-no,Sem-no,Year)

Result preview tabel has normalized in to two tables as “Result preview” and “Result total GPA” .

 Result preview (Reg-no,Index-no,Course code,Name,Sub-Name)
 Result total GPA (Reg-no,Results,Credits,Total GPA)

Likewise we can normalizing our tables into sub tables. One table divide into several tables. For the
third normalization also requirements have satisfied. There for now all the tables have satisfied the
requirements in First, Second, and third normalization.

55. 54 | P a g e



3.5.3 Data Types Identification


3.5.3.1 Indexes

















Course
Field Data type Size on disk
Course Name Varchar(50) 50 bytes
Dept-name Varchar(100) 100 bytes




Student
Field Data type Size on disk
Reg-no Int(20) 4 bytes
Index-no Int(20) 4 bytes
Fname Varchar(50) 50 bytes
Lname Varchar(50) 50 bytes
Mobile Varchar(20) 20 bytes
Dept-name Varchar(20) 20 bytes
Course name Varchar(20) 20 bytes
Password Varchar(20) 20 bytes
E-mail Varchar(20) 20 bytes
Name Varchar(20) 20 bytes
Sem-no Varchar(20) 20 bytes
Year Varchar(20) 20 bytes




Result preview
Field Data type Size of Disk
Reg-no Int(11) 4 bytes
Index no Int(11) 4 bytes
Course code Varchar(50) 50 bytes
Name Varchar(200) 200 bytes
Sub- name Varchar(200) 200 bytes
Result Varchar(50) 50 bytes
Credits Varchar(50) 50 bytes
Total GPA Varchar(50) 50 bytes

56. 55 | P a g e






Subject
Field Data type Size on disk
Code Varchar (20) 20 bytes
Semester Varchar (20) 20 bytes
Year Varchar (20) 20 bytes
Credit Varchar (20) 20 bytes
Subject Name Varchar (20) 20 bytes



Important days
Field Data type Size on Disk
Sem-no Varchar(20) 20 byes
Year Varchar(20) 20 bytes
Sub name Varchar(20) 20 bytes
End date Date
Start date Date
Exam date Date



Compulsory
Field Data type Size On Disk
Subject name Varchar(20) 20 bytes
Credit Varchar(20) 20 bytes
Code Varchar(20) 20 bytes
Year Varchar(20) 20 bytes
Semester Varchar(20) 20 bytes



Optional
Field Data type Size On Disk
Subject name Varchar(20) 20 bytes
Credit Varchar(20) 20 bytes
Code Varchar(20) 20 bytes
Year Varchar(20) 20 bytes
Semester Varchar(20) 20 bytes

57. 56 | P a g e




Notices
Field Data type Size On Disk
Notice-Id Int(20) 4 bytes
Title Varchar(100) 100 bytes
Beginning date Date
Author Varchar(50) 50 bytes
Ending date Date
Description Varchar(500) 500 bytes
Admin-Id Int(20) 4 bytes



Include
Field Data type Size On Disk
Course name Varchar(20) 20 bytes
Code Varchar(20) 20 bytes



Current Semester
Field Data type Size On Disk
Sem-no Varchar(50) 50 bytes
Year Varchar(50) 50 bytes
Sub name Varchar(50) 50 bytes


Current Semester
Field Data type Size On Disk
Sem-no Varchar(50) 50 bytes
Year Varchar(50) 50 bytes
Sub name Varchar(50) 50 bytes

Admin
Field Data type Size On Disk
Admin-ID Int(20) 4 bytes
Admin level Varchar(50) 20 bytes

Department
Field Data type Size On Disk
Department-name Varchar(20) 20 bytes

58. 57 | P a g e





Time table
Field Data type Size On Disk
Day Varchar(20) 20 bytes
Subject name Varchar(20) 20 bytes
Course name Varchar(20) 20 bytes
Code Varchar(20) 20 bytes
Time Varchar(20) 20 bytes
Admin-Id Int(20) 4 bytes



Subject list
Field Data type Size On Disk
Subject name Varchar(50) 50 bytes
Course code Varchar(20) 20 bytes
Admin-ID Int(20) 4 bytes



























Control matrix
Field Data type Size On Disk
Admin-ID Int(20) 4 bytes
Name Varchar(50) 50 bytes
Add users Boolean
Remove users Boolean
Manage users Boolean
View users Profile Boolean
Remove selected subject
from selection
Boolean
Create new subjects Boolean
Edit existing subjects Boolean
Delete subjects Boolean
Create new subject lists Boolean
Make adjustments of no of
credits
Boolean
Subject combination tool Boolean
Time table management Boolean
Create time table Boolean
Update time table Boolean
View student choices Boolean

59. 58 | P a g e




3.5.6 Triggers


In a DBMS, a trigger is a SQL procedure that initiates an action when an event (INSERT, DELETE or
UPDATE) occurs .The SQL CREATE TRIGGER statement provides a way for the database management
system to actively control, monitor, and manage a group of tables whenever an insert, update, or
delete operation is performed. The statements specified in the SQL trigger are executed each time an
SQL insert, update, or delete operation is performed. An SQL trigger may call stored procedures or
user-defined functions to perform additional processing when the trigger is executed.

The CREATE TRIGGER statement defines a trigger at the current server.


Ex:

CREATE TRIGGER fname_trigger
BEFORE UPDATE ON student_table
REFERENCING NEW ROW AS n, OLD ROW AS o
FOR EACH ROW
IF n.fname <> o.fname THEN

END IF;

60. 59 | P a g e



3.6 User interface designing

3.6.1 Rules and guidelines for user interface designing

3.6.1.1 User input validation methods


This system will use java script for basic form validations. But for further validations functions we use
php. Using php greatly increases security and usability.

JavaScript will detect empty fields of a form, and php will be used to determine whether inputs are
met some per-defined rules to insure only desired inputs are stored in the database. Detecting and
avoid accepting erroneous inputs before storing in the database, will make system more efficient.

E.g.

Rules to make sure user enters a correct E-mail address:

1. Input e-mail address must contain a @ sign and at least one dot (.)
2. Also, the @ must not be the first character of the email address, and the last dot must be
present after the @ sign and minimum 2 characters before the end.Php will be used to
ensure that these rules are met, while entering an E-mail address.

Few instances we hope to use validations

1. On all text inputs, check boxes to ensure user fill all the required fields.
2. E-mail address validations (mentioned above)
3. Input date validation, to make sure entered date is not likely to be an unacceptable one.

61. 60 | P a g e





3.6.1.2 Guideline for error messages, warnings & supportive information.

System will use simple but informative error messages to inform user what is wrong with a certain
operation. The type of the error will be stated top of the error message, enabling user to
understand quickly what caused the problem.






Warnings will contain the same characteristics of Error messages but will clearly display the type of
it. Occupationally system will display some useful tips and trick for the user. This will reduce user's
time to figure out everything on their own.

62. 61 | P a g e



A tips will look like Warning.




3.6.1.3 Guideline for Interface designing.



1. Allow users to use either the keyboard or mouse (flexible)

Users will be able enter data and navigate using any method, either keyboard or mouse.
(Scrolling, Selecting)

2. Allow users to change focus (interruptible)

Users will open several windows once but focus working on only one interface. This
will open different interfaces in different web browser tabs, making it easier to change
among tasks. (Navigation will be convenient)

3. Display descriptive messages and text (Helpful)

Tool tips will be displayed to help users to understand further what important oper-
ations and buttons do. User will be able to view them when mouse hover above the
relevant texts, buttons.

4. Provide immediate and reversible actions, and feedback (forgiving)

Most of the time users will be given help to revise their selections in the same inter-
face where they make changes.
E.g. there will be options to remove subjects on the interface where users select their
subject list, making it easier to do changes quickly.

63. 62 | P a g e



5. Provide meaningful paths and exits (navigable)

Finding a relevant interface and exiting from it should be easy and sensible. Opera-
tions should be able to understand without much technical knowledge for all users.
Users should be able to guess where to find certain interfaces without complex pro-
cedures.

6. Accommodate users with different skill levels (accessible)

System will be used by users with many skill levels. And all of them should be able
get their job done without specific technical support. This system will be designed
with simple interfaces, easy to understand operations and many tool tips. And occa-
sional warnings will be displayed if the users is likely to do a risky operations to aware
the user about its danger.


E.g. Users will be displayed warnings when they choose to delete a subject from database or if a
student choose to remove a subject and it makes some issue.es. (Not covered an enough credit level)








7. Principals that make the user interface consistent

a. Sustain the context of users’ tasks (continuity)

Users will be provided points of reference as they navigate through a product
interface. Window titles, navigation maps and trees, and other visual aids give
users an immediate, dynamic view of where they are and where they’ve been.

64. 63 | P a g e



b. Maintain consistency within and across products (experience)

One of the most important aspects of the interface is to enable users to learn
general concepts about system and products and then apply what they’ve
learned to new situations in different programs or different parts of the system.
Consistency in behavior means that the way an object works is the same eve-
rywhere.


c. Keep interaction results the same (expectations)

Interaction technique consistency is also important. The same shortcut keys
should work in similar programs. Consistency in interface behavior is very im-
portant. If users experience different results from the same action, they tend to
question their own behavior rather than the product’s behavior.


d. Provide aesthetic appeal and integrity (attitude)

The software interfaces will be clean and professional looking but also it will
not contain any high resource consuming visual effects and tricks. Because as
we hope to implement this on a campus server, we try to use minimal resources
as much as possible. Otherwise when there are many students are logged into
the system, it will not be able to handle all user requests.


e. Encourage exploration (predictable)

Interface will be clean and user friendly as described above, but we try to
make all the interfaces and options more predictable and user finds it is fun
to use the software as it is a simple. User should be tempted to use new fea-
tures and explore them, as there are no use of being quiet.

65. 64 | P a g e




3.6.1.4 Guideline for error messages, warnings & supportive information.


We use simple but informative error messages to inform user what is wrong with a certain operation.
The type of the error will be stated top of the error message, enabling user to understand quickly
what caused the problem.


















( Reference: Golden rules of user interface design by Theo Mandel )

66. 65 | P a g e




3.6.2 User interfaces for each use case



Use case 01 : Login into the system.

67. 66 | P a g e




Use case 02 : Change user password

68. 67 | P a g e



Use case 03 : Add users

69. 68 | P a g e



Use case 04 : Remove users

70. 69 | P a g e



Use case 05 : Manage users

71. 70 | P a g e



Use case 06 : Edit profile information

72. 71 | P a g e



Use case 07 : Remove selected subjects from student's selections

73. 72 | P a g e



Use case 08 : Create new subjects

74. 73 | P a g e




Use case 09 : Edit existing subjects

75. 74 | P a g e




Use case 10 : Delete subjects

76. 75 | P a g e





Use case 11 : Create new subject lists

77. 76 | P a g e




Use case 12 : Make adjustment of credits per subject.

78. 77 | P a g e




Use case 13 : Subject combination tool

79. 78 | P a g e




Use case 14 : Publish time table

80. 79 | P a g e




Use case 15 : Update time table

81. 80 | P a g e




Use case 16 : Current subjects by subject vice

82. 81 | P a g e




Use case 17 : Past subject selections by subject vice

83. 82 | P a g e




Use case 18 : View the past and present subject selections of a student

84. 83 | P a g e




Usecase19 : Edit student's profile

85. 84 | P a g e



Use case 20 : Select subjects

86. 85 | P a g e




Use case 21 : Remove subjects from the list

87. 86 | P a g e


Use case 22 : Save

This use case is for save document details on server.


Use case 23 : View previous semester information

88. 87 | P a g e



Use case 24 : View Notices

89. 88 | P a g e




Use case 25 : Guest view of the student's profile

90. 89 | P a g e




Use case 26 : Super user confirmation

91. 90 | P a g e




Use case 27 : Access Control Matrix

92. 91 | P a g e





Team name : Humming Bird
Team leader : W.D.R.Y. Jayasundara

Members :


Y.M.Y.T.K Yaparatne ICT/10/11/050 2687
K.Gunawardana ICT/10/11/008 2640
K.A.D.C.P. Kaluarachchi ICT/10/11/057 2650
S.D. Thrimawithana ICT/10/11/032 2675
W.D.R.Y. Jayasundara ICT/10/11/013 2648