Hotel Management System

Software Design Document

Name (s):
Syed Muhammad Sohaib Abbas
Aden Bin Farrukh
Abdulrahman
Ramiz Siddique
Date: (11/04/2020)
HOTEL MANAGEMENT SYSTEM

Preface

This document is Software Design Document for our project named as Hotel Management
System. In this document, system modules will be documented clearly.

Table of Contents

PREFACE.......................................................................................................................................2
TABLE OF CONTENTS....................................................................................................................3
1. INTRODUCTION..................................................................................................................4

2
HOTEL MANAGEMENT SYSTEM

1.1. Purpose...................................................................................................................................4
1.2. Scope......................................................................................................................................4
1.3. Definitions, Acronyms & Abbreviations..............................................................................4
1.4. REFERANCES.......................................................................................................................5
2. SYSTEM OVERVIEW........................................................................................................6
3. SYSTEM COMPONENTS.............................................................................................................7
3.1. Decomposition Description.................................................................................................7
3.1.1. Module Decomposition................................................................................................7
3.1.2. Data Decomposition..................................................................................................15
3.2. Dependency Description...................................................................................................15
3.2.1. Intermodule Description............................................................................................15
3.2.2. Data dependencies....................................................................................................17
A user can book several rooms. A room can be reserved by one user........................................17
3.3. 3.3 Interface Description...................................................................................................18
3.3.1. Module Interfaces......................................................................................................18
3.3.2. User Interfaces (GUI)...............................................................................................18
4. DETAILED DESIGN................................................................................................................22
4.1. Module Detailed Design....................................................................................................22
4.1.1. Login Module.............................................................................................................22
4.1.2. Register Module........................................................................................................22
4.3. Data Detailed Design.........................................................................................................23
5. APPENDICIES....................................................................................................................26
ER Diagram..................................................................................................................................26
Class Diagram..............................................................................................................................27

2
HOTEL MANAGEMENT SYSTEM

1. Introduction

1.1. Purpose

The purpose of Software Design Description is to identify what need to coded that is
specified in SRS. In this document, brief information of Hotel Management System will be
given.

1.2. Scope

In this document, the detailed description of Hotel Management System will be given.
Our hotel management system project will have a web interface.

In the web interface, there are 3 types of user and which are;

-Administration

-Staff

-Authorized user

Each user type will have a different authorization to access to the system.

1.1. Definitions, Acronyms & Abbreviations

2
HOTEL MANAGEMENT SYSTEM

DB Database
FP Function Points
GUI Graphic User Interface
HW Hardware
IDE Integrated Development Environment
IE Internet Explorer
IEEE Institute of Electrical and Electronics Engineers
I/O Input / Output
IP Initial Plan
KU Knowledge Unit
LOC Line Of Code
MS Microsoft
PS Problem Statement
RAM: Random Access Memory
SDD Software Design Description
SPS Student Portal System
SPMP Software Project Management Plan
SQL Structured Query Language
SRS Software Requirements Specification
SW Software

1.2. REFERANCES

 IEEE Std 1058-1998, IEEE Standard for Software Project Management Plans
 Pressman, Roger S., Software Engineering, 4th edition, McGraw-Hill, 1997
 Fairley, R. E., Work breakdown Structure, Software Engineering Project Management,
IEEE CS Press, 1997

2
HOTEL MANAGEMENT SYSTEM

2. System Overview

Hotel management system is a desktop project, which helps to hotel employees interacting
to clients and each other. To do this, hotel management system has following modules,

 Email/Messaging

 POS

 Reservations/Cancellation

 Sign-in/Sign-up

 Aunthentication

All these modules are briefly described and decomposed in the next part.

2
HOTEL MANAGEMENT SYSTEM

3. System Components

2.1. Decomposition Description

2.1.1. Module Decomposition

The way followed while making module decomposition is to divide the system into
modules so that the operations are done under each module will be higly related with each
other, but they are not so much related with other operations in other modules. Taking this
into consideration, hotel management system project’s main services are as follows;

