Design Document. Version 2.0 May 1, Texas Christian University, Computer Science Department

Transcription

1 Design Document Version 2.0 May 1, Texas Christian University, Computer Science Department

2 i. Revision Signatures The following asserts that all team members have read the document and assert that the information contained within this document is complete and correct. Nicholas Bomm Name Signature Date Philip Howell Kathryn Jaslikowski Wills Ward EasyBites 5/1/2017 ii

3 ii. Revision History All revision history is listed below. Version Change Summary Date 1.0 Initial Draft Draft with additions Draft with updated diagrams Final draft with grammar corrections EasyBites 5/1/2017 iii

4 iii. Contents i. Revision Signatures... ii ii. Revision History... iii iii. Contents... iv 1. Introduction Document Purpose Project Overview Document Overview Design Constraints Assumptions and Dependencies Development Methods and Constraints System Architecture Django Model System Diagrams Individual Organization Stack Multiple Organization Compute Stack Multiple Stack Hosting Platform Database Design UML Diagrams Sequence Diagrams Key Modify Data Object Add Food Item Generate Recipes State Diagrams Key Client Assist Activity Diagrams User Interface Login Client Assist View Client Recipe Generation Shopping List Recipe List EasyBites 5/1/2017 iv

5 6.7 Front End View Front End Edit Administrator View Administrator Edit Mobile Device Compatibility Glossary of Terms Appendix A: Use Case Models EasyBites 5/1/2017 v

6 1. Introduction 1.1 Document Purpose The purpose of this document is to outline the core design elements of EasyBites. 1.2 Project Overview Meals On Wheels, Inc. (MOWI) of Tarrant County is one of the largest MOWI organizations in the country. It serves approximately 4,500 clients with a median age and monthly income of 74.7 years and $1,000, respectively. The organization provides 10 meals per week for each client and wants to help with any other meals that they might need in a week. This is especially needed by clients who are immobile, who do not have access to proper kitchen items, or who cannot afford to buy a large variety of foods. Samantha Powell, a professor in the TCU Nutritional Sciences Department and a former dietitian at MOWI, approached the TCU Computer Science Department about developing a web application to assist dietitians in creating simple recipes for clients based on an available list of foods and stores. Development of the basic web application began in the spring of 2016 and was then elevated to a capstone project EasyBites that has consisted of finishing and enhancing the requirements laid out by MOWI. 1.3 Document Overview This document includes the design constraints, system architecture, database design, UML models, and user interface for EasyBites. It also includes a glossary and use cases to supplement the Sequence Diagrams. EasyBites 5/1/2017 1

7 2. Design Constraints 2.1 Assumptions and Dependencies The deployment and usage of EasyBites assumes that the organization is capable of providing, installing, and maintaining the server-side software as defined in the preceding requirements document. Use of EasyBites assumes the user has a device with an updated internet browser and a valid internet connection with at least 1.5 Mbps download and 0.5 Mbps upload speeds. 2.2 Development Methods and Constraints EasyBites is assumed and required to run in a deployment environment consisting of the following specifications: One or more Linux servers (version >= 4.4.0) Docker (version >= ) Docker Compose (version >= ) Each containerized run environment is assumed to have the necessary applications, packages, and libraries as listed: Name Description URL PyPy2.7 v5.7.1 An alternative implementation of Python that adds Justin-Time compiling Django 1.10 A framework, written in Python, which follows the modelview-template (MVT) architectural pattern django-crispy Library for HTML form creation django-wkhtmltopdf Library for PDF creation easy-thumbnails 2.3 Library facilitating the proper cropping and reduction of thumbnail images Pillow Image manipulation library PostgreSQL An object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance Docker 1.11.x An open source project to pack, ship, and run any application as a lightweight container Nginx An HTTP and reverse proxy server, a mail EasyBites 5/1/2017 2

8 Phusion Passenger proxy server, and a generic TCP/UDP proxy server A free application server with support for Ruby, Python and Node.js designed to integrate into the Apache HTTP Server or the nginx web server EasyBites 5/1/2017 3

9 3. System Architecture This section contains diagrams of system components and their interfaces. 3.1 Django Model The Django Web Framework follows a Model, View, Template architectural pattern which is outlined in following diagram. EasyBites 5/1/2017 4

