0% found this document useful (0 votes)
4 views49 pages

GAMS Requirement & Design Specs 1.0

The document outlines the Requirement & Design Specification for the Global Assess Management System (GAMS) version 1.0, detailing user requirements, system functionalities, and high-level design elements. It includes records of changes, actor descriptions, use case diagrams, screen flows, and database design. The document serves as a comprehensive guide for the development and implementation of the system.
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)
4 views49 pages

GAMS Requirement & Design Specs 1.0

The document outlines the Requirement & Design Specification for the Global Assess Management System (GAMS) version 1.0, detailing user requirements, system functionalities, and high-level design elements. It includes records of changes, actor descriptions, use case diagrams, screen flows, and database design. The document serves as a comprehensive guide for the development and implementation of the system.
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

Requirement & Design Specification

Global Assess Management System (GAMS)


Version: 1.0

– Hanoi, May 2024 –

GAMS-SRS_v1.0 Page 1 / 20
Record of Changes
Version Date A* In charge Change Description
M, D
V1.0 18/5 A DuongVD Add User Requirements of all Actors
V1.0 19/5 A DuongVD Add Use Case Diagram for Guest, Customer, Sale
V1.0 19/5 A DuongVD Add Screen Flow Diagram of Guest
V1.0 19/5 M HoangVT Modify some detail in actor descriptions
V1.0 19/5 A HoangVT Add Use Case Diagram for Marketing,Admin
V1.0 19/5 A DuongNQ Add information to Use Cases descriptions
V1.0 19/5 A DuongNQ Add screen flow diagram of Customer
V1.0 19/5 M DuongNQ Modify the Use Case of Customer
V1.0 19/5 M VinhBT Modify the Screen Authorization
V1.0 19/5 A VinhBT Add Screen Descriptions
V1.0 19/5 A VinhBT Add screen flow diagram of Customer
V1.0 19/5 A HoangVT Add screen flow diagram of Marketing
V1.0 21/5 A HoangVT Add data schema
V1.0 24/5 M HoangVT Update 3.1 Database design
V1.0 24/5 M HoangVT Modify Use Case

None None
None None
*A - Added M - Modified D - Deleted

GAMS-SRS_v1.0 Page 2 / 20
Contents
Record of Changes.........................................................................................................................................2
I. Overview....................................................................................................................................................5
1. User Requirements.................................................................................................................................5
1.1 Actors...............................................................................................................................................5
1.2 Use Cases.........................................................................................................................................5
2. Overall Functionalities...........................................................................................................................6
2.1 Screens Flow....................................................................................................................................6
2.2 Screen Descriptions.........................................................................................................................6
2.3 Screen Authorization.......................................................................................................................6
2.4 Non-UI Functions............................................................................................................................7
3. System High Level Design....................................................................................................................7
3.1 Database Design...............................................................................................................................7
3.2 Code Packages.................................................................................................................................7
II. Requirement Specifications.......................................................................................................................9
1. <<Feature Name>>................................................................................................................................9
1.1 << UC Name>>...............................................................................................................................9
2. Common Functions..............................................................................................................................11
2.1 Login System.................................................................................................................................11
3. Patron Feature......................................................................................................................................12
3.1 Order a Meal..................................................................................................................................12
3.2 Register for Payroll Deduction......................................................................................................13
III. Screen Designs.......................................................................................................................................14
1. <<Feature Name>>..............................................................................................................................14
1.1 <<SubFeature Name>>..................................................................................................................14
1.2 System Access...............................................................................................................................14
IV. Code Designs.........................................................................................................................................17
1. <Feature/Function Name1>.................................................................................................................17
1.1 Class Diagram................................................................................................................................17
1.2 Sequence Diagram(s).....................................................................................................................17
1.3 Database Queries...........................................................................................................................18
2. <Feature/Function Name2>.................................................................................................................18
V. Appendix.................................................................................................................................................18
1. Assumptions & Dependencies.............................................................................................................18
2. Limitations & Exclusions....................................................................................................................18
3. Business Rules.....................................................................................................................................18

GAMS-SRS_v1.0 Page 3 / 20
4. ..............................................................................................................................................................19

