sdd example

EC/CS226B/06/2007/SDDCLASSIFIED

DOCUMENT IDENTIFICATIONFORMAT ITEM NUMBER REVISION PAGE

A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

1. SCOPE

1.1. Identification

System Number : 01System Name : “ Counseling System ”System Abbreviation : CS

CSCI Number : FTMSK-2006-01-06-0BCSCI Name : “E-Counseling System”CSCI Abbreviation : EC

1.2. CSCI OverviewThis paragraph describes the purpose of the system and the CSCI to which this SDD

applies.

Purpose of the system:

This paragraph describes the purpose of the system and the CSCI to which this SDD applies.

Purpose of the system:

The system is the Counseling System that defined the following several main functional components in the system for the contract:

A user friendly system for both student and counselor A counseling forum A flexible computerized system for E-Counseling Easy for student to get counselor advise on Career and Employment, Education,

Finance, Health and Psychology

Purpose of the CSCI:

The purpose of the E-Counseling System, EC is establishing an online counseling system for students of SMK Seksyen 18. The system will provide are: [1] Register membership by student; [2] Authenticate password by administrator, counselor and student (member); [3] Update account for student (member) and counselor [4] Join forum for student (member) and counselor; [5] Make appointment by student; [6] Maintain message for student (member) and counselor; [7] Manage appointment by counselor;

1



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

[8] Manage event for Counseling and Guidance Club (CGC) by counselor; [9] Maintain student record by administrator; [10] Maintain counselor record by administrator; [11] Manage schedule by counselor;

2



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

1.3. Document Overview

This document specifies the procedure to be applied during:

- Preliminary design stage: Breakdown of CSCI to CSCs Description of each CSC design Description of characteristics common to CSCs Traceability requirements set forth in SRS

- Detailed design stage: Breakdown of CSCs into CSUs Description of CSU design Description of CSCI overall data

The Software Design Document (SDD) describes the complete design of a Computer Software Configuration Item (CSCI). It describes the CSCI as composed of Computer Software Components (CSCs) and Computer Software Units (CSUs).

The SDD describes the allocation of requirements from a CSCI to its CSCs and CSUs. Prior to Preliminary Design Review (PDR), the SDD is entered into the Developmental Configuration for the CSCI.

The contractor uses the SDD for three primary purposes, namely: Present the preliminary design at the Preliminary Design Review Present the detail design at the Critical Design Review Use the design information as a basis for coding each CSU.

The SDD is used by the Government to assess the preliminary and detail design for the CSCI.

Chapter 1 describes the scope, identification, system overview and document overview.

Chapter 2 describes the applicable documents, government documents and non- government documents.

Chapter 3 describes the preliminary design, CSCI overview, CSCI architecture, static organization, dynamic organization, CSCs interfaces, CSC external CSCIs interfaces, system states and modes, memory and processing time allocation and CSCI design description.

Chapter 4 describes the detailed design, CSC name, CSU name, CSU design specification/constraints and CSU design.

Chapter 5 describes the CSCI data.

3



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Chapter 6 describes the CSCI data file to CSC/CSU cross reference

Chapter 7 describes the requirements traceability.

Chapter 8 describes the abbreviations used and the other issue that enhance the readability of this document.

4



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

2. APPLICABLE DOCUMENTS

This section lists the document number and document name referenced in this document. Any discrepancy of this document in describing the software development process should be covered by the documents listed in this chapter.

In case of any conflict between the documents listed and this document, it is this document that should be taken into consideration in any decision-making process regarding software development of this CSCI.

2.1. Government Documents

Not Applicable.

2.2. Non-Government Documents

Unless otherwise specified in the present document, the requirements set forth in the standard indicated below form part of the statement of work:

[1]Guideline PHP-1 PHP and MYSQL For Dynamic Web Sites (Peachpit Press)

[2]Guideline PHP-2 Internet & World Wide Web How To Program (Prentice Hall)

[3]Guideline UML-1 Object-Oriented Systems Analysis and Design (McGraw Hill)

[4]Guideline PHP-3 http://www.phpmysqltutorial.com [5]Guideline UML-2 The Unified Modeling Language User Guide (Addison

Wesley) [6]Guideline UML-3 The Unified Software Development Process (Addison

Wesley) [7]SDP (0B-02-01-06-037-) Software Development Plan

