System and Software Architecture Description (SSAD)

Transcription

1 System and Software Architecture Description (SSAD) Transportation Grant Fund Database Team #14 Team Members Muruganantham Raju Kirill Khistyaev Karim Sacre Reza B Far Stephan Rice Zhanna Seitenova Ayman Khalil Roles Primary Project Manager Software Architecture Prototyper IIV&V IIV&V Life Cycle Planner Operational Concept Engineer SSAD_FCP_F11a_T14_V1.4

2 Version History Date Author Version Changes made Rationale 10/10/11 KK 1.0 SSAD for CoreFCD Initial version of the SSAD 10/14/11 KK 1.1 Projects Log attributes are added in Figure 2: Artifacts and Information Diagram The associations from Project Log, Project Schedule, and Project document to Project Profile were changed in Figure 2: Artifacts and Information Diagram User management related Use-Cases in Figure 3: Process Diagram 10/19/11 KK 1.2 Send and Export Projects Information Use-Cases are added in Figure 3: Process Diagram New Actor External Website is added to the System Context diagram 10/24/11 KK 1.3 Stereotype <<evolutionary>> added for External Website in the System Context diagram Pre-condition page added for the Login Use-Case KK 1.4 Project management Use-Cases changed in Figure 3: Process Diagram Changes according to feedback from TAs and evaluators are done Changes according to feedback from TAs, Clients and evaluators are done Changes made based on the ARB comments Changes made based on the ARB comments SSAD_FCP_F11a_T14_V1.4 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... vi 1. Introduction of the SSAD Status of the SSAD System Analysis System Analysis Overview System Context Artifacts & Information Behavior Modes of Operation System Analysis Rationale NDI/NCS Interoperability Analysis Introduction COTS / GOTS / ROTS / Open Source / NCS Connectors Legacy System System Structure Evaluation Summary SSAD_FCP_F11a_T14_V1.4 iii

4 Table of Tables Table 1: Actors Summary... 4 Table 2: Artifacts and Information Summary... 5 Table 3: Process Description (Login)... 7 Table 4: Typical Course of Action (Login)... 7 Table 5: Alternate Course of Action (Login)... 7 Table 6: Process Description (Logout)... 8 Table 7: Typical Course of Action (Logout)... 8 Table 8: Process Description (Add User)... 8 Table 9: Typical Course of Action (Add User)... 9 Table 10: Alternate Course of Action (Add User)... 9 Table 11: Process Description (Edit User)... 9 Table 12: Typical Course of Action(Edit User)... 9 Table 13: Alternate Course of Action(Edit User) Table 14: Process Description (Delete User) Table 15: Typical Course of Action (Delete User) Table 16: Alternate Course of Action (Delete User) Table 17: Process Description (View Users) Table 18: Typical Course of Action (Add User) Table 19: Process Description (Create Project) Table 20: Typical Course of Action (Create Project) Table 21: Alternate Course of Action (Create Project) Table 22: Process Description (Edit Project) Table 23: Typical Course of Action (Edit Project) Table 24: Alternate Course of Action (Edit Project) Table 25: Process Description (Delete Project) Table 26: Typical Course of Action (Delete Project) Table 27: Alternate Course of Action (Delete Project) Table 28: Process Description (Get Project Information) Table 29: Typical Course of Action (Get Project Information) Table 30: Alternate Course of Action (Get Project Information) SSAD_FCP_F11a_T14_V1.4 iv

