System and Software Architecture Description (SSAD)

Transcription

1 System and Software Architecture Description (SSAD) LADOT Scanning Team 08 Name Primary Role Secondary Role Anirudh Govil Project Manager Life Cycle Planner Jeffrey Colvin Prototyper Systems and Software Architect Aditya Kumar Feasibility Analyst Project Manager Nisheeth Joshi Systems and Software Architect Life Cycle Planner Niraj Brahmkhatri Operational Concept Engineer Requirements Engineer Corey Painter IIV&V Shaper SSAD_DCP_F11a_T08_V3.1.doc i

2 Version History Date Author Version Changes made Rationale 10/09/11 JC 1.0 Original copy using with Instructional ICM-Sw v1.0 template Initial Draft 10/10/11 Nisheeth 1.1 Updated section 2.0 template Initial Draft Joshi 10/16/11 NJ 1.2 Updated incorrect text associated with diagrams TA Grading 10/10/11 JC 2.0 Updated diagrams Diagrams misrepresented system and were not detailed enough 10/23/11 JC 3.0 Modified diagrams Diagrams needed corrections due to rescoping/arb session comments 10/24/11 JC 3.1 Added future considerations Needed to meet requirements Fixed some typos SSAD_DCP_F11a_T08_V3.1.doc ii

3 Table of Contents SYSTEM AND SOFTWARE ARCHITECTURE DESCRIPTION (SSAD) VERSION HISTORY TABLE OF CONTENTS TABLE OF TABLES TABLE OF FIGURES I II III IV V 1. INTRODUCTION of the SSAD Status of the SSAD 1 2. SYSTEM ANALYSIS System Analysis Overview System Context Artifacts & Information Behavior Truck System Use-Case Model Log job call Perform Job Select Job Login Logout 6 3. FUTURE CONSIDERATIONS System Context System Context Artifacts & Information Behavior Computer System Use-Case Model View location job history View Own Employee Job History Login Logout View Maintenance Report Edit Maintenance Report Assign Truck Tasks Assign Task to Truck 13 SSAD_DCP_F11a_T08_V3.1.doc iii

4 Table of Tables Table 1 - System Context Diagram Details 2 Table 2 - Artifacts and Information Diagram Details 3 Table 3 Future System Context Diagram Details 8 Table 4 Future Artifacts and Information Diagram Details 9 SSAD_DCP_F11a_T08_V3.1.doc iv

5 Table of Figures Figure 1 - System Context Diagram 2 Figure 2 - Artifacts and Information Diagram 3 Figure 3 - Truck System Use-Case Model 4 Figure 4 Future System Context Diagram 8 Figure 5 Future Artifacts and Information Diagram 9 Figure 6 Future Computer System Use-Case Model 10 SSAD_DCP_F11a_T08_V3.1.doc v

6 1. Introduction 1.1 of the SSAD The SSAD will outline the overall object-oriented analysis and design (referred to as OOA&D) of the system being developed. The system, once developed, should be faithful to the architecture defined in the SSAD and the builders (programmers) should use this document as a reference to the system architecture. Additionally, the SSAD may be used by the maintainer and clients to understand the structure of the system after the system has been delivered. 1.2 Status of the SSAD This version of the SSAD has changed to reflect re-scoping of the project and comments from the ARB session. The main changes stem from re-scoping the project to deliver a working prototype of the truck software. Additional models are only outlined. SSAD_DCP_F11a_T08_V3.1.doc 1

7 2. System Analysis 2.1 System Analysis Overview The purpose of the new LADOT Scanning System is to eliminate the current document scanning process and to create a new electronic system to help maintain both time-keeping and maintenance reports for LADOT field workers. The LADOT Electronic Field System will be stored on LADOT trucks and will log in a field workers hours, job status (including time stamps) as well as notes about the job such as what the problem was and what equipment was needed to fix it. The software will create 2 files upon sign-out, a time-keeping report and a maintenance report System Context Figure 1 - System Context Diagram Table 1 - System Context Diagram Details Actor Description Responsibilities Field worker Employees who go to the field and do the work Performs the actual fixing of the defects SSAD_DCP_F11a_T08_V3.1.doc 2

8 2.1.2 Artifacts & Information Figure 2 - Artifacts and Information Diagram Table 2 - Artifacts and Information Diagram Details Artifact Issue Job Time Sheet User Location DTime Report This keep a note of one of the issues that were resolved during a job (ex: broken red light on east-facing lamp) It describe a particular task/job allocated to a particular field worker A field worker s hours by day A user of any of the systems (either truck of computer system) depending on their permission attribute Either a job location (28 th and Figuroa) or the location of a truck, depending on the owner The export file in FLAT format for all the time-sheets on a biweekly basis to be uploaded to LADOT s DTime system. SSAD_DCP_F11a_T08_V3.1.doc 3

9 2.1.3 Behavior Truck System Use-Case Model Figure 3 - Truck System Use-Case Model Log job call Requirements FW-01: Assign truck tasks Field worker needs to log that they were called with a job WC_481, WC_523 Must be logged in 1 Select Log Call button 2 Input job location and information 3 Add the call to the user s queue 4 Time-stamp the job with current time Perform Job FW-02: Perform job Field worker needs to be able to log that they have performed a SSAD_DCP_F11a_T08_V3.1.doc 4

