Pro Manual

User Manual:

Open the PDF directly: View PDF .
Page Count: 28

Download
Open PDF In Browser	View PDF

Project Manual—Time Sheet System

Team: Xray
Member: Orkut Karacalik
Chuyi Sun
Esha Agrawal
Bibi Nazneen
29. September 2018
TIME SHEET SYSTEM

Contents
Contents
Contents ............................................................................................................................................. 2
Introduction ........................................................................................................................................ 3
A list of Requirements ....................................................................................................................... 4
List of Completed and Missed Requirements ................................................................................ 4
Functional Requirements ........................................................................................................... 4
Nonfunctional requirements ...................................................................................................... 8
How to install the application? ........................................................................................................ 11
System Setup................................................................................................................................ 11
Before installation: Create JDBC connection pool and resource................................................. 13
Installation ................................................................................................................................... 15
The starting point: Entity ............................................................................................................. 17
Using the application ....................................................................................................................... 18
Login ............................................................................................................................................ 18
Contract ........................................................................................................................................ 19
Timesheet ..................................................................................................................................... 21
Person........................................................................................................................................... 22
Total hours ................................................................................................................................... 23
The problems and solutions ............................................................................................................. 24
Timeline ........................................................................................................................................... 25
Time Spent ....................................................................................................................................... 26
Subsystems in TSS Application ....................................................................................................... 27
Glossary ........................................................................................................................................... 28

TIME SHEET SYSTEM

