Software Requirements

Specification
For

Patriot Easy Order System

Version 1.2

Prepared by

Mohammad Abu Matar

Wahid Sadek
Frank Sanders
Zakaria Abouelfaid

December 11th 2006

Copyright © 1999 by Karl E. Wiegers. Permission is granted to use, modify, and distribute this document.
Software Requirements Specification for Patriot Easy Order System Page ii

Table of Contents
1. Introduction................................................................................................................................1
1.1 Purpose .............................................................................................................................................. 1
1.2 Document Conventions...................................................................................................................... 1
1.3 Intended Audience and Reading Suggestions.................................................................................... 1
1.4 Product Scope .................................................................................................................................... 1
1.5 References.......................................................................................................................................... 1
1.6 Overview ........................................................................................................................................... 2
2. Overall Description....................................................................................................................2
2.1 Product Perspective............................................................................................................................ 2
2.2 Product Functions .............................................................................................................................. 2
2.3 User Classes and Characteristics ....................................................................................................... 2
2.4 Operating Environment...................................................................................................................... 3
2.5 Design and Implementation Constraints ............................................................................................ 3
2.6 User Documentation .......................................................................................................................... 3
2.7 Assumptions and Dependencies ........................................................................................................ 3
3. External Interface Requirements .............................................................................................3
3.1 User Interfaces ................................................................................................................................... 3
3.2 Hardware Interfaces ........................................................................................................................... 3
3.3 Software Interfaces ............................................................................................................................ 4
3.4 Communications Interfaces ............................................................................................................... 4
4. System Features..........................................................................................................................5
5. Other Nonfunctional Requirements.......................................................................................18
5.1 Performance Requirements.............................................................................................................. 18
5.2 Safety Requirements ........................................................................................................................ 18
5.3 Security Requirements ..................................................................................................................... 18
5.4 Software Quality Attributes ............................................................................................................. 18
5.5 Business Rules ................................................................................................................................. 18
6. Other Requirements ................................................................................................................19

Revision History
Name Date Reason For Changes Version
Frank Sanders 11/5/200 Initial Release For Review 1.0
6
Sanders, Sadek, 12/01/20 Interim Release finalizing content of use cases 1.1
Abumatar and 06
Abouelfaid
Sanders, Sadek, 12/11/20 Final Draft 1.2
Abumatar and 06
Abouelfaid
Software Requirements Specification for Patriot Easy Order System Page 1

1 Introduction

1.1 Purpose

This document will outline the requirements for the Patriot Easy Order System. It will

present a detailed description of the Patriot easy order system. It will explain the purpose

and features of the system, the interfaces of the system, what the system will do, the

constraints under which it must operate.

This document is intended for both the stakeholders and the developers of the system.

1.2 Document Conventions

The standards and the conventions adopted in this SRS document are the following: we

used the Arial font with a font size of 12. We assumed that priorities for higher-level

requirements are inherited by detail requirements. Standards and other referenced

external documents will appear in bold.

1.3 Intended Audience and Reading Suggestions

Project stakeholders, System Users (restaurant employees/managers), Consultants and

Developers are the intended audience.

1.4 Product Scope

The Patriot Easy Order System allows customers to easily order and pay for food from

their table through a touch screen device, without having to stand in line. Additionally the

system provides a limited set of entertainment options, as well as integrating with the

inventory system used by the restaurant, and allows staff to generate reports and easily
Software Requirements Specification for Patriot Easy Order System Page 2

retrieve orders for preparation. The system will interface with third party vendors to get the

entertainment programming.

The Patriot Easy Order System will provide the following benefits for the stakeholders:

• Increase overall customer experience

• Meet increase in demand of restaurant services

• Find a fixed cost solution

• Cater to young tech-savvy crowd

• Improve ambience (no lines)

• Provide entertainment for customers

• Increase efficiency of inventory management

The system will interface with third party vendors for inventory to order products

through managers, and for entertainment to get entertainment streaming to the

customers.

1.5 References

1. Patriot Easy Order System Statement of Work.

2. OASIS standards www.oasis-open.org

3. NCR EasyPoint Xpress Payment -

http://www.ncr.com/en/products/hardware/sa_easypoint_xpayment.htm

4. IBM SurePoint displays -

http://www-03.ibm.com/products/retail/products/peripherals/surepoint/
Software Requirements Specification for Patriot Easy Order System Page 3

1.6 Overview

The rest of this document contains a detailed description of the Patriot Easy Order

System. It also contains detailed software requirements specifications organized based on