GAMS-SRS_v1.0 Page 4 / 20
I. Overview
1. User Requirements
1.1 Actors
[An actor is a person (or sometimes another software system or a hardware device) that interacts with
the system to perform a use case. Following are some questions you might ask to help user
representatives identify actors
● Who (or what) is notified when something occurs within the system?

● Who (or what) provides information or services to the system?

● Who (or what) helps the system respond to and complete a task?

This part gives the description of system actors, you can follow the table form as below]
# Actor Description
1 Admin Administrative role for managing user accounts, system settings
2 Guest Common role for unregistered user, this user can view products, view posts
This user has all permissions of Guest user can
3 Customer
place orders and send feedbacks.
4 Sale This user manages specific users’ orders
5 Sale Manager This user has access to all orders and can assign orders for Sale users
This user can manage posts, sliders, products manage user, view feedback
6 Marketing
and edit feedback status.

1.2 Use Cases


[A use case (UC) describes a sequence of interactions between a system and an external actor that
results in the actor being able to achieve some outcome of value. The names of use cases are always
written in the form of a verb followed by an object. Select strong, descriptive names to make it evident
from the name that the use case will deliver something valuable for some user]

GAMS-SRS_v1.0 Page 5 / 20
a. Diagram(s)
[Provide the UC diagram(s) to show the actor-UCs and UC-UC relationships like the sample below. You
can have multiple UC diagrams for the system]

Figure 1.2.1: Guest’s Use Case Diagram

GAMS-SRS_v1.0 Page 6 / 20
Figure 1.2.2: Customer’s Use Case Diagram

GAMS-SRS_v1.0 Page 7 / 20
Figure 1.2.3: Sale and Sale Manager’s Use Case Diagram

GAMS-SRS_v1.0 Page 8 / 20
Figure 1.2.4: Marketing’s Use Case Diagram

GAMS-SRS_v1.0 Page 9 / 20
Figure 1.2.5: Admin’s Use Case Diagram

b. Descriptions
This part describes the use cases, you can follow the table form as below]
ID Feature Use Case Use Case Description
01 Manage Setting View Setting Admin can list, filter, search, sort, show or hide system
List settings.
02 Setting Editor View Setting Admin can view and edit the details of a specific system
Details setting.
03 User Editor View User Enables admin to view and edit the detail of a specific user.
Details
04 Product Details View Show the product’s information including name, image,
Product price,...and relevant product.
Details
05 Profile Editor View User Show the information of user and enable to edit their own
Profile information except email

2. Overall Functionalities
2.1 Screens Flow
[This part shows the system screens and the relationship among screens. You can draw the Screens Flow
for the system in the form of diagram as below. Please note that beside the normal flat screen, we might

GAMS-SRS_v1.0 Page 10 / 20
have the oval notation for pop-up screen (Orders Import) or a screen with multiple information tab
(Order Update), etc. You may also use text or background format for different visuality purpose]

2.2 Screen Descriptions


# Feature Screen Description
1 Homepage Homepage Show sliders, hot posts, featured products + the sider
with the latest posts, static contacts/links
- Shown slider information includes its image and title;
the user is redirected to the slider's backlink on his/her
clicking
- Shown post information includes its thumbnail, title,
brief-info; the user is redirected to the post's details on

GAMS-SRS_v1.0 Page 11 / 20
his/her clicking
- Shown product information includes its thumbnail, title,
brief information; the user is redirected to the product's
details on his/her clicking
2 Manage Setting Setting list View list of system setting.
3 Allows administrator of the system to edit setting
Setting Editor Setting Details
information
4 Allows admin of the system view detailed user
User Editor User Details
information, add new, view or edit user information
5 Product Show the information of a product and the relevant
Product Detail
Details product
6 Show the information of user and able to edit the
Profile Editor Profile Details
information except email
7 Show the posts pagination (sorted by updated date,
paginated) + the sider with the post search box, post
Manager Blog categories, the latest posts, and static contacts/links;
Blog List
List Shown post information includes its thumbnail, title,
brief-info; the user is redirected to the post's details on
his/her clicking
8 Show post details (including title, author, updated date,
Manager Blog
Blog Details category, and post details) + the sider with the post
Details
search box, post categories, static contacts/links
9 This is a pop-up screen which allows the user to enter
email & password to login; on this page, there are also
User Login Login
options for user to register new information or reset the
password for the case s/he forget it
10 This is a pop-up screen which allows the user to register
himself/herself to the system by inputing following
information: full name, gender, email, mobile, and
User Register User Register
address; User then need to verify by clicking the link sent
via email to him/her before being able to access the
system
11 This is a pop-up screen which allows the user to edit
his/her profile information, including the registered ones
User Profile User Profile
& the avatar image. Please note that s/he is not allowed
to change the email

GAMS-SRS_v1.0 Page 12 / 20
2.3 Screen Authorization

GAMS-SRS_v1.0 Page 13 / 20
Screen Admin Guest Customer Marketing Sale Sale Manager