[8]SRS (0B-02-01-06-045-) Software Requirement Analysis

5

http://www.phpmysqltutorial.com/



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3. PRELIMINARY DESIGN

3.1. CSCI Overview

Description:

Below is the overview of the use case external interface requirement for EC.

FIGURE 3.1: CONTEXT DIAGRAM.

6

CSCI EC

Administrator

Student

Counselor



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.1.1. CSCI ArchitectureThis paragraph describes the internal organizational structure of the CSCI EC.

3.1.1.1. Static Organization

The CSCI EC is organized into 3 main packages, which are shown in the Figure 3.2 below. Each package defines a set role, which results in a minimum of coupling and a maximum of cohesion within the package. The use cases are packages due to their role.

Figure 3.2: The CSCI EC packages.

7



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

The packages are briefly described as follows

3.1.1.1.1. EC CONTROLLERThis package contains classes that manage each and every services provided by this CSCI EC. Classes in this package are:

studMemberController studNonMemberController teacAdminController teacCounselorController appointmentController scheduleController messageController cgc_eventController forumController forum_topicController topic_replyController app_userController

3.1.1.1.2. EC ENTITYThis package contains all of the classes that are not interacting with the user and will provide necessary data upon request. Classes in this package are:

s_member s_nonmember administrator counselor appoinment schedule message cgc_event forum forum_topic topic_reply app_user

8



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.1.1.1.3. EC BOUNDARYThis package contains input and output interface classes that interact directly with the user. This package provides services to accept and provide output to the driver. Classes in this package are:

studMemberForm studNonMemberForm teacAdminForm teacCounselorForm appointmentForm scheduleForm messageForm cgc_eventForm forumForm forum_topicForm topic_replyForm app_userForm

9



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.1.1.2. Dynamic Organization

studNonMember.php

student.mdb

RegisterMembershipExe

ManageScheduleExe

schedule.php

schedule.mdb

10

Figure 3.3: Processes in CSCI EC

Figure 3.4: RegisterMembership process

Figure 3.5: ManageSchedule process



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.1.1.3 CSCs Interfaces

CSCI EC

EC Controller

EC Entity EC Boundary

Figure 3.7: Relationship between the CSCs.

3.1.1.3. CSC External CSCIs InterfacesNot Applicable.

11



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.1.2. System States and ModesThe system modes and states of the CSCI EC were encapsulated into use cases identified in the Software Requirements Specifications (SRS [30]). Listed below are the package names and the related use cases, which they contain.

- EC ControllerRegister membership, Authenticate password, Update account, Manage teachers’ record, Manage students’ record, Join forum, Make appointment, Manage appointment, Manage schedule, Maintain message, Manage event for CGC Use Cases.

- EC InterfaceRegister membership, Authenticate password, Update account, Manage teachers’ record, Manage students’ record, Join forum, Make appointment, Manage appointment, Manage schedule, Maintain message, Manage event for CGC Use Cases.

- EC EntityRegister membership, Authenticate password, Update account, Manage teachers’ record, Manage students’ record, Join forum, Make appointment, Manage appointment, Manage schedule, Maintain message, Manage event for CGC Use Cases.

3.1.3. Memory and Processing Time AllocationNo constraints on the memory and processing time allocation.

12



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.2. CSCI Design DescriptionA CSC is represented by a package. The figure below shows the internal classes inside a package and also its visibility to external packages.

3.2.1. CSC EC Controller [SDD_REQ_1000]The EC Controller packages groups the classes that provide services to control the operations of each entity. The classes included in this package are, the base class and the derived classes:

studMemberController studNonMemberController teacAdminController teacCounselorController appointmentController scheduleController messageController cgc_eventController forumController forum_topicController topic_replyController app_userController

Relationship with the other CSCs is shown as below:

Figure 3.8: Visibility of CSC EC Controller with other CSCs.

13

EC Controller

studNonMemberControllerstudMemberController appointmentConroller

scheduleController messageController cgc_eventController

forumContrller forum_topicController topic_replyController

app_userController

EC Boundary

EC Entity

teacAdminController teacCounselorController



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.2.2. CSC EC Entity [SDD_REQ_2000]The EC Entity groups the classes that are not interacting with the user and responsible to provide necessary data upon request. The classes included in this package are:

