Friday, December 18, 2009

Coding Standards


 Coding Standards:
  1. All the methods name whether it is in java script or java methods start with a small letter and the second word starts with a capital letter.
  2. All the java classes start with a capital letter.
  3. The name of the methods or classes is a verb showing its functionality.
  4.  All the variable names are understandable nouns or verbs.
  5. All the variables have been assigned some default values.
  6. Every function has a description as of what it does and explaining the parameters.
  7. There will be comments in the code whenever it is necessary to describe.
  8. Inline comments to show the end of control statements.
  9. 3 spaces indentation is provided.
  10. As part of file organization , al the css and javascript files are placed in css and js folders respectively besides html codes.
  11. The WEB-INF has classes folder which contains the classes.
  12. Error handling is done using try catch statements of java code.
  13. Where ever necessary we are using the relative path names and not the absolute path names.
  14. When ever there are some reusable components , they are placed in separate file so that they can be included as part of header files.


Traceability Matrix



Traceability Matrix

1-> UI Controller               2->Create case


3->Tagging                         4->View Authored


5->Add Teaching Notes    6->Record Audio


7->Speech to Text converter 8->Questions based on type (Templates)


9->Searching cases             10->Add Multimedia


11->Mail Server


12->Authentication


13->View Case status

The above shows the dependencies among different modules that were identified in the project.
The ‘X’ mark denotes a dependency from a module in that particular row to the corresponding columns.


Deployment View


This is the deployment view of the whole project, these are the things need to be deployed at the server side.


Class Diagram



These are the packages going to be used.


Here add multimedia,  add Questions based on type, Add teaching notes, view status are grouped as single package. The links show the communication.



Architecture description


Architectural Drivers:
Time efficiency (Performance, reusability, plug and play architecture)
Usability.
Portability.
Architecture Style Used:
Three tier architecture, Object oriented with plug and play architecture.
Justification:                
Portability: A web based architecture  enables the portability on all the types of browsers and also Operating system compatible. Hence the three-tiered-Architecture
Resuability: An object oriented approach enables reusability.
Plug and play Architecture: The division of the business tier into two layers one as basic platform and the other for plug and play justifies this architectural driver.

The logical diagram below shows the list of modules and how the various modules communicate among themselves. The software is based on the 3 tier architecture.  The Business Layer is divided into 2 sub layers- Plug and play module Layer and Basic Module Layer. Plug and play module layer helps to add the features based on authors requirement.  The Basic modules are the minimum modules that will be present in case authoring tool. This serves as  platform. Below is the list of all the modules that will be present in the Plug and Play layer.

1.      Speech to Text Converter will be tool that user can install to convert the audio based case description into text there by increasing the productivity of the author.
2.      Record Audio will help author to Record conversation with company people. So that he can later reuse audio for future references and as well as add the audio to the case.
3.      View Tool module is used by users other than author to view the case.
4.      Tagging module is used to create tag for the case and store them in data base.
5.      Searching case makes use of the tags generated by Tagging modules. By using tags we increase the searching efficiency and performance.
6.      Networking modules help to develop the connection to the server from a remote desktop system.
7.      Teaching and scribbling points helps teacher or author to add additional points to help them to store data. This data will be stored in file system.
8.      Add Multimedia is used add multimedia features to the case to make it more lively and interesting to read and understand
Basic Modules includes
  1. Creating case which is further divided into sub modules which are helpful in creating the case.
  2. Authentication module comes under basic module as it is important to verify the author before letting anyone edit/create the existing case. All the authentication details will be stored in the database.
  3. Logging is also an important feature as it helps to keep track of all the activities that the user did.
  4. Registration module is used to get the registration details of the company and the user. All the registration details are stored in the database.


Architecture-Logical Diagram


Conceptual Diagram






This conceptual architecture tells about the various modules that are present in the system and how they communicate with each other. Its an abstract view of the system.
The modules were divided based on the functionalities.
A double arrow indicates a two way communication.