Home Page x x x x x x

Blogs List x x x x x x

Blog Details x x x x x x

Products List x x x x x x
(Public)

Product Details x x x x x x
(Public)

Cart Details x x

Cart Contact x

Cart Completion x

Feedback x

User Login x

User Register x

Reset Password x

Change Password x x x x x

User Profile x x x x x

My Orders x

Order Information x

MKT Dashboard x

Posts List x

Post Details x

GAMS-SRS_v1.0 Page 14 / 20
Sliders List x

Slider Details x

Products List x
(Marketing)

Product Details x
(Marketing)

Customers List x

Customer Details x

Feedbacks List x

Feedback Details x

Sale Dashboard x x

Orders List x x

Order Details x x

Admin Dashboard x

Users List x

User Details x

User Insert x

Setting Details x

Setting List x

GAMS-SRS_v1.0 Page 15 / 20
2.4 Non-UI Functions
[Provide the descriptions for the functions which have no UI (or not screens), i.e batch/cron job, service,
API, etc.]
# Feature System Function Description
1
2

3. System High Level Design


3.1 Database Design
a. Database Schema

GAMS-SRS_v1.0 Page 16 / 20
b. Table Descriptions
No Table Description
01 Address id INT ,
district VARCHAR(255),
city VARCHAR(255),
detail TEXT,
is_default BOOLEAN

GAMS-SRS_v1.0 Page 17 / 20
- Primary keys: id
- Foreign keys: No
02 Role id INT,
name VARCHAR(255)
- Primary keys: id
- Foreign keys: No
03 User id INT,
email VARCHAR(255) UNIQUE NOT NULL,
password VARCHAR(255) NOT NULL,
name VARCHAR(255),
gender BOOLEAN,
status VARCHAR(50),
role_id INT,
phone VARCHAR(20),
last_log DATETIME,
created_by INT,
created_date DATETIME,
pfp TEXT,
- Primary keys: id
- Foreign keys: role_id,updated_by
04 User_address customer_id INT,
address_id INT,
- Primary keys: id,address_id
- Foreign keys: id,address_id
05 Product id INT,
title VARCHAR(255),
description TEXT,
import_price DECIMAL(10, 2),
list_price DECIMAL(10, 2),
status VARCHAR(50),
featured BOOLEAN,
thumbnail TEXT,
created_date DATETIME,
quantity INT,
category_id INT,

- Primary keys: id
- Foreign keys: category_id
06 Cart id INT,
user_id INT,
product_id INT,
quantity INT

- Primary keys: id
- Foreign keys: user_id,product_id
07 Order id INT,
customer_id INT,
ordered_date DATETIME,
status VARCHAR(50),

GAMS-SRS_v1.0 Page 18 / 20
is_delivered BOOLEAN,
delivered_date DATETIME,
total DECIMAL(10, 2),

- Primary keys: id
- Foreign keys: customer_id
08 Order_details order_id INT AUTO_INCREMENT,
product_id INT,
quantity INT,
import_price DECIMAL(10, 2),
sell_price DECIMAL(10, 2),

- Primary keys: order_id,product_id


- Foreign keys: order_id,product_id
09 Product_feedb id INT,
ack product_id INT,
user_id INT,
detail TEXT,
star INT,
image TEXT,
status VARCHAR(50),
created_by INT,
created_date DATETIME,

- Primary keys: id
- Foreign keys: product_id,user_id
10 Promotion id INT,
product_id INT,
sale_price DECIMAL(10, 2),
start_date DATETIME,
end_date DATETIME,

- Primary keys: id
- Foreign keys: product_id
11 Setting_type id INT,
name VARCHAR(20)

- Primary keys: id
- Foreign keys: No
12 Setting id INT,
setting_type_id INT,
name VARCHAR(50),
`order` INT,
status VARCHAR(10),
description TEXT,

- Primary keys: id
- Foreign keys: type_id
13 Post id INT,
title VARCHAR(255),

GAMS-SRS_v1.0 Page 19 / 20
thumbnail TEXT,
detail TEXT,
status VARCHAR(50),
featured BOOLEAN,
created_date DATETIME,
created_by INT,
category_id INT,

- Primary keys: id
- Foreign keys: categor_id,created_by
14 Slider id INT,
title VARCHAR(255),
image TEXT,
back_link TEXT,
status VARCHAR(50),
description TEXT

- Primary keys: id
- Foreign keys: no
15 Contact id INT,
icon TEXT,
link TEXT
- Primary keys: id

