System and Software Architecture Description

Transcription

1 System and Software Architecture Description (SSAD) Mental Math Team - 7 Chang Yu Prototyper, Requirements Engineer Isha Agarwal Prototyper, Life Cycle Planner, Implementer Jingxing Cheng Implementer Kajal Taneja Operational Concept Engineer, UML Modeler, Implementer Kiranmai Ponakala Implementer, Life Cycle Planner, IIV & V Sushant Ramesh Software Architect, Operational Concept Engineer Sunmeet Nagpal Program Manager, Quality Focal Point Yuanxiu Yang Feasibility Analyst, Tester 11/30/18

2 Version History Date Author Version Changes made Rationale 10/22/18 SR 1.0 Android application for use with Instructional ICM-Sw v1.0 11/30/18 SR 2.0 Android app and initial ios architecture for use with Instructional ICM-Sw v2.0 Initial draft for use with Instructional ICM-Sw v1.0 Final draft for use with Instructional ICM-Sw v2.0! 2

3 Table of Contents System and Software Architecture Description (SSAD)... 1 Version History... 2 Table of Contents... 3 Table of Tables... 4 Table of Figures Introduction Purpose of the SSAD Status of the SSAD System Analysis System Analysis Overview System Context Artifacts & Information Behavior Capability Mental Math Application Processes Modes of Operation System Analysis Rationale Technology-Independent Model Design Overview System Structure Technology-Specific System Design Design Overview System Structure Design Classes Sequence Diagram Architectural Styles, Patterns and Frameworks... 25! 3

4 Table of Tables Table 1: Actors Summary... 3 Table 2: Artifacts and Information Summary... 4 Table 3: Process Description - UC Table 4: Typical Course of Action - UC Table 5: Process Description - UC Table 6: Typical Course of Action - UC Table 7: Process Description - UC Table 8: Typical Course of Action - UC Table 9: Alternate Course of Action - UC Table 10: Process Description - UC Table 11: Typical Course of Action - UC Table 12: Process Description - UC Table 13: Typical Course of Action - UC Table 14: Alternate Course of Action - UC Table 15: Exceptional Course of Action - UC Table 16: Process Description - UC Table 17: Typical Course of Action - UC Table 18: Alternate Course of Action - UC Table 19: Process Description - UC Table 20: Typical Course of Action - UC Table 21: Alternate Course of Action - UC Table 22: Exceptional Course of Action - UC Table 23: Hardware Component Description Table 24: Software Component Description Table 25: Design Class Description (Android) Table 25: Design Class Description (ios) Table 26: Architectural Styles, Patterns, and Frameworks... 25

5 Table of Figures Figure 1: System Context Diagram... 2 Figure 2: Artifacts and Information Diagram... 4 Figure 3: Process Diagram... 5 Figure 4: Conceptual Domain Model Figure 5: Hardware Component Class Diagram Figure 6: Software Component Class Diagram (Free) Figure 7: Software Component Class Diagram (Paid) Figure 8: Deployment Diagram Figure 9: Design Class Diagram (Android) Figure 10: Design Class Diagram (ios) Figure 11: Sequence Diagram... 24!5

6 1. Introduction 1.1. Purpose of the SSAD The SSAD describes the whole picture of our project, which describes how the user can interact with the application and use all the features available. This report contains the diagrams that are demonstrate the details of each of the feature that is available in the app. It also specifies the architectures of the project, with the focus on the software Status of the SSAD At this time, we have included the use case diagram, system context diagram, software and hardware class diagrams.! 1

7 2. System Analysis 2.1. System Analysis Overview The foremost objective of the Mental Math application is to allow the users to test and gauge their math skills in order to improve on it. The app is built in android Android 5.1. The users can use the free or paid versions of the application, both online (using their Google accounts) and offline System Context Figure 1: System Context Diagram! 2

8 Table 1: Actors Summary Actor Description Responsibilities User Maintainer Developer The users who use the application and play the game. The person/s in charge of monitoring the application once it is operational. Students of 577A, in charge of developing the application. 1. Sign-in using Google account 2. Play game 3. Share scores and refer application with friends 1. Fix bugs and maintain application based on documentation provided by developers 2. Obtain analytics reports 1. Develop both versions (free and paid) of the application. 2. Maintain good documentation, including training document to be handed to the maintainer.! 3