The various modules that were identified and their descriptions are as follows:
1. User Interface Controller: This is the controller for the user Interface. This enables communication with various other modules.
2. Questions Based on type (Template): This brings some predefined questions, in the form of template based on the type of case study.
3. Tagging: The main goal of this module is allow to Tags to Added to the Case. This can be used latter for searching and designing the template.
4. Searching: This enables the teacher to search for cases in the existing using tags.
5. Add Multimedia: This enables to add images, Audio and video to enrich the events.
6. Speech To Text Converter: The main goal of this module is to convert a given audio into text format.
7. View Authored: The main goal of this module is allow to author to check how the case written looks immediately while editing.
8. Mail Server: This module enables to send mails.
9. Teaching Notes: This module enables the author can who add teaching notes at any point of time, which will be useful for both students and author.
10. Record audio: This module enables the author to record the audio.
11. Authentication: This module enables only authenticated users use the system.
12. Create Case: This enables to create a new case or edit a new case by adding or deleting actors, events, narrations.
13. View Case status: This module enables the user to know the status of all the cases he is undertaking.



Use case Descriptions


1.
Use case Name:
Request for the  conversion of speech to text

Actors Involved:
Author, Speech to text converter

Use case Description:
The main goal of this functionality is to convert a given audio into text format.
Pre Conditions:
NA
Post Conditions:
1. After the conversion, the document should be saved in database.
Basic Flow:
1. The author should add audio files.
2. Then should request to convert the audio to text.
3 . Then he can view the converted data.
Alternate Flow:
Indicates error in conversion and terminates conversion.
2.
Use case Name:
Request Company profiles
Actors Involved
Author
Use case Description:
This is used to fill the details of company.
Pre Conditions:
1.       There should be list of questions to fill in the details
2.       The author should be logged in.
Post Conditions:
submitted data should update  the database.
Basic Flow:
1.            When the author has to fill the company profiles, there a predefined  questions should be answered.
2.            After completion, he can submit details.

Alternate Flow:
Shows errors if compulsory fields are empty.

3.
Use case Name:
  Request Documents
Actors Involved
Author, Project Team, Email server
Use case Description:
This enables the author to request the project team of required documents.
Pre Conditions:
The Author should be logged in to the system
Post Conditions:
The sent documents are stored in database.
Basic Flow:
1. The author requests the required documents from project team.
Alternate Flow:
NA
4.
Use case Name:
Adding references         
Actors Involved
Author
Use case Description:
This enables the author to provide useful  references for future use
Pre Conditions:
The author should be logged in.
Post Conditions:
The listed references are stored in database.
Basic Flow:
The author while authoring can add references in the available section.
Alternate Flow:
NA






5.
Use case Name:
Add questions                                  
Actors Involved
Author
Use case Description:
This enables the author to prepare fact sheet based on these question.
Pre Conditions:
1. The author should select the type of the case.
2.  Based on the type of case there are questions in the database.
3. The author should be logged in
Post Conditions:
The responses should be updated in database.
Basic Flow:
1. The author should first select  the type of case.                   2 .Then should answer them and update them.
Alternate Flow:
NA

6.
Use case Name:
Update Company profile
Actors Involved
Author
Use case Description:
This enables the author to update the information already present.
Pre Conditions:
  1. The basic information should be present in the database.
  2. The author should be logged in.
Post Conditions:
The database is updated.
Basic Flow:
1 . The author can visit the profile page.
2 .Make required changes.
3. Update changes.
Alternate Flow:
An error that updating has been failed.

7.
Use case Name:
Adding Narration
Actors Involved
Author
Use case Description:
Author can add narration or description for every event in the case study.
Pre Conditions:
1.Author must select a type of case study and create an event to add narration.
2. The author must be logged in.
Post Conditions:
After the narration is given by author, it must be saved in the database.
Basic Flow:
1.       Author will select the type of case study he wants.
2.      The Author will create an event in the case study.
3.       He can add narration to that event.
4.      This narration is stored in the database.
Alternate Flow:
An error is indicated showing the failure of update.