the features of the system as outlined by the IEEE STD 830-1998 standard.

It should be noted that the software requirements specifications are presented as part of

the detailed use cases of the system.

Software Requirements Specification for Patriot Easy Order System Page 4

2 Overall Description

2.1 Product Perspective

The Patriot Easy Order System is a new software and hardware system being designed at

the request of Patriots restaurant.

Customer Wait staff Manager

Uses entertainment Deliver orders

Option
Pay Bill Enter order Checks orders Manages
inventory

Patriot Easy
Ordering
System

Checks receipts
Fills supply
Receives orders orders
Owner Prepares orders Vendor

Cook

2.2 Product Functions

• Customer ordering ability from tables

• Standard and custom ordering options

• Automated sending of orders to kitchen

• POS (Point of sale) at tables

Software Requirements Specification for Patriot Easy Order System Page 5

• Automated inventory management

o Automated ordering of inventory through vendors sites when available

• Customer accounts

o Discounts

o Storing of recent meals

• Entertainment for kids and adults (browsing news headlines, music, perhaps sports

or checking email)

2.3 User Classes and Characteristics

• Owners – Have the same access privileges and abilities as managers.

• Customers – Customers can place an order, use the entertainment option and pay

their bill.

• Wait staff – Deliver the order to the customer table and clean the table after the

customer is done.

• Cooks – Receive customer orders and prepare the order.

• Managers – Reorder supplies. The owner can check receipts and inventory to see

how business is doing.

• Vendors (for automated supply ordering) – Receive orders from Managers for

supplies.

• Vendors (for entertainment programming) – Feed entertainment programming to

the Patriot Easy System.

Software Requirements Specification for Patriot Easy Order System Page 6

2.4 Operating Environment

The system will be written in java and run on NCR EasyPoint Xpress Payment systems, as

well as PCs connected to IBM surepoint displays. The specifications for the PCs will

match the specifications of the Xpress Payment kiosks.

2.5 Design and Implementation Constraints

The time allotted for this project will be limited to the fall 2006 semester.

The language of the product will be JAVA and the development environment will be

eclipse. We will be using NCR EasyPoint Xpress Payment and IBM SurePoint displays.

Only the manager and the owner will have physical access to the server and the programs

on it, unless permission is granted as otherwise by them.

2.6 User Documentation

Electronic copies of the database software user manuals and the NCR Easypont Xpress

Payment kiosks, and IBM SurePoint display documentation will be provided to

stakeholders upon delivery of the software, in addition to any manuals developed as part

of the software system.

2.7 Assumptions and Dependencies

The software system will be developed in java to run on the selected hardware (NCR

Easypoint Express Payment), with network access to a database which supports JDBC.
Software Requirements Specification for Patriot Easy Order System Page 7

3 External Interface Requirements

3.1 User Interfaces

Place Your Order

Soups
Welcome To Patriots & Entrees
Salads
Touch the Screen to Begin Your Order

Drinks Sides

Place Your Order - Entrees Place Your Order: Customize Item

Burgers Pasta Chicken

V V
V
Beef Pork Sandwiches

Place Your Order: Sandwiches User Registration

Name:
Italian Turkey
Address:
-----------------------------------------------------
Roast
Ham On Screen Keyboard
Beef
Software Requirements Specification for Patriot Easy Order System Page 8

Pay Bill Order List

Time Order No. Status
13:31:12 1230099 Delivered EDIT

Cash Debit Card Credit Card 13:42:34 1230100 Cooked EDIT

13:46:32 1230101 Cooked EDIT

13:57:02 1230102 Paid EDIT

Order Details Inventory List

Name Type Vendor
Order No. 1230100 Basil Spice Sams Co. EDIT

Honey Bread Vincent

Order Cheese Burger
Small Fries
Wheat Products EDIT

Small Diet Coke Bread

Status Cooked Save Changes
Tomato Sauce Campbell EDIT
Sauce
American Cheese Sergento EDIT
Cheese

Choose Options
Entertainment

News Music

System Displays Options

Sports Movies
Software Requirements Specification for Patriot Easy Order System Page 9

Customer Selects Option System Displays Music Options

Music
News Music Video Artists
V
Sports Movies Radio Music News

Customer Selects Options

Music Video Artists

Radio
Music News
V

3.2 Hardware Interfaces

The hardware selected for the project is the NCR Easypoint Xpress Payment system,

which will be deployed at all point of sales locations (customer tables as well as at the user

registration/staff kiosk). All other displays will be IBM SurePoint displays utilizing only their

