30
1 SCK1233/SCJ1203 SOFTWARE DESIGN DOCUMENT SECTION 2 Group Members: 1. Mary Anne A/P A.X.Arputharaj 2. Mohd Hazman Bin Arif 3. Mohamad Fazlan Ismail Bin Abdul Rahman 4. Mohamad Yunus Bin Mohd Merah

Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

  • Upload
    others

  • View
    0

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

1

SSCCKK11223333//SSCCJJ11220033

SSOOFFTTWWAARREE DDEESSIIGGNN DDOOCCUUMMEENNTT

SECTION 2

Group Members:

1. Mary Anne A/P A.X.Arputharaj

2. Mohd Hazman Bin Arif

3. Mohamad Fazlan Ismail Bin Abdul Rahman

4. Mohamad Yunus Bin Mohd Merah

Page 2: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

2

TABLE OF CONTENT

1. INTRODUCTION 3

1.1 Purpose 3

1.2 Scope 3

1.3 Overview 3-4

1.4 Definitions, Acronyms and Abbreviation 4

2. SYSTEM OVERVIEW 5

3. SYSTEM ARCHITECTURE 5

3.1 Architecture Design Decision 5

3.2 Decomposition Description 6-7

3.3 Design Rationale 8

4. DATA DESIGN 9

4.1 Data Description 9

4.2 Data Dictionary 10

5. COMPONENT DESIGN 11

5.1 Use Case 11

5.2 Sequence Diagram 12

5.2.1 Sequence Diagram : Student Log In 12

5.2.2 Sequence Diagram : Staff Log In 13

5.3 Class Diagram 14

5.4 State Diagram 15

6. User Interface Design 16

6.1 Overview of User Interview 16

6.2 Screen Image 17-28

7. REQUIREMENT MATRIX 29

7.1 Traceability Diagram 29

7.2 Requirement Matrix - Table 30

8. Reference 30

Page 3: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

3

1. INTRODUCTION

1.1 Purpose

This SRS will discuss more about the functions and constraints of newly suggested system

additional function of KTGB hostel management system, developed at the Kolej Tun Ghafar

Baba, Universiti Teknologi Malaysia, Skudai. The expected audiences of this document are our

lecturer Pn Shahliza. It will also help us, the group members, to maintain focus throughout the

course of the project.

1.2 Scope

KTGB hostel management system (KTGB HMS) is a system that will provide hostel registration

system for student and update the student information to the hostel management which is the

staff of the collage. The system will also have some added a feature which is a new marking

scheme to get the principal quota which is MERIT marking. By using the MERIT marking, the

students easily to view their detail information of the activity that have been they participated.

The objective of the system is the management able to update the student information. The staff

in KTGB hostel can easily manage and use the system. The students able to view their activity

information by using MERIT marking. At the end of the month the system will generate a full

report of the registered students in the hostel.

1.3 Overview

Located on the north side Universiti Teknologi Malaysia (UTM), College of Tun Ghafar Baba is

one of the colleges that have a strategic position for some students who want a peaceful and

tranquil environment. Although the position is located in the outer shell, but cannot be denied in

the college environment has attracted the interest of students, particularly college students to

occupy the Tun Ghafar Baba with greenness fauna such as is in the village and its inhabitants

captivating villages. According to the early hierarchical formation history, College of Tun

Ghafar Baba was first commissioned in 2000 and completed in early 2004. These college

students are estimated to accommodate a total of more than 1500 people at any one time. Very

large number of residents is accommodated by four blocks of residential XA1, XA2, X1 and X2

Page 4: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

4

which houses more than 200 individual rooms (single room), and two of 250 rooms (double

room). In addition, Tun Ghafar Baba College also has two fellows home, at XA3 and X3, and a

college office, located on the ground floor XA1. In 2008, the statistical records of occupants of

residential colleges have reached 900 people, where over 100 residents are international students

from different countries. After the completion of repair works carried out, the administration of

the college began operating in mid-June 2004. In the early years, this newly built college was

named College to 14 & 15. However, in June 2007 year, 14 & 15 College name was changed to

College of Tun Ghafar Baba officially announced by the Deputy of Student Affairs, the

Honorable Dato 'Prof.. IR. DR. ALIAS BIN MOHD. NOOR during Sanggar Sanjung Night

Program III. This is to appreciate the contributions and sacrifices that have been highlighted by

the country's political hero of the famous late Tun Abdul Ghafar Baba. Thus, what attracted

attention, Tun Ghafar Baba College is the only college that has a futsal court facilities covered

(a) and not covered (a). In addition, the facility covered motorcycle parking area sufficient

college is also available to residents. In appreciation of the residents stay in the college, the

college administration in cooperation with the Student Elections Committee, KTGB has

consulted with the CICT to upgrade the Internet access system (wifi UTM) in each block to

facilitate their learning process.

1.4 Definitions, Acronyms and Abbreviations

SRS: Software Requirements Specification

KTGB hms: Kolej Tun Ghafar Baba hostel management system

Page 5: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

5

2. SYSTEM OVERVIEW

KTGB hostel management system (KTGB HMS). This system main function is focused on

