SDD Example

EC/CS226B/06/2007/SDD
CLASSIFIED
1.
SCOPE
1.1.
Identification
System Number
System Name
System Abbreviation
: 01
: Counseling System
: CS
CSCI Number
CSCI Name
CSCI Abbreviation
: FTMSK-2006-01-06-0B
: E-Counseling System
: EC
1.2. CSCI Overview

This 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:
This document and the information it contains is the property of FTMSK-UiTM. Do

not make copy of this document without proper authorization from FTMSK-UiTM.
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;
DOCUMENT IDENTIFICATION
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
1/84
EC/CS226B/06/2007/SDD
CLASSIFIED

[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;
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
2/84
EC/CS226B/06/2007/SDD
CLASSIFIED
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 nongovernment 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.

FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
3/84
EC/CS226B/06/2007/SDD

CLASSIFIED
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.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
4/84
EC/CS226B/06/2007/SDD
CLASSIFIED
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
[2]Guideline PHP-2

[3]Guideline UML-1
[4]Guideline PHP-3
[5]Guideline UML-2
[6]Guideline UML-3
[7]SDP (0B-02-01-06-037-)
[8]SRS (0B-02-01-06-045-)
PHP and MYSQL For Dynamic Web Sites

(Peachpit Press)
Internet & World Wide Web How To Program (Prentice
Hall)
Object-Oriented Systems Analysis and Design (McGraw
Hill)
http://www.phpmysqltutorial.com
The Unified Modeling Language User Guide (Addison
Wesley)
The Unified Software Development Process (Addison
Wesley)
Software Development Plan
Software Requirement Analysis
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
5/84
EC/CS226B/06/2007/SDD
CLASSIFIED
3.
PRELIMINARY DESIGN
3.1.
CSCI Overview
Description:
Below is the overview of the use case external interface requirement for EC.
Administrator
CSCI
EC

Counselor
Student
FIGURE 3.1: CONTEXT DIAGRAM.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
6/84
EC/CS226B/06/2007/SDD
CLASSIFIED
3.1.1.
CSCI Architecture
This 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.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
7/84
EC/CS226B/06/2007/SDD
CLASSIFIED
The packages are briefly described as follows

3.1.1.1.1.
EC CONTROLLER
This 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 ENTITY
This 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
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
8/84
EC/CS226B/06/2007/SDD
CLASSIFIED

3.1.1.1.3.
EC BOUNDARY
This 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
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
9/84
EC/CS226B/06/2007/SDD
CLASSIFIED
3.1.1.2.
Dynamic Organization
Figure 3.3: Processes in CSCI EC
studNonMember.php
RegisterMembershipExe

student.mdb
Figure 3.4: RegisterMembership process
schedule.php
ManageScheduleExe
schedule.mdb
Figure 3.5: ManageSchedule

process
DOCUMENT
IDENTIFICATION
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
10/84
EC/CS226B/06/2007/SDD
CLASSIFIED
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.
Not Applicable.
CSC External CSCIs Interfaces

FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
11/84
EC/CS226B/06/2007/SDD
CLASSIFIED
3.1.2.
System States and Modes
The 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 Controller
Register 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 Interface
EC Entity

3.1.3.
Memory and Processing Time Allocation
No constraints on the memory and processing time allocation.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
12/84
EC/CS226B/06/2007/SDD
CLASSIFIED
3.2.
CSCI Design Description
A 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:
teacAdminController
scheduleController
messageController
cgc_eventController
forumController
app_userController
Relationship with the other CSCs is shown as below:
EC Controller

appointmentConroller
scheduleController
messageController
cgc_eventController
forumContrller
teacAdminController
app_userController
EC Boundary
EC Entity
Figure 3.8: Visibility of CSC EC Controller with other CSCs.

FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
13/84
EC/CS226B/06/2007/SDD
CLASSIFIED
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.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
14/84
EC/CS226B/06/2007/SDD
CLASSIFIED
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
EC Interface
studMemberForm
studNonMemberForm
appointmentForm
scheduleForm
messageForm
cgc_eventForm
forumController
forum_topicForm
topic_replyForm
teacAdminForm
teacCounselorForm
app_userForm

EC Controller
Figure 3.10: Visibility of CSC EC Boundary with CSC EC Controller.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
15/84

CLASSIFIED
EC/CS226B/06/2007/SDD
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
16/84
EC/CS226B/06/2007/SDD
CLASSIFIED
4.
DETAILED DESIGN
This paragraph describes CSCs used in CSCI EC.
EC SYSTEM
EC BOUNDARY
studMemberForm
cgc_ev entForm
studNonMemberForm
forumForm
teacAdminForm
appointmentForm
f orum_topicForm
topic_reply Form
teacCounselorForm
scheduleForm
app_useForm
messageForm
EC CONTROLLER

teacAdminController
topic_reply Controller
app_userController
s_member
s_nonmember
administrator
counselor
messageController
f orumController
EC ENTITY
schedule
appointment
cgc_event
forum
scheduleController
cgc_ev entController
f orum_topicController
message
forum_topic
app_user
topic_reply
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.
FORMAT
ITEM NUMBER
CSC EC Controller [SDD_REQ_1000]
A4
0B-02-01-06-034-
REVISION
PAGE
A
A
17/84
EC/CS226B/06/2007/SDD
CLASSIFIED
updateAccount()
viewProfile()
joinForum()
makeApp()
maintainMessage()
teacAdminController
registerMember()
registerCGC()
addRecord()
updateRecord()
deleteRecord()
viewRecord()
printRecord()
app_userController
login()
logout()
updateAccount()
viewProfile()
joinForum()
manageApp()
manageSchedule()
manageCGCevent()
maintainMessage()
forumController
addForum()
viewForum()
searchForum()
makeApp()
cancelApp()
viewApp()
manageApp()
searchApp()
printAppList()
scheduleController
messageController
addSchedule()
editSchedule()
deleteSchedule()
viewSchedule()
printSchedule()
sendMessage()
deleteMessage()
viewMessage()
fwdMessage()
replyMessage()
addForumTopic()
viewForumTopic()
addTopicReply()
addReply()
viewTopicReply()
cgc_eventController
addEvent()
updateEvent()
deleteEvent()
viewEvent()

Figure 4.2: CSC EC Controller class diagram.
4.1.1.
CSU studMemberController [SDD_REQ_1010]

studMemberControllerDOCUMENT
FORMAT
updateAccount()
viewProfile()
A4
joinForum()
makeApp()
maintainMessage()
IDENTIFICATION
ITEM NUMBER
REVISION
PAGE
0B-02-01-06-034-
A
A
18/84
EC/CS226B/06/2007/SDD
CLASSIFIED
Class type
Responsibility
Attributes
Methods
: Control class
: This class handles the operations done by student (member).
: None
:
4.1.1.1.
updateAccount
Responsibility
:
Input Parameter
:
Output Parameter
:
Precondition
:
Postcondition
:
Algorithm
:
BEGIN
END

4.1.1.2.
viewProfile
Responsibility
: To start control class
Input Parameter
: None
Output Parameter
: None
Precondition
: 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]