9 Artifacts & Information Figure 2: Artifacts and Information Diagram Table 2: Artifacts and Information Summary Artifact Level Page Description Page Game Page Score Report Google Leaderboard Share Options Settings Language Selection Color Scheme Selection Developer and App Info Purpose Displays all levels and categories for the user to choose from. Displays level description to teach users. Displays game for users to play and complete within a time limit. Displays score, time, slowest time and mean time of the user. Leaderboard where global best scores are uploaded. Options to share scores through messages or Facebook. Settings page for the application User can switch between languages (English and Russian). User can switch between different color schemes. User can view developer and app details, for their information.! 4

10 Behavior Figure 3: Process Diagram! 5

11 Capability Mental Math Application Processes 1. User can login using their Google account. Table 3: Process Description - UC01 Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC01 The user has the option of accessing leaderboards and checking others scores. Authentication None Internet connection, Existing Google account Once user is logged in, everything is saved to their profile.! 6

12 Table 4: Typical Course of Action Seq# Actor s Action System s Response 1 Click on Google symbol 2 Open Google login 3 Authenticate Table 5: Alternate Course of Action Seq# Actor s Action System s Response 1 Click on Google symbol 2 Display error No internet connection Users can change the color theme. Table 6: Process Description - UC02 Identifier Purpose UC02 The user has the option of changing the color Requirements Development Risks Pre-conditions Post-conditions None None Application downloaded. Once a color is selected, it is applied to all the pages.! 7

13 Table 7: Typical Course of Action Seq# Actor s Action System s Response 1 Click on color symbol 2 Open color selection palette. 3 Select color. 3. Users can change the language. Table 8: Process Description - UC03 Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC03 The user has the option of changing the language between English and Russian. None None Application downloaded. Once a language. is selected, it is applied to all the pages.! 8

14 Table 9: Typical Course of Action Seq# Actor s Action System s Response 1 Click on globe symbol. 2 Open language options. 3 Select language. 4. Users can select category/topic. Table 10: Process Description - UC04 Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC04 The user can choose the type of operation they wish to learn. Android phone None The user is on the level selection page. Level selection for chosen topic is displayed. Table 11: Typical Course of Action - UC04 Seq# Actor s Action System s Response 1 Click on topic (Addition, Subtraction, Multiplication, Division). 2 Open level selection for chosen category. 4. Users can select level to play. Identifier Purpose UC05 The user can choose the level they wish to play at.! 9

15 Requirements Development Risks Pre-conditions Post-conditions Android phone None The user is on the level selection page. Description page opens up, if description is available. Else, game page is displayed. Table 12: Process Description - UC05 Table 13: Typical Course of Action - UC05 Seq# Actor s Action System s Response 1 Click on level within a category. 2 Open description page for that level. Table 14: Alternate Course of Action - UC05 Seq# Actor s Action System s Response 1 Click on level within a category. 2 Open level, if there is no description page. Table 15: Exceptional Course of Action - UC05 Seq# Actor s Action System s Response 1 Click on level within a category. 2 Display error Level not unlocked. Complete previous level!! 10

16 5. Users can play the game to test their skills. Table 16: Process Description - UC07 Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC07 The user can enter an answer to the question displayed. Android phone None The user has begun the game. If final question, the score report is displayed. Else, next question appears. Table 17: Typical Course of Action - UC07 Seq# Actor s Action System s Response 1 Enter an answer. 2 Verify answer. 3 Add points to score, based on verification. 4 Save time taken for the question. 5 Display next question.! 11

17 Table 18: Alternate Course of Action - UC07 Seq# Actor s Action System s Response 1 Enter an answer. 2 Verify answer. 3 Add points to score, based on verification. 4 Save time taken for the question. 5 Display next question. 6. Users can view progress report or play again after viewing the score report. Table 19: Process Description - UC12 Identifier Purpose Requirements Development Risks Pre-conditions Post-conditions UC12 The user can track their overall progress to improve their skills. Android phone None The user has completed a level. Description page, if available. Else, game page. View progress report if selected. Table 20: Typical Course of Action - UC12 Seq# Actor s Action System s Response 1 View score report. 2 Click play again. 3 Open description page for that level.! 12