touch-screen capabilities, connected to PCs.

3.3 Software Interfaces

The Java Programming language will be used to write the software system. Therefore the

database used to store data must support JDBC. Additionally Java APIs will be leveraged

to support the touch screen capabilities of the SurePoint displays and Xpress Payment

kiosk, as well as the card reader, cash scanning and receipt printing capabilities of the

Xpress Payment kiosks.

Software Requirements Specification for Patriot Easy Order System Page 10

3.4 Communications Interfaces

All communication with external systems will be accomplished through the use of OASIS

web standards. Email will be sent using JavaMail.

Software Requirements Specification for Patriot Easy Order System Page 11

4 System Features
This section presents the software requirement specifications organized by feature within detailed
use cases.

Ordering
Software Requirements Specification for Patriot Easy Order System Page 12

Use case name: Order

Use case ID: Ord – 100
Primary actor(s): Customer
Secondary actor(s):
Brief description: Customer orders food for purchase and consumption.
Preconditions:
Flow of events: 1. Customer begins an order.
2. For each item the Customer wishes to order:
(a) User selects an item from menu if the item is an
alcoholic beverage the order is flagged as needing ID.
(b) The item is added to the order.
3. The customer selects finished ordering.
Post-conditions: The order is considered to be “Ordered”
Priority:
Alternative flows and Special Order - Insert after step 2a. If the customer wishes to
exceptions: they may customize any item ordered. This takes them to a sub
menu which will present them with the default configuration of
the ordered item. Customers may select or de-select any
condiment toping or ingredient. Customer will then indicate that
they have completed the customization.
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 13

Use case name: Pay Bill

Use case ID: Ord – 110
Primary actor(s): Customer
Secondary actor(s):
Brief description: Customer pays for their ordered food.
Preconditions: The order is considered “Ordered”.
Flow of events: 1. The customer is presented with payment options.
(a) If the customer has elected to pay by debit/credit or
gift card the customer is prompted to swipe their card
in the card reader.
(b) Otherwise, the customer is prompted to pay using the
cash scanner in the booth.
2. A receipt is printed for the customer any change that may
be due to the customer is paid out at this time as well.
Post-conditions: The order is considered to be “Paid”
Priority:
Alternative flows and
exceptions:
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW

Use case name: Notify Order Placed

Software Requirements Specification for Patriot Easy Order System Page 14

Use case ID: Ord-120

Primary actor(s): Cook
Secondary actor(s):
Brief description: Retrieve an order for preparation.
Preconditions: The order is considered to be “Paid”
Flow of events: 1. Cook is displayed next order in the queue on a touch-
video screen.
2. Cook prepares and selects order complete when finished
preparing food.
3. Order status is changed to “Cooked” and removed from
the Cook’s queue.
4. The inventory is updated.
Post-conditions: The order is considered to be “Cooked”
Priority: High
Alternative flows and
exceptions:
Non-behavioral
requirements:
Assumptions: Machines are used to count the volume of condiments in order to
track their usage, and other components of all items come in
easily measurable and traceable quantities.
Issues:
Source: Patriot Easy Order System SOW

Use case name: Notify Order Ready

Use case ID: Ord-130
Software Requirements Specification for Patriot Easy Order System Page 15

Primary actor(s): Wait Staff

Secondary actor(s):
Brief description: Notify the wait staff that an order is ready for pickup.
Preconditions: The order is “Cooked”.
Flow of events: 1. The wait staff is notified that an order is ready for
delivery indicating whether or not ID is required, on a
system display.
2. The wait staff delivers the order to the table, checking ID
if necessary.
3. The wait staff marks the order as delivered in the system.
Post-conditions: The order is considered “Delivered”
Priority: High
Alternative flows and
exceptions:
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 16

Use case name: Generate Order Report

Use case ID: Ord-140
Primary actor(s): Manager
Secondary actor(s):
Brief description: The Manager can generate order reports. These reports are on
current and past orders. These reports will provide information
on order frequency, cook time, delivery time and method of
payment
Preconditions: The user is authenticated as a Manager.
Flow of events: 1. Manager chooses the order information to generate
filtered by order date.
2. Manager inputs the parameters used to generate the
report.
3. Report is displayed on screen and an option is provided
to save/print the report.
Post-conditions:
Priority:
Alternative flows and
exceptions:
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 17

Rewards and Discounts

Software Requirements Specification for Patriot Easy Order System Page 18

Use case name: Activate Restaurant Id Card

Use case ID: RD-100
Primary actor(s): Employee
Secondary actor(s):
Brief description: Employee activates new card for customers and employees

