You are on page 1of 31

THE NEW HUNGER GAMES: What a Difference an Alert makes!

This functional specification document

details out the functionality information of the system. It includes functional details of the modules, features and the business rules attached. The navigational flow is also explained through this document.

Table Of content

Introduction........................................................................................................................................... 4
PURPOSE......................................................................................................................................................................................4 PROJECT OBJECTIVE...................................................................................................................................................................... 5

Functional Flow Specifications............................................................................................................ 6


STRUCTURE OF THE PROJECT.........................................................................................................................................................6 Front End......................................................................................................................................................... 8

A. Authentication .......................................................................................................................... 8 A. !reate "rofile #$egistration% ............................................................................................... 8 . &iagrammatic Flow for !reate "rofile................................................................................. 8 .' (arrative )se !ase for !reate "rofile............................................................................ * A. ' +ogin................................................................................................................................. ' . &iagrammatic Flow for +ogin............................................................................................ ' .' (arrative )se !ase for +ogin........................................................................................... ' A. , $ecovered "assword....................................................................................................... . &iagrammatic Flow for $ecover "assword....................................................................... .' (arrative )se !ase for $ecover "assword...................................................................... .. /earch 0odule....................................................................................................................................... *

.. .asic and Advance /earch........................................................................................... * . &iagrammatic Flow for .asic 1 Advance /earch.............................................................. * .' (arrative )se !ase for .asic 1 Advance /earch ......................................................... ' ..' "roduct &etails ............................................................................................................ ', . &iagrammatic Flow for "roduct &etails............................................................................. ', .' (arrative )se !ase for "roduct &etails................................................................. ', !. !ategories...................................................................................................................... '. &iagrammatic Flow for "roduct &etails........................................................................ '.' (arrative )se !ase for "roduct &etails........................................................................... '8 &. 2uic3 Entry4Add to /hopping !art4 .uy (ow.................................................................. , . &iagrammatic Flow for 2uic3 Entry4Add to /hopping !art4.uy (ow..........................., .' (arrative )se !ase for 2uic3 Entry4Add to /hopping !art4.uy (ow.............................,' E. 5our !art........................................................................................................................ ,6 . &iagrammatic Flow for 5our !art................................................................................ ,6 .' (arrative )se !ase for 5our !art ....................................................................... ,6 E. 7rder 8istory #7rder 0anagement%............................................................................. ,8 . &iagrammatic Flow for 7rder 8istory........................................................................... ,8 .' (arrative )se !ase for 7rder 8istory ............................................................................. ,*

"age ' 9 :

"age , 9 :

Introduction
In the year since (ewtown, at least ': school shootings have claimed at least ; lives, according to a &aily .east investigation. 7n Friday, a day after this investigation, a '6th occurred in !olorado. In the year since '< first=graders were shot and 3illed at /andy 8oo3 Elementary, another school shooting ta3en place in America every two wee3s on average.

has

These events aren>t necessarily the types of tragedies that come to mind when one thin3s of ?school shootings@A madmen in fatigues roaming school hallways, strapped with automatic=style guns, murdering indiscriminatelyAnor do they receive the media attention of such mass shootings. .ut they can be similarly traumatiBing for students and staff, and they have led to at least ': inCuries and ; deaths over the past year, The &aily .east has found. These repeats could have been prevented if students were mobiliBed with phones eDuipped with Apps that notified students early of school closings, school delays, school emergencies, fire drills to 3eep students connected to the administration and to 3eep the administration connected to students. A simple alert could have saved a life. "rincipleEs 7fficeF Code 9-11, please sta in t!e classroo", turn off li#!ts, loc$ door and #et as far awa fro" t!e doors and windows are possible. %elp is on t!e wa &. GThis proCect outlines the functionality of the mobile app used to save lives in schools. /ince we are living in a new normal and our sending our children into warBones not classrooms, we need a fight and flight plan in place nationwide to ensure our students get out educated and alive.

Purpose
The purpose of the document is described with respect to the intended audience of the document. Hithin the !ompany Administrator )sersF 0anaging the content on the A"". 0anaging the )sers4$egistered )sers

