System and Software Architecture Description (SSAD)

Transcription

1 System and Software Architecture Description (SSAD) Perfecto Coffee Xpress Consistent Perfection Team 5 Chloe Good Yekaterina Glazko Edwards Hays Yucheng Hsieh Atreya Lahiri Jaimin Patel Yun Shen Andrew Tran Name Team Members & Roles Primary/Secondary Role IIV & V / Quality Focal Point IIV & V Requirements Engineer Software Architect Feasibility Analyst Project Manager / Life Cycle Planner Prototyper Operational Concept Engineer 12/03/2018 i

2 Version History Date Author Version Changes made Rationale 12/03/18 CG, AL Incorporate feedback and development changes since DCR - updates since DCR 10/21/18 YH 1.0 Initial draft Initial draft of SSAD ii

3 Table of Contents System and Software Architecture Description (SSAD)... i Version History... ii Table of Contents... iii Table of Tables... iv Table of Figures... v 1. Introduction Purpose of the SSAD Status of the SSAD System Analysis System Analysis Overview System Analysis Rationale Technology-Independent Model Technology-Specific System Design Design Overview Design Rationale Architectural Styles, Patterns and Frameworks...32 iii

4 Table of Tables Table 1: Actors Summary... 3 Table 2: Artifacts and Information Summary... 4 Figure 3: Process Diagram... 5 Table 3: Process Description : Login... 5 Table 4: Typical Course of Action - Login success... 6 Table 5: Alternate Course of Action - Login with social media account ( Facebook )... 6 Table 6: Alternate Course of Action - Login failure... 7 Table 7: Process Description : Logout... 7 Table 8: Typical Course of Action - Logout success... 8 Table 9: Process Description : Sign up... 8 Table 10: Typical Course of Action - Sign up success... 9 Table 11: Alternate Course of Action - Sign up failure... 9 Table 12: Process Description : Choose a base Table 13: Typical Course of Action - Choose a base Table 14: Process Description : Customize a base Table 15: Typical Course of Action - Customize a base Table 16: Process Description : Save a recipe Table 17: Typical Course of Action - Save a customized recipe Table 18: Process Description : Browse recipes Table 19: Typical Course of Action - Browse recipes Table 20: Process Description : Update a recipe Table 21: Typical Course of Action - Update recipe success Table 22: Process Description : Delete a recipe Table 23: Typical Course of Action - Delete recipe success Table 24: Process Description : Share a recipe Table 25: Typical Course of Action - Share recipe success when logged in with social media account Table 26: Alternate Course of Action - Share recipe success when logged in without social media account Table 27: Process Description : Order a recipe Table 28: Typical Course of Action - Order success Table 29: Process Description : Search kiosk Table 30: Typical Course of Action - Retrieve a list of search result Table 31: Alternate Course of Action - Location service is not available Table 32: Process Description : Select a kiosk Table 33: Typical Course of Action - Select a kiosk for picking up the order Table 34: Hardware Component Description Table 35: Software Component Description Table 36: Design Class Description Table 37: Architectural Styles, Patterns, and Frameworks iv

5 Table of Figures Figure 1: System Context Diagram... 2 Figure 2: Artifacts and Information Diagram... 3 Figure 3: Process Diagram... 5 Figure 4: Conceptual Domain Model Figure 5: Hardware Component Class Diagram Figure 6: Software Component Class Diagram Figure 7: Deployment Diagram Figure 8: Design Class Diagram Figure 9: Robustness Diagram Figure 10: Sequence Diagram v

6 1. Introduction 1.1 Purpose of the SSAD The purpose of the SSAD is to elaborate and define the detailed aspects including system analysis, scope, and the fundamental architecture and framework. The objective of this document is to identify the high priority features which are required by our client and will be the essential parts for the integration with hardware in the future and also provide a robust baseline for the entire product. 1.2 Status of the SSAD This is the first version of SSAD which is populated during the preparation for DCR ARB. The current main points for this document include system analysis and architecture confirmation. 1

