Software Design Descriptions. Good Eats Inc. Total Web ERP (GE-TWERP)

Transcription

1 Software Design Descriptions For the Good Eats Inc. Total Web ERP (GE-TWERP) Version 1.0 Awaiting Approval Prepared by Troy Delanoe Anderson Anderson Enterprises April 3, 2014

2 Software Design Document for Good Eats Inc. Total Web ERP Page ii Table of Contents Table of Contents... ii Revision History... ii 1. Introduction Purpose Scope... Error! Bookmark not defined. 1.3 Definitions, Acronyms and Abbreviations References Reference Listing Decomposition Descriptions Module Decomposition Process Data Import Process Supplier Information Interface Descriptions Webstore Interface Appendix A: Laugh Model...15 Revision History Name Date Reason For Changes Version

3 Software Design Document for Good Eats Inc. Total Web ERP Page 1 1. Introduction The Software Design Document provides an informational representation of the software systems to be created. This document includes graphical and narrative documentation to assist in the development and understanding of the Good Eats Inc. Total Web Enterprise Resource Planning (GE-TWERP) system. 1.1 Purpose The purpose of the Software Design Document is to provide documentation which will aid in software development by providing necessary informational representation of software systems and how the software system is structured. It is used as a translation of requirements necessary for the creation of the software to fulfill its purpose and describes the software components, interfaces and necessary data for implementation. 1.2 Scope The Software Design Document identifies design entities and describes their type, purpose, functions, attributes, subordinates, dependencies, interfaces and data elements. This may include the resources and processing required to fulfill their functions. 1.3 Definitions, Acronyms and Abbreviations Term Attribute DFD Customer Data Database DBMS Dependencies Design Entity Employee ERP GE-TWERPS GUI Interface Quarry Repository SRS Subordinate Table 1 - Definitions Definition Characteristic or property. Provides a statement of fact about the object it references. Data Flow Diagram - a graphical notation that depicts how data moves through a system. Both Online and Store customer of the Good Eats Inc. franchise Facts and statistics collected together for reference or analysis An organized collection of data Database Management System -system that interacts with the user, other applications, and the database itself to capture and analyze data. An object or system that is required in order for another to operate. An element (component) of a design that is structurally and functionally distinct from other elements and that is separately named and referenced. Any individual employed by Good Eats Inc. Enterprise Resource Planning Good Eats Total Web Enterprise Resource Planning System Graphical User Interface Interactions between entities or objects A statement and way of retrieving information from a database A logical, but also sometimes physical grouping of data from related but separate databases Software Requirements Specification Objects that compose a lager object.

4 Software Design Document for Good Eats Inc. Total Web ERP Page 2 User Frame Someone who interacts with the GE-TWERPS web application A part of a web page or window which displays content independent of its container 2. References This section lists the references used to format the Software Design Description document and other references utilized to formulate the ideas presented. 2.1 Reference Listing [1] IEEE Software Engineering Standards Committee, IEEE Std , IEEE Recommended Practice for Software Design Descriptions, September 23, [2] IEEE Software Engineering Standards Committee, IEEE Std , IEEE Standard Glossary of Software Engineering Terminology December 31, [3] IEEE Software Engineering Standards Committee, IEEE/ISO/IEC , Systems and software engineering Vocabulary, December 15, 2010 [4] IEEE Software Engineering Standards Committee, IEEE Std. 1233, IEEE Guide for Developing System Requirements Specifications, December 8, 1998

5 Software Design Document for Good Eats Inc. Total Web ERP Page 3 3. Decomposition description This sections describes the division of the GE-TWERP system into design entities. It describes the structure of the software and the functions/purposes of each entity along a detailed description. The section includes a hierarchical structure of entities. The overall system can be seen by the entity diagram in Figure Module Decomposition Figure 1: GE-TWERP and Subsystem Interactions GE-TWERP requires three separate components to function correctly, that being the Online Store Database, the Local Store Databases and the Regional Warehouse Databases. We will break down how all items interact fully in the following section. Figure 2 shows the shapes that compose the following diagrams.