registerMember()
registerCGC()
DOCUMENT
IDENTIFICATION
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
19/84
EC/CS226B/06/2007/SDD
CLASSIFIED
Class type
Responsibility
: Control class
: This class handles the operations done by student
(nonmember).
: None
:
Attributes
Methods
4.1.2.1.
registerMember
Responsibility
Input Parameter
: None
Output Parameter
: None
Precondition
: control class is constructed.
student
Postcondition
: Incoming
properly.
teacher
app_userSignal is handling
stud_id
Algorithm
: user_id
teac_id
stud_name
teac_name
BEGIN stud_addr
user_pword
teac_ic
user_role
stud_postcode
teac_positi on
stud_state
END
teac_username
stud_ic
login()
teac_pword
stud_pob
logout()
stud_phoneNo
stud_email
4.1.2.2. stud_username
registerCGC
stud_pword
cgc_member
Responsibility
stud_status
administrator
counselor
Input Parameter
: None
Output Parameter
: None
addRecord()
updateAccount()
Precondition
: control class
is constructed.
updateRecord()
viewProfile()
Postcondition
: Incoming Signal
is handling properly.
deleteRecord()
joinForum()
s_member
s_nonmember
Algorithm
:
viewRecord()
manageApp()
printRecord()
manageSchedule()
BEGIN
registerMember()
updateAccount()