3.2 Code Packages


[Provide the package diagram for each sub-system. The content of this section including the overall
package diagram, the explanation, package and class naming conventions in each package. Please see
the sample & description table format below]

Package descriptions
No Package Description
1 controller Contains controller classes or control methods.
2 dao Contains classes and files related to accessing and
processing data from the data source (database, file,
API, etc.).
3 dbcontext Create and manage connections to the database
4 model Contains filters that are used to apply rules and
process before or after actions in the controller.
Filters allow us to perform tasks such as
authentication, access checks, logging handling, and
data changes before it is sent to the view or after it is
sent from the view.

GAMS-SRS_v1.0 Page 20 / 20
II. Requirement Specifications

1. Common Functions
1.1 Login System
a. UC Specification
UC Name: Login System
Primary Actor: Customer Secondary Actors: None
Trigger: User clicks Login button from the page header, or
User accesses an authenticated feature (from a link or type the page URL directly
into the address bar)
Description: As a user, I want to be able to log into the system so that I can use the system’s
authenticated features and access my personalized account.
Preconditions: User account has been created & authorized
Postconditions: ● Admin logs in the system successfully

● The system tracked successful login into the Activity Log


Normal Flow Login System
1. User accesses the User Login screen
2. User types in the login details or choo other login options (see alternative
flows AF1, AF2 in the next section)
3. User clicks the Login button
4. System validates the login details (see E1)
5. System allows user to access
6. System tracks user’s success login to the Activity Log
7. System accesses the Home Page (or the previous calling page if any)
Alternative Flows: AF1. Google Login
1. User chooses to login system using Google account
2. System redirects the user to the Google’s Login screen
3. User types in the Google account details and chooses to login
4. Google validates user’s login information successfully and redirect him/her
back to the system
5. Return to step 5 of normal flow.

AF2. Facebook Login


1. User chooses to login system using Facebook account
2. System redirects the user to the Facebook’s Login screen
3. User types in the Facebook account details and chooses to login
4. Facebook validates user’s login information successfully and redirect him/her
back to the system
5. Return to step 5 of normal flow.
Exceptions: E1. System can’t authenticate the user
1. The Error Message screen is shown to the user
2. User cancels the logging in => UC stops, change to other UC-View Home Page
3. User clicks “Forgot Password?” link => change to the other UC-Reset Password
4. User clicks “Register” link => change to other UC-Register User Account

GAMS-SRS_v1.0 Page 21 / 20
Business Rules: FR1, FR2, FR3

b. Business Rules
1.2 View Homepage
a. UC Specification
UC Name: View Homepage
Primary Actor: Guest Secondary Actors: None
Trigger: User clicks on site’s logo, Home button on other pages or initially called upon
web run.
Description: As a guest, i want to view Homepage to see other functions/screens
Preconditions: None
Postconditions: The Homepage is displayed to user.
Normal Flow View Homepage
1. User enters the homepage URL in the browser.
2. System retrieves the homepage content.
3. System displays the homepage to the user.
Alternative Flows: AF1. Registered User
Personalized Homepage is displayed.
Exceptions: E1. Incorrect URL
Redirect to 404 error page. => UC stops.
Business Rules:

b. Business Rules

1.3 Product Details


a. UC Specification
UC Name: View Product Detail
Primary Actor: Customer Secondary Actors: None
Trigger: User clicks to a product in website or
User click to product link from advertisement
Description: As a user,i want to view product detail so that i can see the specific information
of a product and consider to purchase or not
Preconditions: User access to the website
Postconditions: ● Product Detail Displayed
Normal Flow View Product Detail
1. User Browses Product Listings or Searches for a Product
2. User Selects a Product
3. System Receives the Request
4. System Retrieves Product Information:
5. System Displays Product Details
6. User Takes Further Actions (Optional)
Alternative Flows: AF1. Image/Detail Load Failure
1. User Browses Product Listings or Searches for a Product
2. User Selects a Product
3. System Receives the Request

GAMS-SRS_v1.0 Page 22 / 20
4. Due to server errors, database issues, or network problems, the system fails to
retrieve all or certain details of the product
5. As the product images couldn't be retrieved, the system displays a placeholder
image or a loading icon
Exceptions: E1. Product not found (user enter ođ link)
1. The system displays a message indicating that the product is not available.
2. It may suggest similar products or provide an option to return to the product
listing page
Business Rules: FR1, FR2, FR3

b. Business Rules
None

2. Admin Feature
2.1 View Users List
a. UC Specification

UC Name: View Users List