10 The following diagram outlines the interaction of the core files and elements within the Django framework. A request is sent from the client to Django and is routed through the URL parser (urls.py). It is then directed to a specific class that is setup in the views.py file which in turn accesses the data model and database documented in models.py. Finally, views.py returns output to the client by merging data from the database and a template file. EasyBites 5/1/2017 5

11 3.2 System Diagrams Pantry Project Architecture System Architecture Front End Client Application Processes Clients Client Application Interface Nutritional Calculator Recipe List Generator Database Recipe Maintainers Recipe Approvers Application Administrative Interface Nutritional Data Retriever Shopping List Generator PostgreSQL Application Administrators System Management Processes System Administrators System Administrative Interface Stack Manager EasyBites 5/1/2017 6

12 3.2.1 Individual Organization Stack Individual Organization Compute Stack Individual Compute Stack Composed of multiple containers Provides a single instance of the application Hosts the data for 1 Meals On Wheels organization Provides redundant web services Provides a single database instance EasyBites 5/1/2017 7

13 3.2.2 Multiple Organization Compute Stack Multiple Organizational Compute Stack Organization Compute Stack Composed of multiple Individual Compute Stacks Provides multiple instances of the application Hosts the data for multiple Meals On Wheels organizations Offers the benefit of hosting the application in a cost effective solution Centralized management of the application offers lower administrative requirements EasyBites 5/1/2017 8

14 3.2.3 Multiple Stack Hosting Platform Multiple Stack Hosting Platform On On Docker Linux Docker Linux BARE METAL HYPER-V The platform can run on hypervisors such as VMware ESXi and Microsoft Hyper-V or on physical Linux servers as required The platform can be hosted in both on-premise datacenters or by cloud providers Scalability and reliability are limited only by the underlying infrastructure Resiliency is baked in to the architecture to minimize impact from system or application level issues EasyBites 5/1/2017 9

15 4. Database Design EasyBites 5/1/

16 5. UML Diagrams 5.1 Sequence Diagrams Key EasyBites 5/1/

17 5.1.2 Modify Data Object EasyBites 5/1/

18 5.1.3 Add Food Item EasyBites 5/1/

19 5.1.4 Generate Recipes EasyBites 5/1/

20 5.2 State Diagrams Key EasyBites 5/1/

21 5.2.2 Client Assist EasyBites 5/1/

22 5.3 Activity Diagrams The following diagram shows the general workflow of the application as well as the interaction between each user category (Administrators, Dietitians, and Interns). *Actor indicates that the action can be taken by several different user groups. EasyBites 5/1/

23 6. User Interface Below is an outline of the UI designs for each general aspect design, shown by their order in a typical user workflow. 6.1 Login EasyBites 5/1/

24 6.2 Client Assist The dietitian can enter the client ID of the person he or she wants to view. EasyBites 5/1/

25 6.3 View Client From this screen, the dietitian can view and edit the client s options and preferences. Additionally, the dietitian can opt to generate a dynamic recipe list based on those configurations. EasyBites 5/1/

26 6.4 Recipe Generation The client can view the recommended recipes and select which ones he or she wants to appear on the shopping and recipe lists. EasyBites 5/1/

27 6.5 Shopping List A dynamic PDF is created showing the shopping list needed to buy the ingredients for the selected recipes. PDFs can then be printed for later use. EasyBites 5/1/

28 6.6 Recipe List Recipe cookbook pages are also generated on the dynamic PDF. EasyBites 5/1/

29 6.7 Front End View Data objects including recipes, foods, and stores can viewed on the front-end in lists similar to the following: EasyBites 5/1/

30 6.7.1 Front End Edit Data objects including recipes, foods, and stores can also edited on the front-end in forms similar to the following: EasyBites 5/1/

31 6.8 Administrator View All data objects can be viewed and edited from the administrator (admin) page, only accessible to accounts with administrator privileges. EasyBites 5/1/

32 6.8.1 Administrator Edit Any data object can be edited and configured with higher fidelity on the administrator edit forms similar to the following: EasyBites 5/1/

33 6.9 Mobile Device Compatibility Each view is designed to be accessed on a mobile device such as a smartphone or tablet, if applicable. EasyBites 5/1/

