System/Software Architect. Description (SSAD)

Transcription

1 System and Software Architecture Description (SSAD) BlackProfessionals.net Team 6 Tian Xiang Tan Sadeem Alsudais Jhih-Sheng Cai Aril Alok Jain Pablo Ochoa Jeng-Tsung Tsai Po-Hsuan Yang Project Manager IIV & V System/Software Architect Engineer Prototyper Operational Concept Engineer Life Cycle Planner October 13, 2014 i

2 Version History Date Author Version Changes made Rationale 10/13/14 JC 1.0 Original template for use with Instructional ICM-Sw v1.0 Initial draft for use with Instructional ICM-Sw v1.0 SSAD_Architected_f14_team06v1.0.doc ii

3 Table of Contents System and Software Architecture Description (SSAD)... i Version History... i Table of Contents... iii Table of Tables... iv Table of Figures... v 1. Introduction of the SSAD Status of the SSAD System Analysis System Analysis Overview System Analysis Rationale SSAD_Architected_f14_team06v1.0.doc iii

4 Table of Tables Table 1: Actors Summary... 3 Table 2: Artifacts and Information Summary... 4 Table 3:... 5 Table 4:... 6 Table 5: Exceptional Course of Action... 6 SSAD_Architected_f14_team06v1.0.doc iv

5 Table of Figures Figure 1: System Context Diagram... 2 Figure 2: Artifacts and Information Diagram... 4 Figure 3: Process Diagram... 5 SSAD_Architected_f14_team06v1.0.doc v

6 1. Introduction 1.1 of the SSAD The purpose of the SSAD is to document the results of the object-oriented analysis and design (OOA&D) of the system, BlackProfessional.net, being developed. SSAD is used for different stakeholders as followed: 1. Prentice Parr Jr., Clients, use it to help understand the structure of the system once the proposed system is delivered. 2. Prentice Parr Jr., Maintainer, use it to help understand the structure of the system once the proposed system is delivered. 3. Team 06 of CSCI577a Fall 2014, programmer (builder), as reference to the system architecture. The system being developed should be faithful to the architecture specified in the SSAD. This document will be accompanied throughout the entire development process of the project, and will be maintained tightly. See Section 1.2 for the latest document status. 1.2 Status of the SSAD The SSAD is currently at version 1.0, released by October 13, under the maintenance of Jhih- Sheng, Cai, the system/software architect of development team. The present development phase is in the Valuation phase. SSAD_Architected_f14_team06v1.0.doc 1

7 2. System Analysis 2.1 System Analysis Overview The primary purpose of the BlackProfessional.net is to improve professional growth of people belonging African-American community. The BlackProfessional.net can let end-users (individuals or companies) create profiles to search or be searched easily, and provide messaging function to let end-users communicate with each other directly and easily. Besides, system can generate recommendations that either people end-users may know or companies that they may be interested in can increase end-users engagement opportunities. Furthermore, they can see the social feed from their friends in the website and recent activity of them. The system can also let them invite their friends to join BlackProfessional.net, and they can advertise on the website System Context Figure 1: System Context Diagram SSAD_Architected_f14_team06v1.0.doc 2

8 Actor Description Responsibilities Administrator An executive/managerial staff of this website. The administrator can approve advertisement, and modify website if needed. 1. Put on/off advertisements. 2. Maintain website, and modify website if needed. User Academic advisor Company Head hunter User who come to look for help, jobs. Staff in school comes to provide school information and recruit skilled students or professionals. HR in company come to provide job information and recruit skilled students or professionals Company comes to find Professionals in specific area. Table 1: Actors Summary 1. Look for help or provide help to other users. 2. Find job opportunity 1. Provide students and professor school information. 2. Recruit skilled students or professionals. 1. Provide students and professor company information. 2. Recruit skilled students or professionals. 1. Recruit skilled professionals for other companies. SSAD_Architected_f14_team06v1.0.doc 3

9 2.1.2 Artifacts & Information Figure 2: Artifacts and Information Diagram Artifact User_Profile Message Connection Post Commend Advertisement Recommendation letter Request Group This table contains users information, including name, company information, skill sets and contact information. This table contains all users pass message, including contact information and message. This table contains users friends list, subscribe companies list. This table contains user s old post. This table contains commends that user commend on posts. This table contains record and status of every application for Advertisement, and the information about advertisement. This table contains recommendation history of all users, including recommender, context, date, user s information. This table contains users request about friendship or follow users or groups. This table contains group name and user that in that group. Table 2: Artifacts and Information Summary SSAD_Architected_f14_team06v1.0.doc 4