5 Table 31: Process Description (View Projects) Table 32: Typical Course of Action (View Projects) Table 33: Alternate Course of Action (View Projects) Table 34: Process Description (Edit Project Financial Information) Table 35: Typical Course of Action (Edit Project Financial Information) Table 36: Alternate Course of Action (Edit Project Financial Information) Table 37: Process Description (Generate Report) Table 38: Typical Course of Action (Generate Report) Table 39: Alternate Course of Action (Generate Report) Table 40: Process Description (Attach Document) Table 41: Typical Course of Action (Attach Document) Table 42: Process Description (Download Document) Table 43: Typical Course of Action (Download Document) Table 44: Process Description (Delete Document) Table 45: Typical Course of Action (Delete Document) Table 46: Alternate Course of Action (Delete Document) Table 47: Process Description (Request Projects Information) Table 48: Typical Course of Action (Request Projects Information) Table 49: Alternate Course of Action (Request Projects Information) Table 50: Process Description (Send ) Table 51: Typical Course of Action (Send ) Table 52: Alternate Course of Action (Send ) SSAD_FCP_F11a_T14_V1.4 v

6 Table of Figures Figure 1: System Context Diagram... 4 Figure 2: Artifacts and Information Diagram... 5 Figure 3: Process Diagram... 6 SSAD_FCP_F11a_T14_V1.4 vi

7 1. Introduction 1.1 of the SSAD The purpose of the SSAD document is to provide the analysis of the operational concept, design the architecture, and design the implementation of the Transportation Grant Fund Database (TGFD) System. It serves as a bridge linking between the inception and the construction phases by providing the in-depth architectural design and implementation of the proposed system. The initial version of the SSAD document consists of the description of system analysis, behavior, and modes of operation of the TGFD. 1.2 Status of the SSAD The current version of the SSAD is 1.0 and it is at the beginning of the Valuation phase. At this point, only the Introduction, System Context, Artifacts, Behavior, Capabilities sections are filled out with preliminary information and relevant Context Diagrams, Use Case Diagrams & Class Diagrams. WinWin negations are not finished yet. Thus this document reflects current understanding of the developing system. SSAD_FCP_F11a_T14_V1.4 1

8 SSAD_FCP_F11a_T14_V1.4 2

9 2. System Analysis 2.1 System Analysis Overview The TGFD system to be built is a web based Content and Document Management System. Users who will be using the system are LADOT employees who are responsible for Transportation Grant Fund process. The system to be delivered intends to automate the transportation grant fund project reporting process. This will centralize the information and documents of all the projects in one database, help to create various reports related to the projects, help to enforce data integrity rules, provide easy access to all the projects data and documents through the web browser interface and finally enhance the productivity of the employees. The system will improve communication between project participants through the both manual and automated messages System Context Figure 1 shows the operational context of the TGFD system. SSAD_FCP_F11a_T14_V1.4 3

10 Figure 1: System Context Diagram Table 1: Actors Summary Actor Description Responsibilities TGFD User General type of the system Browse through the projects user Retrieve required projects information Generate reports Download project documents Administrator Project Manager A superuser able to administrate the system A project manager of the certain projects in the system Create, edit and delete users Assign users roles and permissions Create new projects Manage own projects: edit all the data except financial (accounting) information Upload project documents Accountant LADOT Accountant Edit project financial (accounting) information External Website External website that requests projects information in XML format from the TGFD system and shows it to the public. External means that this site is not the part of the system. Request projects information through the XML interface SSAD_FCP_F11a_T14_V1.4 4

11 2.1.2 Artifacts & Information Figure 2: Artifacts and Information Diagram Table 2: Artifacts and Information Summary Artifact ATF-1: Role ATF-2: User Profile ATF-3: Project Profile ATF-4: Report ATF-5: Project Schedule ATF-6: Project Document ATF-7: Project Log ATF-8:Project Change Role is assigned by administrator to every user and determines the permissions of the user. System has fixed number of roles with fixed permissions. User Profile contains all the information about user: name, password, Role, , current status (active or disabled), etc. Project Profile contains all the information about the project: title, owners of the project, schedule, and attached documents. Can be edited by the owners with appropriate permissions. Report contains determined information about selected projects with fixed formatting or as an xml file. Report is generated by certain user from the information retrieved from projects profiles. There are several fixed report types in the system. Project Schedule contains the schedule of the project: start date, estimated end date, actual end date, etc. Project document is a document of any type attached to a certain project. Project Log contains a collection of Project Changes which contain information about the change of the project data Project Change includes the date and description of the project change event SSAD_FCP_F11a_T14_V1.4 5

