Constituency Management System Software Requirements Specification. Team Ready2Code. Team Members Abdul Gaffar Mallanagouda Patil Sameer S Vivekananda

Transcription

1 1 Constituency Management System Software Requirements Specification Team Ready2Code Team Members Abdul Gaffar Mallanagouda Patil Sameer S Vivekananda Project guide Manish Kumar

2 2 Index & Tables 1. Introduction Purpose Scope Definition, Acronyms and Abbreviations References Technologies to be used Overview Overall Description Product Perspective Software Interface Hardware Requirements Communication Interface Product Function User Characteristics Constraints Use-Case Model Survey Architecture Diagram & Database Design Assumption and Dependencies Data Dictionary Assumption and Dependencies Specific Requirements Use Case Report Supplementary Requirements. 25

3 3 1. Introduction 1.1 Purpose The Constituency Management System is comprehensive solution to e- governance so that various constituencies can be managed and a complete solution is obtained. This will have all constituencies managed by respective MLA and each of the funds used/left will be shown. The residents can also complain over any problem they are facing and will have their queries responded. 1.2 Scope The system aim is to provide secure login to each user. To register to the site residents need the Election ID card. Each complaint will be given a Complaint_ID for future reference. The complaint can be forwarded to the respective departments by the MLA s. There will be a chat session once in a week, the residents directly can interact with the MP/MLA s The existing E-Governance system can be integrated with this system. The updates about funds (available and spent) will be available for general public. All the user accounts will be managed by the system administrators only. The system will be available 24x Definitions, Acronyms and Abbreviations J2EE: Java 2 Enterprise Edition is a programming platform part of the Java Platform for developing and running distributed multitier architecture Java applications. JSP: Java Server Pages. XML: Extensible Mark-up Language. DB2: DB2 Database is the database management system that delivers a flexible and cost-effective database platform to build robust on demand business applications. WAS: Web Sphere Application server is an application server that runs business applications and supports the J2EE and web services standards. CMS: Constituency Management System. AJAX: Asynchronous JavaScript and XML. 1.4 References 1. IEEE Standard Format (93) for SRS. 2. J2EE 1.4 Bible. 3. XML 1.1 Bible

4 4 1.5 Tools and Technologies WSAD Development Tool. WAS Web Application Server. Rational Rose UML Designing Tool. J2EE Application Architecture. DB2 Database. XML - Extensible Mark-up Language. 1.6 Overview SRS will include two sections: Overall Description will describe major components of the system, interconnection and external interfaces. Specific Requirements will describe the functions of actors, their role in the system and constraints.

5 5 2. Overall Description Describe the general factors that affect the product and its requirements. 2.1 Product Perspective: HTTP/ HTTPS TCP/ IP For Internet users web pages (XML/JSP) will provide the user interface to citizen and MLA at client Side. Communication between citizen and server is provided through HTTP/HTTPS Protocols. In local network client will be connected to the server through TCP/IP protocol. On the server side web server is used for EJB and database server is for storing the information.

6 6 2.2 Software Interface. Client on Internet/Intranet: Web Browser. Web Server: WAS. Database Server: DB2. Development End: WSAD (J2EE, Java, JavaBeans, JSP, HTML, XML). 2.3 Hardware Requirements: Client Side Processor RAM Disk Space Internet Explorer 6.0 Or Higher. Computer with a 233MHz processor or higher (Pentium processor recommended) 64MB Minimum Minimum1GB Server Side WAS Intel Pentium processor at 500MHz or faster Minimum 512MB physical memory; 1GB recommended Minimum 4GB DB2 Intel Pentium processor at 500MHz or faster Minimum 512MB physical memory Minimum1GB 2.4 Communication Interface: Access of the CMS through Internet will be using HTTP/HTTPS protocol. Access of the CMS within Local Network will be using TCP/IP Protocol.

7 7 2.5 Product Function: Registration of Users: This module will get details from intended users of the System and will register only valid users. Maintenance/Updation: This module will facilitate Admin and other authorized users to add or modify the contents of CMS. Get access: It provides interface to registered users for accessing different information from CMS and also supporting features like raising a request, lodging a complaint, etc. Maintain Logs: Super Admin can keep track of different activities of the users in the system. 2.6 User Characteristics: Every user should have knowledge of computers and working of internet. Users must also have idea about different activities taking place in his or her Constituency. 2.7 Constraints: To understand and use the system user must have knowledge of how activities in Constituencies are carried out. Citizen of one constituency cannot access info about other constituencies. User must have Voter-ID card in order to register with the CMS and access the system. Users without internet facility cannot make use of the system. GUI does not include regional language.