34 7. Glossary of Terms Compute Stack a set of resources used to define an instance of an application; typically includes web, application, and database tiers Container a standardized unit for development which allows for software packaging in a stand-alone filesystem that contains everything needed to run the software package: code, system tools, application binaries, and libraries Container Host an instance of a server that provides the ability to run container instances Database a structured set of data that provides access and storage for reference by computing applications Database Management System an application used to manage and provide access to databases Django a free and open-source web framework, written in Python, which follows the model-view-template (MVT) architectural pattern Docker an open source project to pack, ship, and run any application as a lightweight container Git a version control system that is used for software development and other version control tasks Load Balancer an application or server that ingests requests and spreads them evenly across a number of servers MySQL an open-source relational database management system (RDBMS) Nginx an HTTP and reverse proxy server, a mail proxy server, and a generic TCP/UDP proxy server Phusion Passenger a free application server with support for Ruby, Python, and Node.js designed to integrate into the Apache HTTP Server or the nginx web server PostgreSQL an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance PyCharm 2016 an Integrated Development Environment (IDE) used in computer programming, specifically for the Python language that provides code analysis, a graphical debugger, an integrated unit tester, integration with version control systems (VCSs), and supports web development with Django PyPy a fast, compliant alternative implementation of the Python language with distinct features such as speed, optimized memory usage, compatibility with existing Python code, and support for a stackless mode Virtualization the act of deploying a computing platform in a self-contained server instance that exists on a physical server and provides an abstracted layer allowing for improved utilization of processor, memory, storage, and networking resources EasyBites 5/1/

35 Appendix A: Use Case Models EasyBites 5/1/

36 Modify stores Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete store information Administrator Store name is required. An image and a list of foods available at the store are optional. The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new store 2. Updated data about an existing store 3. The desire to delete an existing store The user selects the Administration tab from the ribbon on the homepage. 1. To add a store, the admin clicks Add next to the Stores header. After filling out the store information, the actor clicks the Save button on the right-hand side of the page. The store is added to the database. 2. To edit a store, the admin clicks Change next to the Stores header. The actor then selects the name of the store to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The store is updated in the database. 3. To delete a store, the admin clicks Change next to the Stores header. The actor selects the name of the store to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The store is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new store has been added, a store has been modified, or a store has been deleted. EasyBites 5/1/

37 Modify recipes Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete recipes, or approve a recipe added by a dietitian or intern Administrator Recipe name; general information about the recipe such as cook time, prep time, servings, nutritional information; instructions; limitations; a photo of the recipe; and information about the ingredients such as the food, amount, and unit of measure The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new recipe 2. Updated data about an existing recipe 3. The desire to delete an existing recipe 4. The desire to approve a recipe The user selects the Administration tab from the ribbon on the homepage. 1. To add a recipe, the admin clicks Add next to the Recipes header. After filling out the recipe information, the actor clicks the Save button on the right-hand side of the page. The recipe is added to the database. 2. To edit a recipe, the admin clicks Change next to the Recipes header. The actor selects the name of the recipe to be edited. After filling out the information, the actor click the Save button on the right-hand side of the page. The recipe is updated in the database. 3. To delete a recipe, the admin clicks Change next to the Recipes header. The actor selects the name of the recipe to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The recipe is removed from the database. 4. To approve a recipe, the admin clicks Change next to the Recipes header and then selects the name of the recipe he or she wants to approve. The actor then scrolls to the checkbox labeled Approved, checks it, and selects the Save button on the right-hand side of the page. The recipe can then be used in the field. If any of the required data is missing, an error message will be displayed to the user. A new recipe has been added, a recipe has been modified, a recipe has been deleted, or a recipe has been approved. EasyBites 5/1/

38 Modify food items Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete food information Administrator Food name, ingredient type, price, and size are required. An image and potential allergy information are optional. The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new food 2. Updated data about an existing food 3. The desire to delete an existing food The user selects the Administration tab from the ribbon on the homepage. 1. To add a food, the admin clicks Add next to the Food header. After filling out the food information, the actor clicks the Save button on the righthand side of the page. The food is added to the database. 2. To edit a food, the admin clicks Change next to the Food header. The actor then selects the name of the food to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The food is updated in the database. 3. To delete a food, the admin clicks Change next to the Food header. The actor then selects the name of the food to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The food is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new food has been added, a food has been modified, or a food has been deleted. EasyBites 5/1/