s_member s_nonmember administrator counselor appoinment schedule message cgc_event forum forum_topic topic_reply app_user


EC Boundary

Figure 3.9: Visibility of CSC EC Entity with CSC EC Controller.

14



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

3.2.3. CSC EC Boundary [SDD_REQ_3000]The EC Boundary groups the classes that interact directly with the user. This package is responsible for providing output to the driver. The classes included in this package are:

studMemberForm studNonMemberForm teacAdminForm teacCounselorForm appointmentForm scheduleForm messageForm cgc_eventForm forumForm forum_topicForm topic_replyForm app_userForm


EC Entity

Figure 3.10: Visibility of CSC EC Boundary with CSC EC Controller.

15

EC Interface

studNonMemberForm appointmentFormstudMemberForm

scheduleForm messageForm cgc_eventForm

forumController forum_topicForm topic_replyForm

app_userForm

EC Controller

teacAdminForm teacCounselorForm



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

4. DETAILED DESIGN

This paragraph describes CSCs used in CSCI EC.

Figure 4.1: Class Diagram for CSCI EC

Note: To view the sequence diagram of detailed design completed class diagram of CSCI EC and state transition diagram, refer Appendix A: Completed Class Diagram.

4.1. CSC EC Controller [SDD_REQ_1000]16

EC SYSTEM

EC BOUNDARY

studMemberForm studNonMemberForm appointmentForm scheduleForm

messageForm

cgc_ev entForm forumForm f orum_topicForm topic_reply Form app_useForm

EC CONTROLLER

studMemberController studNonMemberController appointmentController scheduleController

messageController cgc_ev entController

f orumController f orum_topicControllertopic_reply Controller app_userController

EC ENTITYs_member s_nonmember appointment schedule message

cgc_event forum forum_topic topic_reply

app_user

counseloradministrator

teacAdminController teacCounselorController

teacAdminForm teacCounselorForm



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Figure 4.2: CSC EC Controller class diagram.

4.1.1. CSU studMemberController [SDD_REQ_1010]

17

studMemberController

updateAccount()viewProfile()joinForum()makeApp()maintainMessage()

studNonMemberController

registerMember()registerCGC()

studMemberController


scheduleController

addSchedule()editSchedule()deleteSchedule()viewSchedule()printSchedule()

cgc_eventController

addEvent()updateEvent()deleteEvent()viewEvent()

topic_replyController

addTopicReply()addReply()viewTopicReply()

forum_topicController

addForumTopic()viewForumTopic()

appointmentController

makeApp()cancelApp()viewApp()manageApp()searchApp()printAppList()

messageController

sendMessage()deleteMessage()viewMessage()fwdMessage()replyMessage()

app_userController

login()logout()

teacAdminController

addRecord()updateRecord()deleteRecord()viewRecord()printRecord()

teacCounselorController

updateAccount()viewProfile()joinForum()manageApp()manageSchedule()manageCGCevent()maintainMessage()

forumController

addForum()viewForum()searchForum()



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Class type : Control classResponsibility : This class handles the operations done by student (member).Attributes : NoneMethods :

4.1.1.1. updateAccountResponsibility : Input Parameter : Output Parameter : Precondition :Postcondition : Algorithm : BEGIN

END

4.1.1.2. viewProfileResponsibility : To start control classInput Parameter : NoneOutput Parameter : NonePrecondition : control class is constructed.Postcondition : Incoming Signal is handling properly.Algorithm : BEGIN

END

4.1.1.3. joinForum

4.1.1.4. makeApp

4.1.1.5. maintainMessage

4.1.2. CSU studNonMemberController [SDD_REQ_1020]

18

studNonMemberController




A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Class type : Control classResponsibility : This class handles the operations done by student

(nonmember).Attributes : NoneMethods :

4.1.2.1. registerMemberResponsibility : To start control classInput Parameter : NoneOutput Parameter : NonePrecondition : control class is constructed.Postcondition : Incoming Signal is handling properly.Algorithm : BEGIN

END

4.1.2.2. registerCGCResponsibility : To start control classInput Parameter : NoneOutput Parameter : NonePrecondition : control class is constructed.Postcondition : Incoming Signal is handling properly.Algorithm : BEGIN

END