8 8 2.8 Use Case Survey Manage System_Users Set-Severity Complain Handle_Complaint Admin Register Citizen Interact (CHAT) MLA CM Update Get_Info View_Details Information Use Case Diagram Administrator: Administrator is responsible for managing different users of the system, viewing logs, and other functionalities of the proposed system. The other functionalities which come under administrator are as follows:- Add or Remove Users: The Administrator can Add a user to the system, or Remove the existing user. He can set the access privileges for different users depending on their role in the system. Update: Administrator has privileges of updating the system by adding a component to the system or removing a component from the system. He will be having full right to do any kind of modification in the database manually. Set Severity: Administrator can set the Severity levels for the complaint logged by the citizen like 1, 2, 3...etc. according to the priority. The Severity 1 complaint is the most urgent and so on. View Details: It will be used to View the details of the different users, complaints posted by users, status of different complaints etc.

9 9 Citizen: These people are the key actors in the system, and are citizen of a constituency. The activities which will be done by citizen are as follows:- Register: To access the Constituency Management System citizens of a particular constituency has to register with the system by filling the registration form of the system. Get Information: Registered users of the system are able to view the details regarding funds of that particular constituency and their uses. Complain: Any registered user can make a complaint about the problems to the MLA of his/her constituency. Complaint Status: One can track the status of the complaint posted by him using complaint reference number. Interact (CHAT): Users can have online CHAT with the MLA of his/her Constituency. Usually it will be once in a week. MLA: Each MLA will be given a special area/page where they can monitor their constituency. The activities which will be done by MLA are as follows:- Handle Complaint: The MLA has the authority to forward the problems to the respective department by or he can take any other action regarding which will be informed to the complainer. Interact (CHAT): MLA can have online CHAT with the citizens of his/her Constituency. Usually it will be once in a week. Chief Minister: He is the head of the state. In Constituency management System he has rights equal to that of administrator. He can do the following activities:- View Details: As a CM he can view various details about all the Constituencies in that particular state. Take Action: CM can take action on complaints posted by the citizen.

10 Architecture diagram: Access Layer Users Citizens MLA CM Administrator Channels WEB E-Government Layer CMS Web Site Services Admin Login Citizen Registration Complaint Form MLA Login Complaint Status Database Layer Database Connection Data Systems CMS Database Basic Government Database Architecture Diagram

11 2.10 E-R Diagram 11

12 Data Dictionary Data Dictionary for Registration FIELD DATA TYPE CONSTRAINTS First_Name Character Not null Last_Name Character Password Text Not null Voter_ID Text Foreign key Conatct_No _ID Number Text Data Dictionary for Complaints FIELD DATA TYPE CONSTRAINTS Complaint_ID Number Primary Key Constituency_No Number Not Null Complaint_Type Text Not null Complaint_Loc Complaint_Details Text Text Voter_ID Text Foreign Key Complaint_Date Date

13 13 Data Dictionary for Complaint Status FIELD DATA TYPE CONSTRAINTS Complaint_ID Number Foreign Key Last_Accessed_Date Date Not Null Status Text Not Null Data Dictionary for Voter ID FIELD DATA TYPE CONSTRAINTS Voter_ID Text Primary Key First_Name Character Not Null Last_Name Address Character Text Data dictionary for MLA FIELD DATA TYPE CONSTRAINTS Constituency_No Number Primary Key Constituency_Name Text Not Null MLA_Name Text

14 Assumptions and Dependencies: The detail data and information related to the MLA, CITIZEN, CM will be provided by other government department e.g. the Voter-ID information will be provided by the Election Commission. Administrator account will be created in the system during the installation of the system. 3) Specific Requirements: 3.1 Use-Case Reports: Name of Use Case: Register. Description: To access the Constituency Management System citizens of a particular constituency has to register with the system by filling the registration form of the system. Pre Condition: User must have a Voter-ID card. Normal Flow of Events: - Fill the registration Form. - Validate Form. - User is registered with the System. Alternate Flow of Events: - If Mandatory Fields in Form are left blank then they must be filled. - If Voter-ID number and Details do not match then re-enter correct details. Post Condition: None.

15 15 Fill the form Enter correct data Incorrect Form Incomplete Form Fill Mandatory Fields Correct Form Register User Register Complain: Complaint_Status Set_Severity Complain Handle_Complaint

16 16 Name Of Use Case: Complain. Description: Any registered user can give a complaint about the problems to the MLA of his/her constituency. Pre Condition: Complaining Person must be a registered user of the System. Normal Flow of Events: - Login to the System. - Write Complaint, related details and submit. - User will get a Reference number for tracking the status of Complaint. Alternate Flow of Events: - Check whether all mandatory fields are filled or not. If not then user must enter data in those fields. Post Condition: None. Login to the System Write complaint Description Fill necessary data Store Complaint and give Complaint_ID

