SRS Pitpay
SRS Pitpay
SRS Pitpay
Specification
for
SplitPay
Version 1.0 approved
ZILDOR, Inc.
February 9, 2011
TABLE OF CONTENTS
1. Introduction .......................................................................................................... 4
1.1 Purpose .............................................................................................................. 4
1.2 Document Conventions ...................................................................................... 4
1.3 Intended Audience and Reading Suggestions ..................................................... 4
1.4 Project Scope...................................................................................................... 5
2. Overall Description ................................................................................................ 6
2.1 Product Perspective ........................................................................................... 6
2.2 Product Features ................................................................................................ 7
2.3 User Classes and Characteristics ......................................................................... 9
2.4 Operating Environment .................................................................................... 11
2.5 Design and Implementation Constraints ........................................................... 11
2.6 User Documentation ........................................................................................ 11
2.7 Assumptions and Dependencies ....................................................................... 12
3. System Features .................................................................................................. 14
Core Features ............................................................................................................ 14
3.1 User Registration and Welcome ...................................................................... 14
3.2 Group Creation and Management .................................................................... 15
3.3 Posting a Bill ..................................................................................................... 16
3.4 Member-to-Member Transactions ................................................................... 17
3.5 Final Debt Resolution ....................................................................................... 18
3.6 Group History ................................................................................................... 19
3.7 Show All Debts ................................................................................................. 20
3.8 Settings Menu .................................................................................................. 21
3.9 Help Menu........................................................................................................ 22
3.10 Push Notifications ............................................................................................ 22
Additional Features ................................................................................................... 24
3.11 Member Debt Visualization .............................................................................. 24
3.12 PayPal ............................................................................................................... 24
3.13 GPS Tracking ..................................................................................................... 25
3.14 Receipt Imaging ................................................................................................ 26
3.15 E-mail/SMS Notifications .................................................................................. 27
3.16 SplitPay Tutorial ............................................................................................... 28
2
SPLITPAY 3
Software Requirements Specification
3
SPLITPAY 4
Software Requirements Specification
1. INTRODUCTION
1.1 PURPOSE
This document features some terminology which readers may be unfamiliar with. See Appendix
A (Glossary) for a list of these terms and their definitions.
This document is intended for all individuals participating in and/or supervising the SplitPay
project. Readers interested in a brief overview of the product should focus on the rest of Part 1
(Introduction), as well as Part 2 of the document (Overall Description), which provide a brief
overview of each aspect of the project as a whole. These readers may also be interested in Part
6 (Key Milestones) which lays out a concise timeline of the project.
Readers who wish to explore the features of SplitPay in more detail should read on to Part 3
(System Features), which expands upon the information laid out in the main overview. Part 4
(External Interface Requirements) offers further technical details, including information on the
user interface as well as the hardware and software platforms on which the application will run.
Readers interested in the non-technical aspects of the project should read Part 5, which covers
performance, safety, security, and various other attributes that will be important to users.
Readers who have not found the information they are looking for should check Part 8 (Other
Requirements), which includes any additional information which does not fit logically into the
other sections.
4
SPLITPAY 5
Software Requirements Specification
The SplitPay system is composed of two main components: a client-side application which will
run on Android handsets, and a server-side application which will support and interact with
various client-side features. The system is designed to facilitate the process of tracking and
settling shared expenses. Potential scenarios include paying rent, splitting a check at dinner,
sharing travel expenses, etc.
For more information about the project and its goals, see Appendix B (Project Proposal).
5
SPLITPAY 6
Software Requirements Specification
2. OVERALL DESCRIPTION
2.1 PRODUCT PERSPECTIVE
The SplitPay project is a new, self-contained product intended for use on the Android platform.
While the SplitPay mobile application is the main focus of the project, there is also a server-side
component which will be responsible for database and synchronization services. The scope of
the project encompasses both server- and client-side functionalities, so both aspects are
covered in detail within this document. Below is a diagram of the SplitPay system which
illustrates the interactions between the server and client applications.
6
SPLITPAY 7
Software Requirements Specification
The following list offers a brief outline and description of the main features and functionalities
of the SplitPay system. The features are split into two major categories: core features and
additional features. Core features are essential to the application’s operation, whereas
additional features simply add new functionalities. The latter features will only be implemented
as time permits.
C ORE F EATURES
1. USER REGISTRATION & WELCOME
o Only appears once (the first time the application is run)
o Allows the user to register with the SplitPay server
o Enables the user to customize his/her account settings and preferences
3. POSTING A BILL
o Stores and monitors the bill amount, the individuals involved, etc.
o Includes support for multiple simultaneous bills
o Efficiently distributes debt amongst the individuals responsible for the bill
4. MEMBER-TO-MEMBER TRANSACTIONS
o Enables group members to simulate transfers of debt, payments made, etc.
o Adjusts member balances accordingly
o Records relevant information (amount paid, members involved, etc.)
6. GROUP HISTORY
o Automatically records all transactions and bills posted to each group
o Provides users with access to a detailed history of transactions
o Supports sorting transactions by date, amount, payer, etc.
7
SPLITPAY 8
Software Requirements Specification
8. SETTINGS MENU
o Allows the user to customize his/her preferences
o Enables the user to modify certain features and functionalities
o Can be accessed at any time using the built-in Settings button on Android phones
9. HELP MENU
o Displays a list of topics covering the different components of SplitPay
o Offers detailed information on each feature, menu, etc.
o Can be accessed at any time via the Settings menu
A DDITIONAL F EATURES
11. MEMBER DEBT VISUALIZATION
o Presents a visual representation of current member balances
o Allows users to navigate through financial information in a more intuitive fashion
o Automatically updates as users post expenses and make transactions
8
SPLITPAY 9
Software Requirements Specification
For more detailed information, see Part 3 of the document (System Features).
The SplitPay project is meant to offer a shared expenses solution that is faster, easier, and more
convenient than manually calculating and handling debts. Consequently, the application will
have little or no learning curve, and the user interface will be as intuitive as possible. Thus,
technical expertise and Android experience should not be an issue. Instead, anticipated users
can be defined by how they will use the product in a particular situation. The following list
categorizes the scenarios in which SplitPay is expected to be utilized:
9
SPLITPAY 10
Software Requirements Specification
These groups are not meant to separate or categorize users, just the different situations in
which SplitPay is likely to be used. In fact, a user may utilize the application for all of these
scenarios simultaneously. This is another defining feature of the SplitPay system: support for
multiple groups. This functionality allows a user to track expenses pertaining to several
unrelated groups at the same time.
10
SPLITPAY 11
Software Requirements Specification
It is crucial that each of these situations be fully supported in the final product so as to
maximize the overall value of the product. It is also important that the application be as user-
friendly as possible, otherwise it will not be a viable alternative to handling shared expenses
manually. Most importantly, the application must be reliable. Regardless of the situation, the
application must accurately distribute costs. There is zero tolerance for error when dealing with
financial transactions.
The main component of the SplitPay project is the software application, which will be limited to
the Android operating system (specifically Android 2.2 and above). The application is not
resource- or graphics-intensive, so there are no practical hardware constraints. The app will rely
on several functionalities built into Android’s Application Programming Interface (API), so
ensuring appropriate usage of the API will be a major concern. Beyond that, the application is a
self-contained unit and will not rely on any other Android-related software components.
The application will, however, frequently interact with the SplitPay server, a virtual dedicated
server hosted by GoDaddy.com. The server operates on a Linux CentOS platform with 1GB of
RAM and 15GB of allocated storage space. The SplitPay database will be stored on the server
using MySQL and will be interfaced with a wrapper written in PHP 5.
The primary design constraint is the mobile platform. Since the application is designated for
mobile handsets, limited screen size and resolution will be a major design consideration.
Creating a user interface which is both effective and easily navigable will pose a difficult
challenge. Other constraints such as limited memory and processing power are also worth
considering. SplitPay is meant to be quick and responsive, even when dealing with large groups
and transactions, so each feature must be designed and implemented with efficiency in mind.
The primary goal of SplitPay is to facilitate the process of managing shared expenses.
Consequently, the application will be designed to be as simple to use as possible. Nonetheless,
users may still require some supplementary information about each component of the SplitPay
system. The application will contain two features that offer this: the SplitPay Tutorial and the
Help menu.
11
SPLITPAY 12
Software Requirements Specification
The Help menu is a collection of topics covering each of the application’s menus, features, etc.
At any time, the user can navigate to the Help menu and select any of these topics to obtain
more information. Details about the Help menu can be found in section 3.9 of this document.
The SplitPay Tutorial takes all of these topics and condenses them into a single, step-by-step
demonstration that the user can access immediately after installing the application. This
tutorial is meant to quickly and effectively teach new users the “ins and outs” of the
application. Section 3.16 covers the tutorial in further detail.
T IME D EPENDENCIES
As mentioned previously, the features of SplitPay are divided into two groups: core features
and additional features. Core features are crucial to the basic functionality of the SplitPay
application. These features must all be implemented in order for the application to be useful.
Optional features, however, are not critical to the function of the application. They are usability
improvements and convenience enhancements that may be added after the application has
been developed. Thus, the implementation of these features is entirely dependent upon the
time spent designing and implementing the core features. The final decision on whether or not
to implement these features will be made during the later stages of the design phase.
H ARDWARE D EPENDENCIES
Some of the additional features rely on hardware components present in Android handsets. For
instance, the camera will be used to record images of receipts for digital storage. Consequently,
this feature is entirely reliant upon the ability to access the camera’s functionalities. In addition,
the application will use the handset’s location sensors (GPS) to record the location of a specific
bill or transaction. Both the camera and the GPS functionalities will be achieved using the API
provided by the Android operating system.
References: http://developer.android.com/reference/android/hardware/Camera.html
http://developer.android.com/guide/topics/location/index.html
12
SPLITPAY 13
Software Requirements Specification
E XTERNAL D EPENDENCIES
Several of the features presented in this document rely on the existence and maintained
operation of several APIs. A non-exhaustive list follows.
EMAIL NOTIFICATIONS
The Android platform is not suited for sending mass emails. Thus, the central server will be
responsible for this feature of the application. The smartphone client will notify the server
when messages need to be sent using a custom API that is to be created. This API will use
standard HTTP messaging to facilitate client-server communications. The API will be
implemented using PHP.
SMS NOTIFICATIONS
This feasibility of this feature is yet to be determined. If implemented, this feature would allow
offline users without an Android smartphone to receive notifications of outstanding debt and
other information via text messages. A suitable and free text messaging API that can be called
from the server has yet to be found. The possibility of sending text messages from the Android
smartphone client itself is also being reviewed.
Reference: https://www.x.com/community/ppx/dev-tools
Reference: http://code.google.com/apis/maps/documentation/places/
13
SPLITPAY 14
Software Requirements Specification
3. SYSTEM FEATURES
SplitPay’s
’s system features are divided into two main categories: core features and additional
features. Core features form the body of the application and include any features that are
essential to the functionality of the SplitPay system. These features must be implemented in
order to have a fully-functioning
functioning application. Additional features, however, are not required for
the app to function. They include any features which, if time permits, will be added to the
application in order to provide extra functionality.
NOTE: Features marked by the server icon ( ) exchangee data with the SplitPay server and thus
require both a functioning server system and an active internet connection. If no connection is
available, the application will cache the data locally until a connection becomes available. The
user will be notified if this condition arises.
CORE FEATURES
3.1 USER REGISTRATION AN
AND WELCOME
When the application is installed and run for the very first time,
time, the user is presented
prese with an
initial registration/welcome screen. This screen prompts the user to create an account on the
SplitPay server using the email address associated with his/her Google account. The user also
enters a “Display Name”, which will be the name that is shown as their handle within the
groups. Completing this process will create and store an account for the user on the SplitPay
server, enabling
nabling all of the application’s synchronization capabilities.
capabilities
3.1.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 SplitPay application launc
launched from the Android home screen
Step 2 The user is prompted to enter an email address and a display name
n
The user’s Google account info is entered by default
Step 3 This information is sent to server and stored in the database
Step 4 Registration is completed aand user is taken to main screen
14
SPLITPAY 15
Software Requirements Specification
The “Groups” screen will be the main screen of the application. From this screen, users will be
able to view and manage existing groups. Groups may be created by adding members from the
user’s contacts or by manually entering
ente an email address and name. The creator of a group is
designated as the “Leader” of that
t group. The Leader is responsible for confirming
conf transactions
submitted by other members of the group and will also have the ability to stop or disband the
group.
3.2.1 STIMULUS/RESPONSE SE
SEQUENCES: GROUP CREATION
Step 1 The user selects “Create a New Group” from the main Groups screen
s
Step 2 The user must choose a unique
unique name to be used as the group’s identifier (e.g., “D.C.
Road Trip”). The user can add members to the group from contacts
c stored on the
phone or via manual entry (email address and display name are required)
required).
Users who are not registered with the SplitPay server are designated on the
server as “offline users”
These users cannot participate in transactions directly, so the leader is
responsible for reconciling their balances
At any time, these offline users may register a SplitPay account (using the
same information stored on the server) and take
e control of their transactions
Step 3 The user finishes selecting members and conf
confirms
irms that the group is complete
Step 4 The user is then designated
design as the leader of the group
15
SPLITPAY 16
Software Requirements Specification
3.2.2 STIMULUS/RESPONSE SE
SEQUENCES: GROUP MANAGEMENT
From the management Screen, th
the Leader can choose from the following options:
• Remove member(s)
• Add member(s)
• Disband group (leave all debts hanging)
• Disband and Remove Group
Final Balance sheet is posted to emails and notifications
Group is removed from “Groups”
“Groups screen
• STOP Group and Reconcile Group
The Group still persists in the main screen but new charges cannot be added.
Transactions to resolve the final balances may still be processed within the group
• Manage Transactions (Confirm/Deny member to member payments)
payments)
• Notify All (sends current balance notification to all members in group)
3.2.4 SYSTEM
EM REQUIREMENTS
On several screens, users are given the option to create a new expense, or “Bill”, and post it tto
a particular group. Bills created within the application are meant to represent expenses
incurred by the group in real life. Users must input a display name (e.g., “Groceries”), the
associated cost, and select the individuals responsible for the expense. Once the Bill is
confirmed, it is synced to the server,
server enabling all other SplitPay users in the group to view it.
16
SPLITPAY 17
Software Requirements Specification
3.3.1 STIMULUS/RESPONSE SE
SEQUENCES: POSTING A BILL TO THEE GROUP
Step 1 The user is presented with a screen where they enter the following information:
Expense title
Bill amount
Optional information includes
Location
Type of expense (e.g., Travel, Groceries, Food, etc.)
Comments (i.e., any other information the user finds relevant)
Step 2 The user then selects the members of the group involved in the Bill
User can choose “Select All” or pick members individually
Step 3 An algorithm calculates the distribution of debt amongst each member involved in
the bill
Step 4 The Bill is pushed to the server, which notifies other group members of the Bill and
also updates their running balances
NONE
Only an active internet connection is required.
required
COST-DIVISION ALGORITHM
The algorithm must divide the cost and add the correct amount to each user’s current balance
3.4 MEMBER-TO-MEMBER
MEMBER TRANSACTIONS
17
SPLITPAY 18
Software Requirements Specification
3.4.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 The user selects Member-to-Member
Member Transaction and inputs the following data:
Transaction Description (optional)
Member(s) to be paid
Amount to be paid (to each member if multiple)
Step 2 The user confirms the transaction
Step 3 Each involved member has his/her balance adjusted automatically
Step 4 The information is sent to the server for approval by the Leader (unless the Leader
created the transaction)
NONE
Only an active internet connection
connectio is required.
REAL-TIME BALANCING
The application must be able to update each user’s balance on the fly.
This feature is utilized when the Leader of a group wants to end the group and resolve all debts.
debts
An algorithm takes into account the balances of all members and determines
determine the most efficient
method of resolving debts, minimizing the number of transactions between members.
3.5.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 The group’s Leader chooses to end the group and resolve allll debts
Step 2 The algorithm automatically determines the most efficient way to resolve all debts
Step 3 E-mails and/or notifications
otifications are sent out containing the following information:
The group’s name, members, and the user’s overall balance in that group
A list of group
oup members who who the user owes and how much he/she owes to
each person
A list of group members who owe the user and how much each person owes
him/her
18
SPLITPAY 19
Software Requirements Specification
NONE
Only an active internet connection is required.
required
3.6.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 The user is presented with a list of all transactions/bills
bills posted to the current group
The user may sort these items by date, amount, payer, payer, etc.
Step 2 The user may select any one of the transactions/bills for detailed viewing
Upon selection, a dialog is presented with the details of the transaction/bill
19
SPLITPAY 20
Software Requirements Specification
NONE
Only an active internet connection is required.
required
NONE
Only an operational server is required.
3.7.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 The user enters this screen from the popup context menu from any other screen in
the app
Step 2 The user can see his/her status in each of the groups he/she is a member of
Selecting
ting a specific group from this list displays that
hat group’s History page
Step 3 The user has the option to resolve his/her debts with a transaction for each group
NONE
Only an active internet connection is required.
required
NONE
Only
ly an operational server is required.
20
SPLITPAY 21
Software Requirements Specification
This menu allows the user to modify more advanced settings within the application. The menu
is accessed from any screen by the Preferences button, a hardware button built into all Android
handsets. Modifiable settings include:
• User settings (e.g., e-mail and other personal information can be modified)
• Notifications preferences (how and when the user is notified, if at all)
• Feature preferences—this includes the following options:
Interface preferences (allows the user to choose what information is displayed)
PayPal account preferences (see section 3.11 for further details)
GPS preferences (see section 3.12 for further details)
From the Settings menu, the user may also access the Help screen (see section for details).
NONE
The Settings menu may be accessed at any time, even if there is no connection with the server.
21
SPLITPAY 22
Software Requirements Specification
The Help menu is meant to answer any questions the user may have while using SplitPay. The
menu displays a list of topics related to features, menus, and the app in general. The user can
select any of these topics to aaccess further information and explanations.
3.9.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 From any screen, the user may press the Settings button built into the phone
Step 2 This displays the Settings menu, where he/she can then select the Help menu
Step 3 The user is presented with a list
list of help topics which he/she can scroll through
Step 4 Once the user selects a topic, more information on that topic is displayed
Step 5 The user can navigate back to the Help screen or exit the Help menu altogether
NONE
The Help menu may be accessed
sed at any time, even if there is no connection with the server.
Push notifications is an added mechanism to provide updates and alerts from the application
server to the user's android device. Whenever a new expense is posted in a group, the server
will broadcast
oadcast notifications to all group members' phones of the new bill and each user's
respective balances. Members are also notified when all debts in a group are resolved or when
the leader chooses to notify all members of the group's balance. Priority: medi
medium
22
SPLITPAY 23
Software Requirements Specification
NONE
Only an active internet connection is required.
NONE
Only an operational server is required.
23
SPLITPAY 24
Software Requirements Specification
ADDITIONAL FEATURES
3.11 MEMBER DEBT VISUAL
VISUALIZATION
This feature allows users to access group balances as bar graphs, rather than the default text-
text
only form. These visuals can be obtained at any time by selecting the Member Debt
Visualization option from any group. The visuals are updated any time a group member’s
balance changes.
3.11.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 The user
ser activates this visualization via a button on a particular
particular group page
Step 2 From here, the user can view details about individual members by selecting them
NONE
Only an active
ve internet connection is required.
required
GRAPHICS IMPLEMENTATION
The application must have a method of converting raw data into rich, dynamic visuals.
3.12 PAYPAL
This feature will offer users the option to resolve their debts through using PayPal.
P This will
enable users to make real financial transactions through the app, which will then update all
balances accordingly.
24
SPLITPAY 25
Software Requirements Specification
3.12.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 The user accesses this feature from any transactions-related
transactions related screen
Step 2 The user enters his/her PPayPal account information
The user has the option of being automatically logged in next time he/she
uses this feature
Step 3 The user is taken to a screen where he/she must fill out all of the necessary details
of the transaction
If this information was already entered in the transactions screen, it will be
filled in automatically
Step 4 The user confirms the payment, and the transaction is completed
All relevant balances are updated to reflect this
PAYPAL ACCOUNT
Only users with a PayPal acc
account
ount will be able to utilize its functionalities. Obtaining a PayPal
account is done independently of the SplitPay system.
PAYPAL INTEGRATION
The application must utilize the PayPal API to provide the appropriate functionalities.
When a Bill is posted or a transaction is made, this feature records the GPS location of the
phone(s) involved. At any point, a user may access this information in the form of a map with
each saved location displayed. This feature provides a visualual record of where the group has
been, what payments were made at specific locations, and what path on the map the group has
taken. The application will use Google Places as its maps tool.
25
SPLITPAY 26
Software Requirements Specification
3.13.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 When posting a bill ill or transaction,
transaction the user has an option to add the GPS location
Step 2 If this option is selected, the phone records the GPS location and also sends it to the
server, where it is synced to all other SplitPay-enabled phones
Step 3 The user may also manually enter in an address if the GPS location is not desired
Step 4 From any group screen, the user may access the group’s associated map
Step 5 Each address and/or GPS location is pinned to the map, with a line tracing the path
between each pin
NONE
Only an active internet connection is
i required.
Receipt imaging allows users to store the receipt associated with a Bill for later viewing.
v
Whenever a user posts a Bill,, he/she will have the option to take a photo of the receipt using
the phone’s built-in camera.. This image is then sent to the server and synced with all SplitPay
users in the group.
3.14.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 While creating a new Bill, the user may select the Receipt Imaging feature.
Step 2 This activates the camera and creates a window on the screen to act as a viewfinder.
Step 3 The user then takes a picture of the receipt by pressing a button on the app.
Step 4 The user has the option to retake the picture until he/she is satisfied with the result.
Step 5 The picture of the receipt is then saved and becomes accessible by viewing the Bill.
Step 6 After the new bill is created, the data will be pushed to the server and synced with
other phones
26
SPLITPAY 27
Software Requirements Specification
FUNCTIONING CAMERA
The phone’s built-in
in camera must be functioning properly.
CAMERA INTEGRATION
The application must utilize the Android API to gain access to the camera.
3.15.1 STIMULUS/RESPONSE SE
SEQUENCES
Step 1 When a Bill is posted or a transaction is made, the server is updated and any user
involved is sent a notification
The group leader may modify offline users’ notification preferences, which
will determine
rmine whether the user receives an e-mail,
e mail, a text message, or no
notification at all
Step 2 SplitPay users are notified within the application, but offline users are sent an e-mail
e
or text message containing information about the update.
27
SPLITPAY 28
Software Requirements Specification
The SplitPay Tutorial is a structured, condensed version of the Help menu. This feature will
allow the user to view brief explanations of each menu and feature. These explanations will be
kept brief, as the user interface will be designed to be as intuitive as possible. The tutorial will
be designed to answer any questions a first-time user may have about the application.
NONE
The user does not have to satisfy any conditions in order to access the tutorial.
TUTORIAL SYSTEM
The application must have a tutorial system in place that is able to navigate through each menu
without letting the user modify any fields. This system will also include pop-ups which briefly
explain each feature, as well as navigation buttons that allow the user move back and forth
between steps.
28
SPLITPAY 29
Software Requirements Specification
• From every menu, the user can access the built-in settings and back/previous button
o These are physical buttons built into the phone, so they are not shown here
• Every menu will have a descriptive title
• Menus will be readable, but will make efficient use of space so the user isn’t forced to
navigate through too many menus
29
SPLITPAY 30
Software Requirements Specification
30
SPLITPAY 31
Software Requirements Specification
• Shows all groups, and how much the user owes the group collectively
• User can select a group to open a View Group (in a separate menu)
• Create a Bill option (Separate menu)
• Create group option (Separate menu)
31
SPLITPAY 32
Software Requirements Specification
• Shows (graphically) how far ahead/behind each member is to the group in terms of
collective debt to the group
• Shows (graphically) how much the users owes or is owed by each member of the group
• Create a Bill option (separate menu)
• Users can make a “Member to Member” transaction by selecting a member and
entering a payment amount (in a separate menu)
• Transaction History (separate menu)
• Group leaders have additional options
o Add / Remove members
o Clear debts (individuals or entire group)
o Designate a new Leader
o Resolve debts (entire group)
o Disband group
32
SPLITPAY 33
Software Requirements Specification
33
SPLITPAY 34
Software Requirements Specification
34
SPLITPAY 35
Software Requirements Specification
• Shows list of transactions/split bills between the user and members of the group
• The group leader can confirm/deny a transaction’s validity
35
SPLITPAY 36
Software Requirements Specification
36
SPLITPAY 37
Software Requirements Specification
SplitPay is intended as a mobile application for the Android platform and hence is solely
supported on Android-powered devices. Messages, updates, and data exchanged between
Android devices are transmitted to and handled by the SplitPay server. This produces the
illusion of peer-to-peer interactivity between group members, however this is not the case as
all interactions always run through the central server first.
SplitPay is being developed specifically for Android 2.2 (Froyo) and all versions released after it.
The Android platform supports push messages that will be used to synchronize data between
the local application and the main application server. Information will be sent using TCP/IP and
the HTTP protocol.
The Android platform provides abstractions for all network communication interfaces and thus
the hardware as well.
The SplitPay app is to be developed under the Android operating systems using the Java JDK
(Java Development Kit) and the Android SDK (software development kit) tools.
37
SPLITPAY 38
Software Requirements Specification
The SplitPay application will have a network server that is web-based and created using the PHP
(Hypertext Processing) language. The server exists to retrieve information from the database
and calculate payments. The product also calls for a database system that stores user
information and transaction history between users. The HTTP server will use a push protocol to
push notifications of updates onto the Android phones. Furthermore, whenever a user opens
the SplitPay app from their phone, a pull protocol will be used to retrieve and sync the latest
transaction updates from the server.
38
SPLITPAY 39
Software Requirements Specification
Performance should not be an issue because all of our server queries involve small pieces of
data. Changing screens will require very little computation and thus will occur very quickly.
Server updates should only take a few seconds as long as the phone can maintain a steady
signal. The cost-division algorithms used by in application will be highly efficient, taking only a
fraction of a second to compute.
SplitPay will not affect data stored outside of its servers nor will it affect any other applications
installed on the user’s phone. It cannot cause any damage to the phone or its internal
components. The only potential safety concern associated with this application applies to
virtually all handset apps: SplitPay should not be used while operating a vehicle or in any other
situation where the user’s attention must be focused elsewhere.
This application assumes that only the user or whoever he/she allows will have access to
his/her Android handset. With that being said, only a Google email address is required to verify
the identity of the user upon opening the app. Since it is not password protected, there is no
method to authenticate the user’s identity. This could only pose a thread if a user has set up
PayPal functionality, however any transaction involving real currency must be authorized and
confirmed before becoming final. The PayPal API provides all of the security checks needed to
ensure that no fraudulent transactions occur.
The graphical user interface of SplitPay is to be designed with usability as the first priority. The
app will be presented and organized in a manner that is both visually appealing and easy for the
user to navigate. There will be feedbacks and visual cues such as notifications to inform users of
updates and pop-ups to provide users with instructions.
39
SPLITPAY 40
Software Requirements Specification
To ensure reliability and correctness, there will be zero tolerance for errors in the algorithm
that computes and splits expenses between group members. To maintain flexibility and
adaptability, the app will take into account situations in which a user loses internet connection
or for whatever reason cannot establish a connection with the server. These users will still be
able to use the application, but any Bills, transactions, etc. posted while disconnected will be
cached until the connection is restored.
Furthermore, the group leader also has the option to add members who do not own an Android
phone and add transactions on their behalf. With SplitPay being ported solely for the Android
platform, this software application has the advantage of being portable and convenient to use
whenever and wherever. Overall, the app balances both the ease of use and the ease of
learning. The layout and UI of the app will be simple enough that users will take no time to
learn its features and navigate through it with little difficulty.
40
SPLITPAY 41
Software Requirements Specification
6. KEY MILESTONES
41
SPLITPAY 42
Software Requirements Specification
Create a Server Database systems & Nick and Eric have Internet No physical server;
application servers experience general knowledge limited number of team
in this field members with SQL/PHP
experience
Sync the Server Application Nick and Eric have Internet Possible compatibility
to the networking with general knowledge issues
Application online servers in this field
Design the Design & usability Josh has extensive Android Developers Schedule conflicts;
Interface experience; familiarity digital design community; published physical constraints of
with Android GUI experience; Rick examples handset screen
design has experience with resolution
human-computer
interaction (HCI)
Design an Knowledge & All members have Android Developers Potential schedule
algorithm experience designing taken data community; published conflicts
mathematical structures and examples
algorithms algorithms
Implement an Familiarity with the All team members Android Developers Potential schedule
algorithm Android development have Java community; published conflicts
environment programming examples
experience Android emulators are
publicly available for
testing
Implement the Familiarity with All team members Android Developers Potential schedule
interface Android GUI have Java community; published conflicts
implementation programming examples
experience Android emulators are
publicly available for
testing
42
SPLITPAY 43
Software Requirements Specification
8. OTHER REQUIREMENTS
A database for SplitPay calls for a server side implementation that holds information for the
users, groups, bills, transactions, as well as all the relationships involved. The database will be
using MySQL. The following provides an example of information that may be stored in the
database:
The server will be configured on a Linux platform, and through use of PHP will allow interaction
and processing in conjunction with the database. Processes to be done on the server include:
pushing/pulling data, updating data, and generating notifications.
43
SPLITPAY 44
Software Requirements Specification
9. APPENDIX A GLOSSARY
OFFLINE USER
A user that has been added to the SplitPay server but does not have a copy of the application.
These users are contacted exclusively through email and/or SMS. An offline user may become a
SplitPay user by downloading the application and claiming their account.
GROUPS
Groups in the context of the SplitPay application are a collection of users that can create Bills
and Transactions amongst each other.
BILLS
Bills are a method of distributing an expense among some or all members of a group.
TRANSACTIONS
Transactions are used for re-allocating debt to different members of the group. Transaction
amounts may be positive or negative and may involve two or more members of a group.
STOP GROUP
Bills and transactions that add debt can no longer be posted to the group. The group enters the
debt resolution state where transactions may only be applied to resolve all debts. The group
still persists in the Groups screen.
44
SPLITPAY 45
Software Requirements Specification
MOTIVATION
We are designing an application that facilitates the process of paying off shared expenses. In other
words, we want to make it easier to pay for things as a group. This is relevant in many different
situations, ranging from every day transactions (friends splitting the cost of dinner), to recurring
payments (roommates paying rent), to a more professional setting (a team of professionals making
business transactions). Depending on the number of people and/or the amount of money involved,
these situations can get very complicated.
PROBLEM STATEMENT
The problems we aim to alleviate with this app include the following:
• Difficulty of calculating divided costs
• Unfair or imbalanced payments amongst individuals
• Lack of accountability for money owed
• Difficulty remembering payments already made, outstanding debts, etc.
The app we design will solve these problems and several more. Consequently, we will include the
following functionalities:
• Automatic calculation of money owed by each member of the group
• Customizable formula for splitting costs
• Transaction history (including all payments made & costs incurred by each individual)
We will also add the following features, which extend beyond the simple task of dividing costs:
• Support for multiple transactions which can take place over extended periods of time
• Automatic notifications, alerting users of outstanding debts and/or other relevant info
• Transaction synchronization, keeping each group member up to date at all times
• PayPal integration, allowing for easier transactions
• Receipt storage, which allows the user(s) to save photos of receipts associated with particular
purchases/expenses
• E-mail and print functions, allowing non-Android users to obtain copies of transactions
NOTE: Some of these features are not part of our core design and will only be added if time permits.
45
SPLITPAY 46
Software Requirements Specification
OBJECTIVES
Beyond implementing the above features, there are a number of additional objectives we must
accomplish as a team. First and foremost, as a group we must familiarize ourselves with the Android
platform, as this will lay the groundwork for future development. Additional objectives include the
following:
METHODOLOGY
We will be dividing the team into 3-4 subgroups, including some or all of the following:
Research/Documentation, Android/Java Implementation, Server/Web, and GUI & Graphics. In addition,
we will divide the development process into several discrete stages. The first stage will be dedicated to
getting everyone in the group acclimated to the new development platform. We will do this by finding
and sharing resources (documentation, sample code, etc.), as well as running through the set-up process
for the Android SDK as a group. Before beginning development, we will establish documentation
guidelines and testing frameworks in order to enhance maintainability and prevent bugs in the long run.
Next, we will work up specifications, establish deadlines, define roles, and allocate tasks to each group
member. We plan on dividing up the development process into two central phases, core development
and feature development. Core development will involve implementing the essential aspects of our
application (calculator, transaction history, auto-sync, etc.), whereas feature development will
encompass any additions which extend the app’s capabilities (PayPal, advanced GUI, e-mail/print
functions, etc.). We will implement these additional features in order of priority (which we will establish
before beginning development).
HISTORY
There are several applications “on the market” which are similar to our proposed app (examples include
Bills Are In, Share a Bill, Split a Bill, Fair Share, and Xpense Split). A majority of these are web-based
applications with little or no mobile functionality. In addition, they all require users to set up an account
before they can utilize their services. The remaining apps we found were limited to the iOS platform,
leaving the Android market open. Furthermore, we plan on adding some features which are not
currently available in any of these applications.
46