SRS for php app

Table of ContentsINTRODUCTION31.1 Introduction31.2 Purpose31.3 Scope31.4 Definitions, Acronyms, and Abbreviations41.5 References41.6 Overview4Overall Description52.1 Description52.2 Product Perspective:5Hardware Interface:6Software Interface:6Communication Interface:6Memory Constraints:62.3 Product Functions:7Student:7Teacher:7Admin:82.4 User Characteristics:92.5 Constraints:9Requirement and Functional Description103.1 Specific Requirements10External Interfaces103.2 Functions15Signing in for existing user:15Signing up for new user:15Setting up Profile:16Setting up New Password:16To add Contacts:17To make audio call:17To make video call:18To send message/file:18To Accept/Decline friend request:19To Send Friend request:19To see all the messages and reply:19To Share a Document and editing them with desired friends:20To Upload an Assignment(for teacher):20To Upload Assignment(for Student):213.3 Logical Database Requirements:223.4 Software system attributes :23Reliability:23Availability:23Security:23Maintainability:23Portability:23

INTRODUCTION1.1 Introduction

The Software Requirements Specification lays the foundation for the systematic approach towards the development of this software. . It provides a general overview of the system. It helps to translate the ideas in the minds of the clients. It includes understanding of the problem domain, establishing an architectural framework, identifying all external entities that will interact with the system, the users and defining their functions, the constraints that would exist and the overall functioning of the system.

1.2 Purpose

We the students of Wireless Lan communicator do not have a localized software to interact which aims at targeting people of Wireless Lan communicator only. Today is an era of android, so taking that under consideration we aim at developing an android app which helps us to communicate to Wireless Lan communicator in an organized, secured way. Basically, this app aims at users discuss over a project/ assignment and make SRS, Project reports or assignments from their hostels or rooms, they dont need to sit together in one room and do the discussions. In this we provided all functionality regarding there is proper login, then provision of making calls, video calls, chat, sending of files or docs, feature of document sharing in which say two people can simultaneously open a document, edit it, make necessary changes and can save the same and assignment in which teachers can submit assignment date and assignment to do for respective students and students can also submit their respective assignments under the time given. Nothing needs to be done manually.

1.3 Scope

The Wireless Lan communicator is designed to facilitate an android app for Wireless Lan communicator for interacting and sharing in a better organized way. The present SRS is an attempt in this direction so as to facilitate subsequent development and implementation of an interactive app.

The software will have functional modules for most of the activities like login, call, video call, messages, document sharing and assignment. A back-end database working for maintaining the student login records which will be managed by admin.

The proposed system will provide quick way and easy flow of information with updatable database bringing the relevant features needed to interact.

This app will be very useful for the 3rd and 4th year students who have to make projects which need everyday communication among them. And, in this era, where everyone is so indulged in their work that going to meet someone and do discussions about project work seems to be a wastage of time. This app will let the users to do all that by sitting at their own places.

1.4 Definitions, Acronyms, and Abbreviations

There are three basic users for our android app: student, teacher and admin.

Student can use all the basic features of the app.

Teacher can also access all the features along with an additional feature of uploading the assignment topic with the submission date.

Admin is a user too who is responsible for log in records and updating of database for any new information.

ADT

Android Development Tools

Admin

Administration

SIP

Session Initiation Protocol

SDK

Software Development Kit

IEEE

Institute of Electrical and Electronic Engineers

IDE

Integrated Development Environment

AVDs

Android Virtual Devices

1.5 References

IEEE 830-1993 standard format is followed.

Pankaj Jalote: An integrated Approach to software engineering,2nd Edition: Narosa Publications

Roger S Pressman :Software Engineering: A practitioners approach:6th edition , Mcgraw hill,1992

1.6 Overview

Our application for the interaction of people of Wireless Lan communicator running on android provides us facility of making call, video call, sending messages, sharing and editing files, uploading assignments on respective teachers account.

SRS includes two sections :

Overall description

Specific requirements.

Overall description will describe the role of the components of the software and their interconnections. Specific requirements will describe roles & functions of the actors i.e., student, teacher and admin.

Overall Description2.1 Description

To begin with, we should know about the types of users for this app, these are:

student

teacher

and, admin

So, there will be three different windows for the respective user. As, all have different requirements, like:

student need to do chat; send file; call; video call; send messages and friend request; see notifications; update their status regarding their working schedule; upload assignments at respective teachers account; discuss on say, projects, and make updation to single document, e.g project report; and all this can be done to the friends in friend list.