39 Modify clients Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete clients Administrator The client s first name and ID number are required. The client s allergies, limitations, food preferences, and stores are optional. The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new client 2. Updated data about an existing client 3. The desire to delete an existing client The user selects the Administration tab from the ribbon on the homepage. 1. To add a client, the admin clicks Add next to the Client Information header. After filling out the client information, the actor then clicks the Save button on the right-hand side of the page. The client is added to the database. 2. To edit a client, the admin clicks Change next to the Client Information header. The actor then selects the name of the client to be edited. After filling out the information, the actor clicks the Save button on the righthand side of the page. The client is updated in the database. 3. To delete a client, the admin clicks Change next to the Client Information header. The actor then selects the name of the client to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The client is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new client has been added, a client has been modified, or a client has been deleted. EasyBites 5/1/

40 Modify allergies Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete allergies Administrator The name of the allergy The website is functioning, and the user has administrative access to the website and one of the following: 1. The name of an allergy 2. The updated name of an allergy 3. The desire to delete an existing allergy The user selects the Administration tab from the ribbon on the homepage. 1. To add an allergy, the admin clicks Add next to the Allergies header. After filling out the allergy information, the actor clicks the Save button on the right-hand side of the page. The allergy is added to the database. 2. To edit an allergy, the admin clicks Change next to the Allergies header. The actor then selects the name of the allergy to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The allergy is updated in the database. 3. To delete an allergy, the admin clicks Change next to the Allergies header. The actor selects the name of the allergy to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The allergy is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new allergy has been added, an allergy has been modified, or an allergy has been deleted. EasyBites 5/1/

41 Modify limitations Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete limitations Administrator The name of the limitation The website is functioning, and the user has administrative access to the website and one of the following: 1. The name of a limitation 2. The updated name of a limitation 3. The desire to delete an existing limitation The user selects the Administration tab from the ribbon on the homepage. 1. To add a limitation, the admin clicks Add next to the Limitations header. After filling out the limitation information, the actor clicks the Save button on the right-hand side of the page. The limitation is added to the database. 2. To edit a limitation, the admin clicks Change next to the Limitations header. The actor then selects the name of the limitation to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The limitation is updated in the database. 3. To delete a limitation, the admin clicks Change next to the Limitations header. The actor selects the name of the limitation to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The limitation is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new limitation has been added, a limitation has been modified, or a limitation has been deleted. EasyBites 5/1/

42 Modify nutritional information Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete nutritional information for specific food items Administrator The name of the nutrient, its value and unit, and the measurement of the food to which it is associated The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new nutrient 2. Updated data about an existing nutrient 3. The desire to delete an existing nutrient The user selects the Administration tab from the ribbon on the homepage. 1. To add a nutrient, the admin clicks Add next to the Measure Nutrients header. After filling out the nutrient information, the actor clicks the Save button on the right-hand side of the page. The nutrient is added to the database. 2. To edit a nutrient, the admin clicks Change next to the Measure Nutrients header. The actor then selects the name of the nutrient to be edited. After filling out the information, the admin clicks the Save button on the righthand side of the page. The nutrient is updated in the database. 3. To delete a nutrient, the admin clicks Change next to the Measure Nutrients header. The actor selects the name of the nutrient to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The nutrient is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new nutrient has been added, a nutrient has been modified, or a nutrient has been deleted. EasyBites 5/1/

43 Modify groups Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete groups Administrator The name of the group is required. The permissions of the group are optional. The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new group 2. Updated data about an existing group 3. The desire to delete an existing group The user selects the Administration tab from the ribbon on the homepage. 1. To add a group, the admin clicks Add next to the Groups header. After filling out the group information, the actor clicks the Save button on the righthand side of the page. The group is added to the database. 2. To edit a group, the admin clicks Change next to the Groups header. The actor then selects the name of the group to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The group is updated in the database. 3. To delete a group, the admin clicks Change next to the Groups header. The actor selects the name of the group to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The group is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new group has been added, a group has been modified, or a group has been deleted. EasyBites 5/1/