10 2.1.3 Behavior Authentication Login Figure 3: Process Diagram Table 2: UC-1: Login Authorize the user to log in the system and assign the user associated system role, such as students or companies. The user is currently on Login page. User is authorized, and will be given access to system operations appropriate to his/her role. Otherwise, the user is denied. SSAD_Architected_f14_team06v1.0.doc 5

11 Table 3: 1 Enter username and password, and click login button. 2 Send username and password to BlackProfessional.net login checking system. 3 Redirect user to the corresponding role s main page. Table 5: Exceptional Course of Action 1 Same as typical course of action 1 to 3. 2 Redirect user to a new login page with notification of message: Username or password is wrong. Please try again Logout UC-2: Logout Log out current user and remove the sessions of current user s. The user has logged in and currently on any page. The user logouts the system. 1 Click log out button. 2 Remove the session of current user, and redirect the page to a new login page. There is no Exceptional or Alternative Courses of action. Blank fields are treated as wrong username or password. SSAD_Architected_f14_team06v1.0.doc 6

12 Profile management Create profile UC-3: Create profile User can have present on BlackProfessionals.net WC_3393 WC_3182 WC_3181 WC_3180 WC_3169 User click create account button in login page. User creates a new profile. 1 Click create account button. 2 Redirect to create account page. 3 User fill in all required and part or none of non-required column, and click submit button. 4 System sends data to account management system, and redirect user to Home page. Alternate Course of Action 1 Same as typical course action 1 to 2 2 User click cancel button. 3 System redirect user to welcome page. Exceptional Course of Action 1 Same as typical course of action 1 to 3 2 System sends data to account management system, but system detects violation of requirement. Redirect user to create account page to continue modify information with error massage shows on the top: Invalid information in red column or required column no fulfilled. SSAD_Architected_f14_team06v1.0.doc 7

13 Import Profile from LinkedIn UC-4: Import profile from LinkedIn User can import data from LinkedIn in to fulfill user profile. WC_3393 WC_3180 User click import from LinkedIn User import profile data to fulfill column in profile page. 1 Click import from LinkedIn button 2 Redirect to pages to LinkedIn login page. 3 User type in LinkedIn login information. 4 Show message: Do you want to import personal data from LinkedIn to BlackProfessionals.net? 5 Click import data. 6 System automatically import personal data from LinkedIn to fulfill all columns that user have in LinkedIn which also in our create profile page. Exceptional Course of Action 1 Same as typical course of action 1 to 3. 2 System cannot detect user in LinkedIn and return to create profile page Create Short Summary for Profile UC-5: Create short summary for profile. User can generate customized short summary. WC_3181 SSAD_Architected_f14_team06v1.0.doc 8

14 User click edit summary button. User get customize summary in profile page. 1 Click edit summary button. 2 Redirect to pages to edit summary page. 3 Users click on information they want to show in summary, and click submit. 4 Show the preview of summary and show massage: Do you want to upload your summary? 5 Click yes button. 6 Direct page to profile management page with new user summary. Alternative Course of Action 1 Same as typical course of action 1 to 4. 2 Click cancel button. Return to edit summary page. Exceptional Course of Action 1 Same as typical course of action 1 to 2. 2 Click cancel button. Return to profile management page Upload Profile Picture UC-6: Upload profile picture. User can upload profile picture. WC_3169 User click edit profile picture button. User get change of picture in profile page. SSAD_Architected_f14_team06v1.0.doc 9

15 1 Click edit profile picture button. 2 Redirect to pages to edit profile picture page. 3 Users choose picture source and click upload button. 4 Show upload picture in profile page. Exceptional Course of Action 1 Same as typical course of action 1 to 2. 2 Click cancel button. Return to profile management page Message Send Message UC-7: Send message User can send message to others. WC_3168 User has connection to each other, and in the message page. Users send message to others. 1 Select which user he/she wants to send message to, and click send a new message button. 2 Popup with send message page. 3 Type in message receiver, finish content, and click send message button. 4 Send message to correspond user, and return to message page. SSAD_Architected_f14_team06v1.0.doc 10