8.
Use case Name:
Adding Multimedia.
Actors Involved
Author
Use case Description:
Author can add images, videos and audio to any event in the case study.
Pre Conditions:
1. Author must select a type of case study and create an event to add multimedia content.
2. The author should be logged in.
Post Conditions:
The images, videos and audio must be stored in the database.
Basic Flow:
1. The Author will select the type of case study.
2. He will create an event.
3. Then he can add images, videos or audio to that event.
4.  This multimedia content will be stored in the database.
Alternate Flow:
An error is indicated showing the failure of update.
               
9.
Use case Name:
Review Case.
Actors Involved
Author
Use case Description:
Author can review the case at any point in the process of creating the case study.
Pre Conditions:
The Author should be logged in.
Post Conditions:
After author selecting this option the data must be retrieved from the database and presented on the screen.
Basic Flow:
1. The Author will select the type of case study.
2.  He fills the required information like company profile and series of events in the case study.
3.  He can review the case at any point by clicking the preview button, it shows the work completed till that point of time.
Alternate Flow:
An error is indicated showing the failure of update.

10.
Use case Name:
Add Actors
Actors Involved
Author
Use case Description:
Author can add actors in the case study i.e. stakeholders in the project. He can add the actors for each event.
Pre Conditions:
1. Author must select a type of case study and create a series of events to add actors to those events.
2.The author should be logged in.
Post Conditions:
The author enters required information about the actor like name, organization,   position and can upload image also. So these data must be stored in the database.
Basic Flow:
1.       The Author will select the type of case study.
2.      He will create series of events and add narration or multimedia content.
3.      He can also add actors to those events and after adding these actors, the data must be stored in the database.
Alternate Flow:
An error is indicated showing the failure of update.

11.
Use case Name:
Add events
Actors Involved
Author
Use case Description:
Author can add scenes or events in the case study. After adding events, he can add any kind of content to every event   in the case study.

Pre Conditions:
  1. Author must select a   case study and create a series of events.
  2. The author should be logged in.
Post Conditions:
The author enters information about the scene like name and description. So these data must be stored in the database.

Basic Flow:
1.       The Author will select the    case study.
2.      He will create event or scene and enters name and description to it. This data must be stored.
Alternate Flow:
An error is indicated showing the failure of update.

12.
Use case Name:
Rearrange events
Actors Involved
Author
Use case Description:
After adding   events, he can rearrange the events by  moving them  Up or down in the case study.
Pre Conditions:
  1. Author must have some set of scenes already created in the case study.
  2. Author must be logged in.
Post Conditions:
After the events are rearranged the changes must be reflected in the database.
Basic Flow:
1.       The Author will select the type of case study.
2.            He will create event or scene and enters name and description to it. This data must be stored.
3.            After adding scenes, he can rearrange scenes which should be reflected in the database.
Alternate Flow:
NA




13.
Use case Name:
Delete  Events
Actors Involved
The main goal of this functionality is to remove unwanted s Events.

Use case Description:
The main goal of this functionality is to remove unwanted events.
Pre Conditions:
  1. Minimum one event to be should be present.
  2. The author should be logged in.
Post Conditions:
After the conversion, the document should be saved in database.
Basic Flow:
1. The author should select the desired event.
2. Then the author can delete the event
Alternate Flow:
Indicates error if no event is present

14.
Use case Name:
Scribble points
Actors Involved
Author
Use case Description:
The main goal of this functionality is to allow the author to add the points that he might like use while teaching.

Pre Conditions:
  1. The author should be logged in.
Post Conditions:
After the author has scribbled the points the scribbled points will be saved in database.
Basic Flow:
1.            Author will open scribble pad.
2.            Then the author can add the points in scribble pad.
3.            Then author can save the points.

Alternate Flow:
 Indicates error if point already exits.


15.
Use case Name:
View authored
Actors Involved
Author, Viewing tool
Use case Description:
The main goal of this functionality is allow to author to check how the case written looks immediately while editing.
Pre Conditions:
1         Some data on case should be present/ complete case should be present.
  1. The author should be logged in.