Preconditions: User is authenticated as manager.

Flow of events: 1. Employee swipes new card through card reader
2. System detects that the card is new
3. System displays ‘New Card Activation’ screen
4. If this is a Reward Card
(a) Employee selects New Reward Customer Activation
(b) System displays New Reward Customer Registration
(c) Employee enters data (name, address, email, phone
number, etc)
(d) System creates customer record

5. If this is an Employee Id card

(a) Employee selects New Id Card Activation
(b) System displays New Id Card Activation
(c) Employee enters data (name, Employee SSN,
address, email, phone number, title, etc)
(d) System creates employee record
Post-conditions: Record is Created
Priority:
Alternative flows and Alternative 1, Insert point step 2
exceptions 1. System cannot read card
2. System instructs employee to use a different card
Software Requirements Specification for Patriot Easy Order System Page 19

Non-behavioral
requirements:
Assumptions: Manager can activate both customer and employee cards.
Issues:
Source: Patriot Easy Order System SOW

Use case name: Display customers’ information

Use case ID: RD-110
Primary actor(s): Customer
Secondary actor(s):
Brief description: The system displays the customer’s name, previous distinct
orders, and method of payment.
Preconditions: Customer is authenticated
Flow of events: 1. System displays customer’s information, this includes:
(a) Name.
(b) Previous method of payments.
(c) Previous distinct orders.
Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 20

Use case name: Order Previous Order

Use case ID: RD-120
Primary actor(s): Customer
Secondary actor(s):
Extends: Order – After Step 1
Brief description: Customer orders a previously placed order
Preconditions: Customer is authenticated
Flow of events: 1) Customer selects the re-order previous order option.
2) Customer is presented with a list of previous orders
3) Customer selects order from list
Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues: Note: This UC extends the ‘Order Food’ UC
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 21

Use case name: Send Discounts and Coupons Email

Use case ID: RD-130
Primary actor(s): Customer
Secondary actor(s):
Trigger: Configurable Time Intervals
Brief description: The system emails discounts to customers based on their
spending milestones.
Preconditions: Customer has reached spending milestone
Flow of events: 1) System determines eligible customers based on configured
spending milestones.
2) If the eligible customer’s record has an associated email
address, system sends out a discount email message.

Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 22

Use case name: Apply discounts

Use case ID: RD-140
Primary actor(s): Customer
Secondary actor(s):
Includes: Pay Bill
Brief description: The system applies discounts based on the customer’s eligibility
Preconditions: Customer is authenticated
Flow of events: 1. System detects that customer is eligible for discounts based
on configured spending milestones.
2. System applies discounts to final price
Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 23

Use case name: Enter Spending Milestones and Discounts

Use case ID: RD-150
Primary actor(s): Manager
Secondary actor(s):
Brief description: Spending milestones and discounts will be specified and
changed from time to time by management
Preconditions: Manager is authenticated
Flow of events: 1. Manager selects Set Discounts and Spending Milestones
2. Manager enters discount terms
(a) Discount Type and Amount
(b) Spending Milestone
(c) Applicable Dates and/or times
(d) Applicable Items
Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 24

Entertainment
Software Requirements Specification for Patriot Easy Order System Page 25

Use case name: Display entertainment options

Use case ID: ENT-100
Primary actor(s): Customer
Secondary actor(s):
Brief description: The customer selects entertainment to check for music, news
and sports options
Preconditions: Order is considered ”Paid”
Flow of events: 1. Customer selects the entertainment option
2. The system displays all entertainment options.
3. The customer selects the option.
Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 26

Use case name: Manage Entertainment Options

Use case ID: Ent-110
Primary actor(s): Manager
Secondary actor(s):
Brief description: Manager Selects among the entertainment provided by the
vendor for use by the customers.
Preconditions: User is authenticated as a manager.
Flow of events: 1. Manager selects Manage Entertainment Options
2. Manager selects among the available options.
Post-conditions: The selected entertainment options are available for customer
use.
Priority: High
Alternative flows and
exceptions:
Non-behavioral
requirements:
Assumptions: The vendor's system conforms to OASIS web standards.
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 27

Inventory
Software Requirements Specification for Patriot Easy Order System Page 28

Use case name: Manage Inventory