3.1.1.1 User Authetication Module

Identification: User Authentication Module

Type: Application

Purpose: This Module provide user to register and authenticate user.

Function: User enables to register to system and log in. Also this module provide
changing password and help user if they forgot their password.

Subordinates:

- Sing in

- Log in

- Changed Password

 Forgotten Password

3.1.1.1.1. Sign in
Identification: Sign in
Type: Process
Purpose: Provides user to get their authorization level which is recorded in corresponding
cell of the user table.

Function: A user enters their required information (e-mail, password) to the web form. If
those information match with a row of the user table, user gets their authorization level.

Subordinates:

 None

2
HOTEL MANAGEMENT SYSTEM

3.1.1.1.2. Sign Up

Identification: Sign up

Type: Process

Purpose: Provides a registration process to user, if user information is not

recorded to the user table.

Funtion: A visitor fills the registration form and click on the Complete Registration
button. If every information given is correct, user's information is recorded to user table
and user get the “customer”status by default. For other employee is defined by the
administrator in their panel manually.

3.1.1.1.4. Change Password

Identification: Change Password

Type: Process

Purpose: To make user able to change their passwords.

Funtion: User enters their old password and new password. New password replaces with
the old password if it is correct.

Subordinates:

 None

3.1.1.1.5. Forgotten Password

Identification: Forgotten Password

Type: Process

Purpose: By this module, user can get their fogotten password.

Funtion: User sends a request to the system that denotes they have forgotten their
password. System sends them an e-mail including their password.

Subordinates:

 None

2
HOTEL MANAGEMENT SYSTEM

3.1.1.2 Searching Module

Identification: Searching Module

Type: Application

Purpose: It allows user to searching infomration, data in the system.

Function:

Subordinates:

Searching Module(Administrator)
- Search Room
- Search Employee
- Search Customer

3.1.1.2.1 Search Room (Administrator)

Identification: Search Room
Type: Process
Purpose: Provides a sophisticated room searching to administrators.
Funtion: Administrator enters the capacity and price intervals to the module.
All suitable rooms are listed.
Subordinates:
 None

3.1.1.2.2 Search Employee

2
HOTEL MANAGEMENT SYSTEM

Identification: Search Employee

Type: Process
Purpose: Provides administrator to search employee by type, name, etc.
Funtion: Administrator specifies how the search will be done, all suitable employee
information are listed.
Subordinates:
 None

3.1.1.2.3 Search Customer

Identification: Search Customer
Type: Process
Purpose: Provides administrator to search customer by name and SSN.
Funtion: Administrator specifies how the search data, all suitable customer information
are listed.
Subordinates:
 None

3.1.1.3 Online Reservation Module

Identification: Online Reservation Module

Type: Application

Purpose: This module allows to customer

Function:

Subordinates:

- Reserve Room

- Modify Reservation

2
HOTEL MANAGEMENT SYSTEM

-Cancel Reservation

3.1.1.3.1 Reserve Room

Identification: Reserve Room
Type: Process
Purpose: Provides customer to reserve a room.
Funtion: Customer picks a room. Specifies entering and leaving dates and how the room
price will be paid. Clicks on reserve button.
Subordinates:
 None

3.1.1.3.2 Modify Reservation

Identification: Modify Reservation
Type: Process
Purpose: Provides customer to change their reservation information.
Funtion: Customer clicks on modify reservation button. They can change any information
about the room and cancel the reservation.
Subordinates:
 Cancel Reservation

3.1.1.3.2.1 Cancel Reservation

Identification: Cancel Reservation
Type: Process
Purpose: Provides customer to cancel the reservation. Any related data in the reservation
table will be erased.
Funtion: Customer clicks on cancel reservation button. Reservation is canceled.
Subordinates:
 None

2
HOTEL MANAGEMENT SYSTEM

3.1.1.4 Manage Room Module

Identification: Manage Room Module