12 2.1.3 Behavior The following Use-Case Diagram shows the 18 processes that were identified when analyzed the capabilities described in the OCD were analyzed. Figure 3: Process Diagram SSAD_FCP_F11a_T14_V1.4 6

13 Authentication Login Table 3: Process Description (Login) UC-1: Login Authorize the user to log into the system, and, if so, assign role and privileges. WC_978: Implement user authentication method WC_397: Role Based (RBAC) and Data Level Security Advanced security protocols may be required User is connected from LADOT intranet. User is at the Login Page If user is successfully authorized he is redirected to the Projects View or Administration page. He can use the system according to his role. Otherwise access is denied and he is redirected to the Login page. Table 4: Typical Course of Action (Login) 1 Enter username and password 2 Clicks the Login button 3 Verify username and password 4 Redirect the user to the Administration if user is an Administrator. Otherwise redirect to the Projects View page. Table 5: Alternate Course of Action (Login) 1 Enter username and password 2 Clicks the Login button 3 Verify username and password 4 Redirect the user to the login page and shoe the message Wrong username or password SSAD_FCP_F11a_T14_V1.4 7

14 Logout Table 6: Process Description (Logout) UC-2: Logout Logout user from the system WC_978: Implement user authentication method WC_397: Role Based (RBAC) and Data Level Security User logged into the system User is logged out from the system and session is terminated Table 7: Typical Course of Action (Logout) 1 User clicks Log Out button 2 Log user out and delete user s session 4 Redirect the user to the log in page Alternate Course of Action for User Logout is not applicable User Management Add User Table 8: Process Description (Add User) UC-3: Add User Add new user to the system and specifies its role. WC_398: user registration to the system must be approved by administrator WC_397: Role Based (RBAC) and Data Level Security WC_977: administrator has a capability to assign fixed roles User is logged in as Administrator. User is in the user management section of the administrative panel. New user added to the system SSAD_FCP_F11a_T14_V1.4 8

15 Table 9: Typical Course of Action (Add User) 1 Click Add User button 2 Redirect to the empty User Form 3 Fill in User Form with new user information and click Submit 4 Check input information for correctness and absence of duplicate names in the database. 5 If information is correct, add new user information to the database 6 Redirect to the user management page Table 10: Alternate Course of Action (Add User) 1-4 Refer to typical course of action 2 If data is incorrect, redirect back to the User Form with corresponding message (e.g. Username already exist ) Edit User Table 11: Process Description (Edit User) UC-4: Edit User Edit user information including assignment of a new role WC_398: user registration to the system must be approved by administrator WC_397: Role Based (RBAC) and Data Level Security WC_977: administrator has a capability to assign fixed roles User is logged in as Administrator. User is in the user management section of the administrative panel. User information has been changed Table 12: Typical Course of Action(Edit User) 1 Click Edit User button 2 Redirect to the User Form filled in with SSAD_FCP_F11a_T14_V1.4 9

16 user data 3 Verify username and password 4 Change user information and click Submit 5 Check input information for correctness and absence of duplicate names. 6 If information is correct, save new user information in the database 7 Redirect to the user management page Table 13: Alternate Course of Action(Edit User) 1-5 Refer to typical course of action 2 If data is incorrect, redirect back to the User Form with corresponding message (e.g. Username already exist ) Delete User Table 14: Process Description (Delete User) UC-5: Delete User Delete existing user from the system WC_397: Role Based (RBAC) and Data Level Security User is logged in as Administrator. User is in the user management section of the administrative panel. User deleted from the system Table 15: Typical Course of Action (Delete User) 1 Click Delete User button 2 Ask for conformation 3 Click confirm 4 Delete user from the database 5 Redirect to the user management page and show the message User [Username] has been deleted SSAD_FCP_F11a_T14_V1.4 10