7 2. System Analysis 2.1 System Analysis Overview The main goal of Perfecto Coffee is to provide a multi-platform system which provides high capability of customization and time-saving for customers who would like to grab a cup of coffee in a more convenient way by utilizing the interaction between mobile app platform and a kiosk-based system. The mobile app platform enables users to customize their own preferences of their chosen drinks with available options. By selecting a coffee recipe from either the based menu or the customized recipes list, users can use the app to locate nearby kiosks then select a preferred one for vending their order System Context Figure 1: System Context Diagram 2

8 Table 1: Actors Summary Actor Description Responsibilities User Users who want to get a cup of coffee. The initial targeted groups include commuter, people on campus. Browse / Customize / Save / Share a recipe. Search and select a kiosk for vending their order. Approach the kiosk and get their cup of coffee Artifacts & Information Figure 2: Artifacts and Information Diagram 3

9 Table 2: Artifacts and Information Summary Artifact Purpose Base flavor / recipe Customization Recipe Recipe list Order Kiosk Map view Share User profile The existed coffee flavors which can be commonly known by public such as Latte, Cappuccino etc.. It provides a start baseline for user to customize their own preferences. Changes that users made to a base coffee flavor including milk kind and ratio, amount of syrup, and extra add-ons. For specifying the customization process. A coffee preferences collection which is made from a base customizing by users. Recipe help users apply their preferences into their order. A collection of recipes which include all recipes which have been customized and saved by a single user. A critical item which include the ordered recipe, pick-up kiosk and customer info. An order is used as a verification before users to get their coffee. Consisting of geolocation data and a name based on its location, which can be used to shown on mobile map app for users to easily find them in order to vending their coffee. A view entity including in the mobile app. The purpose of the map view is to let users locate nearby kiosks for vending their order. A shared information about users customized recipe uploaded to social media platform. (Note : The item will be hosted on COTS platform instead. ) Users information including user name, password, , payment method, and information which is available via social media account such like Facebook, Twitter. 4

10 2.1.3 Behavior Figure 3: Process Diagram User authentication Login Table 3: Process Description : Login Identifier UC-1 User login Purpose To verify users authentication for accessing the system / service. Requirements WC_4981 Development Risks For logging with social media account: Social media SDK integration. Pre-conditions Users have already signed up or had a supported social media account and the database is initialized for storing user account 5

11 information. Post-conditions Users get the accessibility to use provided services via the app. Table 4: Typical Course of Action - Login success Seq# Actor s Action System s Response 1 Enter username and password. 2 Click the login button. 3 Retrieve user credentials from DB. 3 Verify user credentials. 4 Receive access token for login success. 5 Navigate to the customization page. Table 5: Alternate Course of Action - Login with social media account ( Facebook ) Seq# Actor s Action System s Response 1 Click Login with Facebook button. 2 Open a browser and show Facebook authorization page. 3 Enter username and password for logging into Facebook and click login button. 4 Retrieve user credentials from Facebook platform. 6

12 5 Receive Facebook access token. 6 Retrieve user credentials from DB. 7 Verify user credentials. 8 Receive access token for login success. 9 Navigate to the customization page. Table 6: Alternate Course of Action - Login failure Seq# Actor s Action System s Response 1 Enter username and password. 2 Click the login button. 3 User credentials cannot be found from DB or the password is not match with retrieved credentials. 4 Receive access token for login failure. 5 Show a login failure message : The username is not found. or The username and password are not match Logout Table 7: Process Description : Logout Identifier UC-2 User logout Purpose Log user out of the app. 7

13 Requirements WC_4981 Development Risks None Pre-conditions User has remained logged in status to the app. Post-conditions User is logged out from the app. Table 8: Typical Course of Action - Logout success Seq# Actor s Action System s Response 1 Blow up the side drawer menu. 2 Click the logout button. 3 Reset user login status and log user out. n Redirect user to login / signup page Sign up Table 9: Process Description : Sign up Identifier UC-3 User account sign up Purpose Requirements Let user create a personal account for getting the accessibility to the app without having a social media account. WC_4981 Development Risks None 8