For &evelopmentF /oftware &evelopers Testers

$eading /uggestion It is recommended that the reader reads the document in the same flow as mentioned in the &ocument !onvention below. Two basic distinctions followed in the document areF Hebsite4Front=end Administrative !ontrol "anel4.ac3end

"age : 9 :

&7!)0E(T !7(IE(TI7(/ The document flow includes functional specifications4 functionalities4 feature details of &igital Front= end and the Administrative !ontrol "anel to manage the &igital app. All the functionalities4features have been explained with the following conventionF &iagrammatic Flow of the "rocess or Feature (arrative )se !ase

The 3ey given below will assist in understanding the diagrammatic flowsF

Project Objective
Expanded /ecurity 0odel rolled out in all schools J proCected time4costF 6 months4 K'<<,<<<.

"age 6 9 :

Functional Flow Specifications Structure of the Project from the school camera's right into your phones: 1. School camera's picture up danger send an alert to the principle's office.

2. Principle immediately notifies police fire departments and all teachers in classrooms via digital te!t. ". #eacher's instruct $ids on %hat to do. &. Police and s%at teams arrive on the premises in seconds. '. Suspect is apprehended and everyone is safe.

Stop !ere.

"age - 9 :

-odule .a"e/ *o#in

0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription *o#in 10C232456 $egistered user of the site. This use case describes the login functionality. This describes the login functionality. )sing this feature, user can authenticate himself and access various other features available on the site.

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields 7ther Ialidations Flow of Events Step +ction . In the LAuthentication> section of the homepage, user needs to fill his login credentials in order to login into his account. #7ther modules which are only accessible to the logged in user, will also provide the same login form.% 7n clic3 of L+ogin>, system will chec3 whether the user exists in the database or not. If the provided username 1 password combination exists then it allows user to successfully log into the system. And will be redirected to the homepage. ,. If the data is invalid then a system will throw appropriate error messages. )ser must be registered member of the site. If user provides wrong username or password. )sername "assword

'.

Additional Information

1.' (usiness )ules for *o#in +ut!entication ,*o#in 1.1 Hhile logging into the system, if user fails to login '=, times and still entering the wrong username and password then LImage verification> will be provided in addition to the login form.

"age ; 9 :

"age 8 9 :

-odule .a"e/ )eco8er 9assword 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription )eco8er 9assword 10C2324'6 $egistered user of the site. This use case describes the recover password functionality. )ser can use this feature to retrieve his4her forgotten password.

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields 7ther Ialidations Flow of Events )ser must be registered member of the site. If user provides wrong email address. Email Address This email address should match with the one user has provide at the time of registration. Step +ction . LAuthentication> section of the homepage includes the lin3 L$ecover "assword>. 7n clic3 of this lin3, user will be redirected to the L$ecover "assword> page. #Hhile logging into the system, if user fails thrice then forth time he4she will be redirected to the L$ecovered "assword> page.% '. 7n the L$ecover "assword> page, user needs to provide same email address which he has provided at the time of registration. 7n clic3 of L/ubmit>, system will chec3 whether the email address exists in the database or not. If it exists then it an email notification will be sent to the user and message will be displayed as ?An email with your account information was mailed to MEmail AddressN. )se the received data for logging into the shop.@ ,. If the data is invalid then a system will throw appropriate error messages.

Additional Information

. Hhile logging into the system, user fails twice then third time he4she will be redirected to the L$ecovered "assword> page.

"age * 9 :

1.' (usiness )ules for )eco8er 9assword +ut!entication , )eco8er 9assword 1.1 An email notification will be sent to the user. This email will contain the login credentials of the user.

"age < 9 :

(. Searc! -odule (.1 (asic and +d8ance Searc!


1.1 3ia#ra""atic Flow for (asic : +d8ance Searc!

"age

9:

1.5 .arrati8e 0se Case for (asic : +d8ance Searc!

"age ' 9 :

-odule .a"e/ (asic : +d8ance Searc! 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription (asic : +d8ance Searc! 10C232446 An anonymous or registered user. .asic and advance search features are available to find the desired product. )sing the search functionality, user can search for the desired product.

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields 7ther Ialidations ;e word 1(asic6 searc!/ Searc! for 9atternF Textbox#!haracters 0inO<P 0axO '<P% #All special characters are allowed% $adio button with valuesF OAll words, Any word and Exact "haseP Searc! inF !hec3boxes with values O"roduct Title, /hort &escription, &etailed &escription and /Q)P +d8ance Searc!/ Searc! In Cate#or / &ropdown with all values coming from category master !hec3boxes with values O0ain !ategory, Additional !ategory, Also search in sub categoriesP 9rice 1C+<6/ Two textboxes separated by hyphen Textbox #(umeric 0inO<P 0axO 6P% #/pecial character L.> Is allowed% Flow of Events Step +ction . )ser may or may not enter the 3eyword and clic3 on LRo>. /earch result will be displayed #if 3eyword is provided then result matching with the criteria will be displayed and if it is blan3 then default listing will be displayed. #&efault listing will be displayed % )ser may sort the listing by . /Q) #"roduct !ode% '. "roduct #"roduct Title% ,. "rice #"roduct "rice% ,. 7n the search result page, user can enter the reDuired Duantity and may choose one of the following optionsF . .uy (ow '. Add to Favorites :. If user clic3s on L.uy (ow> then user will be redirected to L5our /hopping !art> page #if user is "age , 9 : logged in> else he4she will be redirected to the L+ogin> page. #$efer )!4&4<-% If user clic3s on LAdd to Favorites> then dropdown will be populated which has folder names

'.

6.

1.' (usiness )ules for (asic : +d8ance Searc! (asic : +d8ance Searc! 1.1 1.2 In order to add the product to the shopping cart, user needs to be logged in user. To add any of the item to the folder #i.e. to save the favorite item%, user needs to create the folder first. #7nly added4edited folders will be available in the dropdown%

(.5 9roduct 3etails


1.1 3ia#ra""atic Flow for 9roduct 3etails

1.5 .arrati8e 0se Case for 9roduct 3etails

"age : 9 :

-odule .a"e/ (asic : +d8ance Searc! , 9roduct 3etails 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type (asic : +d8ance Searc! , 9roduct 3etails 10C2324=6 An anonymous or registered user. &etails related to the particular product will includeF "roduct &escription "roduct !ode Height "rice 0anufacturer !atalog "age (umber $ecommended "roduct +ist This use case describes various features available on the detailed pageF . /end to friend '. "roduct $ating ,. !ustomer $eviews

&escription

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields Send to Friend/ 5our name 5our e=mail $ecipients e=mail Custo"er Feedbac$/ 16 9roduct )atin#/ /elect your rate 56 Custo"er )e8iews/ 5our name 5our message Image verification 7ther Ialidations Send to Friend/ 5our name F Textbox #!haracters 0inO'P 0axO'<P% 5our e=mailF Textbox#Alphanumeric 0inO'P 0axO6<P% #/pecial characters li3e LS>, L.> Are allowed. L.> and LT> should be present in the provided string.% $ecipients e=mailF Textbox#Alphanumeric 0inO'P 0axO6<P% #/pecial characters li3e LS>, L.> Are allowed. L.> and LT> should be present in the provided string.% Custo"er Feedbac$/ 16 9roduct )atin#/ /elect your rate &ropdown will have following values OExcellent, very Rood, Rood, Fair, "oorP 56 Custo"er )e8iews/ 5our nameF Textbox #!haracters 0inO'P 0axO'<P% 5our messageF Textbox #!haracters 0inO'P 0axO'<<P% #All special characters and white spaces are allowed% Image verificationF Image IerificationF $andom image will be displayed here. And textbox will be provided to enter the same code into it. #Ret different code> lin3 will be available, on clic3 of which6 9 : "age code will be refreshed and user can see different code.% Flow of Events Step +ction

1.' (usiness )ules for (asic : +d8ance Searc! , 9roduct 3etails (asic : +d8ance Searc! , 9roduct 3etails 1.1 1.2 )ser can vote for any product only once. )ser can add review for any product only once.

"age - 9 :

C. Cate#ories
1.1 3ia#ra""atic Flow for 9roduct 3etails

"age ; 9 :

1.5 .arrati8e 0se Case for 9roduct 3etails

"age 8 9 :

-odule .a"e/ Cate#ories 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription Cate#ories 10C232466 An anonymous or registered user. )ser can browse through various categories available and can buy desired product. This use case describes product catalog added through bac3=end. Iarious categories and sub categories of the product are available.

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields 7ther Ialidations Flow of Events Step . )ser can clic3 on any of the category listed under L!ategories> module. /ub categories will be available under that category with the product count. )se can either clic3 on sub category or can view the default listing of the products. )ser can browse though this product catalog till the last level. #+evel is not defined. "roduct catalog has nth level.% :. 6 Hhen user comes on the product listing page, )ser may sort the listing by . /Q) #"roduct !ode% '. "roduct #"roduct Title% ,. "rice #"roduct "rice% -. 7n the search result page, user can enter the reDuired Duantity and may choose one of the following optionsF ,. .uy (ow :. Add to Favorites ;. If user clic3s on L.uy (ow> then user will be redirected to L5our /hopping !art> page #if user is logged in> else he4she will be redirected to the L+ogin> page. #$efer )!4&4<;% If user clic3s on LAdd to Favorites> then dropdown will be populated which has folder names #ReneralF default folder and other #if any% created by the user.% #if user is not logged in then he4she will be "age * 9 : redirected to the L+ogin page>% )ser needs to select the folder where he wants to save his favorite item.

'. ,.

8.

1.' (usiness )ules for Cate#ories Cate#ories 1.1 "roduct catalog has nth level. This catalog will be handled in the bac3=end.

"age '< 9 :

3. >uic$ 7ntr 2+dd to S!oppin# Cart2 (u .ow


1.1 3ia#ra""atic Flow for >uic$ 7ntr 2+dd to S!oppin# Cart2(u .ow

"age ' 9 :

1.5 .arrati8e 0se Case for >uic$ 7ntr 2+dd to S!oppin# Cart2(u .ow

"age '' 9 :

-odule .a"e/ >uic$ 7ntr 2+dd to S!oppin# Cart2(u .ow 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription Flow of 78ents "reconditions Failed End !ondition 0andatory Fields )ser needs to be logged in. If user does not supply any mandatory details then he4she is as3ed to fill it again. >uic$ 7ntr "roduct !ode #/Q)% Step 1/@our S!oppin# Cart 2uantity Step5 /9ersonal 3etails 9ersonal Infor"ation/ First (ame +ast (ame (illin# +ddress/ Address !ity "rovince4 Territory !ountry "ostal !ode Contact Infor"ation/ "hone E=mail 0ser na"e : 9assword/ "assword !onfirm "assword 7ther Ialidations >uic$ 7ntr "roduct !ode #/Q)% F Textbox #Alphanumeric 0axO <P% 2uantityF Textbox #(umeric 0axO,P Step 1/@our S!oppin# Cart 2uantityF Textbox #(umeric 0axO,P Step5 /9ersonal 3etails !ustomer (oF +abel #&isplays customer number% 9ersonal Infor"ation/ First (ameF Textbox #!haracters 0inO'P 0axO'<P% +ast (ameF Textbox #!haracters 0inO'P 0axO'<P% !ompanyF Textbox #!haracters 0inO<P 0axOO6<P% (illin# +ddress/ "age ', 9 : AddressF Textbox #!haracters 0inO'P 0axO <<P% Address #line'%F Textbox #!haracters 0inO<P 0axO <<P% >uic$ 7ntr 2+dd to S!oppin# Cart2 (u .ow 10C2324?6 A registered user of the site. )ser can add items to the shopping cart and ma3e the payment of the product. This use case describes shopping cart functionality.

1.' (usiness )ules for >uic$ 7ntr 2 +dd to S!oppin# Cart2(u .ow >uic$ 7ntr 2+dd to s!oppin# Cart2 (u .ow 1.1 1.2 1.3 An order notification will be sent to user>s email address. An order will get processed according to the delivery details provided while shopping. )ser can not Cump to step : #i.e. "lace 7rder% until unless he complete step, #i.e. /hipping and "ayment%

"age ': 9 :

7. @our Cart
1.1 3ia#ra""atic Flow for @our Cart

1.5 .arrati8e 0se Case for @our Cart

"age '6 9 :

-odule .a"e/ @our Cart 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription @our Cart 10C2324A6 Anonymous or registered user of the site. )ser can view the products added to the cart. This module also has Duic3 lin3 for chec3out. Following features are available in this sectionF . Iiew !art '. !hec3out ,. 0odify "rofile :. &elete "rofile 6. 7rder 8istory

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields If user does not supply any mandatory details then he4she is as3ed to fill it again. Biew Cart 2uantity -odif 9rofile 9ersonal Infor"ation/ First (ame +ast (ame (illin# +ddress/ Address !ity "rovince4 Territory !ountry "ostal !ode Contact Infor"ation/ "hone E=mail 0ser na"e : 9assword/ "assword !onfirm "assword 7ther Ialidations Biew Cart 2uantityF Textbox #(umeric 0axO,P% C!ec$out &elivery 0ethodF $adio button with value O&elivery P "ayment 0ethodF $adio button with values O7n account, "urchase 7rder, "hone 7rdering and Fax 7rderingP Fa8orites Rroup nameF Textbox#!haracters 0inO'P 0axO6<P% #.y default Rroup named LReneral> exists% -odif 9rofile !ustomer (oF +abel #&isplays customer number% "age '- 9 : 9ersonal Infor"ation/ First (ameF Textbox #!haracters 0inO'P 0axO'<P% +ast (ameF Textbox #!haracters 0inO'P 0axO'<P%

1.' (usiness )ules for @our Cart @our Cart 1.1 1.2 At least one product needs to be available in the cart, in order to access chec3out feature. L0odify "rofile> and L&elete "rofile> features will reDuire authentication.

"age '; 9 :

7.1 Order %istor 1Order -ana#e"ent6


1.1 3ia#ra""atic Flow for Order %istor

"age '8 9 :

1.5 .arrati8e 0se Case for Order %istor

"age '* 9 :

-odule .a"e/ Order %istor 0se Case Identification )se !ase (ame 1 Id )ser )se !ase Type &escription Order %istor 10C232496

$egistered user of the site. )ser can search for the orders to view4process. This use case describes the order management functionality.

Flow of 78ents "reconditions Failed End !ondition 0andatory Fields 7ther Ialidations (asic Searc!/ &ate "eriodF $adio buttons with values OAll dates, This month, This wee3, Today, /pecify the period belowP Following options will be enabled only if user selects option L /pecify the period below>F 7rder date fromF Three dropdowns for month, date and year respectively. 7rder date throughF Three dropdowns for month, date and year respectively. . First dropdown will have values from Uanuary to &ecember '. /econd dropdown will have values from to , ,. Third dropdown will have values from *** to '<<* +d8ance Searc! 7rder I&F Two textboxes First textboxF !haracters 0axO'<P /econd TextboxF !haracters 0ax O,<P 7rder /tatusF &ropdown with values O(ot Finished, 2ueued, "rocessed, .ac3ordered, &eclined, Failed, !ompleteP Flow of Events Step . +ction )ser may or may not enter the search criteria and clic3s on L/earch>. /earch result will be displayed as per the criteria specified. #.y default result for all dates will be displayed.% /earch result will contain following columnsF 7rder Id /tatus !ustomer &ate Total ,. 7n clic3 of any of the lin3 except customer user will be redirected to the L7rder &etails> page "age ,< 9 : where user can view the order process details. In order to view the invoice #order details%, user can chec3 the desired one and clic3 on L7rder for

'.

1.' (usiness )ules for @our Cart , Order %istor 1Order -ana#e"ent6 @our Cart ,Order %istor 1Order -ana#e"ent 6 1.1 /tatus of the order will get updated as the order will be processed by the admin.

"age , 9 :

You might also like