Primary Actor: Admin Secondary Actors: None
Description: As an admin, I want to view the list of all users to manage all users and maintain the
integrity of the system.
Trigger: Admin clicks on Users List button from admin dashboard.
Preconditions: 1. Admin is logged into system with admin account.
Postconditions: 1. Admin has view the users list
Normal Flow: View Users List
1. Admin logs into the system
2. System check Admin authentication(E1)
3. System display list of users
4. Admin can filter, search, and sort the list(E2)
5. Admin can active/inactive an user.
Alternative Flows: None.

Exceptions: E1. Unauthenticated Access


1. 11Admin attempts to access the list without proper permissions.
2. Return to Login page.
E2. No searching match
3. Admin enter name to search users.
4. The list is empty and a red line appeared.

Business Rules: BR-1, BR-2


b. Business Rules

ID Business Rule Business Rule Description


BR-1 Access Control Only admin with admin account able to access the user list.
BR-2 Data privacy Sensitive user information (such as passwords) should not be

GAMS-SRS_v1.0 Page 23 / 20
visible in the list.

2.2 View User Details


a. UC Specification

UC Name: View Users List


Primary Actor: Admin Secondary Actors: None
Description: As an admin, I want to view the details of all user so that so that I can make change
on them.
Trigger: Admin clicks on Edit button from specific Users in Users List.
Preconditions: 1. Admin is logged into system with admin account.
Postconditions: 1. Admin has view the users list
Normal Flow: View Users List
1. Admin logs into the system.
2. System check Admin authentication.(E1)
3. Admin access Users List screen.
4. System show paginated User list.
5. Admin clicks on Edit button from specific Users in Users List.
6. System display user details.
7. Admin can change User Role or User Statuts.
Alternative Flows: AF1. Admin edit an user
1. Admin change User Role or User Status.
2. Admin clicks on Save Changes Button.(E2)
3. Return to Users List screen.
AF2. Admin add an user
1. Admin clicks on Add New Setitng.
2. User input user details that he want to add.(E3)
3. Admin clicks on Add button.
4. System return to Settings List screen.
Exceptions: E1. Unauthenticated Access
1. Admin attempts to access the list without proper permissions.
2. Return to Login page.
E2. No change commited
1. Admin save change with no adjustment.
2. A message appear to notice that no change has been committed.
E3. Invalid input
1. Admin input invalid format of information.
2. Message pop up under textbox.

Business Rules: BR-1, BR-2, BR-3


b. Business Rules
None

GAMS-SRS_v1.0 Page 24 / 20
2.3 View Settings List.
a. UC Specification

UC Name: View Users List


Primary Actor: Admin Secondary Actors: None
Description: As an admin, I want to view the list of all settings to manage all system settings.
Trigger: Admin clicks on Settings List button from admin dashboard
Preconditions: 1. Admin is logged into system with admin account.
Postconditions: 1. Admin has view the setting list.
Normal Flow: View Users List
1. Admin logs into the system.
2. System check Admin authentication.(E1)
3. Admin click on System Setting button.
4. System display paginated list of setting.(E3)
5. Admin search or filter, search, and sort the list to find settings.(E2)
6. Admin can active/inactive a setting.
Alternative Flows: None.

Exceptions: E1. Unauthenticated Access


1. Admin attempts to access the list without proper permissions.
2. Return to Login page.
E2. No searching match
1. Admin enter name to search settings.
2. The list is empty and a red line appeared.
E3. No setting appear
1. System fails to retrieve the setting

Business Rules: BR-1, BR-2, BR-3


b. Business Rules

ID Business Rule Business Rule Description


BR-3 Data Accuracy Any changes to setting data should be immediately reflected.

2.3 View Setting Details.


a. UC Specification

UC Name: View Setting Details


Primary Actor: Admin Secondary Actors: None
Description: As an admin, I want to view the details of all setting so that so that I can make
change on them.
Trigger: Admin clicks on Edit button from specific Setting in Settings List.
Preconditions: 1. Admin is logged into system with admin account.
Postconditions: 1. Admin has view the settings list
Normal Flow: View Users List

GAMS-SRS_v1.0 Page 25 / 20
1. Admin logs into the system.
2. System check Admin authentication.(E1)
3. Admin access Settings List screen.
4. System display paginated list of Setting
5. Admin clicks on Edit button from specific Settings in Settings List.
6. System display specific setting details.
Alternative Flows: AF1. Admin edit an setting
1. Admin input changed details.
2. Admin clicks on Save Changes Button.(E2)
3. Return to Users List screen.
AF2. Admin add an setting
1. Admin clicks on Add New Setitng.
2. User input user details that he want to add.(E3)
3. Admin clicks on Add button.
4. System return to Settings List screen