4.2. CSC EC Entity [SDD_REQ_2000]

19

teacherteac_idteac_nameteac_icteac_positionteac_usernameteac_pword

administrator

addRecord()updateRecord()deleteRecord()viewRecord()printRecord()

counselor

updateAccount()viewProfile()joinForum()manageApp()manageSchedule()manageCGCevent()maintainMessage()

studentstud_idstud_namestud_addrstud_postcodestud_statestud_icstud_pobstud_phoneNostud_emailstud_usernamestud_pwordcgc_memberstud_status

s_member


s_nonmember


app_useruser_iduser_pworduser_role

login()logout()

messagemsg_idmsg_descmsg_datemsg_timemsg_subjectrecipient_idsender_idoutboxmsg_statusreply_idfwd_id

sendMessage()deleteMessage()viewMessage()fwdMessage()replyMessage()

schedules_ids_times_days_dateteac_id

addSchedule()editSchedule()deleteSchedule()viewSchedule()printSchedule()

cgc_eventcgc_idcgc_namecgc_desccgc_timecgc_dateteac_id

addEvent()updateEvent()deleteEvent()viewEvent()

topic_replyreply_idreply_descreply_datereply_timetopic_idreply_touser_idstatus

addTopicReply()addReply()viewTopicReply()

forum_topictopic_idtopic_nametopic_datetopic_timeforum_iduser_idtopic_view

addForumTopic()viewForumTopic()

forumforum_idforum_nameforum_descforum_dateforum_timeforum_catuser_idforum_view

addForum()viewForum()searchForum()

appointmentapp_idapp_subjectapp_descapp_statuss_iduser_idstud_idteac_id

makeApp()cancelApp()viewApp()manageApp()searchApp()printAppList()



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Figure 4.3: CSC EC Entity class diagram.

20



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

4.2.1. CSU s_member [SDD_REQ_2010]

Figure 4.4: CSU s_member class diagram.

Class type : Entity classResponsibility : Hold the information of student (member).Attributes :

stud_id :int(10)stud_name :varchar(200)stud_ic :varchar(12)stud_addr :varchar(200)stud_postcode :int(5)stud_state :varchar(50)stud_pob :varchar(200)stud_phoneNo :varchar(10)stud_email :varchar(150)stud_username :varchar(50)stud_pword :varchar(50)cgc_member :char(3)stud_status :char(3)

Methods :

21


s_member


s_nonmember




A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

4.2.1.1. updateAccountResponsibility : To update student’s username and password. Input Parameter : NoneOutput Parameter : NonePrecondition : Need to login to be in member’s session.Postcondition : Username and/or password are updated. Algorithm : BEGIN

stud_username=new_username;stud_pword=new_pword;updateAccount ();

END

4.2.1.2. viewProfileResponsibility : To view student’s profile such as new messages

(if any), new appointment (if any), forum alerts or CGC activities alert.

Input Parameter : NoneOutput Parameter : NonePrecondition : Need to login to be in member’s session.Postcondition : Initialized value for EntityAlgorithm : BEGIN

viewProfile();END

4.2.1.3. joinForumResponsibility : Enable student to join forums.Input Parameter : NoneOutput Parameter : NonePrecondition : Need to login to be in member’s session.Postcondition : Initialized value for Entity Algorithm : BEGIN

joinForum();END

4.2.1.4. makeAppResponsibility : Enable student to make appointment with counselor.Input Parameter : NoneOutput Parameter : NonePrecondition : Need to login to be in member’s session.Postcondition : Initialized value for Entity.Algorithm : BEGIN

makeApp();END

22



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

4.2.1.5. maintainMessageResponsibility : Enable student to maintain messages to counselors or

other students.Input Parameter : NoneOutput Parameter : NonePrecondition : Need to login to be in member’s session.Postcondition : Initialized value for Entity Algorithm : BEGIN

maintainMessage();END

23



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

4.2.2. CSU s_nonmember [SDD_REQ_2020]

Figure 4.5: CSU s_nonmember class diagram.

Class type : Entity classResponsibility : Hold the information of student (nonmember).Attributes :

stud_id :int(10)stud_name :varchar(200)stud_ic :varchar(12)stud_addr :varchar(200)stud_postcode :int(5)stud_state :varchar(50)stud_pob :varchar(200)stud_phoneNo :varchar(10)stud_email :varchar(150)stud_username :varchar(50)stud_pword :varchar(50)cgc_member :char(3)stud_status :char(3)

