Consolidated Use Cases
From ZenWiki
Contents |
Use Case Model
This use case model shows the allocation of requirement between roles (aka, actors).
The relation between roles is generalization. SMART Member is a generalization of Interview, Analyst and Administrator.
Key: UML
| Use Case Name | Description |
|---|---|
| Sign In | SMART Member needs to sign in the system before performing any other operations. |
| Sign Out | SMART Member can sign out from the system during any give time. |
| Acquire Engagement Data | Prior to any interview phases of a given engagement, the interviewer obtains a copy of the engagement setup data prepared in the Setup Engagement Data use case. |
| Choose Question | During an interview, the interviewer chooses a question in the system as the focus of the discussion. The interviewer browses through the categories of topics, and from which a desired question is located. To quickly locate a question, the interviewer can enter keywords and instruct the system to search the matching questions. The interviewer can also follow a predefined sequence of questions that facilitates a smoother interview session. |
| Record Answer | During an interview, the interviewer records annotations to a selected question. The possible types of annotations include predefined answers, comments, and tags. One possible predefined answer can be "not-applicable". For the purpose of status, a question is considered to be "answered" if one of two mutually exclusive conditions are met. First, if there are one or more predefined answers associated with a particular question, then the question is considered to be "answered" if and only if at least one of the predefined answers has been selected or a comment has been entered. Second, if there are no predefined answers associated with a particular question, then the question is considered to be "answered" if and only if there is a comment entered for that question. A question may be annotated with one or more tags, but applying tags has no effect on the question's "answered" status. The purpose of the tags is for generating templates (Authors' note: Should we distinguish answer from annotation?) |
| Consolidate Interview Data | After each interview phase of a given engagement, the interviewers submit their individual interview data for consolidation. Each interviewer associated with a specific engagement is expected to upload the data they took, however this is not mandated. Once at least two sets of data has been submitted, anyone of the interviewers can explicitly trigger the consolidation. This consolidated interview data can then be obtained by the interviewers. |
| Generate Report | This use case applies to two circumstances: First, during an engagement, the analyst instructs the system to generate reports based on interview data collected so far. The analyst first chooses a report type, such as Current SMIG or Migration issues table, and then the system generates the report. Second, in between engagements, the analyst instructs the system to generate reports based on historical engagements. The analyst selects one report type, such as Draft of final report or List of questions per tag, and then the system generates the report accordingly. |
| Generate Template | Analyst generates two kinds of templates: service table or component table. The format of the templates must be editable. The preferred format is xls but csv is also acceptable. The system is given the templates that are used during interview, and then the system adds new columns to them. The columns are the short names of questions marked with specific tags. |
| Setup Engagement Data | Administrator prepares an engagement by entering information obtained prior to an engagement. The information includes the engagement client organization, type of system under evaluation, profiles of interviewees, the version of the SMIG which will be used, and the set of tags that will be used. |
| Update SMIG Information | Administrator updates SMIG information. It includes the basic create, read, modify and delete operations. The administrator can also promote the updated SMIG into a new version. The system has to keep the old versions of SMIG in order to maintain data consistency for old engagement data. |
| Update Tag List | Administrator updates the default tag list, which is used during Setup Engagement Data. It includes the basic create, read, modify, and delete operations. |
| Register User Account | Administrator registers user account, which can be used in the Sign In use case. Additionally, administrator can modify, delete and reset user account. |
Use Case - SMIG Navigation
Use Case 101: Choose question
| Use case name: | Choose question |
| Unique use case ID: | UC101 |
| Primary actor(s): | Interviewer |
| Secondary actor(s): | None |
| Brief description: | During an interview, the interviewer chooses a question in the ZEN Client as the focus of the discussion. The interviewer browses through the categories of topics, and from which a desired question is located. To quickly locate a question, the interviewer can enter keywords and instruct the system to search the matching questions. The interviewer can also follow a predefined sequence of questions that facilitates a smoother interview session. |
| Preconditions: | The interviwer has signed-in to the ZEN Client. |
| Flow of events: |
|
| Postconditions: | The interviewer has been able to reach the question which was expected |
| Alternative flows and exceptions: |
|
Use Case - Information Gathering
Use Case 201: Enter answer
| Use case name: | Enter answer |
| Unique use case ID: | UC201 |
| Primary actor(s): | Interviewer |
| Secondary actor(s): | None |
| Brief description: | During an interview, once an interviewer selects and loads a question from the SMIG, he/she should be able to select an answer to that question from a list of pre-defined answers within the SMIG. This use case focuses on this ability of the user. |
| Preconditions: | The interviewer has selected and loaded a question from the SMIG. |
| Flow of events: |
|
| Postconditions: | The interviewer records the answer for a particular question. |
| Alternative flows and exceptions: |
|
Use Case 202: Enter comments
| Use case name: | Enter comments |
| Unique use case ID: | UC202 |
| Primary actor(s): | Interviewer |
| Secondary actor(s): | None |
| Brief description: | In addition to selecting an answer for a question, an interviewer may enter a text based comment along with his/her response to the question. This use case focuses on this ability of the interviewer. |
| Preconditions: | The interviewer has selected and loaded a question from the SMIG |
| Flow of events: |
|
| Postconditions: | The interviewer records comments for a particular question |
| Alternative flows and exceptions: |
|
Use Case 203: Tag Question
| Use case name: | Tag Question |
| Unique use case ID: | UC203 |
| Primary actor(s): | Interviewer |
| Secondary actor(s): | None |
| Brief description: | In addition to selecting an answer for a question, an interviewer may choose one or more tags along with his/her response to the question. This use case focuses on this ability of the interviewer. The list of tags are predetermined during engagement setup. Tags are applied per question. |
| Preconditions: | The interviewer has selected and loaded a question from the SMIG |
| Flow of events: |
|
| Postconditions: | The interviewer has been able to tag a question |
| Alternative flows and exceptions: |
|
Use Case 204: Save response
| Use case name: | Save response |
| Unique use case ID: | UC204 |
| Primary actor(s): | Interviewer |
| Secondary actor(s): | None |
| Brief description: | Once the interviewer has entered his/her answer to a particular question along with any optional tags and/or comments, the user should be able to save this data into the Zen tool. This use case focuses on the ability of the interviewer to get the response to a question recorded into the Zen tool via the Zen client. |
| Preconditions: | The interviewer has entered at least an answer or a comment to the subject question. |
| Flow of events: |
|
| Postconditions: | The interviewer's overall response to a question (i.e. answer, tags, and comments) are recorded by the Zen tool. |
| Alternative flows and exceptions: |
|
Use Case - Report Generation
Use Case 301: Generate Report
| Use case name: | Generate Report |
| Unique use case ID: | UC301 |
| Primary actor(s): | Analyst, Interviewer, Notetaker |
| Secondary actor(s): | Interviewer (in case interviewer wants to view data belonging to other engagements) |
| Brief description: |
|
| Pre-conditions: |
|
| Flow of events: |
|
| Post-conditions: |
|
| Alternative flows and exceptions: |
|
Use Case 302: Modify Report
| Use case name: | Modify report |
| Unique use case ID: | UC302 |
| Primary actor(s): | Interviewer, Analyst |
| Secondary actor(s): | Administrator |
| Brief description: | The interviewer or analyst might want to change the details being viewed for the report. He might want to hide an existing column or filter out rows. He might want to sort the results based on some column in the report. |
| Pre-conditions: | The user is logged in to the Zen server via the browser |
| Flow of events: |
|
| Post-conditions: | The report should be re-generated based on the changes made by the user |
| Alternative flows and exceptions: |
Use Case - Interview Status
Use Case 401: Application launch
| Use case name: | Application launch |
| Unique use case ID: | UC401 |
| Primary actor(s): | Interviewer, Note-taker |
| Secondary actor(s): | None |
| Brief description: | When the application is launched (either with a preexisting engagement or a new one), the interview status tool updates its progress display to reflect the portion of the questions in each SMIG category that has already been answered. The progress display for each category will follow the following color code:
|
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | * The progress level in the status tool is initialized. |
| Alternative flows and exceptions: |
If the interviewer double-clicked a saved engagement file, the application will be launched automatically, that engagement will be loaded, and the status tool will be initialized with the engagement's SMIG interview data. |
Use Case 402: Question answered
| Use case name: | Question answered |
| Unique use case ID: | UC402 |
| Primary actor(s): | Interviewer, Note-taker |
| Secondary actor(s): | None |
| Brief description: | When an interviewer answers a question in the SMIG, the status tool is automatically updated to reflect the progress of the engagement.
Note:
|
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | * The progress level in the status tool is updated (increased). |
| Alternative flows and exceptions: |
Instead of marking an answer for a question, an interviewer removes the answer from a previously answered question.
The postcondition is now that:
|
Use Case - Deployment
Use Case 501: ZEN Client Installation
| Use case name: | ZEN Client Installation |
| Unique use case ID: | UC501 |
| Primary actor(s): | User |
| Secondary actor(s): | None |
| Brief description: | At any given time, the SMART Team may choose to install the ZEN Client on a target platform (usually a laptop) for use within a SMART engagement. To do so, a SMART Team member will run an installation program on the target platform. |
| Precondictions: | The computer owner has been verified to be authorized to access and use the ZEN Tool (client, server, and browser). |
| Flow of events: |
|
| Postcondictions: | The computer has the ZEN Client installed, and a unique username and password is associated with this installation. |
| Alternative flows and exceptions: | None. |
Use Case 502: ZEN Client Startup
| Use case name: | ZEN Client Startup |
| Unique use case ID: | UC502 |
| Primary actor(s): | Interviewer, Analyst |
| Secondary actor(s): | None |
| Brief description: | At any time, a user can choose to start the ZEN Client. This can be to process a SMART Engagement, to upload or download data, or to analyze data. |
| Precondictions: | The computer has the ZEN Client installed. |
| Flow of events: |
|
| Postcondictions: | The ZEN Client is successfully initialized. |
| Alternative flows and exceptions: |
|
Use Case 503: ZEN Server Installation
| Use case name: | ZEN Server Installation |
| Unique use case ID: | UC503 |
| Primary actor(s): | Administrator |
| Secondary actor(s): | None |
| Brief description: | In order to support SMART Engagements using the ZEN Tool, the SMART team must set up a ZEN Server. This will involve installing the web server functionality and the database functionality. |
| Precondictions: | None. |
| Flow of events: |
|
| Postcondictions: | The computer has the ZEN Server installed, and it is prepared to support SMART Engagements. |
| Alternative flows and exceptions: | None. |
Use Case 504: ZEN Server Startup
| Use case name: | ZEN Server Startup |
| Unique use case ID: | UC504 |
| Primary actor(s): | Administrator |
| Secondary actor(s): | None |
| Brief description: | The ZEN Server should only need to be started upon initial installation and updates. Startup should make the ZEN Server support the ZEN Client and ZEN Browser online functionality. |
| Precondictions: | The computer has the ZEN Server installed. |
| Flow of events: |
|
| Postcondictions: | The ZEN Server is successfully running. |
| Alternative flows and exceptions: |
None. |
Use Case - Browser/ZEN Server Interaction
Use Case 601: Authenticate Identity
| Use case name: | Authenticate Identity |
| Unique use case ID: | UC601 |
| Primary actor(s): | SMART Member |
| Secondary actor(s): | None |
| Brief description: | Whenever anyone logs onto the website, they go through an authentication process to determine and validate their identity. |
| Preconditions: | The user has access to a web-enabled browser (IE, Firefox, ...). |
| Flow of events: |
|
| Postcondictions: |
|
| Alternative flows and exceptions: |
|
Use Case 602: Generate Report
| Use case name: | Generate Report |
| Unique use case ID: | UC602 |
| Primary actor(s): | Analyst |
| Secondary actor(s): | |
| Brief description: | If a user successfully logs into the web server, he is presented a set of options that include the generation of various engagement reports. |
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | The selected report is displayed to the viewer. |
| Alternative flows and exceptions: |
|
Use Case 603: Manage SMIG
| Use case name: | Manage SMIG |
| Unique use case ID: | UC603 |
| Primary actor(s): | Administrator |
| Secondary actor(s): | |
| Brief description: | If a user successfully logs into the web server, he is presented a set of options that include the management of the SMIG. |
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | The SMIG is updated on the server. |
| Alternative flows and exceptions: |
|
Use Case 604: Manage Tags
| Use case name: | Manage Tags |
| Unique use case ID: | UC604 |
| Primary actor(s): | Interviewer |
| Secondary actor(s): | Administrator |
| Brief description: | If a user successfully logs into the web server, he is presented a set of options that include the management of tags. |
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | Changes to the list of tags is reflected on the server. |
| Alternative flows and exceptions: |
or
|
Use Case 605: Download Data
| Use case name: | Download Data |
| Unique use case ID: | UC605 |
| Primary actor(s): | SMART Member |
| Secondary actor(s): | |
| Brief description: | If a user successfully logs into the web server, he is presented a set of options that include the downloading of data. |
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | Selected data is downloaded to the user. |
| Alternative flows and exceptions: |
Use Case 606: Manage Engagement
| Use case name: | Manage Engagement |
| Unique use case ID: | UC606 |
| Primary actor(s): | Administrator |
| Secondary actor(s): | |
| Brief description: | If a user successfully logs into the web server, he is presented a set of options that includes setting up a new engagement or managing an existing one. |
| Preconditions: |
|
| Flow of events: |
|
| Postcondictions: | None. |
| Alternative flows and exceptions: |
or
or
|
Use Case 607: Consolidate Interview Data
| Use case name: | Consolidate Interview Data | |
| Unique use case ID: | UC607 | |
| Primary actor(s): | Interviewer | |
| Secondary actor(s): | ||
| Brief description: | If a user successfully logs into the web server, he is presented a set of options that includes consolidating interview data. This option allows the user to merge the information from multiple reports associated to a single engagement, and download the consolidated version of the reports. | |
| Pre-conditions: |
| |
| Flow of events: |
| |
| Post-conditions: |
| |
| Alternative flows and exceptions: |
|
Use Case - ZEN Client/ZEN Server Interaction
Use Case 701: Authenticate to Server using ZEN client
| Use case name: | Authenticate to Server using ZEN client | |
| Unique use case ID: | UC701 | |
| Primary actor(s): | Interview, Notetaker | |
| Secondary actor(s): | ||
| Brief description: |
| |
| Pre-conditions: |
| |
| Flow of events: |
| |
| Post-conditions: |
| |
| Alternative flows and exceptions: |
|
Use Case 702: Download Engagement Setup
| Use case name: | Download Engagement Setup | |
| Unique use case ID: | UC702 | |
| Primary actor(s): | Interview, Notetaker | |
| Secondary actor(s): | ||
| Brief description: |
| |
| Pre-conditions: |
| |
| Flow of events: |
| |
| Post-conditions: |
| |
| Alternative flows and exceptions: |
|
Use Case 703: Upload Interview data
| Use case name: | Upload Interview data | |
| Unique use case ID: | UC703 | |
| Primary actor(s): | Interview, Notetaker | |
| Secondary actor(s): | ||
| Brief description: |
| |
| Pre-conditions: |
| |
| Flow of events: |
| |
| Post-conditions: |
| |
| Alternative flows and exceptions: |
|
Use Case 704: Download Consolidated Interview data
| Use case name: | Download Consolidated Interview data | |
| Unique use case ID: | UC704 | |
| Primary actor(s): | Interview, Notetaker | |
| Secondary actor(s): | ||
| Brief description: |
| |
| Pre-conditions: |
| |
| Flow of events: |
| |
| Post-conditions: |
| |
| Alternative flows and exceptions: |
|
Use Case 705: Secure Upload/Download
| Use case name: | Secure Upload/Download | |
| Unique use case ID: | UC705 | |
| Primary actor(s): | Interviewer, Notetaker | |
| Secondary actor(s): | ||
| Brief description: |
| |
| Pre-conditions: |
| |
| Flow of events: |
| |
| Post-conditions: |
| |
| Alternative flows and exceptions: |
|