10 Requirements job WC_523 Must be logged in; must have job active 1 Select Log Arrival upon arrival 2 Time-stamp arrival in job 3 Select Log Completion upon completing 4 Time-stamp completion 5 Select issues fixed from sliders 6 Select Log Departure when departing 7 Time-stamp departure and close job Select Job Requirements FW-03: Select job Field worker needs to be able to choose which job to do WC_523 Must be logged in; must not have an active job; must have jobs in call queue 1 Load list of job s in queue 2 Select job from queue 3 Select begin job button 4 Register job as started, transfer to Perform Job page Login Requirements FW-04: Login Field worker must be able to verify permissions WC_523 Must not be logged in SSAD_DCP_F11a_T08_V3.1.doc 5

11 1 Enter username and password 2 Submit data 3 Validate username/password Time-stamp beginning of user session 4 Store user data in code until logout Logout Requirements FW-05: Login WC_523 Must be logged in to the online system with task allocator permissions 1 Click logout button 2 Time-stamp end of user session 3 Save user session until exported SSAD_DCP_F11a_T08_V3.1.doc 6

12 3. Future Considerations 3.1 System Context The purpose of the new LADOT Scanning System is to eliminate the current document scanning process and to create a new electronic system to help maintain both time-keeping and maintence reports for LADOT field workers. The LADOT Electronic Field System will be stored on LADOT trucks and will log in a field workers hours, job status (including time stamps) as well as notes about the job such as what the problem was and what equipment was needed to fix it. When the truck is returned to the yard for shift changes, the truck will upload its current data to two centralized databases through Wi-Fi at the truck yard. The first database will be used to upload pay-essential time-keeping information to LADOT S DTIME database via a FLAT file on a bi-weekly basis. The second database will be used to store maintenance information and may be queried by supervisors for maintenance reports by location. Additionally, there will be a web service that will allow changes to be made to reports, tasks to be allocated based on truck GPS locations and management queries. SSAD_DCP_F11a_T08_V3.1.doc 7

13 3.1.1 System Context Figure 4 Future System Context Diagram Table 3 Future System Context Diagram Details Actor Description Responsibilities User A super-type A generalized actor for log-in Task Allocator Person who will be Allocating tasks to trucks choosing which tasks to allocate to certain trucks Department Supervisor A supervisor needing to Query the database for logs create maintenance report logs Field Worker Employees who go to the field and do the work Performs the actual fixing of the defects SSAD_DCP_F11a_T08_V3.1.doc 8

14 3.1.2 Artifacts & Information Figure 5 Future Artifacts and Information Diagram Table 4 Future Artifacts and Information Diagram Details Artifact Issue Job Time Sheet User Truck Location DTime Report This keep a note of one of the issues that were resolved during a job (ex: broken red light on east-facing lamp) It describe a particular task/job allocated to a particular field worker A field worker s hours by day A user of any of the systems (either truck of computer system) depending on their permission attribute A truck that stores it s location for GPS purposes Either a job location (28 th and Figuroa) or the location of a truck, depending on the owner The export file in FLAT format for all the time-sheets on a biweekly basis to be uploaded to LADOT s DTime system. SSAD_DCP_F11a_T08_V3.1.doc 9

15 3.1.3 Behavior Computer System Use-Case Model Figure 6 Future Computer System Use-Case Model As a note, no win-condition requirements are listed for the Computer System Use-Case Model. This is due to the computer system not being a requirement under the current scope of the project View location job history Pre-Conditions DS-01: View location job history Review the jobs that have been performed at a specific location Must be logged into the system with Department Superisor permissions SSAD_DCP_F11a_T08_V3.1.doc 10

16 1 Enter location id 2 Click view 3 Validate id existence 4 Query database for jobs with location id 5 Return table of jobs performed on location chronologically View Own Employee Job History Pre-Conditions DS-02: View Own Employee Job History Review job performance by a certain individual Must be logged into the system with Department Superisor permissions 1 Enter employee id 2 Click view 3 Validate id existence 4 Validate user permission for id 5 Query database for jobs completed by employee id 6 Return table of jobs performed by employee chronologically Login UC-01: Login To log in to the online system 1 Enter username and password 2 Submit data 3 Validate username/password 4 Store user data as encrypted cookie until log out SSAD_DCP_F11a_T08_V3.1.doc 11

17 Logout UC-02: Logout To log out of the online system Must be logged into the online system 1 Click logout button 2 Remove user cookie View Maintenance Report FW-01: View maintenance report Field worker can review their maintenance reports Must be logged in to the online system with field worker permissions 1 Select report to view from list 2 Click View button 3 Displays read-only job summary until Back or Edit button is selected Edit Maintenance Report FC-02: Edit maintenance report Employees must be able to edit reports in case of mistakes Must be logged in to the online system with field worker permissions 1 Select Edit button on view report page 2 Display job page with editable fields 3 Edit fields in need of changing 4 Click Submit button 5 Update changed fields in job database 6 Change page to view report page SSAD_DCP_F11a_T08_V3.1.doc 12

18 Assign Truck Tasks TA-01: Assign truck tasks Allocator needs to be able to assign a truck specific tasks Must be logged in to the online system with task allocator permissions 1 Select a truck from the allocator page 2 Click Assign button 3 Refresh page with only tasks and current truck visible 4 Select task(s) from list to give to truck 5 Click Submit button 6 Allocate tasks to given truck 7 Go back to main allocator page Assign Task to Truck TA-02: Assign task to truck Allocator needs to be able to assign a task to a specific truck Must be logged in to the online system with task allocator permissions 1 Select a task from the allocator page 2 Click Assign button 3 Refresh page with only trucks and current task visible 4 Select truck from list to give to task 5 Click Submit button 6 Allocate task to given truck 7 Go back to main allocator page SSAD_DCP_F11a_T08_V3.1.doc 13