24


s_member


s_nonmember




A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Methods :

4.2.2.1. registerMemberResponsibility : To register as a member to access to the system.Input Parameter : stud_ic :varchar(12)

stud_pword :varchar(50) (temporary password given by administrator)

Output Parameter : NonePrecondition : Must have a correct and match identification card

number and temporary password given by administrator.

Postcondition : Registered as a member with username and new password.

Algorithm : BEGIN

IF (entered_stud_ic == stud_ic AND entered_stud_pword == stud_pword)THEN registerMember();

END IFEND

4.2.2.2. registerCGCResponsibility : To register as member of Counseling and Guidance

Club.Input Parameter : NoneOutput Parameter : NonePrecondition : Must complete the member registration.Postcondition : Registered as CGC member and receive alerts

for CGC activities.Algorithm : BEGIN

IF (entered_stud_ic == stud_ic AND entered_stud_pword == stud_pword)THEN registerMember();

registerCGC();END IF

END

25



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

5. CSCI EC DATA TYPE DEFINITIONS

5.1. CSCI EC ConstantsNot Applicable

5.2. CSCI EC Data TypesData Dictionary for Entity Database

Data types for studMember Entity classstud_id :int(10)stud_name :varchar(200)stud_ic :varchar(12)stud_addr :varchar(200)stud_postcode :int(5)stud_state :varchar(50)stud_pob :varchar(200)stud_phoneNo :varchar(10)stud_email :varchar(150)stud_username :varchar(50)stud_pword :varchar(50)cgc_member :char(3)stud_status :char(3)

Data types for studNonMember Entity classstud_id :int(10)stud_name :varchar(200)stud_ic :varchar(12)stud_addr :varchar(200)stud_postcode :int(5)stud_state :varchar(50)stud_pob :varchar(200)stud_phoneNo :varchar(10)stud_email :varchar(150)stud_username :varchar(50)stud_pword :varchar(50)cgc_member :char(3)stud_status :char(3)

26



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Data types for teacAdmin Entity classteac_id :int(10)teac_name :varchar(50)teac_ic :varchar(12)teac_position :varchar(50)teac_username :varchar(50)teac_pword :varchar(50)

Data types for teacCounselor Entity classteac_id :int(10)teac_name :varchar(50)teac_ic :varchar(12)teac_position :varchar(50)teac_username :varchar(50)teac_pword :varchar(50)

Data type for appointment Entity classapp_id :int(10)app_subject :varchar(100)app_desc :varchar(200)app_status :varchar(50)stud_id :int(10)teac_id :int(10)user_id :varchar(50)s_id :int(10)

Data type for schedule Entity classs_id :int(10)s_time :varchar(50)s_day :varchar(20)s_date :dateteac_id :int(10)

Data type message Entity classmsg_id :int(10)msg_desc :textmsg_date :datemsg_time :timemsg_subject :varchar(50)recipient_id :varchar(50)sender_id :varchar(50)outbox :char(3)msg_status :int(2)reply_id :int(10)fwd_id :int(10)

Data type for cgc_event Entity class27



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

cgc_id :int(10)cgc_name :varchar(50)cgc_desc :varchar(100)cgc_date :datecgc_time :timeteac_id :int(10)

Data type for forum Entity classforum_id :int(10)forum_name :varchar(100)forum_desc :textforum_date :dateforum_time :timeforum_cat :varchar(100)forum_view :int(10)user_id :varchar(50)

Data type for forum_topic Entity classtopic_id :int(10)topic_name :texttopic_date :datetopic_time :timeforum_id : int(10)user_id :varchar(50)topic_view :int(10)

Data type for topic_reply Entity classreply_id :int(10)reply_desc :textreply_date :datereply_time :timetopic_id :int(10)reply_to :varchar(50)status :varchar(10)user_id :varchar(50)

Data type for app_user Entity classuser_id :varchar(50)user_pword :varchar(50)user_role :varchar(50)

28



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

6. CSCI DATA FILESNot Applicable.

29



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

7. REQUIREMENTS TRACEABILITY

Table 7.1: Requirements traceability.

30



A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.