forum
manageCGCevent()
maintainMessage()
registerCGC()
viewProfile()
joinForum()
END
makeApp()
maintainMessage()
cgc_event
topic_reply
reply_id
reply_desc
reply_date
reply_time
topic_id
reply_to
user_id
status
addForum()
viewForum()
searchForum()
4.2.
addTopicReply()
addReply()
viewTopicReply()
CSC EC Entity
forum_topic
topic_id
topic_name
topic_date
topic_time
forum_id
user_id
topic_view
addForumTopic()
viewForumTopic()
appointment
cgc_id
cgc_name
cgc_desc
cgc_time
cgc_date
teac_id
forum_id
forum_name
forum_desc
forum_date
forum_time
forum_cat
user_id
forum_view
addEvent()
updateEvent()
deleteEvent()
viewEvent()
app_id
app_subject
app_desc
app_status
s_id
user_id
stud_id
teac_id
message
msg_id
msg_desc
msg_date
msg_time
msg_subject
recipient_id
sender_id
outbox
msg_status
reply_id
fwd_id
makeApp()
cancelApp()
[SDD_REQ_2000]
viewApp()
sendMessage()
manageApp()
schedule
deleteMessage()
searchApp()
viewMessage()
s_id
printAppList()
fwdMessage()
s_time
replyMessage()
s_day
s_date
teac_id
FORMAT
ITEM NUMBER
addSchedule()
editSchedule()0B-02-01-06-034A4
deleteSchedule()
viewSchedule()
printSchedule()
REVISION
PAGE
A
A
20/84

CLASSIFIED
EC/CS226B/06/2007/SDD
Figure 4.3: CSC EC Entity class diagram.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
21/84
EC/CS226B/06/2007/SDD
CLASSIFIED
4.2.1.
CSU s_member [SDD_REQ_2010]

student
stud_id
stud_name
stud_addr
stud_postcode
stud_state
stud_ic
stud_pob
stud_phoneNo
stud_email
stud_username
stud_pword
cgc_member
stud_status
s_member
s_nonmember
updateAccount()
viewProfile()
joinForum()
makeApp()
maintainMessage()
registerMember()
registerCGC()

Figure 4.4: CSU s_member class diagram.
Class type
Responsibility
Attributes
: Entity class
: Hold the information of student (member).
:
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
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
22/84
EC/CS226B/06/2007/SDD
CLASSIFIED
4.2.1.1.
updateAccount
Responsibility
: To update students username and password.
Input Parameter
: None
Output Parameter
: None
Precondition
: Need to login to be in members session.
Postcondition
: Username and/or password are updated.
Algorithm
:
BEGIN
stud_username=new_username;
stud_pword=new_pword;
updateAccount ();
END
viewProfile
: To view students profile such as new messages
(if any), new appointment (if any), forum alerts or
CGC activities alert.
Input Parameter
: None
Output Parameter
: None
Precondition
Postcondition
: Initialized value for Entity
Algorithm
:
BEGIN
viewProfile();
END

4.2.1.2.
Responsibility
4.2.1.3.
joinForum
Responsibility
: Enable student to join forums.
Input Parameter
: None
Output Parameter
: None
Precondition
Postcondition
Algorithm
:
BEGIN
joinForum();
END
4.2.1.4.
makeApp
Responsibility
: Enable student to make appointment with counselor.
Input Parameter
: None
Output Parameter
: None
Precondition
Postcondition
: Initialized value for Entity.
Algorithm
:
BEGIN
makeApp();
END
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
23/84
EC/CS226B/06/2007/SDD
CLASSIFIED
maintainMessage
: Enable student to maintain messages to counselors or
other students.
Input Parameter
: None
Output Parameter
: None
Precondition
Postcondition
Algorithm
:
BEGIN
maintainMessage();
END

4.2.1.5.
Responsibility
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
24/84
EC/CS226B/06/2007/SDD
CLASSIFIED
4.2.2.
CSU s_nonmember [SDD_REQ_2020]

student
stud_id
stud_name
stud_addr
stud_postcode
stud_state
stud_ic
stud_pob
stud_phoneNo
stud_email
stud_username
stud_pword
cgc_member
stud_status
s_member
updateAccount()
viewProfile()
joinForum()
makeApp()
maintainMessage()
s_nonmember
registerMember()
registerCGC()
Figure 4.5: CSU s_nonmember class diagram.

Class type
Responsibility
Attributes
: Entity class
: Hold the information of student (nonmember).
:
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)
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
25/84
EC/CS226B/06/2007/SDD
CLASSIFIED
Methods
4.2.2.1.
registerMember
Responsibility
: 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
: None
Precondition
: 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 IF
END