Exceptions: E1. Unauthenticated Access


1. Admin attempts to access the list without proper permissions.
2. Return to Login page.
E2. No change commited
1. Admin save change with no adjustment.
2. A message appear to notice that no change has been committed.
E3. Invalid input
3. Admin input invalid format of information.
4. Message pop up under textbox.

Business Rules: BR-1, BR-2, BR-3, BR-4


b. Business Rules

3. Customer Feature
3.1 Add feedback
a. UC Specifications
UC Name: Add Feedback
Primary Actor: Customer Secondary Actors: None
Trigger: User Clicks on Add Feedback button on order details page
Description: As a customer, i want to add my feedback to let other people know what is
the quality of the real product.
Preconditions: ● User has already logged in and ordered a product.
● That product status is set to delivered
Postconditions: User’s comment is successfully posted on product feedback screen.
Normal Flow: Add a feedback
1. User access order details page, chooses Delivered section.
2. User clicks on Add Feedback button.
3. User type in feedback in the textbox.
4. User can choose to add image of product(see alternative flow AF1)

GAMS-SRS_v1.0 Page 26 / 20
5. User clicks Submit button().
6. Feedback is successfully posted and will be pending to posted on
product feedback screen
Alternative Flows: AF1. Add Image of Product
1. User clicks on Add Image button.
2. User is prompted to select image, then clicks submit.
3. Selected image will be displayed for preview.
4. User can choose to Submit feedback or remove selected image(see
alternative flow AF2.
5. Return to step 5 of normal flow.
AF2. Remove Image
1. User clicks on X button on each image to remove.
2. Return to step 5 of AF1.
E1. User inputs too many character (>700)
Exceptions: 1. Summit button will be blurred, user can not post the feedback
2. Display warning message, prompt user to reduce characters
E2. User upload too large image (>50MB)
1. Summit button will be blurred, user can not post post feedback
2. Display warning message, prompt user to reduce characters
Business Rules: FR1, FR2
b. Business Rules

ID Business Rule Business Rule Description


BR1 Access Control ● Registered user
● Product is ordered, status is set to delivered
BR2 Validation ● Feedback must be less than 700 characters

● Uploaded image must be less than 50MB

4. Blog List
a. UC Specification

UC Name: View Blog List


Primary Actor: Guess Secondary Actors: Customer
Description: As a guest or customer, I want to view the details of all blogs so that I can
explore and engage with the content effectively.
Trigger: User clicks on the "View Blogs" button from the main navigation menu.
Preconditions: 1. User is on the website.
Postconditions: 1. User has viewed the blog list.
Normal Flow:

1. User navigates to the website.

GAMS-SRS_v1.0 Page 27 / 20
2. User accesses the "Blogs List" screen.
3. System shows a paginated blog list.
4. User clicks on a specific blog entry to view details.
5. System displays blog details.

Alternative Flows: AF1. User searches for a blog


1. User enters a keyword in the search bar.
2. System filters and displays the relevant blog list.
3. User clicks on a specific blog entry to view details.
AF2. User filters blogs:
1. User selects filter options (e.g. categories,...).
2. The system filters and displays the blog list according to the selected
filter.
3. Users click on a specific blog entry to view details.
4. The system displays blog details.

Exceptions:
E1. No Blogs Found:

1. User searches or filters for blogs.


2. System does not find any matching blogs.
3. System displays a message indicating no blogs were found.

Business Rules: BR-1, BR-2, BR-3

b. Business Rules

III. Screen Designs


[Link] Setting
1.1 Settings List
a. View setting list
This is for the administrator to view the list of current system settings. On
the screen, s/he can also activate or deactivate (change status) of a
specific setting.

GAMS-SRS_v1.0 Page 28 / 20
Field Name Field Type Description
Filter/Search Fields
Search Name Text box This is for user to input name to search for settings.
Search Button User click to search by name.
Type filter Combo Box Filled with the list of current active setting types
(Single Choice) Allow to filter the list by setting type;
Default value is “All Type”
Status filter Combo Box Filled with the All Status, Pending, Active, Inactive
(Single Choice) Allow to filter the list by status;
Default value is “All Status”
Clear Button User clicks to reset filter, sort ,search
Data Table
ID INT Auto-increased identifier of the setting
Setting type String(20) Name of setting type
Name String(20) Name of setting
Order INT Order of setting
Status String(10) Status of setting
Action Links
Edit Button User click to redirect to User Details
Active Button User click to active setting
Inactive Button User click to inactive setting

Table CRUD Description


setting RU Query the list of current settings from the database
Update status of a specific setting

GAMS-SRS_v1.0 Page 29 / 20
setting_type R Query the list of type name

1.2 Setting Details


a. View setting details
This is for the administrator to view the detail of specific setting. On the
screen he can input data and save change.

Field Name Field Type Description


Data Table
Group String(20) Name of setting type
Order Textbox Display setting order
INT(>=0)
Name Textbox Name of setting
String(20)
Status Ratio Status of the setting: Active or Inactive
Description Text Setting description

GAMS-SRS_v1.0 Page 30 / 20
Action Links
Add new Button User click to redirect to pop up a form to add new Setting.
Save changes Button User click to update setting.

Database Access
Table CRUD Description
setting U Update setitng

b. Add New Setting


This is for the administrator to input new setting information and create it
in database.

Field Name Field Type Description


Data Table
Group Combo Box Type of the setting, filled with the list of setting types
(Single Choice) Default value: the first type in the list.
Order Textbox This is for user to input order of setting.
INT(>=0)
Name Textbox This is for user to input name of setting.

GAMS-SRS_v1.0 Page 31 / 20
String(20)
Description Text This is for user to input description of setting.
Action Links
Add Button User click to add new setting.

Database Access
Table CRUD Description
setting C Create new setting

GAMS-SRS_v1.0 Page 32 / 20
2. Homepage

GAMS-SRS_v1.0 Page 33 / 20
Field Name Field Type Description
Logo Hyperlink Redirect to homepage
Home Hyperlink Redirect to homepage
About Hyperlink Redirect to about section
Shop Hyperlink Redirect to product list screen
Blog Hyperlink Redirect to blog list screen
Account Hyperlink Redirect to login screen or register screen
Slider Diplay image of slider
Slider button Button Redirect to slider backlink
Slider next/back Button Next or Previous Slider
button
All product Button User click to display all products
Hot product Button User click to display hot products
New product Button User click to display new products
Product item Hyperlink Redirect to product details page
Blog Item Hyperlink Redirect to blog details page

GAMS-SRS_v1.0 Page 34 / 20
3. Product Detail

Field Name Field Type Description


Action Links
Home Hyperlink User click to home then redirect to Home page
Contact Hyperlink User click to contact then the website will redirect user to
contact page with contact information of shop
Add to cart button Add to cart help user add the product to cart to purchase
Cart Hyperlink User click to cart then appear the cart page with all product
and information of all product user added to cart
Add to wishlist button add the favorite product to the list to user see later
See more button see all the feedback of that product
Leave feedback button to leave a feedback after purchase that product
Product related Hyperlink redirect the user to the product detail of that product

GAMS-SRS_v1.0 Page 35 / 20
Table CRUD Description
Product R Query specify product from the database

4. UserList

Field Name Field Type Description


Filter/Search Fields
Search Name Text box This is for user to input name to search for User
Search Button User click to search by name.
Gender filter Combo Box User choose gender to filter return a list of that user got that
(Single Choice) gender
Role filter Combo Box List with all role in system and users are able to choose role
(Single Choice) to filter
Status filter Combo Box users are able to filter the user list by all status in system
(Single Choice)
Action Links
Edit Button User click to redirect to User Details
Active Button User click to active user
Inactive Button User click to inactive user

Table CRUD Description

GAMS-SRS_v1.0 Page 36 / 20
Product RU Query list of user from the database
Update user status

5 Blog List
UI Design

Field
Name Field Type Description

Button Search User click to search by name of post.

Search Text Box Search field to find specific blog posts by title.

View Button Click to view the detailed content of the blog post

Table CRUD Description


Post R Query list of posts from the database

GAMS-SRS_v1.0 Page 37 / 20
5.1 Blog Detail

Table CRUD Description


Post R Query list of posts from the database

IV. Code Designs

1. Settings List
[Provide the detailed design for the function <Feature/Function Name1>. It includes class diagram and
sequence diagram(s)]
1.1 Class Diagram
[This part presents the class diagram for the relevant feature]

GAMS-SRS_v1.0 Page 38 / 20
1.2 Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature/function, see the sample below. Sequence diagrams
with similar message flow can be omitted, but you need to mention the appropriate reference to the
similar sequence diagram]