17 17 View Status: Use Case Name: View Status. Description: One can track the status of the complaint posted by him using complaint reference number. Pre Condition: - One must be a registered user of System. - One must have already posted problem in order to view the status. Normal Flow of Events: - Login to the system - Enter the reference ID of the complaint whose status is to be viewed. - View the status. Alternate Flow of Events: - If a wrong Reference ID is entered, appropriate message is to be displayed and option is to be provided for entering reference ID once again. Post Condition: None Login to the System Enter Complaint_ID Invalid Enter correct Complaint_ID Valid View Complaint Status View Complaint Status

18 18 Get Information: Name of the Use Case: get info. Description: Registered users of the system are able to view the details regarding funds of that particular constituency and their uses. Pre Condition: - Only registered users of the System can access the Information. Normal Flow of Events: - Login to the system. - Select options from menu in order to view details about that. Alternate Flow of Events: - None Post Condition: None. Login to the System Select option from menu View Information Interact (CHAT)

19 19 Name of Use case: Interact (CHAT). Description: Users can have online CHAT with the MLA of the Constituency. Usually it will be once in a week. Pre Condition: - User must be logged in to the system. - MLA must also be logged in to the system. - Enough users should be available online. Normal Flow of Events: - Login to the system. - Select CHAT option. -Interact with each other. -Close CHAT tool. Alternate Flow of Events: - If enough users are not online then CHAT option is disabled. User has to try next time. Post Condition: None. Login to the System If enough users are available Select CHAT option Interact

20 20 Handle Complaint. Name of Use Case: Handle-Complaint. Description: The MLA has the authority to forward the complaints to the respective department. Pre Condition: -MLA must be logged in. -There must exist at least one complaint to take action on it. Normal Flow of Events: - Login to the system. - Select a complaint to take action. - Take action. Alternate Flow of Events: - If no complaints are there, MLA will get no complaint message immediately after logging. Post Condition: Action on complaint is taken. Login to the System If complaints are there Select a complaint to take action Take action Handle_Complaint

21 21 Manage System Users. Name of use case: Manage System Users. Description: View the list of system users in a role and view the details of roles, tasks and permissions assigned to a system user. Preconditions: - Administrator is already logged in. - System users have already been created and assigned some roles, tasks and permissions. Normal flow of events: - Login to the System - The system user or a role will be selected. - Query will be submitted. - Relevant output will be displayed (If system user is selected then roles, tasks and permissions assigned to one will be displayed and if role is selected then list of system users assigned to that role will be displayed). Alternate flow of events: None. Post Condition: A login id is generated with its details or the existing user is removed. Login to the system System User or Role is selected Submit Query Relevant Output is Disdplayed Manage System Users

22 22 Update Name of Use Case: Update Description: Administrator has responsibility of updating the system by adding a component to the system or removing a component from the system. Pre Condition: - Administrator must be logged in. - Information which has to be updated must be available. Normal Flow of Events: - Login to the system. - Take the action to update the information. - Save the changes made to the system. Alternate Flow of Events: None. Post Condition: None. Login to system Take the action to update information Save the changes made to system Update

23 23 Set Severity Name of Use Case: Set Severity Description: The administrator can manage the problems on Severity levels like 1, 2, 3...etc. according to priority. The Sev 1 problem is the most urgent and so on. Pre condition: -Admin must be logged in. -A complaint must exist. Normal Flow of Events: - Login to the system. - Select a complaint to take action. - Set severity depending on problem type. Alternate Flow of Events: - If complaints are not present, admin must wait until a complaint is reported. Post Condition: None. Login to the system If complaints are present Set severity based on problem type Set-Severity

24 24 View Details Name of Use Case: View Details. Description: View the details of different users, complaints posted by users, status of different complaints etc. Pre Condition: - System must have some data stored in it. Normal Flow of Events: - Login to the system. - Select the fields about which information is needed. - Submit the query. - Get the required details. Alternate Flow of Events: - None. Post Condition: None Login to system Select the feilds about which info needed Submit the Query View the required details View Details

25 Supplementary Requirements 24x7 Availability : Because system can be an automated process, so it can stay open for 24 hours a day. System is required to be available 24x7 so UPS support must be on server site for at least 8 hours in case of power failure. System will remain inaccessible to users at some fixed timing for backup and maintenance purpose. User Friendly Interface : Since users of CMS are not having much technical knowledge so the interface of the system must be easy to understand and operate. Security: CMS stores key information regarding citizens, MLA and CM, so that CMS must provide secured access to data and information. Reminder: If MLA does not take any actions regarding complaints CMS must send reminder to the respective MLA.