HeaderSIS.jpg

IS480 Team wiki: 2014T1 Team Epsilon Documentation

From IS480
Jump to navigation Jump to search

Team Epsilon Logo.png.png

Home   Project Overview   Project Management   Documentation   Team

Design Overview   Prototype   User Testing   Meeting Minutes   Submission Archive


Architecture Design

Architecture Diagram Epsilon.png

Use Case Diagram

Use Case Description

Module Function Description User
Account Login/Log Out
Allows the user to login to the system


Normal Login/Log Out
  • Login: Allows the user to login to the system through email and password
  • Logout: Allows the user to logout from the system

Facebook Login

  • Login: Allows the user to login to the system through Facebook
Public
Agency
Admin
Registration
Allows the user to register for an account


Identification of user is by their email address.

Mobile verification is required for registration. User will be required to key in their mobile number, which will be used to send an authentication code to complete the registration process.

Normal Registration

  • Allows the user to register for an account

Facebook Registration

  • Allows the user to register for an account, and facilitates the process by using information (e.g. email address) pulled from their Facebook
Public
Change Password
Allows the user to change password




Public
Feedback Create Feedback
(iOS-only)

Allows the user to submit a new feedback


Additional details that can be input when creating a feedback:

  • Capture Image: Allows the User to take a photo to be attached to the feedback.
  • Image Annotation: Allows the User to annotate and attribute issues for feedback.
  • Feedback Description: Allows the User to write/edit a description of the feedback.
  • Location Input: Allows the User to select a pre-determined location for the feedback.


Users who have an account will be able to create a new feedback regarding a service or infrastructure issue that they wish to highlight to the relevant agencies to be resolved.

This functionality is limited to iOS-only.

Public
Display All Feedback
Allows the user to display all the feedback


Public users will be able to look at all feedback posted by other users to vote and comment on.

Agency and Admin users can view all feedback submitted.

Public
Agency
Admin
Display My Feedback
Allows the public user to display feedback that the user created, has commented, or has voted on


Public
Display Agency Feedback
Allows the agency to display feedback tagged to it by an Admin user


Agency
Close Feedback
Allows the user to close an existing feedback


Primary Scenario
When the agency marks a feedback as resolved, the feedback owner will be notified to check and close the feedback. If the feedback status is not updated by the owner for three days, the admin will be notified to close the feedback.

Secondary Scenario
If the user closes the feedback before the agency marks it as resolved, the agency will be notified of the feedback status update that the feedback owner made.

Public
Agency
Delete Feedback
Allows the user to remove a feedback from the system


This function will not be used under normal circumstances and is only reserved for the admin to rectify errors.

Admin
Mark Feedback Resolved
Allows the user to mark a feedback as resolved


After resolving an issue posted by the public users, the agency will be able to use this function to inform them that it has been resolved and that the feedback should not be closed.

Agency
Vote on Feedback
Allows the user to express support to an existing ‘open’ feedback posted by another user


Feedback voted by public users will be displayed on their personalized wall feed (DIsplay My Feedback).

This also helps gauge public interest level on a given feedback, as the more people voting on a particular feedback would generally mean a higher public interest level to get the issue resolved. This in turn helps the agencies to prioritize on which issues to resolve first.

Public
Comment on Feedback
Allows the user to comment on an existing ‘open’ feedback


Users will be able to look at feedback entries posted by other users, and comment on them. This is useful when other users want to provide additional information on the feedback, ask questions to clarify anything regarding the feedback, or reply to a comment posted by another user on the feedback.

This also helps gauge public interest level on a given feedback, as the more people commenting on a particular feedback would generally mean a higher public interest level to get the issue resolved. This in turn helps the agencies to prioritize on which issues to resolve first.

Public
Agency
Admin
Agency Update
Allows the agency to post updates on the feedback


Agencies can post updates or document important details on a section that works like a bulletin board for other users to take note of. There is only one main body field to post and update the content.

Agency
Set Feedback Status
Sets and updates the status of feedback depending on the feedback progress


Feedback Status:

  1. New: Newly-created feedback defaults to this.
  2. In Progress: Tagged feedback defaults to this.
  3. Flagged as Resolved: Agencies can set status to this and inform user about it once issue is resolved for verification and closure.
  4. Resolved: Feedback that has been closed by either the feedback owner or admin.



When an agency requests for a feedback to be closed, the user who submitted the feedback will be notified to verify and close it. If the user does not respond within 3 days, the agency request will be forwarded to the admin for further actions.

If feedback owner closes a feedback before an agency requests it to be closed, the agency and admin will be notified on the feedback status update.

Public
Agency
Admin



E-R Diagram

ERD Epsilon.png