Requirements Allocation reference

DescriptionSource Allocated

SDD_REQ_1000 4.1 Provides services to control the operation each entity

SDD_REQ_1010SDD _REQ_1020SDD _REQ_1030SDD _REQ_1040SDD _REQ_1050

:::::::

SDD_REQ_2000 4.2 Provide necessary data upon requestSDD_REQ_2010

SDD _REQ_2020SDD _REQ_2030SDD _REQ_2040SDD _REQ_2050

:::::::

Table 7.2: Summary of requirements in Software Details Design

Notes:Please refer Appendix A for summary of requirements in Software Requirements Specification.

31


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


8. NOTES

Abbreviation used:

CDR - Critical Design ReviewCI - Configuration ItemCSC - Computer Software ComponentCSCI - Component Software Configuration ItemCSU - Computer Software UnitPDR - Preliminary Design ReviewSDD - Software Design DocumentSRS - Software Requirement SpecificationUML - Unified Modeling LanguageCGC - Counseling and Guidance Club

32


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


APPENDIX A

Summary of Requirements

33


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


No. Requirements Description1. SRS_REQ_1000 Register Membership2. SRS_REQ_1010 Filling up the registration form 3. SRS_REQ_1020 Register now4. SRS_REQ_1030 Cancel registration5. SRS_REQ_1040 Invalid data type6. SRS_REQ_1050 Insufficient data

7. SRS_REQ_2000 Authenticate Password8. SRS_REQ_2010 Filling up the user id and password9. SRS_REQ_2020 Verifying user id and password10. SRS_REQ_2030 Determine the status of user11. SRS_REQ_2040 Invalid user id and password

12. SRS_REQ_3000 Update Account13. SRS_REQ_3010 View details14. SRS_REQ_3020 Update account15. SRS_REQ_3030 Change Password16. SRS_REQ_3040 Invalid data entry17. SRS_REQ_3050 Insufficient data entry18. SRS_REQ_3060 Invalid change password

19. SRS_REQ_4000 Join Forum20. SRS_REQ_4010 Select to join a forum21. SRS_REQ_4020 View form22. SRS_REQ_4030 Create new topics23. SRS_REQ_4040 Post a new message24. SRS_REQ_4050 Reply to the others posted message25. SRS_REQ_4060 Invalid data type26. SRS_REQ_4070 Insufficient data entry

27. SRS_REQ_5000 Make Appointment28. SRS_REQ_5010 Select make appointment29. SRS_REQ_5020 Request appointment30. SRS_REQ_5030 View a list of appointment31. SRS_REQ_5040 Cancel appointment32. SRS_REQ_5050 Invalid data type33. SRS_REQ_5060 Insufficient data entry

34


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


34. SRS_REQ_6000 Maintain Message35. SRS_REQ_6010 Select to maintain message36. SRS_REQ_6020 Read message37. SRS_REQ_6030 Write message38. SRS_REQ_6040 Reply message39. SRS_REQ_6050 Forward message40. SRS_REQ_6060 Delete message41. SRS_REQ_6070 Invalid data type42 SRS_REQ_6080 Insufficient data entry

43. SRS_REQ_7000 Manage Appointment44. SRS_REQ_7010 Capability to manage appointment45. SRS_REQ_7020 View list of appointment46. SRS_REQ_7030 Approve or disapprove appointment47. SRS_REQ_7040 Invalid Date of appointment

48. SRS_REQ_8000 Manage Event for CGC49. SRS_REQ_8010 Manage event for CGC50. SRS_REQ_8020 Add event for CGC51. SRS_REQ_8030 Retrieve event for CGC52. SRS_REQ_8040 Update event for CGC53. SRS_REQ_8050 Delete event for CGC54. SRS_REQ_8060 Invalid data type55. SRS_REQ_8070 Insufficient data entry

56. SRS_REQ_9000 Maintain Students’ Record57. SRS_REQ_9010 Maintain Students’ Record58. SRS_REQ_9020 Add student record59. SRS_REQ_9030 Retrieve student record60. SRS_REQ_9040 Update student record61. SRS_REQ_9050 Delete student record62. SRS_REQ_9060 Print student record63. SRS_REQ_9070 Invalid data type64. SRS_REQ_9080 Insufficient data entry