Use case ID: Inv-100
Primary actor(s): Manager
Secondary actor(s): Vendor Supply Ordering System
Brief description: Manager manages the inventory by adding new items needed by
the restaurant and removing items that are not used anymore.
Manager selects items that the system should auto-order when
necessary. Manager also sets the item auto-order count trigger --
level where it should send supply orders to the appropriate
vendor supply ordering system via oasis standard web service
protocol.
Preconditions: User must be authenticated. To set an item for auto-order system,
the system must be configured to communicate with the vendor
order supplying system
Flow of events: 1. The manager uses the inventory management screen to
search for item to update or add a new item
2. The manager updates the item information, which includes:
(a) Add/Update meta data information for the item
(b) Identify or remove item as auto-order
(c) Set the auto-order trigger count level
Post-conditions:
Priority: High
Alternative flows and
exceptions
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 29

Use case name: Order Supplies

Use case ID: Inv-110
Primary actor(s): Manager
Secondary actor(s): Vendor Supply Ordering System
Brief description:
Preconditions: Auto-order must be set for the item
Flow of events: 1. The system connects to the Vendor Supply ordering system.
2. The system sends the order to the vendor’s system
3. The system sends the manager order confirmation
Post-conditions:
Priority: High
Alternative flows and
exceptions:
Non-behavioral All communication to external systems will be implemented by
requirements: OASIS standard web services.
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 30

System
Software Requirements Specification for Patriot Easy Order System Page 31

Use case name: Authenticate User

Use case ID: Sys-100
Primary actor(s): User
Secondary actor(s):
Brief description: The user authenticates as a system user.
Preconditions: User information is in the system
Flow of events: 1. The user enters their authentication information into the
system
2. The system authenticates the user by matching to the
information stored in the system
3. User is authenticated as Cook/Customer/Manager/Technical
Support Specialist/Wait Staff
Post-conditions: User is authenticated as Cook/Customer/Manager/Technical
Support Specialist/Wait Staff
Priority: High
Alternative flows and The system cannot authenticate user. The system notifies user
exceptions: that authentication failed
Non-behavioral
requirements:
Assumptions:
Issues:
Source: Patriot Easy Order System SOW
Software Requirements Specification for Patriot Easy Order System Page 32

5. Other Nonfunctional Requirements

5.1 Performance Requirements

Orders placed by customers must be sent to the kitchen with order confirmation and

acknowledgement displayed for the customer within 5 seconds. Additionally the system

must maintain 99.9% availability.

5.2 Safety Requirements

None identified by stakeholders.

5.3 Security Requirements

All credit card transactions will be accomplished in a secure manner with as few payment

processing errors as is possible (>99.999% accuracy). Additional consideration must be made to

ensure that employees, managers and owners are all authenticated properly, and that only users

with the proper privileges are allowed access to the associated features and system capabilities.

5.4 Software Quality Attributes

The stakeholders have not identified such attributes. The developers should focus on

interoperability (through OASIS standards), flexibility, robustness, with an eye on future

extensibility of the system to meet changing customer needs.

5.5 Business Rules

1. Any applied discounts must be applied to the bill before taxes are calculated.

2. Only users who have made an order and paid their bill will be given access to the

entertainment options.
Software Requirements Specification for Patriot Easy Order System Page 33

6. Other Requirements

Appendix A: Glossary and References:

Stakeholder Any person with an interest in the project who is not a developer.

Developers Anyone who contributed in the developing phase of the project.

OASIS Organization for the Advancement of Structured Information Standards

SOW Statement of work

Kiosks Touch screen PC.

SRS Software requirements specifications

NCR Provider of the kiosks.

Cash Scanner A device that accepts payments in cash.

Armour, F and Miller G. Advanced Use Case Modeling, Addison-Wesley,

Reading, Massachusetts, 2001.

IEEE. IEEE STD 830-1998 IEEE Recommended Practice for Software Requirements

Specifications. IEEE Computer Society, 1998.

Software Requirements Specification for Patriot Easy Order System Page 34

Appendix B: Analysis Models

The below state transition diagram represents the states that an order goes through during

it's lifecycle within the system.

Software Requirements Specification for Patriot Easy Order System Page 35

Appendix C: Traceability Table:

The below table describes the association between the previously presented UI screens

and their corresponding use cases.

UI Traceability

Screen Title Source Use Case

Welcome to Patriots, Place Your Order Food

Order, Place Your Order Entrees,

Place your Order: Customize Item,

Place Your Order Sandwiches, Order

Details

Pay Bill, Order Details Pay Bill

Order List Order Previous Order

Inventory List Inventory

Entertainment, Choose Options, Entertainment

Customer Selects Option, System

Displays Music Options, Customer

Selects Options

User Registration Activate Restaurant Id Card