6 Software Design Document for Good Eats Inc. Total Web ERP Page 4 Figure 2.1: Data Flow Diagram Shapes As was stated in the GE-TWERP Software Requirements Specification, the GE-TWERP database imports information into itself every day from the other company databanks. To ensure data integrity and decrease the burden on these databases, it occurs at 03:00 AM when stores and warehouses are closed and very few online orders are being processed. When a request comes from a user of the GE-TWERP web service for data newer than that held in its repository, it will import the specified data necessary from each specified system. This data is held only until the report is generated then, removed from the system to ensure that duplicate data does not occur during the daily update the following update period. Each of the three other components that the GE-TWERP system requires functionality on their own with minimal connectivity between each other. Figure 3 shows the breakdown of the level 1 DFD and each components interaction. Figure 2.2 shows what each color scheme relates to in Figure 3. Following Figure 3 is breakdowns of each process and their accompanying information for design specifications. Figure 2.2 DFD Color Scheme Key

7 Software Design Document for Good Eats Inc. Total Web ERP Page 5 Figure 3 Level 1 DFD

8 Software Design Document for Good Eats Inc. Total Web ERP Page Process Data Import Figure 3.9 Data Import Process Figure 3.9 shows the breakdown from the level 1 DFD to a level 2 DFD of the Data Import process for the GE-TWERPS system. The GE-TWERP database upon either request by headquarters users requesting a quarry in which data is not already loaded, or upon 03:00 AM data import, must quarry other Good Eats Inc. databases and copy necessary data. These external databases include the online store database, individual stores databases and regional supply databases. Each process that must occurs is defined in the following sections Determine Data Import Type The GE-TWERP database shall determine which type of import is being requested. Internally data will differ on how it is stored dependent on the type. If data is to be imported during the 03:00 AM import then the data will be added to the internal structure of the database, with unique numerical keys upheld with current numbers in the system. If the data import is for a quarry by headquarters users, then the data will be assigned temporary space that to the user seems contiguous but internally is a faux unique number identifier. This data shall be deleted upon finishing the report generation from the quarry data Determine Database Requested The GE-TWERP database shall determine which external database the import data must come from. The GE-TWERP database shall take a multiple database import request and break it down into single database requests during this process Determine Data Requested What type of data is imported from the specified data import request is handled internally in the GE-TWERP system. The system shall load proper variable names of the specified database to access the required data. The system shall have the Primary Keys of each database table and be able to create proper quarries dependent on the individual requirements.

9 Software Design Document for Good Eats Inc. Total Web ERP Page Process Data Import After the GE-TWERP system accomplishes the determination of variables necessary for the data import of a specified external database, it shall perform a connection to the external database and retrieve the proper data through proper quarry. The quarry will return the information requested, whereupon the data will be filed in either a temporary table or added to the internal tables of the GE-TWERP database. Deletion of temporary table data is accomplished in Process Process Supplier Information Figure 3.11 Processing of Supplier Information The processing of supplier information is handled only in the regional warehouse databases. All information pertaining to quarrying, inputting and editing supplier/item information is handled in these databases. The items and suppliers are currently not completely ubiquitous between each database and may become concurrent at a later date on the decision of the Good Eats Inc. headquarters department. Each regional warehouse may manually enter supplier/item information or may run patches by the Good Eats Inc. to semi-synchronize each database with specific supplier/item details. All these databases shall have the capabilities of doing both. The decomposition of the handling of the supplier information process includes navigation, processing quarries, adding new item/supplier information and editing/deleting existing information. The following sections expounds on these subjects