registering students in the KTGB hostel. Students are required to log in to the system to request

for room in KTGB, students also can view their merit marks which they obtain by participating

college activities, the marks then will be updated in the student portal and the students can just

view the marks, as for staff their role is to log in and edit and update student detail in the hostel

management system, the staff also will refer to database before allocating room for the students.

The system is focus to student who registers for hostel in KTGB only, the students’ information

will be retrieve from aimsweb as the student need to log in using their ACID account. This

system will allocate rooms for the students based on availability. This function will be handled

by the staff that will request for room from the database and then allocate it to students. Other

than that this system is introduced to students so that it would be easier for students to keep track

of their merit marks and the activity they join in the college.

3. SYSTEM ARCHITECTURE

3.1 Architecture Design Decision

Summary of Architecture Design Decision

What approach will be used to structure the

system?

Object oriented decomposition, easier

maintenance. Objects may be

understood as stand-alone entities.

What architectural styles are appropriate? Layered Architecture because organizes the

system into layers with related functionality

associated with each layer. A layer provides

services to the layer above it so the lowest-

level layers represent core services that are

likely to be used throughout the system.

What control strategy should be used? Centralized control model (Manager Model)

How will the structural components be

decomposed into subcomponents?

Distributed over the network because this an

online system.

Is there a generic application architecture that

can be used?

Transaction based application

What architectural organization is best for Maintainability, because to use the current

Page 6: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

6

delivering the non functional

requirements?

system which is depends on the big server of

the university is not reliable, using own system

will be easier to manage student details.

The following subtopics are the detail description of the Architecture Design Decision

KTGB-Hostel Management System

Web Browser

Login Role_Checking Form and Menu Staff Data Validation

Room Management Merit

Transaction Management Database

This Diagram should be drawn using

EA Class Model – with layered

packages and package for each layer

Page 7: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

7

KTGB HMS

SYSTEM

MAINTENANCE

DATA

PROVIDE

MONTHLY

REPORT

ALLOCATE

ROOMS

LOG IN

REQUEST

ROOM

MANAGE

STUDENT

DETAILS

Control Style: Centralized Control (Manager Model)

This is applicable to concurrent systems. One system component is designated as a system

manager and provide monthly report, manage student details, request room, login, allocate

rooms and maintenance data. This system can be implemented in sequential systems as a case

statement.

3.2 Decomposition Description

KTGB HMS

SYSTEM

MAINTENANCE

DATA

PROVIDE

MONTHLY

REPORT

ALLOCATE

ROOMS

LOG IN

REQUEST

ROOM

MANAGE

STUDENT

DETAILS

Page 8: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

8

1. The top layer is responsible for implementing the user interface. In this case, the

user interface (UI) has been implemented using a web browser.

2. The second layer provides the UI functionality that is delivered through the web

browser. It includes components to allow users to log in to the system and

checking components that ensure that the operation they use are allowed by their

role. This layer includes form and menu management components that present

information to users, and data validation components that check information

consistency.

3. The third layer implements the functionality of the system and provides

components that implements management system and creation and updating merit

data from database.

4. Finally, the lowest layer, which is built using a commercial database management

system, provides transaction management.

3.3 Design Rationale

Why :-

In the layered-architecture style, each layer represents a well-defined, distinct set of functional

responsibilities, with obvious interface boundaries between the layers. The layers are a highly

cohesive set of functionality that is implemented as an ordered set—referred to as a "stack."

Control is passed from one layer to the next sequential layer, down the stack.

Benefits :-

Adding more functionality to the application is made easier.

…..

……

……

Trade offs: -

……

……

Page 9: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

9

4. DATA DESIGN

4.1 Data Description

This section explains the data function and describe how it interacts.

1. Stud_Name

- Contain the student’s username. The student’s username will be used as a log in ID

when the student wants to check their merit mark and request room.

2. Mat_no

- Contain the student’s matrix number. The matrix number will be use as identifier.

3. Stud_ICNo

- Contain the student’s identification number. The student’s identification number will

be used as a default password.

4. Room_no

- Contain the student’s room number. The staff can edit student’s profile based on

student input.

5. ActivityDetails

- Contain the student’s activity list. The staff can edit student’s profile based on

student activity.

6. MeritStatus

- Contain the student’s merit mark. The staff can edit student’s profile based on student

merit mark.

7. Staff_Name

- Contain the staff’s full name. Will be used as ID for staff log in.

8. Staff_IC

- Contain the staff’s identification number. Will be used as default password.

9. Room_id

- Contains the room block (exp: K06)

Page 10: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

10

4.2 Data Dictionary

Table Entity

Name

Element

Name

Definition Type Storage

Format

Stud_Info

Stud_Name Name Student’s

name

Text Any

Mat_no MatrixNo

Student’s

matrix

number

Varchar Any

Stud_ICNo IC No Student’s I/C

number

Int 12digit

Room_type Type Student’s

room types

Varchar Any

ActivityDetail

s ActivityDetail

Student’s

activity

details in

kolej

Text Any

MeritStatus Marks Student’s

merit marks

double 4digit

Staff_Info