65. SRS_REQ_10000 Maintain Counselor’ Record66. SRS_REQ_10010 Maintain Counselor’ Record67. SRS_REQ_10020 Add counselor record68. SRS_REQ_10030 Retrieve counselor record69. SRS_REQ_10040 Update counselor record70. SRS_REQ_10050 Delete counselor record71. SRS_REQ_10060 Print counselor record72. SRS_REQ_10070 Invalid data type73. SRS_REQ_10080 Insufficient data entry

35


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


74. SRS_REQ_11000 Manage Schedule75. SRS_REQ_11010 Manage Schedule76. SRS_REQ_11020 Add Schedule77. SRS_REQ_11030 Retrieve Schedule78. SRS_REQ_11040 Update Schedule79. SRS_REQ_11050 Delete Schedule80. SRS_REQ_11060 Print Schedule81. SRS_REQ_11070 Invalid data type82. SRS_REQ_11080 Insufficient data entry

36


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


APPENDIX B

Class Diagram

37


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


CSCI Entity to Entity Class Diagram

38


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


CSCI Analysis Class Diagram

39


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


THIS PAGE IS INTENTIONALLY LEFT BLANK

40


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


REVISION HISTORY

Revision Description

- 19/04/2007 – Creating Document

A 26/04/2007 – Updating Document

B

C

D

- A B C D

Date 19/04/2007 26/04/07Written by

Noraini A. Ghani Noraini A. Ghani

Inspected bySiti Safuraa Mazlan Siti Safuraa Mazlan

Approved bySiti Noor Baizura Ahmad Bistamam

Siti Noor Baizura Ahmad Bistamam

41


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


LIST OF EFFECTIVE PAGE(s)Page(s) Revision Page(s) Revision

iiiivvvivii

7-1316

18-202833394243486162

----------------

42


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


43


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


SOFTWARE DESIGN DOCUMENT (SDD)

for the

E-COUNSELING

of the

COUNSELING SYSTEM

Prepared for:

Pn. Juliana Hamka Kamaroddin

Prepared by:

Noraini bt A. Ghani (2006874685)Siti Safuraa bt Mazlan (2006874733)

Siti Noor Baizura bt Ahmad Bistamam (2006874692)

Authenticate by __________________ Approved by __________________ (Contracting agency) (Contractor)

Dated __________________________ Dated _______________________

44


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


SOFTWARE DESIGN DOCUMENT(SDD)

for the

E-COUNSELING(EC)

of the

COUNSELING

system

45


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


TABLE OF CONTENTS

1. SCOPE..............................................................................................................................11.1. Identification............................................................................................................11.2. CSCI Overview........................................................................................................11.3. Document Overview................................................................................................3

2. APPLICABLE DOCUMENTS.......................................................................................52.1. Government Documents...........................................................................................52.2. Non-Government Documents..................................................................................5

3. PRELIMINARY DESIGN..............................................................................................63.1. CSCI Overview........................................................................................................6

3.1.1. CSCI Architecture................................................................................................73.1.1.1. Static Organization.......................................................................................73.1.1.2. Dynamic Organization...............................................................................103.1.1.3. CSCs Interfaces..........................................................................................143.1.1.4. CSC External CSCIs Interfaces..................................................................14

3.1.2. System States and Modes...................................................................................153.1.3. Memory and Processing Time Allocation..........................................................15

3.2. CSCI Design Description.......................................................................................163.2.1. CSC EC Controller [SDD_REQ_1000]............................................................163.2.2. CSC EC Entity [SDD_REQ_2000]....................................................................173.2.3. CSC EC Boundary [SDD_REQ_3000]..............................................................18

4. DETAILED DESIGN....................................................................................................194.1. CSC EC Controller [SDD_REQ_1000]:...............................................................20

4.1.1. CSU studMemberController [SDD_REQ_1010]...............................................214.1.2. CSU studNonMemberController [SDD_REQ_1020]........................................22

4.1.3. CSU teacAdminController [SDD_REQ_1030].................................................23 4.1.4. CSU teacCounselorController [SDD_REQ_1040]............................................24

4.1.5. CSU appointmentController [SDD_REQ_1050]...............................................254.1.6. CSU scheduleController [SDD_REQ_1060].....................................................26