4.2.2.2.
Responsibility
registerCGC
: To register as member of Counseling and Guidance
Club.
Input Parameter
: None
Output Parameter
: None
Precondition
: 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
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
26/84
EC/CS226B/06/2007/SDD
CLASSIFIED
5.
CSCI EC DATA TYPE DEFINITIONS
5.1.
Not Applicable
CSCI EC Constants
5.2.
CSCI EC Data Types
Data Dictionary for Entity Database

Data types for studMember Entity class

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)
Data types for studNonMember Entity class
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)
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
27/84
EC/CS226B/06/2007/SDD
CLASSIFIED
Data types for teacAdmin Entity class

teac_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 class
teac_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 class

app_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 class
s_id
:int(10)
s_time
:varchar(50)
s_day
:varchar(20)
s_date
:date
teac_id
:int(10)
Data type message Entity class
msg_id
:int(10)
msg_desc
:text
msg_date
:date
msg_time
:time
msg_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)
FORMAT
Data type for cgc_event Entity class

A4
ITEM NUMBER
REVISION
PAGE
0B-02-01-06-034-
A
A
28/84
EC/CS226B/06/2007/SDD
CLASSIFIED
cgc_id
cgc_name
cgc_desc
cgc_date
cgc_time
teac_id
:int(10)
:varchar(50)
:varchar(100)
:date
:time
:int(10)
Data type for forum Entity class

forum_id
:int(10)
forum_name
:varchar(100)
forum_desc
:text
forum_date
:date
forum_time
:time
forum_cat
:varchar(100)
forum_view
:int(10)
user_id
:varchar(50)

Data type for forum_topic Entity class

topic_id
:int(10)
topic_name
:text
topic_date
:date
topic_time
:time
forum_id
: int(10)
user_id
:varchar(50)
topic_view
:int(10)
Data type for topic_reply Entity class
reply_id
:int(10)
reply_desc
:text
reply_date
:date
reply_time
:time
topic_id
:int(10)
reply_to
:varchar(50)
status
:varchar(10)
user_id
:varchar(50)
Data type for app_user Entity class
user_id
:varchar(50)
user_pword
:varchar(50)
user_role
:varchar(50)
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
29/84

CLASSIFIED
6.
EC/CS226B/06/2007/SDD
CSCI DATA FILES
Not Applicable.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
30/84
EC/CS226B/06/2007/SDD
CLASSIFIED

7.
REQUIREMENTS TRACEABILITY
Table 7.1: Requirements traceability.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
31/84
EC/CS226B/06/2007/SDD
CLASSIFIED
Source
SDD_REQ_1000
Requirements
Allocated
Allocation
reference
4.1
SDD_REQ_1010
SDD _REQ_1020
SDD _REQ_1030
SDD _REQ_1040
SDD _REQ_1050
:
:
:
:
:
:
:
SDD_REQ_2000
4.2

SDD_REQ_2010
SDD _REQ_2020
SDD _REQ_2030
SDD _REQ_2040
SDD _REQ_2050
:
:
:
:
:
:
:
Description
Provides services to
control the operation
each entity
Provide necessary
data upon request
Table 7.2: Summary of requirements in Software Details Design
Notes:
Please refer Appendix A for summary of requirements in Software Requirements
Specification.
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
32/84
EC/CS226B/06/2007/SDD
CLASSIFIED
8.
NOTES
Abbreviation used:

CDR
CI
CSC
CSCI
CSU
PDR
SDD
SRS
UML
CGC
Critical Design Review

Configuration Item
Computer Software Component
Component Software Configuration Item
Computer Software Unit
Preliminary Design Review
Software Design Document
Software Requirement Specification
Unified Modeling Language
Counseling and Guidance Club
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
33/84

CLASSIFIED
EC/CS226B/06/2007/SDD
APPENDIX A
Summary of Requirements
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
34/84
EC/CS226B/06/2007/SDD