1.3 Database Queries


[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]

- Get all Setting: SELECT [Link], type_id, [Link],`order`,status, description, [Link] as type FROM
setting as s join setting_type as t on type_id = [Link] order by [Link]
- Get all Setting Type: SELECT name from setting_type

GAMS-SRS_v1.0 Page 39 / 20
- Get search Setting: SELECT [Link],type_id,[Link],`order`, status, description,[Link] as type
FROM setting as s join setting_type as t on type_id = [Link] where [Link] like ?
- UPDATE setting SET status = 'Active' WHERE id = ?
- UPDATE setting SET status = 'Inactive' WHERE id = ?

2. Settings Details
2.1 Class Diagram

2.2 Sequence Diagram(s)

GAMS-SRS_v1.0 Page 40 / 20
2.3 Database Queries
- INSERT INTO setting(type_id,`order`,name,status,description) VALUES (?,?,?,'Pending',?)
- UPDATE setting SET type_id = ?, name = ?, `order` = ?, status = ?, description = ? WHERE id
=?
3. User Details
3.1 Class Diagram

GAMS-SRS_v1.0 Page 41 / 20
3.2 Sequence Diagram

3.3 Database Queries


-UPDATE user SET role_id = ?,status = ? WHERE id = ?
-INSERT INTO user(email,password,name,gender,status,role_id,phone) VALUE (?,MD5(?),?,?,?,?,?)