teacher need to do chat; send file; call; video call; send messages and friend request; update their status regarding their working schedule; upload assignment topic with the submission date and this can be sent as notifications to all the students; discuss on say, projects, and make updation to single document, e.g project report; and all this can be done to the friends in friend list.

Admin is a simple user. He/ She can be a student or a teacher with an extra feature provided to him/her of managing the students/ staff list of Wireless Lan communicator.

This app needs an internet connection with wifi working or systems connected through LAN/routers.

2.2 Product Perspective:

The software is a self-contained and an independent product with proper user interface. The application uses the centralized database which contains all the information. It works on any android based phone.

(DB)

(WIRELESS LAN COMMUNICATOR COMMUNICATOR ) (Android Phone) (Wi-FI/LAN)

(ADMIN)

(STUDENT)

(TEACHER)

Hardware Interface:

An android phone with an inbuilt Camera or it can run on an AVDs (Emulator) running on computer having a webcam, speakers/headphones and microphones. They all should be working.

Software Interface:

It works with SQLite database . SQLite is an Open Source Database which is embedded into Android. SQLite supports standard relational database features like SQL syntax, transactions and prepared statements. In addition it requires only little memory at runtime.

Eclipse, an IDE with SDK and ADT installed in it with Minimum SDK version 8 and Target SDK version 17.

Communication Interface:

Sip(Session Initiation Protocol) functionality is used to make and answer VOIP calls. This needs to import package android.net.sip.

Memory Constraints:

Today Android phones have memory in GBs. Our app would need around 256MB.

2.3 Product Functions:

The application functions varies with the user using it.

Student:

On clicking the Wireless Lan communicator, a sign-in screen is displayed. If the user is a new user, he will click the sign-up link on the screen, otherwise will sign in with the specified details.

On successfully filling all the fields in signup, a mail with the password is sent at the users e-mail id. A user can exit anytime during sign-in/sign-up.

Now, user has signed in and a home screen is displayed with the five buttons on it: profile, contacts, message, friend request, and docs.

Profile button will take the user to their profile screen showing fields: photo upload, user name, branch, status, entry no. and a reset password button.

Contacts button will display all the added friends and by selecting any contact a new contact_display screen is displayed with options call, video call and send message/file.

Message button will display a message screen with all the past conversations and notify about the assignments and file sharing.

Friend request button will display a request screen showing all the awaited requests.

Docs button will take the user to docs screen showing the shared files with respective users sharing it. By opening the file, users having share priviledge on it can edit the file and can save the same.

Assignment uploading can be done at teachers profile.

From, any screen user can switch to home screen and can log out.

Teacher:

On clicking the Wireless Lan communicator, a sign-in screen is displayed. If the user is a new user, he will click the sign-up link on the screen, otherwise will sign in with the specified details.

On successfully filling all the fields in signup, a mail with the password is sent at the users e-mail id. A user can exit anytime during sign-in/sign-up.

Now, user has signed in and a home screen is displayed with the six buttons on it: profile, contacts, message, friend request, docs and assignment.

Profile button will take the user to their profile screen showing fields: photo upload, user name, status, teacher id and a reset password button.





Assignment button will show the assignment screen with fields: assignment topic, branch, batch and submission date. By clicking the upload button, an automatic message is sent to the respective batch students in the contact list to their message screen. This uploading will not be shown after the submission date.


Admin:

Since, admin is a user too. He will sign-in like any other user.

On clicking the WIRELESS LAN COMMUNICATORCOMMUNICATOR, a sign-in screen is displayed. User signs-in. (He doesnot need to sign up).

Now, user has signed in and a home screen is displayed with the six buttons on it: profile, contacts, message, friend request, docs, assignment and admin.

Profile button will take the user to their profile screen showing fields: photo upload, user name, branch, status, entry no. and a reset password button.





Assignment button will show the upload button for the user to upload the assignment to the respective teacher (if user signs-in as student) and with upload assignment topic button (if user signs-in as teacher).


2.4 User Characteristics:

The user(student/teacher) should have basic knowledge of using phones.

2.5 Constraints:

The phones having the application should either be connected over LAN or internet.

The users are only the people of WIRELESS LAN COMMUNICATORas their e-mail ids are taken at the time of sign-up.

Sign-in and password are used for the identification of user.

Admin needs to update the database after every session.

Requirement and Functional Description3.1 Specific Requirements External Interfaces

The User Interface produced by the system are :

Sign-In Screen:

This module is for the signing in of the existing user. Its fields are:

WIRELESS LAN COMMUNICATORcommunicator text: It is a text label displaying the name of the software. It is non-clickable.

Sign In text: It is a text displaying the activity title. It is non-clickable.

Exit: It is a text label which is clickable and take the user back to the menu of the emulator.

Entry No.: It is a text box which takes the entry no./teacher id no. as input. It is non-clickable.

Password: It is a text box which takes the password sent to user on his e-mail id as input. It is non-clickable.

Sign In: It is a button and is clickable and takes the user to home screen.

Sign Up text: It is a text label to register new users for the software. It is clickable and takes the users to sign-up screen.

Sign-Up Screen:

This module is for the signing up for the new user. Its fields are:


Sign up text: It is a text displaying the activity title. It is non-clickable.

Exit: It is a text label which is clickable and take the user back to the menu of the emulator.

Entry No.: It is a text box which takes the entry no./teacher id no. as input. It is non-clickable.

E-mail id: It is a text label which takes the e-mail id of the user as input. It is non-clickable.

UserName: It is a text label which takes the username as input. It is non-clickable.

Sign Up: It is a button and is clickable and takes the user to sign-in screen.

Home Screen:

This module is for using the features of the app. Its fields are:


Home : It is a button and is clickable. It takes the user to home screen.

Status : It is a radio button showing the status of the user whether he is available or not.

Log Out : It is a button which is clickable and takes the user out of the application to the emulator menu.

Profile: It is a button which is clickable and takes the user to the profile screen.

Contacts: It is a button which is clickable and takes the user to the contacts screen.

Messages: It is a button which is clickable and takes the user to the messages screen.

Friend Request: It is a button which is clickable and takes the user to the friendrequest screen.

Docs: It is a button which is clickable and takes the user to the docs screen.

Assignment: It is a button which is clickable and takes the user to the assignment screen.

Profile Screen:

This module is for seeing and editing ones own profile. Its fields are:





Photo: It is a image view and is non-clickable. It displays the image of the user.

Photo Upload: It is a button to upload any photo and changes the photo image view. It is clickable.

Username: It is a text label showing users name.

Edit: It is a button to change the username and is clickable.

Save: It is a button to save the new username entered and is clickable.

Branch: It is a text label showing the branch of the user. It is non-clickable.

Batch: It is a text label showing the users batch. It is non-clickable.

Reset: It is a button and is clickable. It takes the user to reset screen.

Reset Screen:

This module deals with the changing of the password. Its fields are:

Old Password: It is a text label which inputs the old password. It is non-clickable.

New Password: It is a text label which inputs the new password. It is non-clickable.

Confirm Password: It is a text label which confirms the new password. It is non-clickable.

Reset: It is a button and is clickable. It resets the password and takes the user to the profile screen.

Contact Screen:

This module displays the added contacts. Its fields are:





Contact List: It is a listview which displays the added contacts and whose each contact is clickable and takes the user to contacts option screen.

Contacts option Screen:

This module shows the three options associated with each contact. Its fields are:





Photo: It is a image view and is non-clickable. It displays the image of the clicked contact.

UserName: It displays the clicked contacts username. It is non-clickable.

Audio Call: It is a button to make call to the contact. It is clickable.

Video Call: It is a button to make video call to the contact. It is clickable.

Send Message/File: It is a button to send messages or any file to the contact. It is clickable.

Message

This module displays the message conversations. Its fields are:





Message List: It is a list view showing all the messages and user can reply to those messages. Its items are clickable.

Friend request screen:

This module deals with friend requests which user has received and can send friend requests too. Its fields are:





Friends list: It is a list view displaying friend requests which user has received.

Accept: It is a button and is clickable. It adds the contact to contact list.

Decline: It is a button and is clickable. It declines the request.

Search: It is a button to search a friend and send him the request.

Docs screen:

This module provides the functionality of sharing a file with other friends, edit them and save them. Its fields are:





File view: It is a list view displaying the shared files and the users with whom user have shared the file. It is clickable and shows the word document on click.

File name: It is a text label which inputs the file name.

Share view: It is a list view which displays the contacts and by selecting them will notify the respective users at other end.

Remove: It is a button and is clickable. It lets the user to remove himself fom the share list for that file.

Share: It is a button and is clickable. It notifies the shared users about the file.

Assignment_teacher Screen:

This module will allow the teachers to upload assignments. Its fields are:





Topic: It is a text label which inputs the assignment given by the teacher.

Upload: It is a button which will upload the assignment if pdf.