10 Software Design Document for Good Eats Inc. Total Web ERP Page Navigation of Supplier/Item Screens The user GUI shall be able to load to the appropriate screens when clicked upon. The screens for supplier and items screens include the Quarry Database screen, the Add Information screen and the Edit Details screen. Each screen handles a different function to include adding, altering and quarrying data from the regional supply database. The screens are viewed on the display in the form of a GUI (Graphical User Interface) Process Database Request Both the Quarry Screen process and the Edit Information process use the Database Request Process. The Database Request process formulates the proper quarry structure statements and interacts with the regional warehouse database, requesting the information, receiving responding data and returning it to the original process to display in the GUI.. Users shall be able to look up information on suppliers and items in the following ways: a. By supplier ID b. By supplier Name c. By supplier Location (Country, State, City and Zip sub searches) d. By item serial number e. By item name f. By item type g. By item department h. By price range i. By wildcard description details Process Administrator Login The system will ensure that only individuals with proper privilege levels will be able to add, alter and delete information out of the database. This will be reserved to managers and database maintainers in order to protect system integrity Process Add Information Request The Add Information Request Process requires a higher level of system privilege to operate. Normal users shall not be able to add information on items or suppliers in order to maintain system integrity. After administrator rights are given through the login process (11.3), the user shall be able to do the following: a. Add a new supplier ID, name, location (address details), contact information, representative details, contract codes and supplier type. b. Add new item details to include: item serial, name, description, product type, size, purchase price, supplier ID, department corresponding, shipping price and retail price. After input of required data and submission to the warehouse database, the user shall receive a confirmation page if information was added or an error page if it was not. This process shall be able to function through a mass data collection supplied by headquarters Process Edit Information Request The Edit Information Request Process requires a higher level of system privilege to operate. Normal users shall not be able to edit information on items or suppliers in order to maintain system

11 Software Design Document for Good Eats Inc. Total Web ERP Page 9 integrity. After administrator rights are given through the login process (11.3), the user shall be able to do the following: a. Quarry an Item or Supplier by ID/Serial Number/Name (through process 11.2) b. View full details of the quarry c. Edit any details of the selected item or supplier d. Save edited information to the database and be prompted with a confirmation of edit acceptance or error if not e. Database shall update all information for previous purchase orders, shipments and inventory data. This process shall be able to function through a mass data collection supplied by headquarters.

12 Software Design Document for Good Eats Inc. Total Web ERP Page Interface Descriptions This section describes the interfaces for end users to interact with the Good Eats databases. This includes the GE-TWERP interface, the warehouses supply interface, the local stores supply and sales interface and the customer online store interface. 4.1 Web Store Interface The Good Eats web store interface is used by customers in the purchasing of products from local stores either as a delivery to home or as in store pickup. Customers are able to browse their local stores inventory and locate items of interest through their search criteria Basic Layout Figure Web Store Home Screen

13 Software Design Document for Good Eats Inc. Total Web ERP Page 11 The basic layout for the Good Eats web store is depicted in Figure and shows what customers will be shown upon loading the html file. The top of the page shall depict the Good Eats name in their respective font and color and their company statement good food for a good life. Below is the main navigational bar that contains from left to right the links to: homepage, departments, store locations, company info (about), company news (news), contact information (contact), sign in, and the customer cart icon at the far right. Below the navigation bar on the left shall contain as a navigation frame in descending order: the search bar, hot items and seven of the most purchased items that week, deals and seven items that are currently marked down and recently viewed, with up to seven items the customer has most recently viewed in descending order. Below the navigation bar and to the right shall be the most recent corporate statement and then news articles that will be at most three and at least one. Below is breakdowns of each of these sections Top of Page and Page Details The running header for the web store shall be Good Eats Web Store. The top most point of the window shall show good eats inc. in their signature font along with the Good Eats company statement of good food for a good life Navigation Bar Figure 4.1.2: Navigational Bar As depicted in Figure 4.1.2, the navigational bar will contain the following links: homepage, departments, store locations, about, news, contact, sign in and a customer cart. Each link brings the customer to different web pages. The homepage, departments, store locations, about, news and contact web pages all have the same overall look. The top and left navigational menus and bars shall remain, while the right most data will alter in accordance with the location they are at. The sign in and cart screens will look different as they contain data for processing their order and login information Homepage The homepage shall look similar to Figure This is the overall aesthetic of the web store. The right most data will contain a message from the Good Eats Company to customers and below will be the most recent news which is populated through an RSS newsfeed Departments The department page shall provide customers with departments to search from for products. These include: Produce, Canned Food, Organic, Meat, Deli & Bakery, Beer and Wine, Pastas, Dairy and Grocery. Upon clicking one of these departments, customers shall be able to browse items that compose these specific departments. Each item may then be clicked upon for full details and added to their online cart Store Locations The store locations page shall provide customers with store locations broken down by: region, state and city. They may also find store locations with a search box for looking up their closest store by the customer s zip code. After selecting a store, customers will be prompted with saving the store as their closest store (for loading inventory data) and shall display the stores contact information About