16 Alternate Course of Action 1 Same as typical course of action 1 to 2 3 Click cancel button. 4 Return to message page. Exceptional Course of Action 1 Same as typical course of action 1 to 3 2 Can t send message because receivers don t exist or empty context is detected, return to message page Recommendation Get recommendation UC-8: Get recommendation User can have present on BlackProfessionals.net WC_3173 Risk of generating appropriate algorithm is high. User login and is in home page. Remind in home page. 1 System generates 3 recommendation. 2 User click on the link provided by system including people, professionals. 3 Redirect user to correspond user profile. 4 User click add friend. 5 System reacts to correspond action and redirect to home page. SSAD_Architected_f14_team06v1.0.doc 11

17 Alternate Course of Action 1 Same as typical course of action 1 to 3 2 User is not interested in that recommendation, and leaves that page. 3 System reacts to what user s request Search General Search Functionality UC-9: General search functionality. User can search other users based on certain parameters WC_3183, WC_3423, WC_3424 User is logged-in User gets a list of results based on search parameters.. 1 User types in a "string" (can be job title, another users name, company/school name, other attributes) in the search bar at the top of any page and hits Search button. 2 Return a list of matching search results on a different page (result page). Alternate Course of Action 1 User types in a "string" (can be job title, another users name, company/school name, other SSAD_Architected_f14_team06v1.0.doc 12

18 attributes) in the search bar at the top of any page and hits Search button. 2 If there are no matching results show a message "No Results Found" on the result page. Exceptional Course of Action 1 User tries to hit the search button after putting an empty string in search bar. 2 Search button is disabled till a nonempty string is entered in search bar Advanced Search Functionality UC-10: Advanced Search functionality. User can search other users based on certain parameters. WC_3183, WC_3423, WC_3424 Implementing all the advanced search options the clients expects and making them part of search algorithm. User is logged-in. User gets a list of results based on search parameters. 1 User presses the advanced search button. 2 User is redirected to an advanced search page where several options to fine-tune the search are available. 3 User selects one or more fine tuning options and gives a nonempty string of keywords. 4 Return a list of matching search results on a different page (result page). SSAD_Architected_f14_team06v1.0.doc 13

19 Alternate Course of Action Same as steps 1-3 of Typical course of action. 4 If there are no matching results show a message "No Results Found" on the result page. Exceptional Course of Action Same as steps 1-2 of Typical course of action 3 User enters an empty-string of keywords. 4 Search button is disabled till a nonempty string is entered in "Keyword(s)" bar Advertisement Company Apply for Advertisement UC-11: Company applies for advertisement. Company can apply for advertising. Company in application form page of advertisement. System record application and report to administrator. 1 User fills all required column in the page and hit submit button. 2 System record the information, and show Submit application successfully SSAD_Architected_f14_team06v1.0.doc 14

20 Exceptional Course of Action 1 User fills all required column in the page and hit submit button. 2 System detects that there is a same record of advertisement in our database, and show message System detects that you have submitted the same application before in time (last record), do you want to submit new version of application? 3 User chooses yes button. 4 System record new version of application with different submit time Approve for Advertisement UC-12: Approve for advertisement. Administration can approve or disapprove for advertisement application. WC_3176 User is logged-in as administrator, and in Approve Application page. User approve on advertisements to be showed in website. 1 User click on a list of advertisements he/she wants to approve and click approve button. 2 System pop up confirm window to show Do you want to approve advertisement of (companies name)? 3 User clicks yes. 4 System record the changes and SSAD_Architected_f14_team06v1.0.doc 15

21 allow.changed advertisement to be showed on the website. Exceptional Course of Action 1 User click on a list of advertisements he/she wants to approve and click approve button. 2 Data was not found in database, and system pop up window shows The record of (company s name) does not exist, and redirect user to Approve Application page Modes of Operation BlackProfessional.net will operate in only one mode, so there is no additional information concerning modes of operations provided. 2.2 System Analysis Rationale The following is the Analysis Rationale section for the BlackProfessional.net project: Users - these users include students, professionals, head hunters, and schools. These users require authentication in order to access the system with various permissions and functionalities based on the type of user. SSAD_Architected_f14_team06v1.0.doc 16