Branch: It is a listview displaying all the branches.

Batch: It is a listview displaying all the batches in the current session.

Submission date: It is a date picker which selects the date for the submission.

Notify: It is a button which will notify the respective branch and batch students.

Upload assignment: It is a listview which will take as input the assignments uploaded by students.

3.2 Functions Signing in for existing user:

This function enables an existing user to sign in.

Inputs: Enter the details showing Entry no and Password in the screen displayed.

Return Values:

Error message

1. Returns an error message if any field remains unfilled.

2. Returns an error message if details doesnt match the database details.

Processing Details:

Step1: In order for a user to sign in he needs to sign in.

Step2: Details are entered.

Step3: Click on Sign In button.

If proper filling of entries is done then user is taken to home screen else error message is displayed.

Signing up for new user:

This function enables a new user to get his account created in the system.

Inputs: Enter the details showing Entry no ,Username and Emailid in the screen displayed.

Return Values:

Error message:


Processing Details:

Step1: In order for a user to sign up he clicks the NEW USER? link in sign in screen.

Step2: Sign up screen is displayed. Details are entered.

Step3: Click on Sign Up button.

If proper filling of entries is done then user is taken to sign in screen else error message is displayed.

Setting up Profile:

This function enables the user to set up his/her profile. Inputs: Enter the details showing Username, Upload picture and Reset password.

Return Value: NULL

Processing Details:

Step1: Profile button from the Home screen is clicked.

Step2: On the Profile screen Photo Upload button is clicked to set the photo.

Step3: On the same screen Edit button is clicked to change the Username and the same is saved by Save button.

Step4: There is a RESET password to reset the password.

If proper filling of entries is done then user remains on same screen or if Reset button is clicked user is taken to reset password screen.

Setting up New Password:

This function enables the user to reset the password. Inputs: Enter the details Old password, New password and Confirm password.

Return Value:

Error message:


2. Returns an error message if Old Password is not the same.

3. Returns an error message if New password and Confirm Password does not match.

4. Returns a message Your password is reset is displayed if all the entries are filled correctly and reset is clicked.

5. Returns an error message if password length is too short.

Processing Details:

Step1: From the profile screen when the Reset Password is clicked reset screen is displayed.

Step2: Enter the details Old Password, New Password and Confirm Password.

Step3: Click the Reset button and then a message displaying Your password is reset is displayed.

To add Contacts:

This function enables the user to add contacts in Contacts screen. This can be done by accepting the friend request or waiting for the sent request to be accepted.

Inputs: Enter the Entry no. which you want to add in Edit text provided aside the Search Button.

Return Value: 1.If the user is present , entry no is displayed else nothing is displayed

Processing Details:

Step1: From the Friend request screen, entry no to be added in our contact list is searched.

Step2: If entry no exists then that particular entry no is displayed to the user and friend request is sent to that entry no.

Step3: If accepted it is added to contact list.

Step4: From the friend request screen accepting any request will update the contact in contact list.

If the user at other end accepts your friend request your contact list is updated.

To make audio call:

This function enables the user to make audio call to the contact present in the contact list.

Inputs: Click on the contact to which you want to make call. Then click on the Audio call button displayed.

Return Value:

Error Message:

1. If the user at the other end rejects it, call terminates.

2. Transport error is displayed if there is some network problem.

Processing Details:

Step1: From the Contact list in the Contact screen clicking any contact will take the user to Contact options Screen

Step2: From the displayed options Audio call button is clicked.

If there is no network problem and user at other end receives the call then call operation is successful else error message is displayed.

To make video call:

This function enables the user to make video call to the contact present in the contact list.

Inputs: Click on the contact to which you want to make call. Then click on the Video call button displayed.

Return Value:

Error message:

1. If the user at the other end rejects it ,call terminates

2. Transport error is displayed if there is some network problem.

Processing Details:

Step1: From the Contact list in the Contact screen clicking any contact will take the user to Contact options Screen.

Step2: From the displayed options Video call button is clicked.

If there is no network problem and user at other end receives the call then call operation is successful else error message is displayed.

To send message/file:

This function enables the user to send message/file to the contacts present in the Contact List.

Inputs: Click on the contact to which you want to send message/file. Then click on the Send message/file button displayed.

Return Value: NULL

Processing Details:

Step1: From the Contact list in the Contact screen clicking any contact will take the user to Contact options Screen

Step2: From the displayed options Send message/file button is clicked.

If there is no network problem and user at other end receives the message then a message Your message has been sent is shown.

