Product Maintenance Application system documentation Project 2022

Running head: Product Maintenance Application system documentation
MITS5502
Product Maintenance Application system documentation
(Student Full Name)
(Student ID)
Running head: Product Maintenance Application system documentation

Table of Contents
1. Introduction 4
1.1 Purpose 4
1.2 Scope 4
1.3 Definitions, Acronyms, and Abbreviations. 4
1.4 Overview 4
2. The Overall Description 4
2.1 Product Perspective 4
2.1.1 System Interfaces 4
2.1.2 Interfaces 4
2.1.3 Hardware Interfaces 4
2.1.4 Software Interfaces 4
2.1.5 Communications Interfaces 4
2.1.6 Memory Constraints 4
2.1.7 Operations 4
2.1.8 Site Adaptation Requirements 5
2.2 Product Functions 5
2.3 User Characteristics 5
2.4 Constraints 5
2.5 Assumptions and Dependencies 5
2.6 Apportioning of Requirements. 5
3. Specific Requirements 5
3.1 External Interfaces 5
3.2 Functions 5
3.3 Performance Requirements 5
3.4 Logical Database Requirements 5
3.5 Design Constraints 5
3.5.1 Standards Compliance 5
3.6 Software System Attributes 5
3.6.1 Reliability 6
3.6.2 Availability 6
3.6.3 Security 6
3.6.4 Maintainability 6
3.6.5 Portability 6
3.7 Organizing the Specific Requirements 6
3.7.1 System Mode 6
3.7.2 User Class 6
3.7.3 Objects 6
3.7.4 Feature 6
Page 2 of 11

3.7.5 Stimulus 6
3. 7.6 Response 6
3.7.7 Functional Hierarchy 6
3.8 Additional Comments 6
4. Change Management Process 7
5. Document Approvals 7
6. Conclusion 7
References 8
Page 3 of 11

1. Introduction
This chapter explains and highlights the background information of the place of study,
the problem statement and the main objective of the proposed project. This project
also describes product management system more clearly and efficiently to as to
determine its use in feasible way. The core mandate is to enhance an online based
sales and purchase of the products.
1.1 Purpose
Product maintenance application system is web-based application system
implemented using jsp concepts. The main purpose of building this application is to
enhance enterprise application through developing a system where products can be
accessed, viewed, added and deleted automatically. In addition, the users, are able to
request for additional products which can not be found at first on the platform and be
delivered later on.
1.2 Scope
This proposed project is aimed at improving the visibility of the products services
offered through online platform. This application involves almost all the features of
the information system; the future implementation will be online help for the user to
obtain more information about the product (Murach & Steelman, 2014). Product
Maintenance application system is an enterprise based system that keep track of the
products that are sold and purchased online.
The system is intended to let the users (administrator, customers) to login and carry out,
interact, view and purchase the needed items. For admin access the system he/she will have
to enter Login ID and a Password. The customers can register to the platform but also they
can view without registering too. The Administrator is the main user of this system whose
task will be to view how the transaction that is taking place. In addition, the system keeps
records of every stock takings.
1.3 Definitions, Acronyms, and Abbreviations.
1.4 Overview
This system is implemented through the use of java enterprise edition models and
concepts such as java server pages, Servlets among others(Goff, Johnson, Koonce,
Kaplinger, Kenna & Moldenhauer, 2012). The main mandate is to enable the develop
a product maintenance application that appear in a browser. It is a web-based system
that offer quality usability to the clients. Its both a client based and also a server sided
where by the front end or client sided is implemented using jsp while the server sided
is done using JDBC and Glassfish server.
2. The Overall Description
2.1 Product Perspective
The product used are those simple products such as mobile phones that are to be
Page 4 of 11

displayed. For this project, I used a new brand for music production which I named
Fresh Corn Production. This brand is so unique for the users who are interested in
music production.
2.1.1 System Interfaces
Basically the role of the system interfaces is usually to transform projects inputs to
outputs. There is mailing of customers products which is a system output. The system
will be hosted using Apache Tomcat web server whereby the application will display
the first interface page which will be the home page.
2.1.2 Interfaces
There is user interfaces where users interact with the application. For instance, there is
a login application, the product pages that display the products online. The application
will display the first interface page which will be the home page. The user will be able
to view the products and be able to search for more products, there will also be
another page for login by the user. Because all this will be making use of the web
interface, there will be an existence of a network which supports HTTP/HTTPS
protocols. This will enable both private and public users to use the application swiftly
thus yielding more productivity.
2.1.3 Hardware Interfaces
For this project, I used Linux operating system, with RAM 4 GB but it can be as little
as 256MB RAM , processor speed of 3.5GHZ and processor of core i7 but any
processor can work, at least 40GB of Hard Disk and above and last the ethernet card.
2.1.4 Software Interfaces
The software I used in this is the Netbeans IDE 8.2, Glassfish server 4.1, JDK 8.1
which are both running within my Linux laptop. The programming language for
product maintenance management system is Java. The major framework of java used
is JSP. There is a smooth communication between client and server via remote
method invocation and also secure socket layer.
Moreover, the JDBC or rather the Java Database Connectivity, uses MySQL
connector or J driver to enable communication between the server to the product
maintenance database.
2.1.5 Communications Interfaces
Within interfaces used in communication within the programs includes. The
communication is basically between the clients and the server. This is done using Java
Remote Method Invocation with secure Socket Layer.
2.1.6 Memory Constraints
For proper running of this project at least 3GB RAM is required. This is to enable
Netbeans IDE to run smoothly.
2.1.7 Operations
The application runs on browsers such as Firefox, Google Chromes when it’s run. The
application can be operated by any user because it online based and hosted but these
Page 5 of 11

