Академический Документы
Профессиональный Документы
Культура Документы
Prepared by:
Nurul Akmar Rosni
Syarmila Es Abdul Wahab
Nurul Aziana Mohd Rabai
(Solution Architect)
Reviewed by:
Wan Mat Wan Sulaiman
(Project Leader)
Approved by:
Rahmat Mohd Aris
(Project Manager)
Distribution:
Company’s Name Recipient’s Name
Faculty of Computer Science & Information System, Dr. Masitah Ghazali
Universiti Teknologi Malaysia (Project Manager)
Project Team
Project Library
Software Design Description for Ceiling Price Checker System Page 2
REVISION HISTORY
Wan Mat Wan Sulaiman 11/10/2009 Final - complete draft, which is 1.0
placed under change control
Syarmila Es Abdul Wahab 10/10/2009 Made some formatting and content 0.4
changes
Nurul Aziana Mohd Rabai 07/10/2009 Insert new primary sequence 0.3
diagram
Syarmila Es Abdul Wahab 06/10/2009 Made some formatting and content 0.2
changes
Nurul Akmar Rosni 02/10/2009 Initial draft created for distribution 0.1
and review comments
Software Design Description for Ceiling Price Checker System Page 3
Table of Contents
PREFACE ..................................................................................................................................... 5
SECTION 1: OVERVIEW ............................................................................................................. 6
1.1 Purpose ................................................................................................................................ 6
1.2 Scope ................................................................................................................................... 6
SECTION 2: SYSTEM ARCHITECTURE ................................................................................... 10
2.1 System Organization: Client Server Model ........................................................................ 10
2.2 Control Style: Centralized Control (Manager Model) ......................................................... 11
SECTION 3: DATA DICTIONARY ............................................................................................. 12
SECTION 4: SOFTWARE DOMAIN DESIGN ............................................................................ 15
4.1 Class Diagram.................................................................................................................... 15
4.2 State Transition Diagram ................................................................................................... 16
SECTION 5: SEQUENCE DIAGRAMS AND DESCRIPTIONS ................................................. 17
5.1 Sequence Diagram: Manage Account ............................................................................... 17
5.1.1 Create Account .................................................................................................... 17
5.1.2 Update Account ................................................................................................... 18
5.1.3 Delete Account .................................................................................................... 19
5.2 Sequence Diagram: Login.................................................................................................. 20
5.3 Sequence Diagram: Manage Information .......................................................................... 21
5.3.1 Insert New Information ........................................................................................ 21
5.3.2 Update Information .............................................................................................. 22
5.3.3 Delete Information ............................................................................................... 23
5.4 Sequence Diagram: Generate Report ................................................................................ 24
5.5 Sequence Diagram: Search For Controlled Goods And Ceiling Price ............................... 25
SECTION 6: USER INTERFACE DESIGN ............................................................................... 26
6.1 Manage User Account........................................................................................................ 27
6.1.1 Main Page ........................................................................................................... 27
6.1.2 Create New Account ........................................................................................... 28
6.1.3 Update Or Delete ................................................................................................ 29
6.2 Login For Administrator ...................................................................................................... 30
6.3 Manage Controlled Goods And Ceiling Price Information .................................................. 31
6.3.1 Main Page ........................................................................................................... 31
Software Design Description for Ceiling Price Checker System Page 4
PREFACE
This software design description (SDD) Price Checker System is develop to help consumer to
check whether the goods was under controlled or not. If the goods is under controlled,
consumer can know the price that have been decided by goverment. Consumer can check the
price in two ways. First, check via online system that Kementerian Perdagangan Dalam Negeri,
Koperasi dan Kepenggunaan (KPDNKK) develop for their customers and second via Short
Message Servis (SMS). By online system, consumer can check the price by enter the name of
the goods. After that, system will check the list of the price whether the goods is under
controlled or not. The system will accept the information and list the name and the price of the
goods. The system will search the name of the goods that consumer want and then view all the
list of the goods. The same thing for the consumer using Short Message Servis (SMS), they just
key in the name and price of the goods and then send to (KPDNKK) number. After that, the
system will accept the information and reply the information by send the same thing which is the
name and the price of the goods. Different from the online system, the system via SMS not view
all the list of good but just view the name and the price of the goods that consumers want. For
the system administrator, they need to login using authorized ID that they register to allow them
access this online systems. They will record and save the transaction such as date and time,
phone number (for SMS) and the message. So, the system administrator can easily generate
the reports.
In this document, we have also included the class diagram; enhance sequence diagram, data
dictionary, architecture design, state diagram, and user interface and traceability matrix of the
price checking system. All of these will help in developing the SMS price checking system which
all the stakeholders as well as the users will feel interested on it.
Software Design Description for Ceiling Price Checker System Page 6
SECTION 1: OVERVIEW
1.1 Purpose
The purpose of Software Design Description (SDD) document is to describe the behaviour of
the ceiling price checker system. Software Design Description defines and describes the
interfaces, data definition language with all the entities, attributes and operations of each entity
for ceiling price checker system. This document also describes the type of relationship and
multiplicity between each entity besides discovering the architecture design for the price
checking system. It also describes the requirement traceability matrix which is the continuous
from previous requirement traceability, and other factors necessary to provide a complete and
comprehensive description of the design for the software. The Software Design Description
(SDD) covers the complete software design description for the system.
1.2 Scope
The Software Design Description (SDD) designs a system to meet the requirements of both the
stakeholder and the consumer of ceiling price checker system from previous Software
Requirement Specification (SRS). The ceiling price checker system that is to be developed
provides the display the price ceiling when consumer want get the info, ceiling price checking
services as well as many other facilities to consumer. The checking price System is supposed to
give the following features to the user:-
a. Limited usage
This system can be used anywhere and anytime for public or online consumer using
system and SMS.
c. Target of Consumer
For consumer that want to view or search for goods controlled price, they can search
this controlled good by system or by SMS. Then, the system will list all the controlled
Software Design Description for Ceiling Price Checker System Page 7
good and the system will assist the system administrator to record the information
about the goods controlled and save the transaction of the information.
The features describe in this document are meet to both the user and stakeholder requirements.
The success criteria for the system are based in the level up to which the features described in
this document are implemented in the system.
Software Design Description for Ceiling Price Checker System Page 8
REFERENCES
Contractual Documents
Unless otherwise specified in the present document, the requirements set forth in the standard
indicated below form part of the statement of work:
[01] Dr Masitah Ghazali, Faculty of Computer Science & Information System. (First short
client meeting, 07th October 2009)
Non-Contractual Documents
Unless otherwise specified in the present document, the requirements set forth in the standard
indicated below form part of the statement of work:
[05] IEEE Std 830-1998 IEEE Recommended Practice for Software Requirements
Specifications
ISBN: 978-0-321-31379-9
ISBN: 983-2473-90-X
ISBN: 983-52-0176-5
Reference Documents
Unless otherwise specified in the present document, the requirements set forth in the standard
indicated below form part of the statement of work:
Template
The software architecture of a program or computing system is the structure or structures of the
system, which comprise software components, the externally visible properties of those
components, and the relationships between them. The term also refers to documentation of a
system's software architecture. Documenting software architecture facilitates communication
between stakeholders, documents early decisions about high-level design, and allows reuse of
design components and patterns between projects.
The system is server-based application written in PHP and accessible by client using any web
browser. C-Print utilize MySQL database. The database is directly connected to the network,
and allows the server to access its information. The server is connected to the Internet this
allows the program to output an HTML files that is visible over the Internet. Figure shows the
system connectivity.
The client-server architectural model is a system model where the system is organized as a set
of services and associated servers and clients that access and use the services. Inputs from
clients are always needed to be used to access the Web server therefore client server model is
used.
Software Design Description for Ceiling Price Checker System Page 11
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.
:Login
+ login() : void
+ logout() : void
:Acc ount
gene rate
:Infor mation
+ active: char
+ category: String
+ code: int :Reporting
+ endingDat e: Date + endingDat e: Date
:Sear ching + name: String + startingDate: Date
+ pk: int
+ keyword: String + price: double + listOfAccou nt() : void
+ startingDate: Date + listOfActiveCP rice() : void
+ listOfInactiveCPrice() : void
+ delete() : void
+ insert() : void
+ update() : void
+ view() : void
Software Design Description for Ceiling Price Checker System Page 16
State Transition Diagram is use cases and scenarios provide a way to describe system behavior
that is the interaction between objects in the system. State diagrams are a technique to describe
the behavior of one object, i.e., state changes of a single object according to events and
messages which the class sends and receives.
stm C-Price
[No?]/prompt
keyword
[No?]/prompt
login/prompt
Wait for input username & password check for authorization
Yes
logout
Wait
Fin al
home hyperlink generate report home hyperlink
manage info
User Account
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 need to read from left to right and above to bottom.
sd Create aAccount
1. manageAccount()
2. getAccountDetails()
3. processAccount()
4. accountStatus()
5. openAccountPage()
6. displayAccountPage()
Descriptions:
This sequence diagram describes how to create a new account. The user starts this
sequence diagram is system administrator. The diagram begins when the user clicks on
[1]
Add New Account hyperlink . When user in account form, the user should fills in and
[2]
submits required parameters and click on Save button . The system will validate the
[3]
input parameters . If in the system found that the username already exist, error
message is displayed. The user can type in a new username or choose to cancel the
operation, at which point the sequence diagram ends. The system will save the input
parameters into database and display successful message [4]. The system displays the
Manage Account page and the sequence diagram ends. [5]
Software Design Description for Ceiling Price Checker System Page 18
sd Update Account
: System Administrator : Acco unt Up date : Accou ntCtrl : Account : Accou nt Page
Account
1.updateAccount()
2.getAccountDetails()
3.processAccount()
4.AccountStatus()
5.openAccountPage()
6.displayAccountPage()
Descriptions:
This sequence diagram describes how to update an existing account. The user starts
[1]
this sequence diagram is system administrator . The sequence diagram begins when
the user (System administrator) fill in the required field and click Search button from
[2]
main page Manage User Account. The list of created account will be displayed . From
[3]
the list, the user can edit existing information and click on Save button . The system
[4]
will save the input parameters into database and display successful message . The
[5]
system displays the Manage Account page and the sequence diagram ends .
Software Design Description for Ceiling Price Checker System Page 19
sd Delete Account
1. deleteAccount()
2.getAccountDetails()
3.confirmation()
4.deleteAccount()
5.accountStatus()
Descriptions:
This sequence diagram describes how to delete an account. The user starts this
sequence diagram is system administrator. The sequence diagram begins when the
[1] [2]
user click on Delete Account button . The list of created account will be displayed .
From the list, the user clicks on the username button. The user will display the details of
created account. Then, the user has to click on Delete button. When the user clicks on
Delete button, the system will pop-up a confirmation alert containing confirmation
[3]
message, Yes button and No button . If the user clicks No button, the system will back
to the previous page. Else, the system deletes the account from the database and
[4]
display successful message . The system displays the Manage Account page and the
[5]
sequence diagram ends .
Software Design Description for Ceiling Price Checker System Page 20
sd Login
1. openLoginPage()
2. getInput()
3. validateAccount()
4.validityStatus()
5.openNextPage()
6.signOut()
Descriptions:
This sequence diagram describes how a user logs into the system. The user starts this
sequence diagram is system administrator. The sequence diagram begins when the
[1]
user types his/her username and password on the login form and press Login button .
The user submits username and password [2]. The system validates the user’s username
and password [3]. The system set the code of user’s roles into the cookies. Each role has
their capabilities [4]. The system displays the main page based on user’s roles [5]. If in the
basic flow the system cannot find the username or the username and password is
mismatch, an invalid username / password error message is displayed. The user can
type in a new username and password or choose to cancel the operation[6], at which
point the sequence diagram ends.
Software Design Description for Ceiling Price Checker System Page 21
: System administrator : Man age I nfo : Mana geCtrl : Man age I nfo : Inf oCtrl : I nfo
Pa ge Fo rm
1.displayManageInfoPage()
2.getInfoType()
3.sendInfoType()
4.getInfoDetails()
5.manageInfo()
6.infoStatus()
7.displayInfoDetails()
8.displayInfoList()
Descriptions:
This sequence diagram describes how to insert new information of controlled goods and
price. The user starts this sequence diagram is system administrator. The sequence
diagram begins when the user click Manage Controlled Goods and Ceiling Price
Information hyperlink at Administrator Section to search information of controlled goods
[1]
and price . User must fill in the required field to reset or add new the record. The
system will check with database whether the information exists or not in the system. If
the information exists, record will be displayed. The system begins when the user click
[2]
on Add New Record button . The Add Controlled Goods Form will be displayed. The
[3]
user fills in the required information and submits information by click on Save button .
[4]
The system validates the input parameters . The system will save the input parameters
[5] [6]
into database and display successful message . The system displays the Manage
[7] [8]
Controlled Goods information page and the sequence diagram ends . If in the basic
flow the system found that the information already exists, error message is displayed.
Software Design Description for Ceiling Price Checker System Page 22
The user can type in a new information or choose to cancel the operation, at which point
the sequence diagram ends.
: System Administrator :Mana ge I nfo :Manag eCtrl : Man age I nfo : Inf oCtrl : I nfo
Pa ge Fo rm
1.updateManageInfo()
2.getManageType()
3.sendManageType()
4.getInfoDetails()
5.manageInfo()
6.infoStatus()
7.displayInfoDetails()
8.displayInfoList()
Descriptions:
This sequence diagram describes how to update existing controlled goods information.
The user starts this sequence diagram is system administrator. The sequence diagram
begins when the user click Manage Controlled Goods and Ceiling Price Information
[1]
hyperlink at Administrator Section to search information of controlled goods and price .
User must fill in the required field to reset or add new the record. The system will check
with database whether the information exists or not in the system. If the information
exists, record will be displayed. The sequence diagram begins when the user click on
[2]
Search button . The List of Controlled Goods will be displayed. The user selects the
information by clicks on the controlled goods hyperlink. The Information Form will display
[3]
the details of the chosen information. The user can edit existing information and click
[4] [5]
on Save button . The system will save the input parameters into database and
[6]
display successful message . The system displays the Manage Controlled Goods
information page [7] and the sequence diagram ends [8].
Software Design Description for Ceiling Price Checker System Page 23
sd Delete info
: System administrator :Mana ge I nfo :Manag eCtrl :Manage I nfo form :Info Ctrl :In fo
Pa ge
1.deleteInfo()
2.getInfoType()
3.sendInfoType()
4.getInfoDetails()
5.confirmation()
6.deleteAccount()
7.infoStatus()
Descriptions:
This sequence diagram describes how to delete existing controlled goods information.
The user starts this sequence diagram is system administrator. The sequence diagram
begins when the user click Manage Controlled Goods and Ceiling Price Information
[1]
hyperlink at Administrator Section to search information of controlled goods and price .
User must fill in the required field to reset or add new the record. The system will check
with database whether the information exists or not in the system. If the information
exists, record will be displayed. The sequence diagram begins when the user click on
[2]
Search button . The List of Controlled Goods will be displayed. The user selects the
information by clicks on the controlled goods hyperlink. The Information Form will display
[3]
the details of the chosen information. The user cannot edit existing information . The
[4]
user only can click on the Delete button . A pop-up window containing message “Are
[5]
you sure to delete this information?”, Yes and No button . If the user clicks on the No
button, the system will back to the previous page. Else, the system deletes the
[6]
information from the database and display successful message. The system displays
Manage Controlled Goods information page [7] and the sequence diagram ends.
Software Design Description for Ceiling Price Checker System Page 24
sd Generate Reports
: System administrator : Generate Re ports : Gene rate Report : Repo rtCtrl : Report
Pa ge Fo rm
1.requestReportPage()
2.getReportType()
3.getReportParameters()
4.generateReport()
5.sendReports()
Descriptions:
This sequence diagram describes how to generate reports. The user starting this
sequence diagram is System Administrator. The sequence diagram begins when the
[1]
user click Generate Reports hyperlink . The system displays the Generate Reports
[2] [3]
Page . The system begins when the user enters all the required parameter and click
on the Generate Report Button to generate the report [4]. The system will save the record
[5]
in the database and display the result. The user can print the report by click Print
button. The system displays the required report successfully and the sequence diagram
ends.
Software Design Description for Ceiling Price Checker System Page 25
5.5 Sequence Diagram: Search For Controlled Goods And Ceiling Price
sd Search Info
1.requestSearchForm()
2.getKeyword()
3.findInfo()
4.searchResult()
5.displayInfo()
6.sendInfo()
Descriptions:
These sequence diagrams allows consumer to search for goods and controlled price
.The sequence diagram begins when the user enter a keyword in the search controlled
[1] [2]
goods text box and click on the Search button . The system will find the information
[3]
based on the keyword entered by user . If the system found the keyword entered, the
[4]
system will list all the controlled goods related to the keyword . The list contains
controlled goods name, starts date enforcement, end date enforcement, price and
[5]
quantity . The user can click on the hyperlink for the controlled goods details. The
system will display the controlled goods details [6] and the sequence diagram ends.
Software Design Description for Ceiling Price Checker System Page 26
Description: User (System administrator) must click hyperlink Manage User Account at
Administrator Section to start manage user account.
Description: The manage user account consist of Username text box, Full name text
box, Search button, Reset button, Add New Record button, Search Result list and Print
button. To start searching, enter username or full name and click on Search button. To
create new user account, click on Add New Record button. To print the search result list,
click on Print button.
Software Design Description for Ceiling Price Checker System Page 28
Description: System begins when the user clicks on Add New Record button. The user
should fills in required parameters and submit it by click on Save button. The system will
validate the input parameters. Then, system will save the record in the database and
display the successful message.
Software Design Description for Ceiling Price Checker System Page 29
Description: The system begins when the system administrator fill in the required field
and click Search button from main page Manage User Account to make sure the
account exist. The list of created account will be displayed. From the list, the user can
click on the username hyperlink and account details page will be displayed. Now system
administrator can start edit existing information and click on Save button. The system will
validate and save the input parameters into database. If user wants to delete the
account, click on Delete button. When the user clicks on Delete button, the system will
pop-up a confirmation alert containing confirmation message, Yes button and No button.
If the user clicks No button, the system will back to the previous page. Else, the system
deletes the account from the database and displays the successful message.
Software Design Description for Ceiling Price Checker System Page 30
Description: System administrator types the username and password on the login form
and press Login button.
Software Design Description for Ceiling Price Checker System Page 31
Description: The manage controlled goods and ceiling price information consist of
Description text box, Enforcement Starting Date text box, Enforcement Ending Date,
Search button, Reset button, Add New Record button, Search Result list and Print
button. To start searching the controlled goods, enter goods or product keyword and
click on Search button. To create new information, click on Add New Record button.
Software Design Description for Ceiling Price Checker System Page 32
Description: The system begins when the user click on Add New Record button. Add
new record for controlled goods and ceiling price form will be displayed. The user fills in
the required information and submits information by click on Save button. The system
validates the input parameters. The system will save the input parameters into database
and display successful message.
Software Design Description for Ceiling Price Checker System Page 33
Description: The system begins when the user fill in the keyword and click on Search
button. This interface describes how to update/delete existing controlled goods
information. The information form will display the details of the chosen information. The
user can edit existing information and click on Update button. The system will save the
input parameters into database and display successful message. If user wants to delete
the information, click on Delete button. A pop-up window containing message “Are you
sure to delete this information?”, Yes and No button. If the user clicks on the No button,
the system will back to the previous page. Else, the system deletes the information from
the database and display successful message.
Software Design Description for Ceiling Price Checker System Page 34
Description: The system begins when the user click Generate Report hyperlink. The
system displays the Reports Generator page.
Description: The generate report consist of Report Type, enforcement Starting Date
text box, enforcement Ending Date, Generate Report button, Reset button, Report
Result list and Print button. To start generate report, select report type and click on
Generate Report button. The system will process the requested report and display the
result. The user can print the report by click Print button.
Software Design Description for Ceiling Price Checker System Page 35
Description: This system allows consumer to search for controlled goods and ceiling
price. The system begins when the user enter a keyword in the search text box and click
on the Search button. The system will find the information based on the keyword entered
by user. If the system found the keyword entered, the system will list all the controlled
goods and ceiling price related to the keyword. The list contains controlled goods code,
description, starts date enforcement, end date enforcement, quantity/unit and ceiling
price.
Software Design Description for Ceiling Price Checker System Page 36
Manage User Account Main page for manage user account Page 24
Page such as list all existing user account,
insert new account, update and delete
account. Administrator must be
logged in to the system to use this
function.
Insert New User This form is use to insert new user Page 25
Account Page account
Insert New Controlled This form is use to insert new record Page 29
Goods and Ceiling of controlled goods and ceiling price
Price Page