14 Software Design Document for Good Eats Inc. Total Web ERP Page 12 The about page shall display a company statement about the inception and evolution of the Good Eats franchise. This information will be supplied by the Public Relations department of headquarters News News is updated on an RSS feed and will cycle with the newest updates appearing higher on the news page. A maximum of five items may display at once on each page, with links to older news articles at the bottom Contact This page will display regional numbers and contact details along with a dialogue boxes for filling out to send a message directly to the Public Relations department Sign In The sign in screen does not have the leftmost navigation frame. It allows users to access their saved accounts which imports in their contact information upon checkout and their local store for product searches. The sign in screen is a standard user name and password field along with a dialogue for Register as New Customer and Continue as Guest. Figure shows what a conceptual version of the frames data. Figure Sign-In Dialogue Frame Shopping Cart The shopping cart screen shall show all items the customer has added to their cart to purchase. Items will be displayed in alphabetical order and have the following information displayed left to right: a product image, product name, price, amount requested, total price. Below all items in the total price column will display the total amount all items added up will be. Beside this figure will be the checkout button which will direct customers to the secure checkout function of the web store Left Navigational Bar (Search and Items Bar) The leftmost frame shall be a navigational bar for customers to utilize for product searching and hot linking of specific items. These hot links include items that have seen the most purchases in the last week, items on sale and items the customer has most recently viewed. Figure shows an approximation of what the frame shall look like Search Box

15 Software Design Document for Good Eats Inc. Total Web ERP Page 13 The search box shall allow customers the ability to input search criteria such as brand name, item description or item type and locate items that are similar to their quarry. The search contacts the web store database and performs the quarry, returning products in the proper XML output to be viewed on the web store. This search is a wildcard search through all variables of the items stored in the repository. After initial search, customers will be prompted with the option of choosing a refined search Hot Items Section The hot items section shall be automatically updated to display seven of the most purchased items by online customers within the last seven days. Website administrators shall have the ability to manually post this data through override code if needed. Each item references an item page which displays the items full details for the customer Deals Section The deals section shall display a minimum of one and a maximum of seven items that are currently on sale. These items are propagated internally by the web store database. Manual entry by website administrators shall be available. Each product shall be marked down from their original price. Each item references an item page which displays the items full details for the customer Recently Viewed The recently viewed section shall display a minimum of none and a maximum of seven items that the customer has recently viewed on the web store. These items are propagated as the customer browses the item details on the web store. Each item references an item page which displays the items full details for the customer Center Information Frame Figure Left Nav Bar The center informational frame shall display the most recent statement to customers from the Good Eats Public Relations department and shall be manually entered by website administrators. Below this statement shall be at a minimum of one and a maximum of three of the most recent news announcements. Figure shows a conceptual design of this frame Public Relations Statement The public relations statement shall be created by the Good Eats Public Relations department and manually entered by website administrators. This statement is designed to attract customers to purchase from the Good Eats Inc. and requires their consumer and marketing knowledge to properly engage customers News Announcements The news announcements bar shall display at a minimum one and maximum of three news stories dependent on the amount of space that each stories requires. The homepage is designed to not require the customer to have to scroll on most displays when viewed full screen. The news announcements are created by headquarters public relations/marketing and passed on to the web

16 Software Design Document for Good Eats Inc. Total Web ERP Page 14 administrators. The web administrators script out the announcements as an RSS feed which auto updates on the news page and on the homepage. Figure : Center Information Frame

17 Software Design Document for Good Eats Inc. Total Web ERP Page 15 Appendix A: Laugh Model *I have nothing to put here so I thought maybe this will break up the monotony of reading all our SDDs.*