Type: Application

Purpose: Adminstator enable to manage room.

Function: This module provides add, delete or change room information like room is
vacated or occupied.

 Add Room

 Delete Room

 Modify Room Information(Vacated/Occupied)

3.1.1.4.1 Add Room

Identification: Add Room
Type: Process
Purpose: Provides administrator to add a new room.
Funtion: Administrator clicks on “Add new Room” button, fills the form according to
room specifications, clicks on save button.
Subordinates:
 None

3.1.1.4.2 Delete Room

Identification: Delete Room
Type: Process
Purpose: Provides administrator to delete a room.
Funtion: Administrator clicks on “Delete Room” button, clicks on save button. Because
room information does not erased from the database, this process is reversible.
Subordinates:

2
HOTEL MANAGEMENT SYSTEM

 None

3.1.1.4.3 Modify Room Information

Identification: Modify Room Information
Type: Process
Purpose: Provides administrator to modify a room's information.
Funtion: Administrator clicks on “Modify Room Information” button, all the information
can be changed.
Subordinates:
 None

3.1.1.5 Employee Management Module

Identification: Employee Management Module

Type: Application

Purpose: Employee management module provides recording all user information except
from customer.

Function: Adding, deleting and modifying employee information.

Subordinates:

 Delete Employee

 Modify Employee Information

 List Employees

3.1.1.5.2 Delete Employee

Identification: Delete Employee
Type: Process
Purpose: Provides administrator to delete an employee.
Funtion: When an employee is fired or quit, administrator clicks on “Delete employee”
button and employee is deleted from user table.
Subordinates:

2
HOTEL MANAGEMENT SYSTEM

 None

3.1.1.5.3 Modify Employee Information

Identification: Modify Employee Information
Type: Process
Purpose: Provides administrator to modify an employee's information.
Funtion: When it is required, administrator clicks on “Modify” button and makes
the necessary changes.
Subordinates:
 None

3.1.1.5.4 List Employees

Identification: List Employees
Type: Process
Purpose: Provides administrator to list all the employees according to
given interval.
Funtion: Administrator clicks on “List” button and specifies the listing property. All the
suitable employee information are listed.
Subordinates:
 None

3.1.1.6. Food Management Module

Identification: Restaurant Management Module

Type: Application

Purpose: This module provides information about food.

Function: Staff enables to add food information.

2
HOTEL MANAGEMENT SYSTEM

Subordinates: Add information food

3.1.1.6.1 Add Food Information

Identification: Add Food Information
Type: Process
Purpose: Provides the charged staff to add food menu information.
Funtion: Staff clicks on “Add” button, fills the fields and clicks on “Done” button.
Subordinates:
 None

2.1.2. Data Decomposition

ER and Class Diagrams for Hotel Management System is given in appendix section.

2.2. Dependency Description

2.2.1. Intermodule Description

The services and modules of Hotel Management System are given detailed in section 3.1.1.
In this part, the dependency between modules under services will be explained. Also, at the
beginning of that section, dependencies between services are depicted. This part of SDD
examines the dependency between modules under those services. These dependencies are
categorized as following:

If module can be used by only authenticated user, this relation is shown with letters “AU”
stands for “Authenticated Users”.

If module gets some data from other module, this relation is shown with letters “GD”
stands for “Get Data”.

2
HOTEL MANAGEMENT SYSTEM

Dependency
Matrix

Mana Employe Contac Restaurant

User Mess Sear ge e Anno to management
Authent Reserv age ch room Manage u nce Supplier module
ication ation Mod Mod Modu ment Modu Module
  Module Module ule ule le Module le

             
User
Authentication
GD GD
Module GD GD GD GD  
Reservation
Module GD  

             

Message Module GD  

Search Module GD  

             

Manage room
Module
Employee
management
Module GD GD  

Announcement
module GD GD

Contact
toSupplier Modu
Restaurant
management
Module              

2.2.2. Data dependencies