14 Pre-conditions Post-conditions User account entity is set up in the database. User needs to set personal information such as username, password, or phone number. User gets an account and can use it to login to the app. Table 10: Typical Course of Action - Sign up success Seq# Actor s Action System s Response 1 Go to the signup view by clicking the sign up tab at the bottom of the login view 2 Filled the required blanks including username, password, re-enter password, , phone number. 3 Click the Signup button. 4 Check username availability and password validation. 5 Create user account data and store them into the database. 6 Show the signup success message. 7 Automatically log user in and navigate to the customization page. Table 11: Alternate Course of Action - Sign up failure Seq# Actor s Action System s Response 1-4 Same as Seq# 1 to 4 in Typical Course of Action for sign up success 9

15 2 Username has already been taken or the password doesn t meet the security requirements. 3 Show the signup fail message. 4 Mark the fields needed to be modified Recipe Customization Choose a base Table 12: Process Description : Choose a base Identifier UC-4 Choose a base from the existed coffee menu Purpose Give user a starter template to customize their own flavor easier. Requirements WC_4820, WC_4846, WC_4918 Development Risks None Pre-conditions User is at the first step of customization in the customization view. Post-conditions A base recipe is selected and kept in the next step of customization. Table 13: Typical Course of Action - Choose a base Seq# Actor s Action System s Response 1 Navigate to the customization view. 10

16 2 Select a base recipe flavor from the menu. 3 Navigate to the next step of view for initiating the customization process Customize a base Table 14: Process Description : Customize a base Identifier UC-5 Customize a base in 3 to 4 steps Purpose Requirements Guide user to go through each step of customization and set every adjustable options with their own preferences. WC_4846, WC_4918 Development Risks Pre-conditions Mobile app navigation architecture and data flow management. The variation in different base flavor recipes would lead to different available options in the customization process. User has a chosen base for starting customization. Post-conditions User gets his/her own customized recipe. Table 15: Typical Course of Action - Customize a base Seq# Actor s Action System s Response 1 User sets milk preferences including milk kind, ratio, cream or foam level then click Next button. 2 Save the setting from milk preferences and navigate user to the next step for syrup choices. 11

17 3 User sets syrup preferences including syrup kind, amount then click Next button. 4 Save the setting from syrup preferences and navigate user to the next step for extra adds-on. 5 User sets extra adds-on including extra number of espresso shots, sugar amount, or decaf option then click Next button. 6 Save the extra adds-on preferences and navigate user to the final review view for reviewing all the customization he / she has made so far. 7 User reviews the overall customization options before they save it into the recipe list Save a recipe Table 16: Process Description : Save a recipe Identifier UC-6 Save a customized recipe Purpose Requirements Let user save their preferences for a specific recipe that can be used every time when they make order while ensuring a consistent flavor they expect. WC_4846 Development Risks Set up the recipe entity in the database. Pre-conditions Post-conditions User finishes the customization process and gets a customized recipe. The customized recipe is stored to user s recipe list. 12

18 Table 17: Typical Course of Action - Save a customized recipe Seq# Actor s Action System s Response 1 After checking all the settings are good to go, click the Save button. 2 Save the customized recipe data into the database. 3 Reply a save success data and message. 4 Receive the data and a saved success message is shown. 5 Navigate user to the view for choosing which view to go next : Recipe list ( Browse the recipe ), Customization ( Keep making a new recipe )or Order view ( Order it right away ) Recipe Browse and Management Browse recipes Table 18: Process Description : Browse recipes Identifier UC-7 Browse recipes Purpose Requirements Let user browses all the customized recipes he / she has made so far. WC_4919 Development Risks None. 13

19 Pre-conditions Post-conditions User has at least one customized recipe existed in his / her recipe list. A list of recipes is shown to user and by clicking any list item user can get a detailed info about the selected recipe. Table 19: Typical Course of Action - Browse recipes Seq# Actor s Action System s Response 1 Click the Recipe list tab from the side drawer menu. 2 Retrieve all the recipe data regarding the user data from the database. ( All the recipes stored in user s recipe list. ) 3 Send the data package back to the client side app. 4 Receive the recipe data package and populate them onto the recipe list. 5 Click any list item on the recipe list. 6 Navigate user to the detailed view showing the ingredient settings of the chosen recipe Update a recipe Table 20: Process Description : Update a recipe Identifier UC-8 Update a selected recipe Purpose Requirements User can modify the preferences of a customized recipe after it was created. WC_