4.1.7. CSU messageController [SDD_REQ_1070].....................................................27 4.1.8. CSU forumController [SDD_REQ_1080].........................................................28 4.1.9. CSU forum_topicController [SDD_REQ_1090]...............................................29

4.1.10. CSU topic_replyController [SDD_REQ_1100].................................................30 4.1.11. CSU cgc_eventController [SDD_REQ_1110]...................................................31 4.1.12. CSU app_userController [SDD_REQ_1120]………………………………….32

4.2. CSC EC Entity [SDD_REQ_2000]:......................................................................334.2.1. CSU s_member [SDD_REQ_2010]...................................................................344.2.2. CSU s_nonmember [SDD_REQ_2020].............................................................37

4.2.3. CSU administrator [SDD_REQ_2030]..............................................................39 4.2.4. CSU counselor [SDD_REQ_2040]....................................................................43

4.2.5. CSU appointment [SDD_REQ_2050]...............................................................474.2.6. CSU schedule [SDD_REQ_2060].....................................................................51

4.2.7. CSU message [SDD_REQ_2070]......................................................................54 4.2.8. CSU forum [SDD_REQ_2080]..........................................................................58 4.2.9. CSU forum_topic [SDD_REQ_2090]................................................................60

46


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


4.2.10. CSU topic_reply [SDD_REQ_2100].................................................................62 4.2.11. CSU cgc_event [SDD_REQ_2110]...................................................................64 4.2.12. CSU app_user [SDD_REQ_2120].....................................................................665. CSCI OBA DATA TYPE DEFINITIONS...................................................................68

5.1. CSCI ECS Constants..............................................................................................685.2. CSCI ECS Data Types...........................................................................................68

6. CSCI DATA FILES.......................................................................................................717. REQUIREMENTS TRACEABILITY.........................................................................728. NOTES............................................................................................................................76

47


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


LIST OF FIGURES

Figure 3.1: Context Diagram....................................................................................................6Figure 3.2: The CSCI EC packages..........................................................................................7Figure 3.3: Processes in CSCI EC..........................................................................................10Figure 3.4: Controller Process................................................................................................11Figure 3.5: Entity Process......................................................................................................12Figure 3.6: Boundary Process................................................................................................13Figure 3.7: Relationship between the CSCs...........................................................................14Figure 3.8: Visibility of CSC EC Controller with other CSCs..............................................16Figure 3.9: Visibility of CSC EC Entity with other CSCs.....................................................17Figure 3.10: Visibility of CSC EC Boundary with other CSCs.............................................18Figure 4.1: Class Diagram for CSCI EC................................................................................19Figure 4.2: CSC EC Controller Class Diagram......................................................................20Figure 4.3: CSC EC Entity Class Diagram............................................................................33Figure 4.4: CSU s_member Class Diagram...........................................................................34Figure 4.5: CSU s_nonmember Class Diagram.....................................................................37Figure 4.6: CSU administrator Class Diagram.......................................................................39Figure 4.7: CSU counselor Class Diagram............................................................................43Figure 4.8: CSU appointment Class Diagram........................................................................47Figure 4.9: CSU schedule Class Diagram..............................................................................51Figure 4.10: CSU message Class Diagram............................................................................54Figure 4.11: CSU forum Class Diagram................................................................................58Figure 4.12: CSU forum_topic Class Diagram......................................................................60Figure 4.13: CSU topic_reply Class Diagram........................................................................62Figure 4.14: CSU cgc_event Class Diagram..........................................................................64Figure 4.15: CSU app_user Class Diagram............................................................................66

48


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


LIST OF TABLES

Table 7.1: Requirements traceability......................................................................................71Table 7.2: Summary of requirements in Software Details Design.........................................75

49


A4 0B-02-01-06-034- A /84

This

doc

umen

t and

the

info

rmat

ion

it co

ntai

ns is

the

prop

erty

of F

TMS

K-U

iTM

. D

o no

t mak

e co

py o

f thi

s do

cum

ent w

ithou

t pro

per a

utho

rizat

ion

from

FTM

SK

-UiT

M.


LIST OF APPENDICES

Appendix A : Summary of Requirements..............................................................................77Appendix B : Class Diagram..................................................................................................81

50

sdd example

Documents

csci design description

system overview

csci overview

system states

complete design

design information

breakdown of csci

csci data