17 Table 16: Alternate Course of Action (Delete User) 1-2 Refer to typical course of action 2 Click Cancel 2 Return to the user management page View Users Table 17: Process Description (View Users) UC-16: View Users View list of users WC_398: user registration to the system must be approved by administrator WC_397: Role Based (RBAC) and Data Level Security WC_977: administrator has a capability to assign fixed roles User is logged in as Administrator. User is in the user management section of the administrative panel. List of users displayed to administrator Table 18: Typical Course of Action (Add User) 1 Click User Management link 2 Select users data from database 3 Redirect to the User Management Page and show list of users Alternate Course of Action for View Users is not applicable Project Management Create Project Table 19: Process Description (Create Project) UC-6: Create project Create new project in the system SSAD_FCP_F11a_T14_V1.4 11

18 WC_366: Grant information can be tracked by the system. WC_357: all projects should be manageable - budget, schedule, project docs, general project reports generation, individual project and summary of project status User is logged in as a Project Manager. User is at the Projects View page New project created in the system Table 20: Typical Course of Action (Create Project) 1 Click Create New Project button 2 Redirect to the empty Project Form 3 Fill in Project Form with new project information and click Submit 4 Check input information for correctness and absence of duplicate project names in the database 5 If information is correct, create new project and add project information to the database 6 Redirect to the Projects View page Table 21: Alternate Course of Action (Create Project) 1-4 Refer to typical course of action 2 If data is incorrect, redirect back to the Project Form with corresponding message (e.g. Project with such name already exist ) Edit Project Table 22: Process Description (Edit Project) UC-7: Edit project Change project information (except financial information) WC_366: Grant information can be tracked by the system. WC_357: all projects should be manageable - budget, schedule, project docs, general project reports generation, individual project SSAD_FCP_F11a_T14_V1.4 12

19 and summary of project status User is logged in as a Project Manager. User is at the Projects View page Project information was changed Table 23: Typical Course of Action (Edit Project) 1 Click Edit Project button in front of the corresponding project 2 Redirect to the empty Project Form filled in with project information 3 Change project information in Project Form and click Submit 4 Check input information for correctness and absence of duplicate project names in the database 5 If information is correct, save new project information to the database 6 Redirect to the Projects View page Table 24: Alternate Course of Action (Edit Project) 1-4 Refer to typical course of action 5 If data is incorrect, redirect back to the Project Form with corresponding message (e.g. Project with such name already exist ) Delete Project Table 25: Process Description (Delete Project) UC-8: Delete Project Delete existing project from the system WC_366: Grant information can be tracked by the system. WC_357: all projects should be manageable - budget, schedule, project docs, general project reports generation, individual project and summary of project status SSAD_FCP_F11a_T14_V1.4 13

20 User is logged in as a Project Manager. User is at the Projects View page Project deleted from the database Table 26: Typical Course of Action (Delete Project) 1 Click Delete Project button in front of the corresponding project 2 Ask for conformation 3 Click confirm 4 Delete project from the database 5 Redirect to the Projects View page and show the message Project [Project name] has been deleted Table 27: Alternate Course of Action (Delete Project) 1-2 Refer to typical course of action 2 Click Cancel 3 Return to the Projects View page Get Project Information Table 28: Process Description (Get Project Information) UC-9: Get Project information Get project information from the database and show it to the user WC_366: Grant information can be tracked by the system. WC_357: all projects should be manageable - budget, schedule, project docs, general project reports generation, individual project and summary of project status User is logged in. User is at the Projects View page Project information showed to the user SSAD_FCP_F11a_T14_V1.4 14