Post Conditions:
After clicking the view option author will be able to view the case.
Basic Flow:
1. The author should select the desired case.
2. Then the author can view the desired.
Alternate Flow:
Indicates error if no case is selected.

16.
Use case Name:
Add tags
Actors Involved
Author, Tag manager

Use case Description:
The main goal of this functionality is allow to Tags to Added to the Case. This can be used latter for searching and designing the template.
Pre Conditions:
  1. Some data on case should be present/ complete case should be present.
  2. The author should be logged in.
Post Conditions:
  1. After saving the complete case will be tagged.
  2. The tags are stored in database.
Basic Flow:
1.  The author should select the desired case.
2.  Then the author will forward the case to tag manger to create and manage tags.
Alternate Flow:
:Indicates error if no case is selected.


17.
Use case Name:
Request for the  conversion of speech to text

Actors Involved:
Author, Speech to text converter

Use case Description:
The main goal of this functionality is to convert a given audio into text format.
Pre Conditions:
NA
Post Conditions:
1. After the conversion, the document should be saved in database.
Basic Flow:
1. The author should add audio files.
2. Then should request to convert the audio to text.
3 . Then he can view the converted data.
Alternate Flow:
Indicates error in conversion and terminates conversion.



18.
Use case Name:
Add Decision-Making Points
Actors Involved
Author
Use case Description:
Author will have a provision for adding decision points, where he can give information like, why this decision has taken and reason ,impact also.
Pre Conditions:
Author must be logged in and create a new case study.
Post Conditions:
NA
Basic Flow:
  1. Author will login and create a new case study.
  2. After adding some events and he can take some decisions in any event.
  3. He must add some information like, why this decision was taken and reason,impact.
Alternate Flow:
NA



19.
Use case Name:
Teaching Notes
Actors Involved
Author
Use case Description:
Author can add teaching notes at any point of time, which will be useful for both students and author.
Pre Conditions:
Author must be logged in and create a new case study.
Post Conditions:
These teaching notes must be stored in the database.
Basic Flow:
  1. Author will login and create a new case study.
  2. He can add teaching notes at any point.
  3. This notes must be stored in the database.

Alternate Flow:
NA


20.
Use case Name:
Create Case
Actors Involved
Author
Use case Description:
Author will have an option to create case study and can add events, actors, narration etc.
Pre Conditions:
Author must be logged in.
Post Conditions:
The template must appear to create the case writing  with necessary functionality.
Basic Flow:
  1. Author will login and create a new case study.

Alternate Flow:
NA


21

               
Use case Name:
Login
Actors Involved
Author
Use case Description:
This enables the user to login into the system.
Pre Conditions:
The user should be a registered one.
Post Conditions:
The user should be able to view his home page on successful authentication.
Basic Flow:
  1. the user should be registered.
  2. He should enter his user id and password and is authenticated.
  3. Then the home page should appear.
Alternate Flow:
An error indication of either invalid user or password is indicated.
22.
Use case Name:
Register
Actors Involved
Author
Use case Description:
This enables the user to register and then login to access the system.
Pre Conditions:
NA
Post Conditions:
Details are stored in the database
Basic Flow:
  1. The user goes to the registration form and fills in some basic details.
  2. Submits the details.
  3. Details are successfully updated.
Alternate Flow:
An error indication is mandatory fields are empty.
23.
Use case Name:
Record audio
Actors Involved
Author
Use case Description:
This enables the author to record the audio.
Pre Conditions:
The author should be logged in.
Post Conditions:
The wav file is created and saved.
Basic Flow:
  1. The user should be logged in to the system.
  2. When he wants to record the audio, he uses it and when he presses stop, a wav file is generated and saved.
Alternate Flow:
An error is indicated.

24.
Use case Name:
Search cases
Actors Involved
Teacher
Use case Description:
This enables the teacher to search for cases in the existing.
Pre Conditions:
The cases should be present.
Post Conditions:
Search results are displayed.
Basic Flow:
The teacher can search for some key words and get the results.
Alternate Flow:
An error is indicated.