Thanks to visit codestin.com
Credit goes to www.scribd.com

0% found this document useful (0 votes)
23 views24 pages

SDD Group 7 Final

computer science
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
23 views24 pages

SDD Group 7 Final

computer science
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 24

2023 FINAL YEAR PROJECTS

Detailed System Design Document


UL JobHub

Group Number: 07
Matselela AT 201816776
Modiba, GM, 201923847
THARAGA M, 201737487
NTSOANE , ME, 20220310

To be completed by Coordinator

Date Received: _____/_____/_______

Signature: ______________________

Coordinator Notes:

________________________________________

________________________________________

________________________________________

REVISION HISTORY
REVISION NUMBER DATE COMMENT
Detailed System Design Document

1.0 Date Details

Page 2 of 24
Detailed System Design Document

Table of Contents
2017 FINAL YEAR PROJECTS......................................................................................................................1

DETAILED SYSTEM DESIGN DOCUMENT...................................................................................................1

NAME OF THE SYSTEM GOES HERE......................................................ERROR! BOOKMARK NOT DEFINED.

REVISION HISTORY...................................................................................................................................2

TABLE OF CONTENTS................................................................................................................................3

1. DOCUMENT OVERVIEW..................................................................................................................5
SCOPE.................................................................................................................................................... 5
AUDIENCE............................................................................................................................................... 5
RELATED DOCUMENTATION......................................................................................................................... 6
DOCUMENT CONVENTIONS......................................................................................................................... 6
2. SYSTEM OVERVIEW.........................................................................................................................7
DESCRIPTION........................................................................................................................................... 7
SYSTEM ARCHITECTURE.............................................................................................................................. 7
Software Architecture...................................................................................................................... 7
Hardware Architectures................................................................................................................... 8
3. HARDWARE DESIGN......................................................................................................................12
HARDWARE COMPONENTS........................................................................................................................ 12
Computer Systems...............................................................................Error! Bookmark not defined.
Peripherals..........................................................................................Error! Bookmark not defined.
Networks............................................................................................. Error! Bookmark not defined.
Project Specific hardware items (e.g. Sensors, Transducers, Robotics, Enclosure Design)...........Error!
Bookmark not defined.
HARDWARE INTEGRATION......................................................................................................................... 13
Logical Design.....................................................................................Error! Bookmark not defined.
Physical Design...................................................................................Error! Bookmark not defined.
Recovery Design..................................................................................Error! Bookmark not defined.
4. SOFTWARE DESIGN.......................................................................................................................15
SOFTWARE PACKAGES.............................................................................................................................. 15
{Software Module #1…N}............................................................................................................... 15
SOFTWARE INTEGRATION.......................................................................................................................... 15
5. DATA AND DATABASE / FILES........................................................................................................19
DATA FLOW DIAGRAMS............................................................................................................................ 19
DATABASE DESIGN (ERD)......................................................................................................................... 19
FILES.......................................................................................................... ERROR! BOOKMARK NOT DEFINED.
SYSTEM PARAMETERS.....................................................................................ERROR! BOOKMARK NOT DEFINED.
6. SYSTEM INTERFACES.....................................................................................................................20
INTERFACES.......................................................................................................................................... 20
7. SYSTEM PERFORMANCE................................................................................................................23
Page 3 of 24
Detailed System Design Document

8. REFERENCES..................................................................................................................................24

Page 4 of 24
Detailed System Design Document

1. DOCUMENT OVERVIEW
This is a technical blueprint for the project.
This document has been developed by Tharaga m , Ntsoane ME , Malatji MS , Ngwenya
S,Matselela AT , Masoka MS , Debeila L, Mabotja BH , Modiba GM , Mphanga K ,
Maile KM for university of Limpopo. The document was developed to satisfy all the
users requirements, objective and expectations.

SCOPE
This Software Design Document (SDD) outlines the design and architecture of the UL
JobHub system, which is an Employment Management System that will be available as a
web application and mobile application. The system is designed to enable job seekers to
access job vacancies posted by the University of Limpopo and to provide them with
relevant information to apply for the job. The UL JobHub system aims to address the
high unemployment rate in South Africa by providing a platform for the university and
its prospective employees to engage.

AUDIENCE
This document is intended for use by the software tester, who will be responsible for
evaluating the performance of the system and ensuring that it meets the requirements set
out in the development plan. The document outlines the various features and capabilities
of the software, providing clear instructions on how to use them and what results can be
expected.

In addition to serving as a guide for the tester, this document is also an important
resource for the developers. It provides them with a clear overview of the system,
allowing them to identify areas that may require further improvement or refinement. By
referring back to the document, developers can ensure that any modifications or
enhancements they make to the software are consistent with the original design and do
not compromise its overall functionality.

Finally, It is also designed to be accessible and informative for end-users of the software.
It provides information on the requirements and specifications for using the application,
including any hardware or software prerequisites that must be met. This information
helps ensure that users are able to access and utilize the software effectively, without
encountering any unexpected obstacles or difficulties. Overall, this document serves as

Page 5 of 24
Detailed System Design Document

an important tool for all stakeholders involved in the development, testing, and use of the
software.

RELATED DOCUMENTATION
The related documents is the software Requirements specification (SRS) which will be
obtained from the university of Limpopo via online application helpdesk and the
developers of the system.

Non-quality documents

Document management system


Quality documents
Draft document

records

DOCUMENT CONVENTIONS
This document is created using Microsoft word 2016, for diagrammatic representations
shapes and symbols. In other instance we included pictures in the diagrams.
The document is organized using Microsoft Word 2016
Title-Times New Roman size 16 bold
Sub-title-Times New Roman size 14 bold
Description of sub-titles-Times new Roman size 12
It has used the bold property to set the headings of the document. Standard IEEE
template is the template used to organize the appearance of the document and its flow.
Unified Modelling Language has been used in this document to diagrammatically
represent some of the major subsystems.

Page 6 of 24
Detailed System Design Document

2. SYSTEM OVERVIEW

DESCRIPTION
 Any member can register and apply for the jobs.
 Only registered members can apply for jobs, get notifications regarding the
opened vacancy , search for jobs ,make job applications and check job application
status.
 Help center is available to the registered users.
 There are two types of roles available : user and admin/management .

This done by the user :


 The user can search for jobs and apply for the position advertised.
 Users can check their job application status.
 Communicate queries on help center.
 Add and remove job preferences and qualifications .
 Users can receive notifications regarding the job vacancy which meet their
preferences.

SYSTEM ARCHITECTURE
SOFTWARE ARCHITECTURE

Page 7 of 24
Detailed System Design Document

client side Server side

Web application
mobile user

Mobile
network

mobile user

database

mobile user
visualization

Managemen
t side

Page 8 of 24
Detailed System Design Document

CLIENT SIDE
On the client side, we need to have PDA in order to execute the client by using mobile
browser (or micro browser), which provides some scripting application (java application
client) as long as it is java-enabled browser. The dynamic route will be presented in flash
as visual map with requested information. In the next section, we will discuss the
interaction between the components in both client and server-side.

SERVER SIDE
WEB APPLICATION SERVER

This server represents as web server consists of web and application services whereby it
is configured to execute business processes and transactions, as well as data
communication while accessing database server. It responds with the requested
information by client through mobile devices.
DATABASE SIDE
The database server stores all information needed to obtain LRT route from depart
station to desired destination by mapping it to the corresponding nearest LRT station. It
serves as a central repository and can be deployed as a standard Structured Query
Language (SQL) database. This server interacts with web application server with respect
to data accessing and storage

MANAGEMENT SIDE
This is where the visualized data of the data stored in the database will be displayed.

SOFTWARE ARCHITECTURE
Web-based Always-online Architecture

Within this architecture (see Fig. 1), the client works always online via a (mobile)
network. The presentation layer is completely realized at the client side, where only a
browser component is needed to realize the graphical user interface (GUI). The
application layer is located server-side and contains a session handling component as
well as components for presentation and business logic. The data layer contains the
databases at the server side. The main advantage of this architecture is, that only a
browser is needed at the client side. Thus, the systems architecture allows the cooperation
with a wide range of client systems independently from the client’ operating systems or
other client-side conditions. Furthermore, as all the data and the logic is located server-
side, no update or synchronization mechanisms are needed. All clients can work on the
same central data base, using the recent data as well as the

Page 9 of 24
Detailed System Design Document

recent presentation and business logic. The effort for the administration of such a system
is very small compared to other system architectures. The main disadvantage of this
solution is, that always a (mobile) network is needed, otherwise the client is unusable.
When using a mobile network, the coverage in certain areas might not be given. Beyond,
mobile networks usually offer just a small bandwidth causing a probably unsatisfying
performance of the client. Furthermore, browser-based applications are limited in terms
of user interface design to the facilities of HTML, which is quite less than users known
from fat client applications. The simultaneous connection of a large number of clients to
the central server also causes high requirements for the central server regarding its
performance as well as its operational availability.

HARDWARE ARCHITECTURES

Page 10 of 24
Detailed System Design Document

The hardware requirements of the application are not complex. The following hardware
components will be required for Our application to function:
 Mobile devices

 Computer which will function as a server to hold the web and data server.

Systems
Due to our application being a web-based application it automatically becomes cross
platform meaning it will work on majority of the mobile devices. Even though is cross
platform, it is highly recommended that users make use of smartphones as their browsers
can handle the new web technologies.

Networks
Since the application is a web-based application which will be accessed via internet the
following protocols will be utilized:
 HTTP

Hypertext transfer protocol which is responsible for fetching application files in the web
server

Page 11 of 24
Detailed System Design Document

3. HARDWARE DESIGN
HARDWARE COMPONENTS
COMPUTER SYSTEMS
The computer systems that will be used for the UL JobHub web app will be comprised of
servers and client machines. The servers will host the web application and the database,
while the client machines will be used by job seekers and administrators to access and
manage the system. The application runs on any android operating system and web
application will runs at any operating system
PERIPHERALS
The system will have wide support for different peripherals to enhance its functionality.
including printers, scanners, keyboards, mice and Network Attached Storage (NAS)
devices. The printers will be networked and will be used to print out application forms,
resumes, and other relevant documents. Scanners will be used to digitize paper
documents, such as transcripts and certificates. Standard keyboards and mice connected
via USB or Bluetooth will be supported. The mobile application will use NFS,CIFS and
HTTP protocol to connect to NAS and manage MySQL database/ web server database
NETWORKS
The UL Jobhub system will require a network to support communication between its
various components. The network will consist of routers, switches, gateways, and other
network components. The app will require a high-speed internet connection with a
minimum bandwidth of 100 Mbps. It will be hosted on a dedicated server that will be
connected to the internet via a high-speed link. The system will utilize Wi-Fi technology
to support wireless communication between devices, such as mobile devices and laptops,
and the system components. The Wi-Fi network will be secured using WPA2-PSK
encryption to prevent unauthorized access.
Since the application will use the internet to connect to our web server database,
The following protocols will be needed:
 A synchronous transfer mode is a switching technique used by
telecommunication networks that uses asynchronous time division multiplexing
to encode data into small, fixed sized cells
 HTTP

Page 12 of 24
Detailed System Design Document

Hypertext transfer protocol which is responsible for fetching application files in


the web server, HTTPS will also be implemented to ensure secure
communication over the network.
 TCP/IP, transmission control protocol/ internet protocol which is responsible for
handling the movement of data in the server
PROJECT SPECIFIC HARDWARE ITEMS (E.G. SENSORS, TRANSDUCERS, ROBOTICS,
ENCLOSURE DESIGN)
 The mobile application uses a touch input sensors and is can be also transfer
from one device to another using transfer sensors such as Bluetooth and SHARE
it and other sensors.

HARDWARE INTEGRATION
LOGICAL DESIGN

Our application is going to connect indirectly to a database server to store and


retrieve our data. The logical design of the UL JobHub system involves the
integration of various hardware components to create a cohesive system

Page 13 of 24
Detailed System Design Document

At the core of the system is the database, which stores all the relevant data for the
UL JobHub platform. The web servers interacts with the database to provide the
necessary data to the application layer, which handles the business logic of the
system. The application layer then communicates with the user devices, such as
laptops, tablets, and mobile phones, to provide access to the UL JobHub platform.

This logical design ensures that the UL JobHub system is scalable and easily
maintainable. It also provides a high level of security by keeping the database and
application layers separate from the user devices.

PHYSICAL DESIGN

Wi-Fi and other data connector are going to be used instead of physical cables
like fibre cables for our application.

RECOVERY DESIGN

As the UL JobHub system is designed to provide reliable and uninterrupted


services to its users, the recovery hardware integration design plays a critical role

Page 14 of 24
Detailed System Design Document

in ensuring business continuity. In the event of any hardware failure, the system
needs to have a recovery mechanism in place to quickly restore services.

Regular backups of the application and database are taken to ensure that in the
event of a catastrophic failure, data can be restored and the application can be
brought back online as quickly as possible. These backups are stored in a secure,
off-site location to prevent data loss in the event of a disaster at the primary data
centre. A database server will be used, that will have one or more database hosted
such as oracle, SQL servers and MySQL. The reason why the our database is
stored on a web server is for recovery in case is lost.

4. SOFTWARE DESIGN
SOFTWARE PACKAGES
File structure of our ULJOBHUB application.
Since the ULJOBHUB includes communication between an application and database we
will have two main directories.
{SOFTWARE MODULE #1…N}

Includes

views

models

controller
Page 15 of 24
Detailed System Design Document

The Includes directory contains the following directories:

 Models - Contains files that will handle the communication with the database.
 Views - Contains files that will generate the user interface on the screen.
 Controllers - Contains files that will use the methods defined in models to fetch
data from the database and render the appropriate views.

ASSETS

STYLE

Page 16 of 24
Detailed System Design Document

SCRIPTS

The assets directory contains the following directories:

 Styles - Contains necessary style sheets that describe the styling of the user
interfaces
 Scripts - Contains necessary codes needed for validation and verification of
inputs.

SOFTWARE MODULE #1 ADMIN LOGIN

DISPLAY LOGIN PAGE

Procedure login
Input "username" and "Password" text boxes
if "LOGIN" button clicked
then{
Search for the user in database for admins
if (is not found)
then {
displays error in page of login "admin not found" re-start Procedure login again
}
Else {
if (username & password correct)
{
if (user == administrator)
{delete post if date closed ,insert new vacancy post, update requirements, change
password, reset password, view visualized data }
Logout;

SOFTWARE MODULE #2 USER LOGIN

DISPLAY LOGIN PAGE

Procedure login
Input "username" and "Password" text boxes

Page 17 of 24
Detailed System Design Document

if "LOGIN" button clicked


then{
Search for the user in database of users
if (is not found)
then {
displays error in page of login "User not found" re-start Procedure login again
}
Else {
if (username & password correct)
{ displays the home page of ULJONHUB and options}

If "register" link is clicked


then { provide user with form to register
If (user registers successfully)
then {store users details on database}
}
else
{ show user reasons for unsuccessful registering, e.g. "username taken", allow
user to try a new username
}

SOFTWARE MODULE #3 CAN CHECK FOR JOB VACANCY

if (user logged in )
then { user can check for job vacancy }
Else
{ show message for user to login or register }

SOFTWARE INTEGRATION
ULJOBHUB consists of multiple software modules that work together to provide a
seamless user experience.
The ULJOBHUB mobile application has been designed to provide an intuitive user
interface that allows users to easily navigate through the app and perform their desired
tasks. The app consists of various activities that users can interact with through their
device's touch screen. These activities are designed in a manner that allows users to
easily identify and understand their purpose.
Each activity consists of various GUI components, such as buttons, labels, images, text
fields, and list objects. These components are neatly laid out to provide a clean and
organized interface. The user can enter data required to perform a task, and the app will
handle the processing and retrieval of relevant data from the server.

Page 18 of 24
Detailed System Design Document

The ULJOBHUB app also integrates with various external services, such as job boards
and resume parsing tools, to provide users with the most up-to-date and relevant job
postings. The app uses industry-standard protocols and APIs to communicate with these
services and ensure seamless integration. In case of any errors or exceptions, the app has
a robust error-handling mechanism in place to ensure that users are informed of any
issues and can take appropriate action.

5. DATA AND DATABASE / FILES


DATA FLOW DIAGRAMS
1. System design
Access web Register or
login
user
CONFIRMATION
website

login
ADMIN

Page 19 of 24
Detailed System Design Document

6. SYSTEM INTERFACES
JOB APPLICATION INTERFACE
The Job Application Interface allows job seekers to apply for job postings listed on the
UL Jobhub platform. The interface provides a form for the applicant to fill out with their
personal information, work experience, education, and other relevant details required by
the job posting.
Hardware Interrupts:
None.

Triggering Event:
The triggering event for this interface is when a job seeker clicks the "Apply Now"
button on a job posting listed on the UL Jobhub platform.

Message Protocol/File Format:


The data will be transmitted over HTTP.

Handshaking:
The job application form will be submitted through a HTTP POST request to the UL
Jobhub server. Upon receipt, the server will respond with an HTTP status code indicating
whether the application was successfully submitted or if any errors occurred.

Record/Data Definitions:
The data fields in the job application form will be defined, containing personal
information, work experience, education, and other relevant details required by the job
posting.

Page 20 of 24
Detailed System Design Document

Timing Restrictions/Frequency:
There are no timing restrictions for the Job Application Interface. The frequency of
submissions will depend on the job postings available on the UL Jobhub platform and the
number of job seekers applying.

Queuing/Buffering:
Job application requests will be queued and processed in the order they are received by
the UL Jobhub server. In case of high traffic, the server may implement queuing or
buffering mechanisms to prevent overload.

Error Identification/Handling/Recovery:
In case of errors during form submission, the server will respond with an HTTP status
code indicating the error. The job seeker will be prompted to correct the errors and
resubmit the form.

Priority:
All job applications will be processed on a first-come, first-served basis. There will be no
priority processing for any specific job application.

Flow-Control:
The Job Application Interface does not require any flow-control mechanisms.

Data Transfer Rate:


The data transfer rate will depend on the size of the job application form and the speed of
the user's internet connection.

Security:
All data transmitted through the Job Application Interface will be encrypted using
SSL/TLS encryption to ensure the security and privacy of the applicant's personal
information.

Capacity/Volume:

Page 21 of 24
Detailed System Design Document

The Job Application Interface will be able to handle a high volume of job application
requests without any degradation in performance or service interruption. The system will
be designed to scale horizontally to accommodate increasing demand.

NOTIFICATION INTERFACE
This interface is responsible for sending notifications to users of the UL Jobhub
application.

Hardware interrupts: None.

Triggering event: The system generates notifications based on certain events, such as
when a user receives a new message or when a job they applied for is updated.

Message protocol: Notifications are sent via push notifications to the user's device. The
protocol used is Firebase Cloud Messaging (FCM).

Handshaking: None.

Record definitions/data definitions: The data contained in the notification will depend on
the type of notification being sent. For example, a message notification will contain the
sender's name and the message content.

Timing restrictions/frequency: Notifications are sent immediately when the triggering


event occurs.

Queuing/buffering: Notifications are queued on the server until they can be delivered to
the user's device.

Error identification/handling/recovery: If a notification cannot be delivered to the user's


device, the system will attempt to retry sending it a certain number of times before giving
up.

Page 22 of 24
Detailed System Design Document

Priority: Notifications are considered high priority and are delivered immediately to the
user's device.

Flow-control: None.

Data transfer rate: Notifications are sent as needed, so the data transfer rate will vary
depending on user activity.

Security: Notifications are sent over a secure connection using HTTPS.

Capacity/volume: The system is designed to handle a high volume of notifications, with


the ability to scale up as needed to meet demand.:

7. SYSTEM PERFORMANCE

 Acceptable response- Three seconds response time is the maximum acceptable


limit; users won’t notice the delay. Any more than Three seconds means there’s a
problem if the delay is ten to twenty seconds a user will typically leave the
system.
 They are calculated by means of following formula.
o User Capacity = actual working hours * direct labour * equivalent workforce
o Machine Capacity = operating hours * operating rate * number of machines

 Calculating DATABASE SIZE determine the size then the average number of
occurrences of each segment type in a database record by multiplying these two
numbers together, you get the size of an average database record.
 DATABASE FILE is the product of the number of database page multiply by the
page size.
 The minimum page size is 1KB, the default page size is 4KB, and maximum page
size is 16KB. Each page can store records only from a single table.

Page 23 of 24
Detailed System Design Document

8. REFERENCES
[1] https://www.lucidchart.com/blog/data-flow-diagram-tutorial
[2] http://solr.bccampus.ca:8001/bcc/file/3e346f96-60d7-4d74-8eb1-7b508bf58eab/1/
Database-Design-1362588850.pdf
[3] https://media.cheggcdn.com/study/17f/17f7db85-d2d9-425b-9df5-
ef0558201e98/202553-6-2PE-i1.png

Page 24 of 24

You might also like