Introduction
The German federal law for minimum wages („Mindestlohngesetz “) requires that employees with
a monthly income below a certain amount (currently 850€) fill time sheets about their working
hours, vacation, illness, etc. This enables examination and verification of the minimum wage
guaranteed by the law.
In the university context, this means that most of the student assistants must report the times on
a weekly base. Both the student assistant as the employee as well as the supervisor as
representative of the employer should sign the time sheets. The university as the employer has
the obligation to file the time sheets for 2 years. After that period, the time sheets shall be
destructed.
The whole process is tedious and error-prone since the current solution (spreadsheets or paper
forms) are inconvenient, students as well as staff easily miss to fill, print, sign, and archive the
forms in a timely manner.
The Time Sheet System (TSS aims at implementing a web application that can be used to record
the working time and remind the employees to sign the timesheet on time.
This user manual will provide instructions on how to access the TSS and installing it on JavaEE 7,
Payara server and NetBeans. In this application, four roles are designed: assistant, supervisor,
secretary, employee.

TIME SHEET SYSTEM

A list of Requirements
List of Completed and Missed Requirements

Functional Requirements
List of Completed requirements for Contract Sub Module.

Requirement No

Short Description

Status

CN1

Ability to manage Contracts

Completed

CN3

View contract Statistics

Completed

CN2

Ability to print contracts

Completed

CN4

Calculate total hours due,

Completed

vacation hours, remaining
hours due
CN4a

Calculation of vacation hours

Completed

CN4b

Calculation of total hours due Completed
for the contract as the sum of
hours due of individual
timesheet

CN4c

Calculation of hours due

Completed

CN4d

Determine the public

Completed

holidays in RheinlandPlatinate

TIME SHEET SYSTEM

CN4e

Determine the public

Completed

holidays in Germany from 01January-2018 until 31December-2027
CN5

Set a contract to PREPARED

Completed

status as soon as it is created
CN6

Ensure that start date, end

Completed

date, frequency, hours per
week, vacation
hours, working days per
week, and vacation days per
year can only be changed
when
the contract is in PREPARED
status.
CN7

Provide assistants and

Completed

supervisors with the ability to
start a contract.
CN9

Ensure that only contracts

Completed

can be aborted whose time
sheets are in status
SIGNED_BY_SUPERVISOR or
IN_PROGRESS.
CN11

Warn the user if there are

Completed

time sheets in

TIME SHEET SYSTEM

state IN_PROGRESS that
have entries, before
terminating the contract
CN12

Set a contract to status

Completed

ARCHIVED as soon as all time
sheets of that
contract are in status
ARCHIVED

List of completed requirements for Time Sheets Sub Module.

Requirement No

Short Description

Status

TS1

Create Timesheets for

Completed

Contract once started
TS2

Timesheet entries can be

Completed

changed only when the
Timesheet is in IN_PROGRESS
state
TS3

delete time sheets in status

Completed

IN_PROGRESS once the
contract is terminated
TS5

Do not delete time sheets

Completed

that are in the
SIGNED_BY_SUPERVISOR
state

TIME SHEET SYSTEM

TS6

Ability to view time sheets

Completed

TS7

Ability to print time sheets

Completed

TS8

Ability to manage time sheet

Completed

entries when time sheet is in
IN_PROGRESS state
TS9:

Managed time sheet entries

completed

Changes when time
sheet is IN_PROGRESS

List of completed requirements for Signatures Sub Module.

Requirement No

Short Description

Status

SG1

Provide employees with the

Completed

ability to sign a time sheet
SG2

Provide supervisors with the

Completed

ability to sign a time sheet
that is in status
SIGNED_BY_EMPLOYEE

List of completed requirements for Reminders Sub Module.

Requirement No

Short Description

Status

RE1

Send reminder mail to

Complete

employee on last day of
TIME SHEET SYSTEM

timesheet if time sheet is in
IN_PROGRESS state

List of completed requirements for Archiving Sub Module.

Requirement No

Short Description

Status

AR1

Ability to archive time sheets

Completed

that are in status
SIGNED_BY_SUPERVISOR
AR3

Delete time sheets 2 years

Completed

after the signature of the
supervisor
AR4

Support variable archive

Completed

durations

Nonfunctional requirements
List of completed nonfunctional requirements for Access Control.

Requirement No

Short Description

Status

AC1

authenticate users prior to

Completed

giving access to any data

List of completed nonfunctional requirements for User Interface.

Requirement No

Short Description

Status

UI1

Support mobile devices

Completed
TIME SHEET SYSTEM

List of completed nonfunctional requirements for Internationalization Sub Module.

Requirement No

Short Description

Status

IN1

Change of User Interface

Completed

Language
IN2

Ability to choose the

Completed

language
IN3

Support at least two

Completed

languages
IN4

Support English language

Completed

IN5

Support German language

Completed

IN6

Send reminders to users in

Completed

preferred language

List of completed nonfunctional requirements for Software Architecture.

Requirement No

Short Description

Status

SA1

Implement layered

Completed

architecture
SA2

Must contain the web and

Completed

ejb module

TIME SHEET SYSTEM

SA3

Use third-party libraries after

Completed

negotiation with the
customer
SA4

Use of the database servers

Completed

MySQL
SA5

Document architectural

Complete

decisions
SA6

Prefix all global names with

Complete

its team name

List of completed nonfunctional requirements for Project Manual.

Requirement No

Short Description

Status

PM1

document in a project

Complete

manual
PM2

Maintain list of completed

Complete

and incomplete
requirements
PM3

Document description of

Complete

problems occurred
PM4

PM5

Document decision made to

Made no changes to the

change requirements

requirements

Record time spent on project

complete

TIME SHEET SYSTEM

How to install the application?
System Setup
TSS is a web application, which means it runs on a server machine and responds to all the requests
made by client via web browser.
A windows/Unix/Linux based system with following software and hardware requirements is
required to run TSS project.

Client-side Software requirements
Latest JavaScript enabled browser to access the application.

Server-side Software requirements
Application Server (Payara)
Application server is required to host the application and provide the necessary environment for its
execution. We will use Glassfish/Payara application server, available at
https://www.payara.fish/downloads.

Database Server
TSS stores all data related to the system in a database. A DERBY database server is required to
run TSS.
TIME SHEET SYSTEM

JAVA
Java Developer Kit (JDK) or Java Runtime Environment (JRE) platform is required to be installed
on the server’s operating system. The latest version of JDK is available at
http://www.oracle.com/technetwork/java/javase/downloads/index.html .

TSS application war
The latest version of the application in war format is submitted.

Server-side Hardware requirements
System with min 2 GB RAM.

TIME SHEET SYSTEM

Before installation: Create JDBC connection pool and resource
1. Start Payara Server from Terminal (How to start the server:
https://docs.payara.fish/getting-started/getting-started.html)

2. Navigate to http://localhost:4848 to access the Administration Console
3.

Create a new JDBC Connection pool as following:

TIME SHEET SYSTEM

4. Edit additional properties

5. Create the new JDBC resource with name jdbc/xray using previous pool

TIME SHEET SYSTEM

6. jdbc realm settings for payara
https://medium.com/@swhp/payara-security-realm-with-jdbc-9cddf0eec427
CREATE OR REPLACE VIEW ACCOUNTS SELECT R.PERSON_ID, R.ID AS
ROLE_ID, P.EMAILADDRESS, P.PASSWORD, R.TITLE FROM APP.PERSONS
P JOIN APP.ROLES R ON R.PERSON_ID = P.ID
This is is the sql query that should be executed before starting

TIME SHEET SYSTEM

Installation
1) Download the xray project
2) Open the project in netbeans
3) Go to project properties -> libraries and import all required libraries and jar files.
4) clean build xray project in netbeans
5) if executed successfully then Go to Files -> xray -> build -> xray-war.war and go to its
properties (by right click and select properties), from properties copy "All Files" path