CLASSIFIED
No.
1.
2.
3.
4.
5.
6.
Requirements
SRS_REQ_1000
SRS_REQ_1010
SRS_REQ_1020
SRS_REQ_1030
SRS_REQ_1040
SRS_REQ_1050
Description
Register Membership
Filling up the registration form
Register now
Cancel registration
Invalid data type
Insufficient data
7.
8.
9.
10.
11.
SRS_REQ_2000
SRS_REQ_2010
SRS_REQ_2020
SRS_REQ_2030
SRS_REQ_2040
Authenticate Password
Filling up the user id and password
Verifying user id and password
Determine the status of user
Invalid user id and password
12.
13.
14.
15.
16.
17.
18.
SRS_REQ_3000
SRS_REQ_3010
SRS_REQ_3020
SRS_REQ_3030
SRS_REQ_3040
SRS_REQ_3050
SRS_REQ_3060
Update Account
View details
Update account
Change Password
Invalid data entry
Insufficient data entry
Invalid change password
19.
20.
21.
22.
23.
24.
25.
26.
SRS_REQ_4000
SRS_REQ_4010
SRS_REQ_4020
SRS_REQ_4030
SRS_REQ_4040
SRS_REQ_4050
SRS_REQ_4060
SRS_REQ_4070
Join Forum
Select to join a forum
View form
Create new topics
Post a new message
Reply to the others posted message
Invalid data type
27.
28.
29.
30.
31.
32.
33.
SRS_REQ_5000
SRS_REQ_5010
SRS_REQ_5020
SRS_REQ_5030
SRS_REQ_5040
SRS_REQ_5050
SRS_REQ_5060
Make Appointment
Select make appointment
Request appointment
View a list of appointment
Cancel appointment
Invalid data type
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
35/84
EC/CS226B/06/2007/SDD

CLASSIFIED
34.
35.
36.
37.
38.
39.
40.
41.
42
SRS_REQ_6000
SRS_REQ_6010
SRS_REQ_6020
SRS_REQ_6030
SRS_REQ_6040
SRS_REQ_6050
SRS_REQ_6060
SRS_REQ_6070
SRS_REQ_6080
Maintain Message
Select to maintain message
Read message
Write message
Reply message
Forward message
Delete message
Invalid data type
43.
44.
45.
46.
47.
SRS_REQ_7000
SRS_REQ_7010
SRS_REQ_7020
SRS_REQ_7030
SRS_REQ_7040
Manage Appointment
Capability to manage appointment
View list of appointment
Approve or disapprove appointment
Invalid Date of appointment
48.
49.
50.
51.
52.
53.
54.
55.
SRS_REQ_8000
SRS_REQ_8010
SRS_REQ_8020
SRS_REQ_8030
SRS_REQ_8040
SRS_REQ_8050
SRS_REQ_8060
SRS_REQ_8070
Manage Event for CGC

Manage event for CGC
Add event for CGC
Retrieve event for CGC
Update event for CGC
Delete event for CGC
Invalid data type
56.
57.
58.
59.
60.
61.
62.
63.
64.
SRS_REQ_9000
SRS_REQ_9010
SRS_REQ_9020
SRS_REQ_9030
SRS_REQ_9040
SRS_REQ_9050
SRS_REQ_9060
SRS_REQ_9070
SRS_REQ_9080
Maintain Students Record

Maintain Students Record
Add student record
Retrieve student record
Update student record
Delete student record
Print student record
Invalid data type
65.
66.
67.
68.
69.
70.
71.
72.
73.
SRS_REQ_10000
SRS_REQ_10010
SRS_REQ_10020
SRS_REQ_10030
SRS_REQ_10040
SRS_REQ_10050
SRS_REQ_10060
SRS_REQ_10070
SRS_REQ_10080
Maintain Counselor Record

Maintain Counselor Record
Add counselor record
Retrieve counselor record
Update counselor record
Delete counselor record
Print counselor record
Invalid data type
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
36/84
EC/CS226B/06/2007/SDD
CLASSIFIED

74.
75.
76.
77.
78.
79.
80.
81.
82.
SRS_REQ_11000
SRS_REQ_11010
SRS_REQ_11020
SRS_REQ_11030
SRS_REQ_11040
SRS_REQ_11050
SRS_REQ_11060
SRS_REQ_11070
SRS_REQ_11080
Manage Schedule
Manage Schedule
Add Schedule
Retrieve Schedule
Update Schedule
Delete Schedule
Print Schedule
Invalid data type
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
37/84

CLASSIFIED
EC/CS226B/06/2007/SDD
APPENDIX B
Class Diagram
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
38/84

CLASSIFIED
EC/CS226B/06/2007/SDD
CSCI Entity to Entity Class Diagram
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
39/84

CLASSIFIED
EC/CS226B/06/2007/SDD
CSCI Analysis Class Diagram
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
40/84