44 Modify users Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete users Administrator A username and password are required. The user s personal information, associated groups, and user permissions are optional. The date that the user joined is automatically filled in. The website is functioning, and the actor has administrative access to the website and one of the following: 1. Data about a new user 2. Updated data about an existing user 3. The desire to delete an existing user The admin selects the Administration tab from the ribbon on the homepage. 1. To add a user, the admin clicks Add next to the Users header. After filling out the user information, the admin clicks the Save button on the righthand side of the page. The user is added to the database. 2. To edit a user, the admin clicks Change next to the Users header. The admin then selects the name of the user to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The user is updated in the database. 3. To delete a user, the admin clicks Change next to the Users header. The admin then selects the name of the user to delete and selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The user is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new user has been added, a user has been modified, or a user has been deleted. EasyBites 5/1/

45 Modify food measures Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides admin the ability to add, modify, or delete food measures for specific food items Administrator The size label for the new food measure (ex: cup, tablespoon, etc.), its equivalent weight in grams, and the food to which it pertains The website is functioning, and the user has administrative access to the website and one of the following: 1. Data about a new food measure 2. Updated data about an existing food measure 3. The desire to delete an existing food measure The user selects the Administration tab from the ribbon on the homepage. 1. To add a food measure, the admin clicks Add next to the Food Measures header. After filling out the information, the actor clicks the Save button on the right-hand side of the page. The food measure is added to the database. 2. To edit a food measure, the admin clicks Change next to the Food Measures header. The actor then selects the name of the food measure to be edited. After filling out the information, the admin clicks the Save button on the right-hand side of the page. The food measure is updated in the database. 3. To delete a food measure, the admin clicks Change next to the Food Measures header. The actor selects the name of the food measure to delete and then selects the Delete button on the right-hand side of the page. The actor then confirms on the next page that the deletion should take place by selecting the Yes, I m sure button. The food measure is removed from the database. If any of the required data is missing, an error message will be displayed to the user. A new food measure has been added, a food measure has been modified, or a food measure has been deleted. EasyBites 5/1/

46 Edit clients Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides dietitian the ability to edit clients from the front-end Dietitian Updated name, client ID, allergies, limitations, food preferences, or stores The website is functioning, and the dietitian has front-end access to the website and updated information about a client From the homepage, the dietitian selects Assist Client from the ribbon at the top of the homepage. The dietitian then searches for the correct client by client ID and inputs the updated information. The actor then clicks the Update button at the bottom of the screen. The client is updated in the database. If any of the required data is missing, an error message will be displayed to the user. An existing client has been modified. EasyBites 5/1/

47 Generate recipes and shopping lists Description Provides dietitian the ability to generate recipes and shopping lists for clients from the front-end Actors Dietitian Data A client s desired recipes Preconditions The website is functioning, and the dietitian has front-end access to the website and a list of recipes the client desires. Triggers From the homepage, the dietitian selects Assist Client from the ribbon at the top of the homepage. Course of events The dietitian then searches for the correct client by client ID and clicks Generate Recipes in the bottom right hand corner. The actor then selects the recipes that the client desires from a system-populated list of suggested recipes based on the client s stores, food preferences, allergies, and limitations. From there, the dietitian clicks Next and the shopping and recipe lists appear. Exceptions If the client does not exist in the database, an error message will be displayed to the user. If the client does not have any suggested recipes, the dietitian must work with the client to change food or store preferences. Post conditions Recipe and shopping lists are generated for the client. EasyBites 5/1/

48 Print recipes and shopping lists Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides dietitian the ability to print recipes and shopping lists for clients from the front-end Dietitian N/a The website is functioning and the dietitian has front-end access to it. Additionally, the dietitian has a functioning tablet and printer connected by Wi-Fi Direct or Bluetooth. From the homepage, the dietitian selects Assist Client from the ribbon at the top of the homepage. From there, the dietitian searches for the correct client by client ID, clicks Generate Recipes in the bottom right hand corner, and selects the recipes that the client desires. The actor then clicks Next and the shopping and recipe lists pertaining to those recipes appears. The actor then selects the Print Both Lists button at the bottom of the page, which will download a PDF file to the device. The lists can then be printed. If the client does not exist in the database, an error message will be displayed to the user. If the printer is not functioning correctly, the dietitian must contact a member of the MOWI IT team. Shopping and recipe lists are printed for the client. EasyBites 5/1/