6) go to cmd and deploy the war file " install-directory/asadmin> deploy
AllFilesPathToWar"
(install-directory is where your Payara Server is installed)
7) Go to the browser and open localhost:8080/xray-war to see the index page

The starting point: Entity
We start the project: from the entities classes and do some basic “CRUD” operations to test the
connection with DB.
TIME SHEET SYSTEM

Using the application
Login

TIME SHEET SYSTEM

Contract

TIME SHEET SYSTEM

Timesheet

TIME SHEET SYSTEM

Person

TIME SHEET SYSTEM

Total hours

TIME SHEET SYSTEM

The problems and solutions
P1. Where could we start our project?
A1. Create JDBC resources, create entities and test the connection with DB
P2. Do we need to create each role entity class or just make role as an attribute of a person
class?
A2. Yes. We need these different role entities, because each role has a different mapping
relationship with the contract entity such as one-to-one, one-to-many, many-to-one.
P3. How to stay in touch during the holiday?
A3. Because we don’t have a long break without lectures during August and September, it’s
difficult to sit down together to discuss our project. But our team members are active and use
different ways to communicate online.
P4. How to deal with the problem: Entity name must be unique in a persistence unit?
A4. Because of the changes of version for one project, some new packages were created with
new entities. New entities have the same name with the former entities, but we just want to use
new entities. Even if delete the old entities source code, when deploy the project there is an
error：Entity name must be unique in a persistence unit. Configure the persistence.xml file and
just make the new entities included such as New entity
true

TIME SHEET SYSTEM

Timeline
06.2018

Set up team and find people

13.08.2018 Starting from the entities

20.08.2018 Simple “CRUD” operation

Bugs fix

16.09.2018 Integration public Calendar
10.09.2018 Person\Contract Management and other roles
12.09.2018 Timesheet main function
22.09.2018 check other unfinished functions
25.09.2018 Bug fix
29.09.2018 Project manual

TIME SHEET SYSTEM

Time Spent

Description

Hours spent

Understanding Java EE. This included
watching courses from Pluralsight and
YouTube

50 hours

Going through the application provided from 9 hours
teacher.

Working on application.

100 approx. (Around 20 days, 2-3 hours
a day) including time for documentation

TIME SHEET SYSTEM

Subsystems in TSS Application
Following subsystems exists in TSS application.

1. Contract and timesheet system
The major business functionalities are handled by this module.
With majority of the functional requirements handled by this subsystem makes it an
integral part of TSS application.

2. Scheduler
The scheduler subsystem takes care of all scheduling related activities like
archiving of timesheets after 2 years, scheduling of email reminders etc.

3. Crud
This module does the job of some basic “CRUD” operations to test the connection
with DB.

4. Holiday system
Calculates public holidays in specified period.

5. Person system
Keeps record (name, email, role, DOB) of employees, assistants, supervisors,
secretary and administrators.

6. Role system
Keeps track of roles information regarding employees, assistants, supervisors,
secretary and administrators.

TIME SHEET SYSTEM

Glossary
Term

Explanation

Administrator

An Administrator is a university staff
member. Administrators are responsible to
install,
configure, and operate the TSS.

Secretary

A secretary is a university staff member.
Secretaries are responsible for printing the
time sheets

Supervisor

A supervisor is a university staff member. The
supervisor is the contractual boss of an
employee.

Application server

Software framework that provides both
facilities to create web applications and a
server environment to run them.

Assistant

An assistant is a university staff member.
Assistants are responsible for the concrete
tasks assigned to employees.

Contract

A written or spoken agreement

Employee

An employee can be a student or a university
staff member

Guest

Guests may only view public information
and documentation about the TSS.
TIME SHEET SYSTEM

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.7
Linearized                      : No
Page Count                      : 28
Language                        : en-AU
Tagged PDF                      : Yes
XMP Toolkit                     : 3.1-701
Producer                        : Microsoft® Word 2016
Creator Tool                    : Microsoft® Word 2016
Create Date                     : 2018:09:30 21:56:00+02:00
Modify Date                     : 2018:09:30 21:56:00+02:00
Document ID                     : uuid:1A120B8E-E9D7-4D44-BDBF-2BF677C29C5C
Instance ID                     : uuid:1A120B8E-E9D7-4D44-BDBF-2BF677C29C5C
Creator                         : Microsoft® Word 2016

EXIF Metadata provided by EXIF.tools

Pro Manual

Navigation menu

Versions of this User Manual:

Views

Navigation