4. Product Details

GAMS-SRS_v1.0 Page 42 / 20
4.1 Class Diagram

4.2 Sequence Diagram(s)

4.3 Database Queries


- select * from product where id = ?
- SELECT [Link], p.product_id, p.user_id, [Link], [Link], [Link], [Link], [Link], [Link],
p.created_date

GAMS-SRS_v1.0 Page 43 / 20
FROM product_feedback p join user u on p.user_id = [Link]
where product_id = 1
ORDER BY created_date desc
limit 3;

- SELECT product.category_id FROM product WHERE [Link] = ?


- SELECT * FROM product WHERE product.category_id = ? AND id <> ? LIMIT 4;

5. User List

4.1 Class Diagram

GAMS-SRS_v1.0 Page 44 / 20
4.2 Sequence Diagram(s)

4.3 Database Queries


- select * from user
- SELECT * FROM setting where setting.type_id = 3
- SELECT * FROM user where [Link] like ?
- SELECT * FROM user where user.role_id like ?
- SELECT * FROM user where [Link] like ?
- SELECT * FROM setting where setting.type_id = 3
- SELECT * FROM user where [Link] like ?
- SELECT * FROM user where [Link] like ?
- SELECT * FROM user where [Link] like ?
- "SELECT * FROM user order by " + msg

6. Homepage
5.1 Class Diagram

GAMS-SRS_v1.0 Page 45 / 20
5.2 Sequence Diagram

5.3 Database Queries


- SELECT * FROM product
- SELECT * FROM product WHERE is_featured = 1 LIMIT 5
- SELECT * FROM post WHERE is_featured = 1 LIMIT 5

GAMS-SRS_v1.0 Page 46 / 20
7. Blog
7.1 Class Diagram

GAMS-SRS_v1.0 Page 47 / 20
7.2 Sequence Diagram

7.3 Database Queries


SELECT
[Link] ,
[Link],
[Link],
[Link],
post.is_featured,
post.created_date,
[Link],

[Link] AS user_id,
[Link] AS user_email,
[Link] AS user_name,
[Link] AS user_phone,
[Link] AS setting_id,
[Link] AS setting_name,
[Link] AS setting_order,
[Link] AS setting_status,
[Link] AS user_name
FROM
post
JOIN
user ON post.created_by = [Link]
JOIN
setting ON post.category_id = [Link]
where [Link] like ?

GAMS-SRS_v1.0 Page 48 / 20
V. Appendix

1. Assumptions & Dependencies


[Record any assumptions that were made when conceiving the project and writing this vision and scope
document. Note any major dependencies the project must rely upon for success, such as specific
technologies, third-party vendors, development partners, or other business relationships.]

2. Limitations & Exclusions


[Identify any product features or characteristics that a stakeholder might anticipate, but which are not
planned to be included in the new product]

3. Business Rules
[Provide common business rules that you must follow. The information can be provided in the table
format as the sample below]

ID Category Rule Definition


BR-1 Access Control Only admin with admin account able to access the user list.
BR-2 Data privacy Sensitive user information (such as passwords) should not be
visible in the list.
BR-3 Data Accuracy Any changes to setting data should be immediately reflected.
BR-4 Access User must be activated to get authentication.
approval

GAMS-SRS_v1.0 Page 49 / 20

You might also like