Professional Development for Computer Science
Capstone Project

Mark Sarasua, Jr.
Ernst Bekkering, Ph.D.
CS 4233
Northeastern State University

The repository includes the project proposal, documentation, and source code.

The Willow Tree OMS Kiosk Demo
PowerPoint Presentation

A mid-scale restaurant in Tahlequah called The Willow Tree utilizes a website-based Order Management System (OMS) that allows customers to place orders at their table using a kiosk. However, the OMS has been facing intermittent performance and security issues due to the software's website-based deployment. Therefore, the OMS requires an overhaul to improve its performance and better secure data.

To address the issue, restaurant owner Maria Zabala has approached Code-Logik, a local software development firm, to discuss a redesign solution.

The following documentation will treat the hypothetical case as a real-life business interaction.

1. Project Proposal
2. Requirements Analysis
3. Risk Management
4. Modeling
5. Development
6. Testing
7. Source Build
8. Pre-Built Installer
9. Installation
10. Usage
11. License
    
    

PROJECT NAME: The Willow Tree OMS
PROJECT REFERENCE: CS4233 CAPSTONE PROJECT 2024
DATE: 23 JAN 2024

The Willow Tree’s current Order Management System (OMS) allows customers to place orders at the table via a kiosk.

Although the current release is functional, the OMS has been facing intermittent performance and security issues due to its software's website-based deployment. A redesign is necessary to improve the performance and better secure data.

The current OMS software performance is impacted by circumstances extending beyond The Willow Tree’s scope of business; the hosted source code is also vulnerable to random and targeted security threats and requires a redesign to protect the integrity of The Willow Tree’s day-to-day operations.

Code-Logik proposes rebuilding the OMS into a desktop application to accommodate the highly interactive usage expected in a restaurant setting. Having the OMS deployed as a desktop application will improve stability and overall performance and reduce the possible footholds available to potential security threats.

The proposal aims to deliver The Willow Tree a secure, stable, high-performance OMS capable of keeping pace with restaurant business demands while providing the customer with the best possible dining experience.

Code-Logik estimates that it will take approximately 13 weeks to complete the redesign of The Willow Tree OMS.

Figure 1 Expected Timeline for Software Development Life Cycle.

This project aims to redesign the Order Management System from a website-based into a desktop-based application. The current OMS is functional; however, the customers' dining experience continues to suffer with intermittent performance and security issues. Code-Logik will redesign the OMS into a secure, stable, high-performance application that will undoubtedly provide The Willow Tree’s customers with the best possible dining experience.

View the full-length Project Proposal document.

OBJECTIVE: Redesign The Willow Tree’s Order Management System (OMS) to create a secure, stable, high-performance application capable of keeping pace with restaurant business demands while providing the customer with the best possible dining experience.

PROBLEM STATEMENT: The current OMS software performance is impacted by circumstances extending beyond The Willow Tree’s scope of business; the hosted source code is also vulnerable to random and targeted security threats and requires a redesign to protect the integrity of The Willow Tree’s day-to-day operations.

FUNCTIONAL REQUIREMENTS

Design and Structure

• Header with The Willow Tree branding and a brief description.
• Navigation Bar for customers to view menu items by logical categories.
• Order Summary section to list selected items.
• Receipt section to detail final order.
  

Menu Items and Selection

• Categorize menu items into logical sections.
• Each menu item includes an image, brief description, and price.
• Customers can select and deselect menu items.
  

Order Summary

• List each selected item with the cost.
• Subtotal all selected items together.
• Update totals in real-time as customers make selections.
• Button to cancel the order.
  

Receipt

• Name of server and table number.
• List selected items, including item name, quantity, and price.
• Customers can specify the tip amount.
• Detail subtotal, tax, tip, and total cost.
• Method of payment.
• Display a “Thank You” message.
  
  

ASSUMPTIONS & CONSTRAINTS

• Payment Service Provider: OMS is compatible with payment processing software.
• Kitchen Management System: OMS is compatible with order placement software.
• Budget: $25,000
  
  

View the full-length Requirements Analysis Document.

SUMMARY: Risk management will be conducted throughout the Software Development Life Cycle (SDLC) via identification, assessment, and registration. The risk management process reduces time spent resolving foreseen and unforeseen risks, boosting productivity and allowing more time for quality work.

PURPOSE: The Risk Management Plan (RMP) will serve as the controlling document to manage and mitigate risks during the SDLC of The Willow Tree OMS project. The RMP seeks early identification of risks using assessment techniques to create a Risk Register (RR) with mitigation planning. Following the creation of the initial RR, any subsequent risks identified or issue tracking will be added to the RMP through addendums.

IDENTIFICATION

Figure 2 Risk Breakdown Structure Diagram

The project scope has been divided into five subcategories to help identify possible risks. Each subcategory focuses on different areas of concern, as shown in Figure 2. The RR will be prepared based on the identified risks and will include a mitigation plan for each risk identified.

RISK REGISTER

