Embed Size (px)
Citation preview
VATM TEAM PROJECT
PORTFOLIO/ SYSTEM
DOCUMENTATION
ABSTRACT The Virtual ATM
allows people to
remotely retrieve
ordered cash unlike
a traditional ATM.
This application
features a style of
leisure for delivery
service ordering
customers to have
cash tender included
with their delivery!
VATM team 2018 capstone project
The Virtual ATM (Virtual Account Management System)
Documentation Created: Sunday, June 10, 2018
Documentation Latest update: Sunday, June 10, 2018
By: VATM TEAM
www.vatm.com
email: [email protected]
We would happily welcome feedback from you on how, if anywhere, you would like this
documentation improved. If you would find anything a little bit easier and more helpful if
we went into more detail or explained something a little better - we'd be happy to hear it.
We want VATM to be the best app! If you have any comments, please mail us via the form
on ww.vatm.com
VATM GROUP MEMBERS INFORMATION
Instructor :
Toyin Aguda
Email: [email protected]
• Tuyet Luuet
Email : [email protected]
• Md Nayeem ul arafin khan
Email: [email protected]
• Wei-Hsuan Wong
Email: [email protected]
• Bakhrom Botirov
Email: [email protected]
• Robert Hill
Email: [email protected]
• Ruvim Kuzmik
Email: [email protected]
Table of content
Introduction
What to Expect
Research and outreach
Framework
1.1 Purpose of that documentation
▪ 1.2 Scope and Client Business background
▪ 1.3 Intended Audience
▪ 1.4 Constraints
2.0 System Overview features and methods relational diagram
▪ 2.1 How our VATM will work
▪ 2.2 VATM API PROCESS Diagram
3.0 System Architecture: The Three Tier Architecture
▪ 3.1 User Interface Layer
▪ 3.2 Application Logic Layer
▪ 3.3 Data Storage Layer DB
4.0Architectural Design of VATM
▪ 4.1Architectural Description
5. Some screen shots of VATM apps
6.0Database Description
▪ 6.1 VATM DB ER SCHEMA Diagram
▪ 6.2 Description of Each Table in the VATM database which
information each table will hold
7.0 VATM Developers Files and its detailed description
▪ 7.1 VATM security features
8 Non-Functional Requirements
▪ 8.1 Hardware Interfaces
▪ 8.2 Software Interfaces
▪ 8.3 Communications Interfaces
9.0 Final words and Other Nonfunctional Requirements
▪ 9.1 Safety Requirements
▪ 9.2 Security Requirements
▪ 9.3 Software Quality Attributes
▪ 9.4 Hardware Constraints
10.0 Results of at least three usability reviews:
Introduction :
App Documentation is the design work product that formally documents the design of the App
components. App Documentation gives us the detailed description about the flow of the project.
We are living in the age of connectivity, and that means more things than ever before are right at
your fingertips — literally. With one press of the button, one swipe left or right, you can open
new worlds in seconds. We’re talking about apps, those little icons on your mobile device.
But as a team , we don’t just talk about apps; we live and breathe apps. We have assembled a
team of the best and brightest minds in software development, marketing, and leadership, giving
our clients access to the most cutting-edge technology. You can rest assured you’re in good
hands, as we have some experience in both Android and iOS app development.
Our goal is to create something you’re proud of and that helps our client business. Apps can be
transcendent, and they can also be colossal failures.
What to Expect
Mobile app development is serious business. It takes time and patience to create something that
works for you and is free of bugs and other issues. Updates are required, but it’s important to
start with a sound foundation. As group, we believe in a thorough approach that provides our
clients with as much engagement as they request. While our entire team will be developing your
app, we will assign a project lead who will be your main point of contact. In that case your main
contact will be our controller Robert hill.
Research and outreach
A large part of the work we did was behind the scenes. There was time when we didn’t
communicate with Client. for weeks, but that’s only because we’re intimately involved in the
development phase. However, before any of that begins, we need to make a checklist of
everything client want in his new mobile app.
We gathered information about client company and vision and how it works. We figured out
who is your customers are and how we can attract more through our new app. Audience
engagement, research, and branding are key in app development, and we conducted focus
groups to find out why people choose [vatm
Framework
Like a website, an app needs a sitemap and wireframes. Think of this as the structural integrity of
a skyscraper. Aegis will have a key role in the design process, as it’s important that you are
getting what you want. Plus, it’s better to work out issues in this stage than later down the road.
Here are some highlights of this process:
• Functionality and content.
• Wireframes, the structural core of your app.
• Branding and integration of existing digital platforms (i.e., web and email).
• User Experience and User Interface, or UX and UI — essentially, how you interact with the app,
what makes it easy to use and desirable.
1.1 Purpose of that documentation
App Design Document defines the modules, interfaces and the interaction between modules and
interfaces. It also helps us in giving information about how the app will look the appearance of
user interfaces and the information about static and dynamic view of the app.
The main objective of this document is to illustrate the requirements of the VATM apps. The
document gives the detailed description of the both functional and nonfunctional requirements
proposed by the client. The document is developed after several consultations with the client and
considering the complete requirement specifications of the given Project. This document forms
the basis for all future design and coding.
The designer's goal is to develop a model that achieves the functional requirements while
operating within key constraints. The main goal is creating a design which is simple, easily
understood, easily communicated, and easily built and easily tested design.
1.2 Scope and Client Business background:
VATM apps is being developed for the company called Aegis. Founded in 1995, Aegis provides custom engineering and technology development services to a broad array of clients, including Fortune 50 companies, the U.S. Government, inventors, and entrepreneurs. Aegis has a proven history of success in technological and product development. Our senior-level engineers, program managers, and consultants supply tailor-made solutions that are consistently at the forefront of technological innovation. The important modules that are implemented in the proposed app are given bellow.
• Log in to the apps via unique id providing throw mobile.
• Make a user profile.
• My account facilities for the registered user so that they can see their account
information.
• Ordering/transection facility depends upon I) cash order ii) or grocery order with the cash
back.
• Administrator has all the privileges to add, modify and delete any information from the
app which will be our client.
1.3 Intended Audience
This document is intended for use by our technical developers. This document also
includes sections relevant to the operational and maintenance group.
The intended audiences for this document are:
• The team members of VATM group.
• The administrative staff of the client company.
• The Project Supervisor/manager or owner.
This document will be reviewed frequently by the above audiences to check if the
different phases of the project are being completed by meeting the given requirements. It
is expected that the intended audience shall critically review this document for functional
accuracy and revert to team with their feedback and comments within a less time.
1.4 Constraints
The team must follow the rules specified in the team contract. The team is proceeding to develop
an appropriate system; however, the design might slightly change to meet the client
requirements.
2.0 System Overview features and methods relational
diagram:
VATM VISSION STATEMENT:
“The Virtual ATM allows people to remotely retrieve ordered cash unlike a traditional
ATM. This application features a style of leisure for delivery service ordering customers to
have cash tender included with their delivery!”
– by Robert Hill (VATM controller administrator)
The Virtual ATM (Virtual Account Management System) is an application providing the
way to access cash, get cash delivered to any customers’ locations within the service area
with their phone. This project has been developed to carry out the processes easily and
quickly that customers can use VATM system to provide many ways to perform
cashback tasks. The VATM System undertaken as a project is based on relevant
technologies. The system is then designed in accordance with specifications to satisfy the
requirements. The system design is then implemented using MVC (Model View Control).
The front-end is developed for both traditional Web and Android applications. The UI
(View) is developed on Java languages. Our server has an endpoint communicating using
AJAX within the page and replies. The server End-to-End point using AJAX
communication and replies JSON packages using Restful API, CRUD technology with
Node.js and creating a connection to MYSQL database where customers’ information
and the transactions are stored. In this project covers the basic functionality of user
Login, Signup, Profile, and Transaction pages with customers’ authentication token to
identify the customers before allowing customers next steps to request a cashback
delivery to their home and updating features, and for every transaction occurs. The
system is designed as an interactive and content management system. Thus, above
features of this project will save transaction time and therefore increase the efficiency of
the system.
Features of VATM :
➢ VATM WILL HANDLE ALL THE INCOMING REQUESTS ASYNCHRONOUSLY LESS
THAN 50MS.
➢ IT COULD HANDLE UP TO 1000 REQUESTS IN ONE SECOND.
➢ VATM USERS CAN CREATE A USER ACCOUNT , CHECK AND MODIFY THEIR
PROFILE, PLACE THE TRANSACTION AND TRACK IT.
➢ WHEN THEY WILL BE DONE WITH THE APP THEY CAN SAFE AND SECURELY LOG
OFF AND LOG BACK IN .
➢ VATM WILL USE AUTHORIZED ENCRYPTED, AND UNIQUE TOKEN TO KEEP THE
USER LOGGED IN AND HAVE TRANSACTIONS SAFE AND SECURED .
2.1 How our VATM will work:
Order
When you’re ready to check out, you’ll see your address, an estimated delivery time and the
price of the order including tax and delivery fee plus how much you want cash back. When
everything looks right, just tap Place order and that’s it. Your will get a confirmation email/text
right way.
Track your order:
You can Follow your order in the app. First, you’ll see the driver accept your order and preparing
for withdraw money. Then, when the driver is ready to leave you will track the driver throw our
GPS system and you will be able to see driver name and photo and track progress on the map
with some other information and duration of time how long it will take to reach you.
Context Diagram summarizes all processing activity and helps users to view highest level of
system with system boundaries. The system overview can be shown in the form of context
diagram.
VATM API login endpoint diagram:
VATM profile get diagram
VATM sign up end diagram
VATM transaction diagram
VATM transaction diagram
2.2 VATM API PROCESS Diagram
API process diagram is the graphical system model that shows all main requirements for an IS in
one diagram
3.0 System Architecture: The Three Tier Architecture:
To develop VATM app the architecture that we implemented is Three Tier Architecture. The
User Interface Layer, Application Logic Layer and Data Storage Layer together called as Three
Tier Architecture.
3.1 User Interface Layer
The User Interface Layer will consist of everything shown directly to the client. This Layer will
communicate only with the Application Logic Layer. This Layer will also be responsible for
initial validation of any user inputted data. Any validation that requires communication to the
Data Storage Layer will however be completed at the Logic Layer.
3.2 Application Logic Layer
The Business logic for our project is Visual Basic. It will be responsible for providing a secure
connection to the Data Storage Layer and formatting information received from the SQL Server
for presentation to the User Interface Layer.
3.3 Data Storage Layer DB
The Data Storage Layer will record all information required by the Logic and User Interface
Layer. This data will include Subject details for general user and admin user information. All
passwords stored in the database will be encrypted to prevent unauthorized access. Within the
Data Storage Layer, a collection of SQL Queries will provide access to the data in a meaningful
way.
4.0Architectural Design of VATM
VATM site map
4.1Architectural Description
Name: User log in page Type: App page Description: User log in page or the first page of our app will contain have two options to sign in or sign up for the user account. it will direct user to their exiting profile or will give the user a unique number via email to register and open an account, throw this page will take the user to their personal profile. Operations: Pre-condition: Connected to the server. Post-condition: presents another page Exceptions: None
Name: user profile page Type: APP page Description: If the user wants to check their account details, it can be done with the help of User profile page. Whenever log in button is clicked the apps will ask asks the user login name and password, if the login name and password is valid the user is directed to user profile page. The left panel changes into user profile page left panel consists user order information an all other account information. Operations: Pre-condition: Connected to serve/account and app Post-condition: presents another page Exceptions: None Name: Transection page Type: APP page Description: Registered user can order or purchase money from here by providing desired amount they want to purchase. This page will link to the checkout page. Operations: Pre-condition: Connected to serve/account and app Post-condition: presents another page Exceptions: None Name: check out page Type: APP page Description: User will provider their address and shipping information here. Operations: Pre-condition: Connected to serve/account and app Post-condition: presents another page Exceptions: None
5. Some screen shots of VATM apps
VATM our log in page.
VATM account signup page
VATM user profile page.
VATM transaction page.
VATM confirmation page
6.0Database Description
The Database of VATM consists 6 tables. They are:
tables userData,
userAddress,
userPhoto, user( user data lookup table),
transaction,
userTransaction (transaction lookup table)
6.1 VATM DB ER SCHEMA Diagram
6.2 Description of Each Table in the VATM database which
information each table will hold:
userData: user id, user last Name, first Name, email, phone Number, and password
userAddress: address id, user primary address1, secondary address, city, state, zip code
userPhoto: user id, photo
user: user id, address id
transaction: transaction id, transaction amount, transaction fee, cash back amount, time requested,
time delivered, confirmation code, is cancelled.
userTransaction: user id, transaction id.
The end users of this database: The end users of this database will be the register user who will
be using VATM apps.
Administrators of This Database: Our honourable client will be the administrators of this
database
Or the developer who are appointed by the administration will have all the privilege to change,
access, modify and delete any query/ information from the database/database table.
7.0 VATM Developers Files and its detailed description: These
are the js files that are loaded into VATM app.
VATM Developers Files Documentation
File name Description Developer Last
modified server.js
Create a http server ,theoretically server is a function that accepts
Bakhrom Botirov
04/28/2018
options and other functions.it will handle all the incoming request and send the response accordingly.
settings.js
This file contains all the settings of the VATM application.
Robert Hill 06/07/2018
helpers/validators.js
This will validate the data and send it to the database and check the existence of user and send back the response to the controller. And will also validate the Token .
Robert Hill 05/28/2018
model/dbInit.js
Main core file for VATM database connection need settings.js/ dbConnection.js file towards work with MYSQL. And will also create userAddress table in vatm database
Tuyet luu 05/29/2018
model/dbConnection.js Authentication of database connectivity ,either we are connected or not give you the response accordingly
Tuyet luu 05/28/2018
model/dbSetData.js Will check the Db connectivity and insert data to the database
Tuyet luu 05/29/2018
model/dbInsertObj.js This is an insert object function dbInsertObj file, which require seetings.js file , this will check the database connectivity , create a connection variable with the required details, make the connection to the database and show the result.
Tuyet luu 05/29/2018
model/dbInitSignUp.js This is the init file that create connectivity to the database and create three userData, userAddress, userPhoto table into the database .
Tuyet luu 05/29/2018
model/dbGetData.js
Retrieve the data based on password and phone Number and user address. It will get the password and phone number from the controller and check the database that the password and phone number is exist in the database or not then send back the response to the controller.
Tuyet luu 06/06/2018
model/model.js Reference to the profile model function.
Robert Hill 05/06/2018
model/transaction.js Create and Monitor Transaction. After delivering cash Vendor will mark as delivered , vendor can view all available transactions as a table, or select the Show all transactions table. To Track a transaction vendor, Select the transaction's name, then select Track as key transaction. And can View transaction trace details which includes a complete summary of single transaction.
Bakhrom Botirov/ Tuyet luu
06/06/2018
controller/transaction.js
calls for the Model to run Last Transaction SQL statement
Robert Hill 06/07/2018
Controller/signUp.js
Will check if there is any error when getting the information from the
Bakhrom Botirov
05/04/2018
user at signup page and validate the data and throw the error or pass it to server.js. and create connection to the vatm database. This file is the signUp controller it will validate user input and Pass valid user input to the model and insert into database, and if user input inserted successfully it will generate a token and assign it into data json object as token key.
controller/controller.js
This file will be used as a main controller and keep all the available controller.
Robert Hill 05/04/2018
controller/auth.js
This file is used for the main Controller to validate the function.
Robert Hill 05/04/2018 File status :Deleted
controller/login.js
This file is used for controllers logging function.
Robert Hill 05/05/2018
controller/profile.js
This File has the functions for the Servers reference, which Pass Requested data to the Controller. The Controller will Pass the verified information to the Model. To attempt GET, and UPDATE statements on the Database.
Robert Hill 05/07/2018
controller/template/profileTemplate.js
Templet for the profile from the database
Robert Hill 05/04/2018
helpers/token.js This file creates token from JSON object and read token and makes
Bakhrom Botirov
05/06/2018
into JSON and pass the value to the controller.
helpers/profileChecker.js
This file has a function to Check the format type of values being passed in an Object.
Robert Hill
05/07/2018
BECAUSE OF THE CLIENT COMPANY PRIVACY AND SECURTY REASON WE WILL
NOT GOING TO PROVIDE ANY HARD CODE ON THE DOCUMENTATION . WE
WILL HAND OVER TO IT TO OUR HONURABLE CLIENT AFTER END OF OUR
PROJECT.
Here is one of our main server.js file code example which Create a http server . server is a function that accepts options and other functions.it will handle all the incoming request and send the response accordingly.
7.1 VATM security features
VATM is Secured from:
1. XSS attack (Crosstie attack)
Cross-site scripting (XSS) is a code injection attack that allows an attacker to execute malicious
JavaScript in another user's browser.
The attacker does not directly target his victim. Instead, he exploits a vulnerability in a website
that the victim visits, to get the website to deliver the malicious JavaScript for him. To the
victim's browser, the malicious JavaScript appears to be a legitimate part of the website, and the
website has thus acted as an unintentional accomplice to the attacker.
2. SQL injection
Structured Query Language (SQL) is used to query, operate, and administer database systems
such as Microsoft SQL Server, Oracle, or MySQL. The widespread use of SQL is consistent
across all database systems that support it; however, there are intricacies that are to each system.
Database systems are commonly used to provide backend functionality to many types of web
applications. In support of web applications, user-supplied data is often used to dynamically
build SQL statements that interact directly with a database. An SQL injection attack is an attack
that is aimed at subverting the original intent of the application by submitting attacker-supplied
SQL statements directly to the backend database. Depending on the web application, and how it
processes the attacker-supplied data prior to building an SQL statement, a successful SQL
injection attack can have far-reaching implications. The possible security ramifications range
from authentication bypass to information disclosure to enabling the distribution of malicious
code to application users.
3. LFI and RFI attacks
In an age when we are constantly developing innovative solutions to brace against sophisticated
cyber-attacks, we often underestimate the havoc that can be unleashed by the benign looking,
more elementary attack forms. They may not make big headlines as the high-profile cyber-
attacks, but they can be disastrous as well.
Local File Execution (LFI) and Remote File Execution (RFI) are like the nefarious Cross Site
Scripting (XSS) attacks. All of them are forms of code injection attack, with the former two
being less sophisticated and therefore easily preventable. Although not taken seriously by the
security community, LFI and RFI attacks constitute 21 percent of all observed web application
attacks.
8 Non-Functional Requirements
8.1 Hardware Interfaces
Server Side:
➢ Operating System: MySQL /PhpMyAdmin, 2 CORE CPU,REMOTE ACCESS
PORT NUMBER
➢ Processor: 1GHz or higher
➢ RAM: 8GB or more
➢ Hard Drive: 80 GB HDD or more
➢ 3.5 inches or more screen size
Client side:
➢ Operating System: KitKat, lollipop & Marshmallow
➢ Processor: 1GHz or higher
➢ RAM: 512 Mb or more
➢ Hard Drive: 10 GB or more
➢ 3.5 inches or more screen size
8.2 Software Interfaces
➢ Database: SQL Server.
➢ Application: REST API (Representational State Transfer)
➢ APP Server: Apache (Web server, MySQL as the relational database
management system)
8.3 Communications Interfaces
The Customer must connect to the Internet to access the and download the APP:
9.0 Final words and Other Nonfunctional
Requirements
9.1 Safety Requirements
The database may get crashed at any certain time due to virus or operating system
failure. Therefore, it is required to take the database backup.
9.2 Security Requirements
We developed a secured database for our client company . Depending upon the
category of user the access rights are decided. It means if the user is an administrator
then he/she can be able to modify the data, delete, append etc., All other users will not
have the rights to retrieve the information about database.
9.3 Software Quality Attributes
The Quality of the database is maintained in such a way so that it can be very user
friendly to all the users of the database.
9.4 Hardware Constraints
The APP requires a database to store persistent data. The database should have backup
capabilities.
10.0 Results of at least three usability reviews:
Thus, we are working on a mobile apps, so our usability testing would be slightly different . we will focus on couple of ground before we test our app , which will be:
1. Purpose, goals and objectives of the test 2. Method (test design) 3. Test environment, equipment and logistics
Purpose, goals and objectives of the test: purpose of the test will be how user friendly is our app is and how it response to user when user interact with that .
Method (test design): Android Mobile App.
Test environment, equipment and logistics: in class with Samsung galaxy s5 or you can use any kind of android devices.
The Tasks that Performed:
• Register an account • Sign into your account • Make profile • And make transaction
Tasks that Performed User 1 User 2 User 3
• Register an account
Easily register for an account with the email address and password
Same as user 1 Easily open an account with the email address and password
Easily register for an account with the email address and password
• Sign into your account
With the confirmation token user easily sign in to their verified account.
With the confirmation token user easily sign in to their verified account.
With the confirmation token user easily sign in to their verified account.
• Make profile User 1 easily create his/her own profile.
User 2 easily create his/her own profile.
User 3 easily create his/her own profile.
• make transaction
User 1 ordered money and got the response that transaction was procced
User 2 ordered money and got the response that transaction was procced
User 3 ordered money and got the response that transaction was procced
…End of the document…
©2018 VATM ALL RIGHTS RECIVED.
