1. CS4566 - ASSIGNMENT NUMBER 2
Protectourwater.ie SRS
Format Used: IEEE STD 830
Computer Systems: Kenny Barry – 09006369 | Jonathan Curran 0848255
Digital Media Design: Killian Stone - 09005157 | Killian Vigna - 10129758
Date: 26th
April 2013
2. ii
Table of Contents
Section One: Introduction.......................................................................................................................1
I. Purpose .......................................................................................................................................1
II. Scope...........................................................................................................................................1
III. Definitions, Acronyms and Abbreviations...............................................................................1
IV. Overview of Document...........................................................................................................1
Section Two: Overall Description............................................................................................................2
I. Context........................................................................................................................................2
II. Product Perspective....................................................................................................................2
III. Product Functions...................................................................................................................2
IV. Characteristics of the Users ....................................................................................................3
V. Constraints..................................................................................................................................3
VI. Assumptions and Dependencies.............................................................................................3
Section Three: Specific Requirements ....................................................................................................3
1. External Interface........................................................................................................................3
2. Functional Requirements............................................................................................................4
3. Performance Requirements........................................................................................................5
4. Logical Database Requirements..................................................................................................6
5. Design Constraints ......................................................................................................................7
3. 1
Section One: Introduction
I. Purpose
The purpose of this document is to provide the system developers with the necessary details
for the successful completion of the product. These details include the requirements for the
intended audiences listed below:
Household & companies whose building is connected to a septic tank system
The State, as it will be a means of generating revenue
Local Authorities, who will carry out the tank inspections.
Environmental Protection Agency (EPA)
Also included, are descriptions of suggested functionality the system should cater to.
II. Scope
This document does not cover hardware suggestions; platform suggestions; and non-
functional requirements, save for, performance and security.
This document does cover the functional requirements of the system through user stories;
input and output requirements for product functions; and the design constraints of the
system.
III. Definitions, Acronyms and Abbreviations
EPA – Environmental Protection Agency
CoR – Certificate of Registration
MPRN – Meter Point Reference Number
IV. Overview of Document
This document is organized in the following manner:
Context
Product Perspective
Product Functions
Characteristics of the Users
Constraints
Assumptions and Dependencies
The context requires homeowners and companies with a septic tank to obtain a Certificate
of Registration through local authorities in order to allow for the inspection and compliance
of proper standards along with raising state revenue.
The product perspective if based on the efficiency of a third party service which allows for
payment of the CoR and its ability to obtain and store records of registration.
The product functions provide a chart showing and individual’s status (from property owner
to a local authority inspector), what they want to do (from creating an online account, to
4. 2
acquiring a list local properties with septic tanks) so that they can (register their properties’
septic tank, or perform a thorough inspection).
Characteristics of Users define the different roles between users, for a homeowner to
receive a CoR, they must have basic computing knowledge, the local authorities must find a
system to allow for more efficient inspections and the EPA must inform the public why it is
necessary to purchase a CoR.
The Constraints revolve around the limitations of the system, how technical is it to register
for a CoR depending on the users computing knowledge, how do the local authorities store
Certifications of Registration, and how accessible are these records to the EPA.
Assumptions and Dependencies are the list of factors this report depends on.
Section Two: Overall Description
I. Context
Figure 1:Context diagram
II. Product Perspective
(Assumption) Dependent on the possible third-party payment system. Unable to
complete registrations without this system.
(Assumption) Dependent on a system that has prior knowledge of known properties with
septic tank installations (paper-trail).
III. Product Functions
The following functions have been identified as core functions to the product.
ID As a... I want to... So that...
1 Property Owner Create an account
I can register my
properties’ septic tank
5. 3
2 Property Owner Log in to my account
I can add new, and manage
current septic tanks
3 System Admin Log into an admin account
I can manage property
owner account accounts
4 Property Owner
Be able to recover my
account details
I can log into my account
5 Property Owner
get information on septic
tank legislation
I am better informed on
the subject
6 EPA/ Local Authority
Provide the necessary
information and forms to
the public
Their properties’ septic
tanks are properly
registered
7 Local Authority Inspector
Acquire a list of local
properties/septic tanks
I can perform a thorough
inspection
Table 1: Table of account function to be in the product
IV. Characteristics of the Users
Property Owners: own a septic tank and requiring a CoR. Age and computer knowledge
of varying standard.
Local Authority Inspectors: require a product or system to allow more thorough and
efficient inspections.
EPA:wish to impart knowledge to the public about septic tank legislation and why
registration is needed.
V. Constraints
User-friendly UI, due to the varying computer skills of users.
Platform must be cost effective while being widely available to property owners.
Storage used for data must be secure and must be adequate in size for the current
number of systems as well as future growth.
Uptime of system must be, or as close to as possible, 24/7.
VI. Assumptions and Dependencies
Programmers Skill Level – Does he/she have the skill to create what’s needed?
Computer literacy of Users – Will ALL users be able to understand the system?
Simple change-over – Will the new system be able to take information from the old
system? (registered septic tanks and owners, etc)
Internet users – Will all septic tank owners have access to internet in order to register
with the new system?
Section Three: Specific Requirements
1. External Interface
The system will be required to link to certain external interfaces in order to gather required
information. External interfaces such as a list of all local residents who own a septic tank,
registered or unregistered, or local authority inspectors databases which would show whose
septic tanks have been inspected and which ones are left to be inspected.
6. 4
Overall, the new system would need access to names, addresses, email addresses of septic tank
owners and the registration status of the septic tank in question.
2. Functional Requirements
The functional requirements are based on Table 1, shown above and detailed as follows:
Product Function 1:Account Creation
User must choose which type of property they to wish to register a septic tank for -
Private or Corporate.
User must enter their email address. Confirmation of this email will be done by the
user re-entering their email.
User must enter a password for their account. Confirmation will be done in the same
way as above.
The system will require the user to enter valid personal details, such as: Forename,
Surname, Contact Number etc. They will also be required to pick and answer a
security question.
User will then be required to input an address for correspondence (This does not
need to be the property of the septic tank).
Confirmation of inputs should then be preformed
A unique account verification code should be generated and sent to the supplied
email address.
Account is successfully created
Product Function 2: Log in
The user should use the previously given verification code and decided password to
log in.
Product Function 3: Admin Log in
Same as Product Function 2, above, except user is a System Admin.
Product Function 4: Account Recovery
Input Reqs. (a) Email, Password
Input
Reqs.
Email address, password, full name, contact details, security
question answer, MPRN (Optional)
Output
Reqs.
Account verification code
Input Reqs. Account verification code, password
Output Reqs. N/A
Input Reqs. Admin-account verification code, password
Output Reqs. N/A
7. 5
(b) Account Reference code, Email
Output Reqs.
(a) Account reference code
(b) New password
User will provide necessary inputs for desired detail recovery
System should supply log in details via email.
Product Function 5: Attaining Legislative Information
Users will search the system for relevant information.
System should provide detailed information to the user.
Product Function 6: Obtaining Registration Forms
EPA and Local Authority users provide the system with legislative information and
registration forms, respectively.
The system should display this information and forms for public consumption.
Product Function 7: Inspection List Generation
Local Authority user should be able tolog in and specify desired area for inspection.
System should provide list of properties in specified area for inspection.
3. Performance Requirements
Account Creation
Once confirmation of inputs has been performed by the user a unique account verification
code should be sent by email to the user within 8.5 seconds. This is the optimum time to
allow the user confirm their details, change from the registration page to their email, and
open up their account verification code without the need to wait and become distracted.
Log in (or Admin)
Input Reqs. Search keywords
Output Reqs. Relevant information
Input Reqs. Legislative information, registration forms
Output Reqs. N/A
Input Reqs. Local Authority account-verification code, Area(City/County)
Output Reqs. List of properties with septic tanks in specified area
Input
Reqs.
Email address, password, full name, contact details, security
question answer, MPRN (Optional)
Output
Reqs.
Account verification code
8. 6
The time taken once account verification code and password have been entered should be
no more than 2 seconds to access the user’s personal account.
Account Recovery
Input Reqs.
(c) Email, Password
(d) Account Reference code, Email
Output Reqs.
(c) Account reference code
(d) New password
Like setting up a new account, to receive a new password an email should be sent to the
recipient within 8.5 seconds of order.
Attaining Legislative Information
95% of relevant information should be sent to the user within 2 seconds of entering search
keywords.
Obtaining Registration Forms
Once EPA and local authority users have input legislative information and registration forms,
the aforementioned information should become available to the public within 15 minutes of
uploading.
Inspection List Generation
A 95%list of properties with septic tanks in a town or city area should become available to
local authority users within 5 seconds of entering their local authority account verification
code and the area desired and up to 8.5 seconds for a full County.
4. Logical Database Requirements
Here are the logical database requirements to be placed into the database;
a) Types of information used by various functions;
b) Frequency of use;
c) Accessing capabilities;
Input Reqs. (Admin) Account verification code, password
Output Reqs. N/A
Input Reqs. Search keywords
Output Reqs. Relevant information
Input Reqs. Legislative information, registration forms
Output Reqs. N/A
Input Reqs. Local Authority account-verification code, Area(City/County)
Output Reqs. List of properties with septic tanks in specified area
9. 7
d) Data entities and their relationships;
e) Integrity constraints;
f) Data retention requirements.
5. Design Constraints
a) Standards compliance – the system must comply with standards in the industry.
b) Database integrity – how well the system will work.
c) Limits on amount of memory available – limited space for information storage.
d) Design of system – must be simple enough to be used by a varying array of users.
*** End of the SRS ***