21 Table 29: Typical Course of Action (Get Project Information) 1 Click on the project name hypertext 2 Find project information in the database 3 If information found redirect user to the Project Details page with project information Table 30: Alternate Course of Action (Get Project Information) 1-2 Refer to typical course of action 2 If project information not found, redirect to the Projects View page and show message Project was not found in the database View Projects Table 31: Process Description (View Projects) UC-10: View Projects View list of all projects (10 per page) or projects selected from the database according to the users criteria WC_366: Grant information can be tracked by the system. WC_357: all projects should be manageable - budget, schedule, project docs, general project reports generation, individual project and summary of project status User is logged in. User is at the Projects View page Projects list showed to the user Table 32: Typical Course of Action (View Projects) 1 Select the criteria (e.g. My Projects) from the dropdown list box or leave the default criteria All Projects 2 Click the button View Projects SSAD_FCP_F11a_T14_V1.4 15

22 3 Find corresponding projects information in the database 4 If information found redirect user to the Project Details page with a list of selected projects Table 33: Alternate Course of Action (View Projects) 1-3 Refer to typical course of action 4 If projects information not found, redirect to the Projects View page and show a message No project satisfies the selected criteria Edit Project Financial Information Table 34: Process Description (Edit Project Financial Information) UC-11: Edit Project Financial Information Change project financial information WC_366: Grant information can be tracked by the system. WC_357: all projects should be manageable - budget, schedule, project docs, general project reports generation, individual project and summary of project status User is logged in as an Accountant. User is at the Projects View page Project financial information was changed Table 35: Typical Course of Action (Edit Project Financial Information) 1 Click Edit Project Financial Information button in front of the corresponding project 2 Redirect to the empty Project Accountant Form filled in with project financial information 3 Change project financial information in Project Accountant Form and click Submit SSAD_FCP_F11a_T14_V1.4 16

23 4 Check input information for correctness 5 If information is correct, save new project financial information to the database 6 Redirect to the Projects View page Table 36: Alternate Course of Action (Edit Project Financial Information) 1-4 Refer to typical course of action 5 If data is incorrect, redirect back to the Project Accountant Form with corresponding message (e.g. Data in the field [Field Name] is incorrect ) Report Generator Generate Report Table 37: Process Description (Generate Report) UC-12: Generate report Generate report of the selected type filled with selected projects WC_370: System can create progress reports Complicated format of the reports User is logged in. User is at the Projects View page Projects report showed to the user Table 38: Typical Course of Action (Generate Report) 1 Select the report type from the dropdown list box 2 Select projects for the report 3 Click the button Generate Report 4 Find corresponding projects information in the database 5 If information found show the report with requested information to the user SSAD_FCP_F11a_T14_V1.4 17

24 Table 39: Alternate Course of Action (Generate Report) 1-4 Refer to typical course of action 5 If projects information not found, redirect to the Projects View page and show a message No selected projects were found in the database Project Document Management Attach Document Table 40: Process Description (Attach Document) UC-13: Attach Document Upload and attach a new document to the project WC_392: Ability to upload (attach) any files to the project User is logged in as a Project Manager. User is at the Project Details page New document uploaded to the server and attached to the project Table 41: Typical Course of Action (Attach Document) 1 Click Attach New Document button 2 Show Choose File dialog 3 Choose a file to be attached 4 Upload file to a server and link to the project in the database 6 Show Project Details page with attached file Alternate Course of Action for Attach Document is not applicable Download Document Table 42: Process Description (Download Document) UC-14: Download Document Download selected document form server to the user workstation SSAD_FCP_F11a_T14_V1.4 18

25 WC_392: Ability to upload (attach) any files to the project User is logged in User is at the Project Details page. Link to the document shown on the Project Details page Document downloaded to the user workstation Table 43: Typical Course of Action (Download Document) 1 Click on the link of the desired document 2 Show Save File dialog 3 Choose location and name and click Save File button 4 Save File on a user workstation Alternate Course of Action for Download Document is not applicable Delete Document Table 44: Process Description (Delete Document) UC-15: Delete Document Delete existing document from the system WC_392: Ability to upload (attach) any files to the project User is logged in as a Project Manager. User is at the Project Details page Deleted deleted from the system Table 45: Typical Course of Action (Delete Document) 1 Click Delete Document button in front of the corresponding document 2 Ask for conformation SSAD_FCP_F11a_T14_V1.4 19