20 Development Risks Set up the recipe entity in the database. The violation in the database constraints. Pre-conditions Post-conditions User has at least one customized recipe. User clicks into the detailed view of the recipe from the recipe list view. The recipe is updated with the latest preferences. Table 21: Typical Course of Action - Update recipe success Seq# Actor s Action System s Response 1 Click the Edit button from the detailed view. 2 Navigate user to the customization view loaded with original preference settings of the recipe. 3-9 Same as Seq# 1 to 7 from Typical Course of Action - Customize a base Same as Seq# 1 to 4 from Typical Course of Action - Save a customized recipe 14 Redirect user back to the detailed view showing updated information Delete a recipe Table 22: Process Description : Delete a recipe Identifier UC-9 Delete a selected recipe Purpose Allow user to delete a recipe which he/she no longer wants to keep. 15

21 Requirements WC_4835 Development Risks None Pre-conditions Post-conditions User has at least one customized recipe existed in his / her recipe list. The selected recipe is removed from user s recipe list. Table 23: Typical Course of Action - Delete recipe success Seq# Actor s Action System s Response 1 Click the Edit button from the recipe list view. 2 Show the deletion icon at the right for each list item. 3 Click the deletion icon then click the slide up Delete button at the left. 4 Show an alert box Are you sure to delete the recipe? 5 Click Yes button in the alert box to confirm the deletion. 6 Remove the recipe under user s recipe list in the database. 7 Send a delete success message back to the client side app. 8 Receive the delete success message sent from the backend. 9 Remove the recipe from user s recipe list view. 16

22 Share a recipe Table 24: Process Description : Share a recipe Identifier UC-10 Share a selected recipe Purpose Requirements Let user to share his / her own customized recipes to social media platform publicly. WC_4909 Development Risks Social media SDK integration. Policy change in social media platform data usage. Pre-conditions Post-conditions The user has at least one customized recipe in his / her recipe list. The user has to have a social media account ( Facebook. ) The customized recipe content is posted to user s social media account publicly for other people to browse. Table 25: Typical Course of Action - Share recipe success when logged in with social media account. Seq# Actor s Action System s Response 1 Click the social media icon ( Facebook icon ) in the detailed view 2 Open up a share dialog. 3 Enter the share context and set the privacy setting. 4 Press Share button in the share dialog. 17

23 5 The recipe content is posted via the social media platform automatically. 6 Show a share success message in client side app. Table 26: Alternate Course of Action - Share recipe success when logged in without social media account. Seq# Actor s Action System s Response 1-2 Click the social media icon ( Facebook icon ) in the detailed view. 2 Open up a browser showing social media login page. 3 Enter username and password ( or simply click a confirm button if user already has logged in to the social media on his/her phone ) for authorizing the usage of social media feature in the app. 4-8 Same as Seq# 2 to 6 from Typical Course of Action - Share recipe success when logged in with social media account Make an Order to Kiosk Order a recipe Table 27: Process Description : Order a recipe Identifier UC-11 Order a recipe Purpose For user who want to vend his / her customized recipe to a kiosk. 18

24 Requirements WC_4919 Development Risks Hardware integration. Pre-conditions User navigates to the order view. Post-conditions The order is made and stored to the database for hardware system / platform to access. Table 28: Typical Course of Action - Order success Seq# Actor s Action System s Response 1 Click the Order tab from the side drawer menu. 2 Navigate user to the order view. 3 Select a recipe from the presented recipe list. 4 Mark the selected recipe from the list. 5 Click Next button 6 Navigate user to the confirmation view. 7 Show all the order information including ordered recipe, pick-up kiosk, payment method. 8 Click Order button 9 Place the order data into the database 10 Reply a order success message back to the client side app. 19