To Accept/Decline friend request:

This function enables the user to accept or decline the friend request received in friend request screen.

Inputs: Click on the accept button to add the contact. Click the decline button to reject the request.

Return Value: NULL

Processing Details:

Step1: The friend list in the friend request screen shows all the requests sent to the user.

Step2: User can accept the request by clicking the Accept button. This will add the friend to Contact list.

Step3: User can decline the request by clicking the decline button.

Accepting the friend request will update the contact list and user can interact with that added friend.

To Send Friend request:

This function enables the user to send request to any other user using this app.

Inputs: Enter the Entry no which you want to add in Edit text provided aside the Search Button.

Return Value: 1.If the user is present, entry no is displayed else nothing is displayed

Processing Details:

Step1: From the Friend request screen, entry no to be added in our contact list is searched.

Step2: If entry no exists then that particular entry no is displayed to the user and friend request is sent to that entry no.

Step3:If accepted it is added to contact list.

If the user at other end accepts your friend request your contact list is updated.

To see all the messages and reply:

This function enables the user to see all the conversations between user and his friends.

Inputs: Click the message button on the home page.

Click the message in the message list to view it.

Click the reply button to reply to any particular message.

Return Value: NULL

Processing details:

Step1: The message button on the home screen is clicked.

Step2: To view any message, the message from the message list is clicked.

Step3: To reply to that message, enter the message in the edittext and click reply button.

Messages can be viewed and reply can be sent to anyone.

To Share a Document and editing them with desired friends:

This function allows the user to share a file with the friends and do editing on the same file simultaneously.

Inputs: Click on the docs button on the home screen. Enter the details: file name and share members.

Return Value: NULL

Processing Details:

Step1: From the home screen, click the docs button.

Step2: Enter the required file name and from the share list, choose the friends with whom user wants to share this file.

Step3: Click the share button to notify the friends.

Step4: To edit any file, click the respective file.

Step5: File will open in word, make changes and save it.

Step6: If any friend with whom file is being shared wants to remove himself, can click the remove button.

The new file will now be displayed in the file view with the names of the shared users.

To Upload an Assignment(for teacher):

This allows a teacher who is also a user of the application to upload topic/pdf of the assignment for respective batch students.

Inputs: Click the assignment button on home page.

Enter the assignment topic or upload a pdf(if any), batch , branch and submission date for the assignment.

Return Values:

Error message: 1) If assignment is not a pdf, error message is displayed.

Processing Details:

Step1: Click the assignment button on home page.

Step2: Enter the assignment topic or upload a pdf(if any), batch , branch and submission date for the assignment.

Step3: Click the notify button to inform the students. This notification will be displayed in message view.

An upload button will be displayed in the assignment page for students to upload their assignments before the submission date.

To Upload Assignment(for Student):

This function allows the student to upload their assignments at the respective teachers profile.

Inputs: Open the teachers profile.

Click Assignment upload button.

Return Values:

Error message:

1. If assignment is not a pdf, error message is displayed.

2. If submission date has expired, no upload button is displayed.

Processing Details:

Step1: Click the respective teachers contact from the contact list in contact screen.

Step2: Now, Teachers contact option screen will be displayed with assignment upload button in it.

Step3: Click the button to upload your assignment.

This will get uploaded to a database maintained at back-end for the teacher.

3.3 Logical Database Requirements:

Table: Information

- Entry No./Teacher_id

- E-mail id

- Username

- Password

- Admin

- Photo

- Branch

- Batch

Table Userdetails

Entry No./Teacher_id

Contacts

Frnd_rqst

Msgs

Call_history

Table Docs

Entry_no.

Shared_entry no.

filename

3.4 Software system attributes :Reliability:

The capability to maintain the specified level of performance is what meant by reliability. This application will run on any android phone.

Availability:

The application will run 24 X 7 if internet connection is available.

Security:

Security requirements placed restrictions on the use of this application by the student and the faculty of Wireless Lan communicator only, control access to the data, provide different kinds of requirements to different people, require the use of passwords. It requires proper programming techniques.

Maintainability:

Maintenance is one form of change that typically is done after the software development has been completed. As the time change, so do the needs. It revolves around the understanding of the existing s/w and the effects of the change. This application needs a timely updation of information table of the database by the admin. Any other feature as per the requirement can be added any time by the admin.

Portability:

The capability to be adapted for different specified environments without applying actions or means other than those provided for this purpose in the product. Since, phones are portable, so do the application.

1

Documents

SRS for php app