18 Table 21: Alternate Course of Action - UC12 Seq# Actor s Action System s Response 1 View score report. 2 Click play again. 3 Open level, if there is no description page. Table 22: Exceptional Course of Action - UC12 Seq# Actor s Action System s Response 1 View score report. 2 Click Progress. View progress report over all levels for each category Modes of Operation The system has 4 modes of operation: 1. Free, Online - The free version of the application, connected to the internet to enable advertisements, Google Sign-In and leaderboards. 2. Free, Offline - The free version of the application not connected to the internet, with ads, Google Sign-In and leaderboards disabled. 3. Paid, Online - The paid version of the application, connected to the internet to enable Google Sign-In and leaderboards. 4. Paid, Offline - The free version of the application not connected to the internet, with Google Sign-In and leaderboards disabled System Analysis Rationale The moment the user signs in using their Google account, their progress page is updated with their progress over the different levels.! 13

19 We have nothing to do with the Google sign-in. The Google API helps to authenticate the user and logs them into their account.! 14

20 3. Technology-Independent Model 3.1. Design Overview System Structure Figure 4: Conceptual Domain Model! 15

21 4. Technology-Specific System Design 4.1. Design Overview System Structure Figure 5: Hardware Component Class Diagram (Common for Free and Paid Applications)! 16

22 Figure 6: Software Component Class Diagram (Free)! 17

23 Figure 7: Software Component Class Diagram (Paid)! 18

24 Figure 8: Deployment Diagram (Common for Free and Paid Applications) Table 23: Hardware Component Description Hardware Component Android Phones Mobile Devices Google Server Workstation Windows/Linux/Mac Description This consists of all Android phones with Android 5.1 platform or higher. Encapsulates all Android devices (phones and tablets). The Google server helps integrate various COTS products into the application. Consists of a computer or a group of computers on the maintainer or developer s end. The computers on the maintainer or developer s end which contain Android studio or Firebase.! 19

25 Software Component Google Sign-In API Google Leaderboard API Firebase Analytics Facebook API Home Page Game Score Report Progress Report Level Selection Description Helps users to login to their Google accounts. Helps users to view the leaderboards and sync their scores to the global standings. Analytics of the application usage which is vital to the client for scalability. Used to share/post scores on Facebook. Option to sign-in to Google account or go to settings page. Answer questions with a time constraint and view level progress. Displays score, time, slowest time and mean time of the user. Displays overall progress of the user in the game. Menu page for choosing topic and level (if unlocked). Table 24: Software Component Description The hardware component class diagram and software component class diagram has not been designed for the ios app as it has only been developed till its prototyping stage. No COTS products have been integrated with the application yet. Furthermore, no APIs have been used or tested yet and since there is still flexibility on how they can be implemented and deployed, it would be premature to create such diagrams for the ios application.! 20

26 Design Classes Figure 9: Design Class Diagram (Android)! 21

27 Figure 10: Design Class Diagram (ios)! 22

28 Table 25: Design Class Description (Android) Class Type Description User Entity Users who download the application (whether free or paid). Accounts Entity Users who login with their Google accounts. SelectLevel Component Category and level selection activity. LevelDescription Component Activity containing level description and previous scores with timestamps for that level. GamePlay Component Activity containing game screen, timer, questions, numpad and progress bar at the top. EndLevel Component Score report with options to share scores, play again and view progress report. ProgressRecord Component Progress report which shows overall user progress in each category. Table 26: Design Class Description (ios) Class Type Description ViewController Component Acts as the home screen to rate and share app as well as enter level selection page. SelectLevel Component Category and level selection activity. LevelDescription Component Activity containing level description and previous scores with timestamps for that level. GamePlay Component Activity containing game screen, timer, questions and numpad at the top. EndLevel Component Score report with options to navigate back to level selection page.! 23

29 Sequence Diagram Figure 11: Sequence Diagram! 24

30 5. Architectural Styles, Patterns and Frameworks Table 27: Architectural Styles, Patterns, and Frameworks Name Description Benefits, Costs, and Limitations Android : 3-tier architecture ios : 3-tier architecture The presentation layer is the Android UI, the logic layer is the Java code, and the data is in the Firebase. The presentation layer is in the storyboard files, the logic layer is in the swift files and the data is in the string files. The user is supposed to have an Android device. The user must have an ios device.! 25