#Youtube video: https://youtu.be/clkPTmwQp8g

Employee Clock User Guide

The Employee Clock system provides time tracking functionality for both employees and administrators. Employees can clock in, clock out, and manage breaks. Administrators and managers can review, edit, and configure all clock records and break types.

---

For Employees: Clock In/Out Widget

The clock-in-out widget is available as a shared widget accessible from your dashboard or assigned workspace.

Clock In

When you first log in and are not currently on the clock, a Clock In button will appear.

1. Click Clock In to start your shift.
2. The system automatically uses your primary assigned job type.
3. If no primary job is assigned, you will see an error notification — contact your manager to resolve.
4. After successfully clocking in, a Clocked In confirmation notification will appear.

Clock Out

When you are currently on the clock (no logout time recorded), a Clock Out button will appear.

1. Click Clock Out when your shift ends.
2. A Clocked Out confirmation notification will appear.
3. Your clock record will show both the login and logout times along with calculated regular and overtime hours.

Taking a Break

While clocked in, you can take breaks using the configured break types.

Starting a Break:

1. While clocked in and not on a break, available break types will be displayed as buttons.
2. Click the break type button to start a break (e.g., "15 Minute Break", "Lunch").
3. A Break Started confirmation notification will appear.

Ending a Break:

1. While on a break, an End Break button will be displayed.
2. Click End Break to return to your active shift.
3. A Break Completed confirmation notification will appear.

Notes:

• Break types are configured by your administrator (see the Break Types section below).
• Breaks can be marked as Paid or Unpaid time by the administrator.

Printing Your Clock Record

When the print view is enabled, you can print a receipt of your clock record.

1. Navigate to the clock view section.
2. Your clock record will display:
   • Employee name
   • Position ID
   • Time ID
   • Time In (login timestamp)
   • Time Out (logout timestamp)
   • Regular Hours
   • Overtime Hours
   • Any associated break records with start time, end time, duration in minutes, and break type
3. Click the Print button to generate and preview your receipt.

---

For Administrators and Management

The Employee Clock Admin module provides comprehensive tools for managing employee time records, break configurations, and reporting.

Employee Clock List

The main clock list view displays all employee clock records in a data grid with the following columns:

Column	Description
Employee	Name of the employee
WeekDay	Day of the week for the login
Login	Clock-in timestamp
Log Out	Clock-out timestamp
Reg Hours	Regular hours worked
Reg Pay	Regular pay amount
OT Hours	Overtime hours worked
OT Pay	Overtime pay amount
Total Hours	Sum of regular and overtime hours
Break Minutes	Total break time in minutes
Break Min Paid	Whether break time was paid
OG Clock In	Original clock-in time (before any edits)
OG Clock Out	Original clock-out time (before any edits)

View Modes

The list supports three view modes:

• List — AG-Grid data table with sortable columns and pagination
• JSON — Raw JSON data viewer with clipboard copy capability
• Sales — Sales and tax report view per employee

Toolbar Actions

• CSV Export — Click the CSV button to export the current grid data as a CSV file.
• ReCalc — Click ReCalc to recalculate all clock records for the selected date range. Use this if hours or pay values appear incorrect.
• Summary — Displays aggregate totals for the filtered period: total hours, total pay, regular hours/pay, and overtime hours/pay.

Filtering Clock Records

The filter panel provides the following search options:

1. Date Range — Select a start and end date using the date range picker. Defaults to the current day.
2. Employee Filter — Toggle between "View Dates" and "Employees" to filter by individual employee.
3. Quick Date Selection — Toggle to "View Dates" to see a list of individual dates in the selected range. Click a date to filter to that single day.
4. Page Size — Adjust the number of records displayed per page.
5. Reset — Clear all filters and return to the default view.
6. Breaks — Quick link to the Break Types configuration page.

Editing a Clock Record

Click the Edit button on any row in the clock list to open the clock record editor in a dialog.

Clock Record Editor

The editor displays the employee name and provides the following editable fields:

• Log In Time — Date/time picker to adjust the clock-in timestamp
• Log Out Time — Date/time picker to adjust the clock-out timestamp
• Pay Rate — View the employee's pay rate for this clock record

Action Buttons

• Save — Save changes to the current clock record.
• Save and Exit — Save changes and close the dialog. The list will refresh to reflect the update.
• Delete — Remove the clock record entirely. Confirm the deletion when prompted.
• Cancel — Close the dialog without saving changes.

Editing Breaks

The break editor section within the clock record dialog allows you to manage break records:

• View Breaks — All breaks for the clock record are listed with start and end times.
• Edit a Break — Click the Edit button next to a break to modify its start and end times using the datetime pickers. Click Save to apply changes.
• Delete a Break — Click the Delete button to remove a break record.
• Add a Break — Click any break type button from the "Add New Break" section to create a new break record for the clocked-in employee. Available break types are defined in the Break Types configuration.
• Refresh — Click Refresh to reload the clock record and its break data.

Break Types Configuration

The Break Types page allows administrators to configure the break types available to employees.

Access: Navigate to the Break Types page from the admin menu or by clicking the Breaks button in the clock filter panel.

Break Type Fields

Field	Description
ID	Unique identifier (auto-generated)
Name	Display name shown to employees (e.g., "15 Minute Break", "Lunch")
Unpaid Time	Toggle switch indicating whether the break is unpaid (true) or paid (false)

Managing Break Types

• Add a New Break Type:

  1. Enter a name in the Name field.
  2. Set the Unpaid Time toggle as needed.
  3. Click Add to create the new break type.

• Edit an Existing Break Type:

  1. Click the Edit button in the row of the break type you want to modify.
  2. The form will populate with the current values.
  3. Make your changes.
  4. Click Save to apply the update.

• Delete a Break Type:

  1. Click the Edit button for the break type you want to delete.
  2. Click Delete to remove it.

• Clear Form: Click Clear to reset the form fields without making any changes.

• Refresh: Click the refresh icon to reload the break types list.

Employees On Clock

The "On Clock" panel displays a real-time list of all employees currently clocked in.

• Shows each employee's name and clock-in timestamp.
• Auto-refreshes every 60 seconds.
• Use the manual Refresh button to update the list immediately.

---

Summary of Roles

Action	Employee	Admin/Manager
Clock In	Yes	Yes
Clock Out	Yes	Yes
Start/End Break	Yes	Yes
View Clock Records	Own records only	All records
Edit Clock Records	No	Yes
Edit Break Records	No	Yes
Configure Break Types	No	Yes
Export to CSV	No	Yes
Recalculate Hours	No	Yes
View Sales Reports	No	Yes
Delete Clock Records	No	Yes
Print Clock Receipt	Yes (when enabled)	Yes