In this part of SDD, relations between entities will be mentioned.

userregistrationInfo – userGeneralInfo

userRegistrationInf
o  1  1 userGeneralInfo

2
HOTEL MANAGEMENT SYSTEM

   

1:1 relation. A user can have one general information. A general information can
belong to one user.

userregistrationInfo – announcement

userRegistrationInfo 1   N Announcement

   

1:N relation. One user(administor) can give several announcements. An

announcement may belong to one user(administrator).

userregistrationInfo - room

userRegistrationI
nfo 1   N Room

A user can book several rooms. A room can be reserved by one user.

2
HOTEL MANAGEMENT SYSTEM

2.3. 3.3 Interface Description

2.3.1. Module Interfaces

In this part of SDD, communication between modules is explained in detail.

ViewInformation
viewReservedRoom
Database Module < - > <-> Profile Module
viewMessages
viewMails

viewSentMessage
viewReceivedMessage
Database Module < - > viewDeletedMessage <-> Message Module
viewMesSender
viewMesReceiver

login
Database Module < - > registration <-> Authentication Module
passwordTransections

setHeader
setImage
Database Module < - > <-> Announcement Module
setContent
announcementHistory

2.3.2. User Interfaces (GUI)

In this part of SDD, user interfaces are explained in detail.

2.3.2.1. Main Page Interface

This interface will be variated according to different user types. For unauthorized users,
there will be a common interface which contains advertisements, announcements, and sign
in, sign up menus.

2
HOTEL MANAGEMENT SYSTEM

When user signed in, according to their type, users will be shown different main pages and
those are;

Authorized user: This type of users’ menu will have standard options (HOME,
CONTACT, ABOUT US, and LOG OUT) and RESERVATION option. Also their

Profile information can be seen.

Administrator: This interface will have ROOMS, MESSAGES, SUPPLIER,

CUSTOMERS and LOG OUT menu. Also an Announcement wizard will be seen

Accounter: This interface will have ROOMS, MESSAGES, ACCOUNTING,

CUSTOMERS and LOG OUT menus. Latest activities will be shown in this menu. Those
activities will be recorded to database in activity history section.

2
HOTEL MANAGEMENT SYSTEM

Staff: This interface will have ROOMS, MESSAGES and LOG OUT menus. Staff also can
operate offline reservations.

3.3.2.2 Registration Interface

All types of users will have to sign up using this interface. They will have to give
their names, e-mail addresses, passwords and authentication level to complete
their registration. Also a security image will be shown and user will be forced to
enter the text in this image for security issues.

3.3.2.3 Login Interface

To login, all users will have to use this interface. It will ask the e-mail and
password to users.

2
HOTEL MANAGEMENT SYSTEM

3.3.2.5 Reservation Interface

In this interface, authorized users(customers) can choose and book a room

according to their needs. To make this progress easier, there will be a reducing
wizard who accepts lowest price and higher price to eliminate the unsuitable
rooms. A screenshot is given in appendix section

There will be profile pages for each user which show the information for each user
such as registration date, name, SSN.

2
HOTEL MANAGEMENT SYSTEM

3. Detailed Design

3.1. Module Detailed Design

3.1.1. Login Module

Method Name: Login

Description: allows users to enter the system
Share Type: public
Return Type: Boolean
Parameters: username, password, imageVerification

3.1.2. Register Module

Method Name: registration

Description: registers a new user to the system
Share Type: public
Return Type: boolean
Parameters: firstName, lastName, password, email, birthDate, gender, country, city, distinct.
3.1. RTM

Requirement Design
Requirement # Requirement Description ref. reference Module name
CR1        
User Authentication Module
- Log-in
1 User Authentication 2.2.1.1 3.1.1.1. - Sign-up
- change Password
- Forgotten Password

Room Management Module

2 Manage Room 2.2.3.1 3.1.1.6. -Add Room
-Delete Room
-Modify Room
Information(Vacated/Occupied)
Manage Employee Module
3 Employee management 2.2.3.5 1.1.8. - Delete Employee
- Modify Employee Info -
List Employee