Figure 3 Risk Register Diagram

The RR details the potential risks associated with The Willow Tree OMS project (Figure 3). This list is not exhaustive and will be updated and revised as needed throughout the SDLC.

View the full-length Risk Management Plan document.

USER STORIES

Figure 4 User Story 1

To view all 8 User Stories, see the full-length Modeling document.

USE-CASE DIAGRAM

Figure 5 Use-Case Diagram

CLASS DIAGRAMS

Figure 6 View Menu Class Diagram

To view all 5 Class Diagrams, see the full-length Modeling document.

ACTIVITY DIAGRAM

Figure 7 Customer Activity Diagram

DEPLOYMENT DIAGRAM

Figure 8 Deployment Diagram

View the full-length Modeling document.

AGILE DEVELOPMENT LIFECYCLE

Concept

• Project | Branch
  

Inception

• Project | Branch
  

Iteration

1. Project | Branch
2. Project | Branch
3. Project | Branch
   

Release

• Project | Branch
  
  

VIEW MENU TEST

To test the correctness of the View Menu Iteration, a simple JSON database consisting of six menu items (Figure 9) was used in conjunction with code specific to testing (Figure 10).

  ...
  {
    "Name": "Coffee",
    "Image": "none",
    "Description": "Black coffee",
    "Category": 4,
    "Price": 5.99,
    "Period": [
      true,
      true,
      true
    ]
  },
  ...

Figure 9 JSON Database

  ...
  Menu menu = new Menu();
  List<List<MenuItem>> current_menu = new List<List<MenuItem>>();

  Console.WriteLine("Breakfast Menu\n");
  current_menu = menu.current_menu(PERIOD.Breakfast);
  foreach (List<MenuItem> category in current_menu)
  {
    foreach (MenuItem item in category)
    {
      Console.WriteLine
      (
        $"  {Convert.ToInt32(item.Period[0])}  " +
        $"  {Convert.ToInt32(item.Period[1])}  " +
        $"  {Convert.ToInt32(item.Period[2])}  " +
        $"  {item.Name}  " +
        $"  {item.Description}  " +
        $"  {item.Price}  "
      );
    }
  }
  Console.WriteLine("\n");
  ...

Figure 10 Test Specific Code

The expected console output was a multi-period display of the six menu items in the JSON database. Since the console output was what was expected (Figure 11), the View Menu Test is considered a success. Therefore, the View Menu Iteration was closed, and the Customer User Interface Iteration was opened.

Figure 11 View Menu Test Console Output

View the full-length Testing document.

To build from source code:

1. Download the latest release and unpack.
2. Navigate to the src directory and then to the TheWillowTreeOMS subdirectory.
3. Open the TheWillowTreeOMS.sln in Visual Studio 2022.
4. Select Build > Batch Build in the menu bar.
5. Locate the Release Configurator of the CustomerUserInterface Project and check the Build checkbox.
6. Locate the Release Configurator of the TheWillowTreeOMS Project and check the Build checkbox.
7. Click the Build button.
8. Navigate to the Release folder to find the setup.exe and TheWillowTreeOMS.msi.
   
   

To download the pre-built installer:

1. Download the latest release and unpack.
2. Navigate to the build directory to find the setup.exe and TheWillowTreeOMS.msi.
   
   

To install The Willow Tree OMS:

1. Run setup.exe to start the Setup Wizard and click Next.
2. Select an installation folder or use the default Desktop location for ease of use.
3. Select Everyone and click Next.
4. Click Next to start the installation.
5. Click Close to complete the installation.
   

FILES INSTALLED

Figure 12 Files Installed

PREREQUISITE: TheWillowTreeOMS (OMS.exe) is actively running.

How to Use:

1. Tap anywhere on the Splash Screen to start a new order.
2. Tap ENTREES, SIDES, DESSERTS, or DRINKS to view the corresponding menu category menu items.
3. Tap the menu item ➕ or ➖ button to add or remove the item from your order.
4. Tap ORDER to send the selected menu items to the Kitchen Management System (KMS) or CANCEL to cancel the order altogether.
   • The ticket is still open, and additional menu items may be selected.
5. Tap PAY BILL to close the current order and pay the balance.
   • The ticket is closed, and no further menu items may be selected.
6. Tap CASH to notify the server to collect payment or CREDIT to use the kiosk card reader.
   • The Tip Server modal is displayed.
7. Tap one of the predetermined percentages, 10%, 15%, 20%, or 25%, or tap and drag the Slider to set the dollar amount.
8. Tap ADD TIP to add the dollar amount shown to the current balance or NO TIP to pay just the order balance.
9. Tap PAY NOW to complete the transaction and return to the Splash Screen.
   
   

SHUTDOWN: Attach a USB keyboard to the kiosk and press the ESC to exit the program.

The Willow Tree OMS is licensed under the MIT License.

MIT License

Copyright (c) 2024 Mark Sarasua, Jr. <mark.sarasua@code-logik.com> www.code-logik.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.