CLASSIFIED
EC/CS226B/06/2007/SDD
THIS PAGE IS INTENTIONALLY LEFT BLANK
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
41/84
EC/CS226B/06/2007/SDD
CLASSIFIED
REVISION HISTORY
Revision
Description
19/04/2007 Creating Document
26/04/2007 Updating Document

Date
Written by
19/04/2007
26/04/07
Noraini A. Ghani
Noraini A. Ghani
Siti Safuraa Mazlan
Siti Safuraa Mazlan
Siti Noor Baizura

Ahmad Bistamam
Siti Noor Baizura

Ahmad Bistamam
Inspected by
Approved by
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
42/84
EC/CS226B/06/2007/SDD
CLASSIFIED
LIST OF EFFECTIVE PAGE(s)

Page(s)
iii
iv
v
vi
vii
7-13
16
18-20
28
33
39
42
43
48
61
62
Revision
-
Page(s)
Revision
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
43/84

CLASSIFIED
EC/CS226B/06/2007/SDD
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
44/84
EC/CS226B/06/2007/SDD
CLASSIFIED
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 __________________
(Contracting agency)
Approved by __________________
(Contractor)
Dated __________________________
Dated _______________________
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
45/84
EC/CS226B/06/2007/SDD
CLASSIFIED
SOFTWARE DESIGN DOCUMENT

(SDD)
for the
E-COUNSELING
(EC)
of the
COUNSELING

system
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
46/84
EC/CS226B/06/2007/SDD
CLASSIFIED

TABLE OF CONTENTS
1. SCOPE..............................................................................................................................1
1.1.
Identification............................................................................................................1
1.2.
CSCI Overview........................................................................................................1
1.3.
Document Overview................................................................................................3
2. APPLICABLE DOCUMENTS.......................................................................................5
2.1.
Government Documents...........................................................................................5
2.2.
Non-Government Documents..................................................................................5
3. PRELIMINARY DESIGN..............................................................................................6
3.1.
CSCI Overview........................................................................................................6
3.1.1. CSCI Architecture................................................................................................7
3.1.1.1.
Static Organization.......................................................................................7
3.1.1.2.
Dynamic Organization...............................................................................10
3.1.1.3.
CSCs Interfaces..........................................................................................14
3.1.1.4.
CSC External CSCIs Interfaces..................................................................14
3.1.2. System States and Modes...................................................................................15
3.1.3. Memory and Processing Time Allocation..........................................................15
3.2.
CSCI Design Description.......................................................................................16
3.2.1. CSC EC Controller [SDD_REQ_1000]............................................................16
3.2.2. CSC EC Entity [SDD_REQ_2000]....................................................................17
3.2.3. CSC EC Boundary [SDD_REQ_3000]..............................................................18
4. DETAILED DESIGN....................................................................................................19
4.1.
CSC EC Controller [SDD_REQ_1000]:...............................................................20
4.1.1. CSU studMemberController [SDD_REQ_1010]...............................................21
4.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]...............................................25
4.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]:......................................................................33
4.2.1. CSU s_member [SDD_REQ_2010]...................................................................34
4.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]...............................................................47
4.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
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
47/84
EC/CS226B/06/2007/SDD
CLASSIFIED

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].....................................................................66
5. CSCI OBA DATA TYPE DEFINITIONS....................................................................68
5.1.
CSCI ECS Constants..............................................................................................68
5.2.
CSCI ECS Data Types............................................................................................68
6. CSCI DATA FILES........................................................................................................71
7. REQUIREMENTS TRACEABILITY.........................................................................72
8. NOTES............................................................................................................................76
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
48/84
EC/CS226B/06/2007/SDD
CLASSIFIED
LIST OF FIGURES

Figure 3.1: Context Diagram....................................................................................................6