4 Messaging 2.2.3.3 3.1.1.2. Messaging Module

-Send Message
- Delete Message

2
HOTEL MANAGEMENT SYSTEM

CR2        

Searching
5 Searching 2.2.3.6 3.1.1.3. Module(Administrator)
- Search Room
- Search Customer
- Search Employee
6 Online Reservation 2.2.2.1 3.1.1.5. Online Reservation Module
- Reserve Room
Announcement Module
7 Announcement 2.2.4.2 3.1.1.10 - Add Announcement
- Delete Announcement
- Modify Announcement

8 Contact to Supplier 2.2.5.1 3.1.1.9.

Contact Supplier Modul
- Add Supplier
CR3        

6 Online Reservation 2.2.2.1 3.1.1.5. Online Reservation Module

-Modify Rezervation
Searching
5 Searching 2.2.3.6 3.1.1.3. Module(Administrator)
- Search Customer
Food Food
9 Food Information Information Information
Module Module Module Food Information Module

3.2. Data Detailed Design

Table Name: userRegistrationInfo
This table holds user’s registration information.

Column Name Data Type Description Example

userId (PK) INT primary key, auto increment, not null 1

firstName VARCHAR(15) holds first name of user Murat

lastName VARCHAR(15) holds last name of user Çatal

Password VARCHAR(15) holds password of user $123_321$

Email VARCHAR(45) holds email of user [email protected]

templateId INT holds the template id of user. This column

is PK for template table. 23333

2
HOTEL MANAGEMENT SYSTEM

Table 1: User Registration Info

Table Name: userGeneralInfo

This table holds the user’s general information.

Column Name Data Type Description Example

userId (PK) INT primary key, auto increment, not null 1

birthDate VARCHAR(15) holds birthDate of user 22.05.1986

Gender VARCHAR(5) holds gender of user Male

Country VARCHAR(45) holds the name of country where user lives Turkey

City VARCHAR(45) holds the name of city where user lives Ankara

District VARCHAR(45) holds the name of district where user lives Bahçelievler

Table 2: User General Info

Table Name: messages

This table holds the messages.

Column Name Data Type Description Example

messageId(PK) INT primary key, auto increment, not null 1

sendDate VARCHAR(15) shows the send date of the message 22.05.2010

byWhom VARCHAR(15) shows the sender of the message Murat

toWhom VARCHAR(15) shows receiver of the message Satiye

readDate VARCHAR(15) shows the read date of the message 23.05.2010

Title VARCHAR(45) shows the title of the message SDD

messageType VARCHAR(45) shows the type of the message (inbox,

outbox etc) Outbox

userId(FK) INT shows that this message belongs to which

user 1

Table 3: Message

This table holds information about announcements.

Column Name Data Type Description Example

2
HOTEL MANAGEMENT SYSTEM

announcementId(PK) INT primary key,auto increment, not null 1

Description VARCHAR(15) holds the description of the announcement 50% price cut

Active INT holds the announcement is active or not 1

Picture VARCHAR(15) holds the name of picture of the announcement picture.jpeg

publishPlace VARCHAR(15) holds the web site publish place of the

announcement left down

userId INT holds the id of the user which gives

announcement 4

Table 4: Announcement
Table Name: rooms

This table holds information about rooms.

Column Name Data Type Description Example

roomId(PK) INT primary key,auto increment, not null 1

Capacity INT holds the description of the capacity 4

Status INT -1:N/A, 0:Reserved, 1:Available 1

Picture VARCHAR(15) holds the name of picture of the announcement picture.jpeg

publishPlace VARCHAR(15) holds the web site publish place of the

announcement left down

userId INT holds the id of the user which gives

announcement 4

1. Appendicies

2
HOTEL MANAGEMENT SYSTEM

ER Diagram

2
HOTEL MANAGEMENT SYSTEM

Class Diagram