Staff_Name Name Staff’s name Text Any

Staff_IC IC No Staff’s I/C

number

Int 12digit

Room_Info

Room_ID ID Room’s ID

number varchar Any

Room_No No Room

number int 3digit

Page 11: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

11

5. COMPONENT DESIGN

5.1 Use Case

Page 12: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

12

5.2 Sequence Diagram

Sequence diagram will shown element-element of object in sequence diagram and describe about

object and message that trying to described about an interaction of this systems. This diagram

needs to read from left to right and above to bottom.

5.2.1 Sequence Diagram: Student Log-in

Page 13: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

13

Descriptions student login:

This sequence diagram describes how a user logs into the system. The user starts this sequence

diagram is Students. The sequence diagram begins when the user type’s username and password

on the login form and press “Masuk” button. The user submits username and password. The

system validates the user’s username and password and if the system cannot find the match

username, invalid error message will displayed. The user can retype the correct username and

password to login the system. The system will role to the next page where they can make request

room or request to view their Merit marks. After Admin update the details in the system, the

system will update it into the student’s profile. To view the details room or Merit marks, students

can see it in their profile. Then, they can allocate the room, at which point the sequence diagram

ends.

5.2.2 Sequence Diagram: Staff Log-in

Page 14: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

14

Descriptions staff login:

This sequence diagram describes how a user logs into the system. The user starts this sequence

diagram is Admin. The sequence diagram begins when the user type’s username and password

on the login form and press “Masuk” button. The user submits username and password. The

system validates the user’s username and password and if the system cannot find the match

username, invalid error message will displayed. The user can retype the correct username and

password to login the system. The system will role to the next page where the admin can view

the students request details (exp: Check Merit or Request room). Then, the Admin will check

for the available room and update the room that has been selected into database. From that, the

free room will display based on the type required. The Admin will update the room details in the

system, at which point the sequence diagram ends.

5.3 Class Diagram

In software engineering, a class diagram in the Unified Modeling Language (UML) is a type of

static structure diagram that describes the structure of a system by showing the system's classes,

their attributes, and the relationships between the classes.

Class diagram should be for each

package in the layered

architecture

Page 15: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

15

5.4 State Diagram

Did not say which this state

diagram is for which class

Page 16: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

16

6. USER INTERFACE DESIGN

6.1 Overview of User Interface

1. Function login

2. View student Details

3. Manage student details

4. Request room

5. Check room

6. Allocate room

7. Edit

6.2 Screen Image

Main interface for both students and staff

Page 17: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

17

Login for students

Description: Students types the username and password which is their ACID

account on the login form and press Login button.

Page 18: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

18

Menu page

Description: this is the student site that contains three tabs which is profile detail,

merit and from where user needs to clicks each of the tabs to view information.

Page 19: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

19

Profile detail

Description: This page contains information of the students which is their name,

matrix number, room number and their session. For any changes the student need

to report it at the office.

Page 20: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

20

Merit page

Description: this page contain information on the activities the students join

organized or collaborated by the college, the students can view their marks only.

Page 21: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

21

Request room

Description: this page is where the user can request for their desired room, this

request will be updated on the system and will be viewed by the staff.

Page 22: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

22

Form page

Description: This page contains all the form related to the college the students can

download the forms here and submitted it to the college office for any matter.

Page 23: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

23

Staff log in

Description: Students types the username and password which is their ACID

account on the login form and press Login button.

Page 24: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

24

Staff menu page

Description: This page is the staff menu page which contains three tabs student

list to edit student details, merit tab to give marks and search tab to quick search

for student.

Page 25: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

25

Student list

Description: This page contains the entire student list in the ktgb college and the

staff can click the edit button to edit each of the students detail.

Page 26: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

26

Staff profile edit

Description: This page is when the staff click edit button on the student list and it

will be navigated to this page where the staff can edit the students detail and can

assigned room to them.

Page 27: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

27

Staff merit page

Description: This page is the page where the staff will update the activities join by

the student

Page 28: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

28

Search page

Description: This page is where the staff can do a quick search to find the students

based on their session or their matrix card number.

Page 29: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

29

7. REQUIREMENT MARTIX

7.1 Traceability Diagram

Page 30: Group Members - people.utm.my · This SRS will discuss more about the functions and constraints of newly suggested system additional function of KTGB hostel management system, developed

30

7.2 Requirement‐Matrix Table

Requirement Source / ID

Use case realization

Design Reference

Observe Personal Details View Student Details Data Display

Generate The New Data Manage Student Details Data Processing

Allow To Room Request Request Room Data Processing

Check Availability For New Room Check For Room Data Processing

Manage Request Room Allocate Room Data Processing

Generate Monthly Hostel Management

Reports

Provide Monthly Report Data Collection

Manage The Data System, Ensuring

data Update

Maintenance Data Data Processing

8. References

http://wiki.answers.com/Q/Explain_the_benefits_of_layered_architecture#ixzz1h8dnl

ZJR

Software_Design_Description_Sample.

Software_Design_Description.

SCJ1203_Week_11_OOD_SDD presentation slide.

SRS documentation of KTGB HMS.