25 11 Receive the order success message and data. 12 Redirect user back to the order view Search kiosks Table 29: Process Description : Search kiosk Identifier UC-12 Search kiosk Purpose Let user to identify all available kiosks near around him / her Requirements WC_4983 Development Risks Google Map API integration Pre-conditions Post-conditions User is in the ordering process. The location service of user s mobile phone is enabled. Several kiosks are marked out on user s map view in the app. Table 30: Typical Course of Action - Retrieve a list of search result Seq# Actor s Action System s Response 1 Click Select a kiosk for picking up tab bar at the bottom of the order view. 2 Navigate user to the map view. 3 Access user s current location data and send it to the backend for retrieving nearby kiosk data. 20

26 4 Retrieve all the kiosk location data which match the distance constraints based on user s current location from the database. 5 Send the kiosk location data back to the client side app. 6 Receive the kiosk location data. 7 Parse the location data and populate all kiosks as marks on to the map view. Table 31: Alternate Course of Action - Location service is not available Seq# Actor s Action System s Response 1-2 Same as Seq# 1 to 2 from Typical Course of Action - Retrieve a list of search result 3 Cannot access user s current location due to the location privacy setting on user s mobile phone. 4 Show an alert box asking for enabling location service. 5 Enable the location service in the settings of mobile phone Same as Seq# 3 to 7 from Typical Course of Action - Retrieve a list of search result 21

27 Select a kiosk Table 32: Process Description : Select a kiosk Identifier UC-13 Select a kiosk Purpose Requirements User can choose which kiosk for making his / her cup and picking up from the marked kiosks on the map view. WC_4916 Development Risks Google Map API integration Pre-conditions Post-conditions User is in the map view and all the nearby kiosks are retrieved and marked on the map view. The location service of user s mobile phone is enabled. The kiosk for picking up the order is updated and shown as the text at the bottom tab bar in the order view. Table 33: Typical Course of Action - Select a kiosk for picking up the order Seq# Actor s Action System s Response 1 Click any one of kiosk marks shown on the map view. 2 Update the selected kiosk for the order. 3 Redirect user back to the order view. 22

28 2.1.4 Modes of Operation The system of Perfecto Coffee will only run under one single mode, which leaves this section as unspecified. 2.2 System Analysis Rationale Due to limited knowledges in robotic and hardware-related field and the fact that the kiosk with desired capabilities is still not existed in the market, our main goal will be proposing a robust software foundation which includes a mobile app, backend server and database collection hosting upon cloud service platform. The foundation will be maintainable and reusable in future development phase and business analysis and have a high flexibility to integrate with possible 3rd party hardware API. 3. Technology-Independent Model Due to the commitment to a specific technology model for our software architecture and framework, this section is left as blank intentionally. 23

29 4. Technology-Specific System Design 4.1 Design Overview Perfecto Coffee will be designed as an ios application built using the react native framework. This will be in conjunction with an AWS hosted server that connects to a MySQL database hosted through AWS RDS. The AWS Server will leverage the sails js framework to provide an API for app functionality, in addition to readily available authentication. This architecture should allow for scalability going forward, as well as easy development of an android application at a later date thanks to react native s code reusability System Structure Figure 4: Conceptual Domain Model 24

30 Figure 5: Hardware Component Class Diagram 25

31 Figure 6: Software Component Class Diagram Figure 7: Deployment Diagram Table 34: Hardware Component Description Hardware Component Description AWS EC2 Web Server AWS Relational Database Service Google Maps API The EC2 Instance hosted on amazon s cloud servers that provides the endpoint for our server. Additionally servers as the secure middle man between our database and any data entries. This AWS RDS setup contains our MySQL database for Perfecto Coffee. It will be managed through this to provide scalability and security. Can only be accessed by our EC2 server, not publicly. This provides the app program interface to plot our kiosk locations on a map. Will be used to provide distance between users and kiosks, and visual for users to see all kiosk locations. 26