users, are managed by the administrator who is in control of the application. He or she
can either add or remove the user from the application platform.
2.1.8 Site Adaptation Requirements
The site requires the local host to operate. It operates on port 8080 which is on the
Apache server the public port of the local hosting within the PC.
2.2 Product Functions
The functions of the products are to enhance the user’s needs in the music industry.
Where the user can download songs, updates the products, delete the products too.
2.3 User Characteristics
The application targets those users who are interested in music, thus it displays
products of the music production branded Fresh Corn Production.
2.4 Constraints
The constraints in this project, include time constraints and cost constraints. The
project require a lot of time to analyze and design it. The cost of the software used are
also high. A lot of time of at least three weeks is needed to design the architecture and
also to implement some fundamental features within it. About five weeks are needed
to add more functions or functionality and then testing. Other constraints include:
1. The application should be available on an hosted site either locally or through
internet. This will enable the users to use the system at their own pleasure.
2. New products and users are added by the administrator and the user should be able
to login
3. The user is supposed to be able to replace or change their passwords.
4. The application is easy to understand at a glance by the user.
2.5 Assumptions and Dependencies
The users are people interested to purchase music materials from online. Therefore,
the product maintenance application’s design should work A realist design for the
system should be implemented to enhance and fit the integration while at the same
time ensuring that there is no interference on the data by the interfaces used. We also
expect the customers to be able to update the information on this online platform.
2.6 Apportioning of Requirements.
Requirements are apportioned in accordance to the time. Those that takes less time are
given the first priority.
3. Specific Requirements
3.1 External Interfaces
Some of the specific external requirement include Sqlite database and MySQL for the
database integration to the project.
3.2 Functions
The function of this application is to deliver the user-based capabilities to enhance
product maintenance. The core reason of having a functional requirements is to
clearly outline the activities or operations of the system.
1. The application carries all the detail of the products.
2. The user is able to manage the products, i.e by first authenticating the user through
Page 6 of 11

logins.
3. The admin is able to see and view all the details of the users.
3.3 Performance Requirements
The overall performance of this project is to employ the concepts and frameworks of
Java such as JSP and Servlets to build an application that runs on most common
browsers.
.
3.4 Logical Database Requirements
This project employs the concepts of relational database management system where
JDBC where the products are inserted within the database table and are able to be
viewed.
3.5 Design Constraints
3.5.1 Standards Compliance
The design concepts that have been used include the Object Oriented Design where
OOP concepts are used and followed.
3.6 Software System Attributes
3.6.1 Reliability
The system is very reliable, this is through the use of the database concepts which
made it scalable too.
3.6.2 Availability
The system is implemented using Java server pages and Servlet, thus its web based
and at the same time its developed using java models such as JavaIO which operate
within the Netbeans environments.
3.6.3 Security
There is Login page for the authentication where the user validates through the
username and the password.
3.6.4 Maintainability
The application is maintained through the use of additional products where the user
can add to the existing ones. The user can also delete the products which are not
wanted.
3.6.5 Portability
This application can run on the most of the browsers available currently.
3.7 Organizing the Specific Requirements
3.7.1 System Mode
This is a Web-based application build using Java Frameworks such as JSP and
Servlets. It has also JavaScripts for front-end sections.
Page 7 of 11

3.7.2 User Class
The users are mostly those interested in Music production. The main functionality of
this product i.e music production include:
1. Administrator user functions- some of the tasks performed by admin includes;
creating new users, changing the password, adding or updating the details of the
products within the application, they are able to view the information concerning the
products, reports among others.
2. The usual user functions - the functions or tasks performed by the normal user
include; changing their password, viewing details of the products and items, adding
information about them, deleting the products among others.
3.7.3 Objects
Some of the objects used include; CheckUserServlet, CompleteOrderServlet,
DisplayCartServlet, ProcessUserServlet, CookieUtil, MailUtil, MusicStore etc.
3.7.4 Feature
Features include; Check User, Login, Check Invoice, Complete Order and many
others.
4. Change Management Process
Change is the most difficult process in any sector or project, similarly, in this project,
some of the innovation are likely to bring change especially when using the database
among others.
Conclusion
Its very possible to apply the software development skills to design Product
Maintenance application where user can add, update, and delete the products. The
following are the screen shots of the this application implemented.
Page 8 of 11

Screen shots.
Cart Page
User Register page
Page 9 of 11

Invoice Page
Login page
Page 10 of 11

References
Goff, R. E., Johnson, S. D., Koonce, E. E., Kaplinger, T. E., Kenna, S. J., &
Moldenhauer, M. A. (2012). U.S. Patent No. 8,185,610. Washington, DC:
U.S. Patent and Trademark Office.
Kalin, M. (2013). Java Web Services: Up and Running: A Quick, Practical, and
Thorough Introduction. " O'Reilly Media, Inc.".
Murach, J., & Steelman, A. (2014). Murach's Java Servlets and JSP. Mike Murach &
Associates.
Page 11 of 11