26 3 Click confirm 4 Delete document from the file system and information about it from the database 5 Redirect to the renewed Project Details page without deleted document Table 46: Alternate Course of Action (Delete Document) 1-2 Refer to typical course of action 2 Click Cancel 3 Return to the Project Details page Projects Information Export Request Projects Information Table 47: Process Description (Request Projects Information) UC-17: Request Projects Information External website can request projects information through the HTTP protocol and receive it in XML format WC_382: Ability to export information for the general public (for example xml) External Website has access to the LADOT intranet. XML information provided to the External Website Table 48: Typical Course of Action (Request Projects Information) 1 Send an HTTP request with specified parameters to the System 2 Check the correctness of the request 3 Select requested projects data from the database 4 Form XML with projects data and return it to the External Website SSAD_FCP_F11a_T14_V1.4 20

27 Table 49: Alternate Course of Action (Request Projects Information) 1-2 Refer to typical course of action 2 If request is incorrect return a response Incorrect request System Send Table 50: Process Description (Send ) UC-16: Send Send to selected users WC_376: System has the capability to send out s through the system User is logged in. User is at the Projects View page sent to the selected users Table 51: Typical Course of Action (Send ) 1 Click Send button 2 Redirect to the empty form 3 Choose recipient s and type in the message 4 Click Submit button 5 Check correctness of data 6 Send to the selected users Table 52: Alternate Course of Action (Send ) 1-4 Refer to typical course of action 2 If data is incorrect, redirect back to the Form with corresponding message (e.g. Please specify at least one recipient ) SSAD_FCP_F11a_T14_V1.4 21

28 2.1.4 Modes of Operation The TGFD System is intended to operate in only one mode. Thus, no further information is giving in this section. 2.2 System Analysis Rationale Based on the clients description, the following information about External Website Actor is given: In future clients want to be able to build a website for the general public which will contain information about LADOT projects. In order for this site to be able to pull data from TGFD System that we develop there will be an HTTP interface which will allow retrieving projects information in XML format. Note about Users Profile: User Profile will contain only basic information about the system user (e.g. name, address) and will be populated and managed by admin. Users will not have ability to change their profiles. SSAD_FCP_F11a_T14_V1.4 22

29 SSAD_FCP_F11a_T14_V1.4 23

30 3. NDI/NCS Interoperability Analysis 3.1 Introduction << Identify the Non-al Item (NDI) and Net-Centric Services (NCS) including open source software or libraries that you are using/ plan to use in your project and analyze their interoperability by using istudio tool>> COTS / GOTS / ROTS / Open Source / NCS << Identify all candidate commercial off-the-shelf, government-off-the-shelf, research-off-theshelf, open source software, libraries, and net-centric services component that you are using/ plan to use. Also identify the purpose of each component. >> Table 45: NDI Products Listing NDI/NCS Products s Connectors << Identify the connector, for example - In this project, we use PHP/MySQL Connector to enable the PHP web application to retrieve and query data from the database. >> Legacy System << Identify the connector, for example - In this project, the development system has to be able to interoperate and works well with BusinessWorks version 5.2, which is a software system that the client is currently using. >> 3.2 System Structure << Using istudio to analyze your component interoperability and post the resulting system structure diagram here. >> 3.3 Evaluation Summary << Summarize the final selection of your interoperable NDI/NCS, its usage and its comment. Example can be found in ICM EPG> Task: Provide Architecture Feasibility Evidence.>> SSAD_FCP_F11a_T14_V1.4 24

31 Table 46: NDI Evaluation NDI Usages Comments SSAD_FCP_F11a_T14_V1.4 25