32 Facebook API Kiosk Mobile Devices Used for Oauth2 login integration. Provides a more convenient login system for users while also providing us the necessary base information to add a user to our database. Sharing to facebook is integral for sharing recipes. The Perfecto Coffee kiosks. Not yet designed or implemented, but will be the physical machine that makes and provides the coffee for pickup. The user s device for using Perfecto Coffee. ios devices are the mobile devices that are currently supported, but expansion to android is planning for the future. Table 35: Software Component Description Software Component Description Login Page Kiosk Page Customize Page Profile Page Interface that allows users to login to Perfecto Coffee. Will support both Facebook s login and our own Sails based authentication system. Page that provides the locations of all our Perfecto Coffee kiosks. Can select favorites or measure distance between user and kiosk. All options for customizing a coffee order will be displayed here. The user s profile options are displayed here. From their accessing this we can allow for input of user photo, social media connections, favorite kiosks, and payment information. 27

33 Order Page Recipe Page User login Data Kiosk Data User Data Recipe Data Facebook API Google Maps API Will display the finalized customized drink to sum up a user s order. Can change the kiosk pickup location and confirm payment. Provides a page where the publicly created recipes can be viewed publicly and upvoted or downvoted to show the most popular recipes. Here we store all the information needed to authenticate a user if they re not logging in through the Facebook API This stores the location of all kiosks we currently have available. In the future will likely store the syrup levels contained at each kiosk, however, while currently lacking the hardware this feature will be omitted. Stores the user information that is not critical to login. Payment methods, favorite kiosks, etc. This records the recipe s makeup. The details of how much syrups, milk type, add shots, etc, are all stored in this table and each entry is treated as a unique recipe. Provides the facebook login screen view to the user, as well as their profile picture and Displays the map interface of the user s current location while showing closely located kiosks Design Classes Recipe Design Classes 28

34 Figure 8: Design Class Diagram Table 36: Design Class Description Class Type Description User Entity Users who want to edit recipes Ingredients Boundary Items which combine to a recipe Inventory Controller Keeps track of ingredients Recipe Component Section with several operations for users to edit 29

35 4.1.3 Process Realization Figure 9: Robustness Diagram 30

36 Figure 10: Sequence Diagram 4.2 Design Rationale Perfecto Coffee will be designed as an ios application built using the react native framework. This will be in conjunction with an AWS hosted server that connects to a MySQL database hosted through AWS RDS. The AWS Server will leverage the Sails.js framework to provide an API for app functionality, in addition to readily available authentication. This architecture should allow for scalability going forward, as well as easy development of an android application at a later date thanks to react native s code reusability. Using Customize page as home page allows user to customize quickly after they login. React native allows for mobile applications to be written in Javascript and then run on mobile phones. Because the framework converts the Jjavascript to the phone s native language a lot of code can be reused to allow for cross-platform compatibility. It is Three-tier architecture pattern. Front tier: Mobile application Middle tier: AWS server Back tier: Database (MySQL) 31

37 5. Architectural Styles, Patterns and Frameworks Table 37: Architectural Styles, Patterns, and Frameworks Name Description Benefits, Costs, and Limitations React Native Sails JS 3 Tier Architecture The native framework that allows for mobile applications to be written in javascript and then run on mobile phones. Because the framework converts the javascript to the phone s native language a lot of code can be reused to allow for cross-platform compatibility. Javascript server framework that runs on top of Node.JS. This provides a framework for code organization as well as a database API that makes interaction between the user and the database simpler while our EC2 instance can remain the middleman. Our application is built using the 3 tier architecture: 1) our mobile application 2) Our AWS Node Server and 3) Our RDS MySQL database. All three of these play an integral role in the functionality of our application, needing each other to work correctly. The mobile application will submit a request to the server, which in term retrieves data from the MySQL database. The data is returned to the server and then sent back in JSON format to the mobile application. Benefits: Simplifies Cross-platform development, Group was more familiar with javascript than obj-c or swift Costs: Free Limitations: Application size can be large due to react library. Not an issue initially, but if app gets larger may someday need to be slimmed down. Benefits: Provides code structure, Models database into functional API, provides built in amenities (e.g. authentication) Cost: Free Limitations: Mostly limited by the AWS Free Tier usage limits currently. The server has a set number of hours it can run per month until the service is upgraded. Benefits: Each tier is specific to a functionality and really focuses development efforts Costs: Free Limitations: Developing cannot be done haphazardly. Must keep all technologies in mind to ensure everything works correctly. 32