Figure 3.2: The CSCI EC packages..........................................................................................7
Figure 3.3: Processes in CSCI EC..........................................................................................10
Figure 3.4: Controller Process................................................................................................11
Figure 3.5: Entity Process......................................................................................................12
Figure 3.6: Boundary Process................................................................................................13
Figure 3.7: Relationship between the CSCs...........................................................................14
Figure 3.8: Visibility of CSC EC Controller with other CSCs...............................................16
Figure 3.9: Visibility of CSC EC Entity with other CSCs.....................................................17
Figure 3.10: Visibility of CSC EC Boundary with other CSCs.............................................18
Figure 4.1: Class Diagram for CSCI EC................................................................................19
Figure 4.2: CSC EC Controller Class Diagram......................................................................20
Figure 4.3: CSC EC Entity Class Diagram............................................................................33
Figure 4.4: CSU s_member Class Diagram...........................................................................34
Figure 4.5: CSU s_nonmember Class Diagram.....................................................................37
Figure 4.6: CSU administrator Class Diagram.......................................................................39
Figure 4.7: CSU counselor Class Diagram............................................................................43
Figure 4.8: CSU appointment Class Diagram........................................................................47
Figure 4.9: CSU schedule Class Diagram..............................................................................51
Figure 4.10: CSU message Class Diagram............................................................................54
Figure 4.11: CSU forum Class Diagram................................................................................58
Figure 4.12: CSU forum_topic Class Diagram......................................................................60
Figure 4.13: CSU topic_reply Class Diagram........................................................................62
Figure 4.14: CSU cgc_event Class Diagram..........................................................................64
Figure 4.15: CSU app_user Class Diagram............................................................................66
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
49/84
EC/CS226B/06/2007/SDD
CLASSIFIED
LIST OF TABLES

Table 7.1: Requirements traceability......................................................................................71

Table 7.2: Summary of requirements in Software Details Design.........................................75
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
50/84
EC/CS226B/06/2007/SDD
CLASSIFIED
LIST OF APPENDICES

Appendix A : Summary of Requirements...............................................................................77

Appendix B : Class Diagram..................................................................................................81
FORMAT
ITEM NUMBER
REVISION
PAGE
A4
0B-02-01-06-034-
A
A
51/84

SDD Example

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SDD Example

Uploaded by

Copyright:

Available Formats

EC/CS226B/06/2007/SDD

1.2. CSCI Overview

This document and the information it contains is the property of FTMSK-UiTM. Do

A user friendly system for both student and counselor

Purpose of the CSCI:

This document and the information it contains is the property of FTMSK-UiTM. Do

This document specifies the procedure to be applied during:

Preliminary design stage:

Detailed design stage:

This document and the information it contains is the property of FTMSK-UiTM. Do

describes the scope, identification, system overview and document

describes the applicable documents, government documents and nongovernment documents.

describes the preliminary design, CSCI overview, CSCI architecture,

describes the CSCI data.

This document and the information it contains is the property of FTMSK-UiTM. Do

describes the CSCI data file to CSC/CSU cross reference

describes the requirements traceability.

This document and the information it contains is the property of FTMSK-UiTM. Do

PHP and MYSQL For Dynamic Web Sites

This document and the information it contains is the property of FTMSK-UiTM. Do

FIGURE 3.1: CONTEXT DIAGRAM.

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 3.2: The CSCI EC packages.

The packages are briefly described as follows

This document and the information it contains is the property of FTMSK-UiTM. Do

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 3.3: Processes in CSCI EC

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 3.4: RegisterMembership process

Figure 3.5: ManageSchedule

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 3.7: Relationship between the CSCs.

CSC External CSCIs Interfaces

This document and the information it contains is the property of FTMSK-UiTM. Do

This document and the information it contains is the property of FTMSK-UiTM. Do

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

This document and the information it contains is the property of FTMSK-UiTM. Do

Relationship with the other CSCs is shown as below:

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

This document and the information it contains is the property of FTMSK-UiTM. Do

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

This document and the information it contains is the property of FTMSK-UiTM. Do

This paragraph describes CSCs used in CSCI EC.

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 4.1: Class Diagram for CSCI EC

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 4.2: CSC EC Controller class diagram.

CSU studMemberController [SDD_REQ_1010]

This document and the information it contains is the property of FTMSK-UiTM. Do

CSU studNonMemberController [SDD_REQ_1020]

This document and the information it contains is the property of FTMSK-UiTM. Do

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 4.3: CSC EC Entity class diagram.

CSU s_member [SDD_REQ_2010]

This document and the information it contains is the property of FTMSK-UiTM. Do

Figure 4.4: CSU s_member class diagram.

This document and the information it contains is the property of FTMSK-UiTM. Do

This document and the information it contains is the property of FTMSK-UiTM. Do

CSU s_nonmember [SDD_REQ_2020]

Figure 4.5: CSU s_nonmember class diagram.

This document and the information it contains is the property of FTMSK-UiTM. Do

This document and the information it contains is the property of FTMSK-UiTM. Do

CSCI EC DATA TYPE DEFINITIONS

This document and the information it contains is the property of FTMSK-UiTM. Do