49 Modify stores Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides a dietitian or intern the ability to add or modify stores Dietitian or intern Store name is required. An image and a list of foods available at the store are optional. The website is functioning, and the user has front-end access to the website and one of the following: 1. Data about a new store 2. Updated data about an existing store The actor selects the Stores tab on the ribbon at the top of the homepage and then selects the Stores subsection. 1. To add a store, the actor then clicks the Add Store in the upper right hand corner. After filling out the information, the actor then selects the Create button at the bottom of the page. The store is added to the database. 2. To modify a store, the actor then clicks on the store to be altered. From there, the actor updates the corresponding information and selects the Update button at the bottom of the page. The store is updated in the database. If any of the required data is missing, an error message will be displayed to the user. A new store has been added or an existing store has been altered. EasyBites 5/1/

50 Modify food items Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides a dietitian or intern the ability to add or modify foods Dietitian or intern Food name, ingredient type, price, and size are required. An image and potential allergy information are optional. The website is functioning, and the user has front-end access to the website and one of the following: 1. Data about a new food 2. Updated data about an existing food The actor selects the Stores tab on ribbon at the top of the homepage and then selects the Food subsection. 1. To add a food item, the actor then clicks the Add Food in the upper right hand corner. After filling out the food information, the actor then selects the Save button at the bottom of the page. The food is added to the database. 2. To modify a food item, the actor then clicks on the food to be altered. From there, the actor updates the corresponding information and selects the Update button at the bottom of the page. The food is then updated in the database. If any of the required data is missing, an error message will be displayed to the user. A new food has been added or an existing food has been altered. EasyBites 5/1/

51 Modify recipes Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides a dietitian or an intern the ability to add or modify recipes Dietitian or intern Recipe name; general information about the recipe such as cook time, prep time, servings, nutritional information; instructions; limitations; a photo of the recipe; and information about the ingredients such as the food, amount, and unit of measure The website is functioning, and the user has front-end access to the website and one of the following: 1. Data about a new recipe 2. Updated data about an existing recipe The actor selects the Recipes tab from the ribbon at the top of the homepage. 1. To add a recipe, the actor then clicks the Add Recipe in the upper right hand corner. After filling out the recipe information, the actor then selects the Save button at the bottom of the page. The recipe is added to the database. 2. To modify a recipe, the actor then clicks on the recipe to be altered and updates the corresponding information. The actor then selects the Update button at the bottom of the page and the recipe is updated in the database. If any of the required data is missing, an error message will be displayed to the user. A new recipe has been added or an existing recipe has been altered. EasyBites 5/1/

52 Modify food measures Description Actors Data Preconditions Triggers Course of events Exceptions Post conditions Provides a dietitian or intern the ability to add, change, or delete food measures Dietitian or intern The size label for the new food measure (ex: cup, tablespoon, etc.) and its equivalent weight in grams The website is functioning, and the user has front-end access to the website and one of the following: 1. Data about a new food measure 2. Updated data about an existing food measure 3. The desire to delete an existing food measure The actor selects the Stores tab on ribbon at the top of the homepage and then selects the Food subsection. The actor then selects the food for which he or she needs to add a food measure, change a food measure, or delete a food measure. 1. To add a food measure, the actor clicks the Add Measure button that floats on the bottom of the page. After filling out the food measure information, the actor then selects the Update button at the bottom of the page. The food measure is added to the database. 2. To modify a food measure, the actor selects the food measure that is to be updated. From there, the actor inputs the new information and selects the Update button at the bottom of the page. The food measure is then updated in the database. 3. To delete a food measure, the actor selects the food measure that is to be deleted. Then, the actor checks the Delete option and selects the Update button at the bottom of the page. The food measure is then deleted from the database. If any of the required data is missing, an error message will be displayed to the user. A new food measure has been added, an existing food measure has been updated, or an existing food measure has been deleted. EasyBites 5/1/