Schema: tls_time_tracker_website

Technical Truth - Models, API endpoints, and data structures

Module Overview

Models

tls.job.tracker (Inherited)

Purpose: Extends job tracker with datetime fields and email sending

Key Methods:

time.tracker.send.to (New Model)

Purpose: Configuration for email notifications

Key Methods:

Controllers / API Endpoints

CustomReportController

Route: /job-tracker
Method: HTTP GET
Auth: Public
Purpose: Display the time entry form

Returns: Website page with:
- Projects (filtered by tick=True)
- Activities (all project.activities)
- Employees (filtered by display_show=True)
- Project/activity type mappings as JSON

Route: /submit_job_tracker
Method: HTTP POST
Auth: Public
Purpose: Create time entry from form submission

Parameters:
| Param | Type | Description |
|-------|------|-------------|
| teammember_field | int | Employee ID |
| project_field | int | Project ID |
| activity | int | Activity ID |
| date_field | date | Entry date |
| hours | float | Hours worked |
| today_start_time | string | Start time text |
| today_finish_time | string | Finish time text |
| start_day_time | datetime | ISO start timestamp |
| end_day_time | datetime | ISO end timestamp |
| description | string | Entry description |

Response: Redirect to /thank-you

Route: /thank-you
Method: HTTP GET
Auth: Public
Purpose: Confirmation page after submission

Returns: Thank you page with link back to form

Route: /get_person_jobs
Method: JSON POST
Auth: Public
CSRF: Disabled
Purpose: Fetch time entries for employee

Parameters:
| Param | Type | Description |
|-------|------|-------------|
| person_id | int | Employee ID |
| selected_date | date | Optional date filter |

Returns: JSON array of job entries:

[
  {"date": "2025-01-26", "hours": 8.0, "activity": "Project Name"}
]

Frontend Components

JavaScript

File: static/src/js/job_tracker.js

Features:
- "Start My Day" button handler (captures timestamp)
- "End My Day" button handler (captures timestamp)
- Activity filtering based on project type
- Load person's job records via JSON endpoint

Email System

Daily Team Email

Cron: Runs daily
Config: time.tracker.send.to with individual=False
Recipients: user_ids in config

Content includes:
- Each employee's hours for today
- Whether they updated entries yesterday

Weekly Individual Email

Cron: Runs weekly
Config: time.tracker.send.to with individual=True
Recipients: Each employee with display_show=True

Content includes:
- Employee's hours for each day of the week
- Total hours for the week

Security Rules

Access Rights

Note: Public access for website controllers via sudo().

Data Flow Diagram

┌─────────────────────────────────────────┐
│         /job-tracker (Website)          │
│                                         │
│  Employee selects:                      │
│  - Project (tick=True filter)           │
│  - Activity (filtered by project type)  │
│  - Team member (display_show filter)    │
│  - Start/End times                      │
│  - Hours and description                │
└───────────────┬─────────────────────────┘
                │ POST /submit_job_tracker
                ▼
┌─────────────────────────────────────────┐
│      tls.job.tracker.create()           │
│      (via sudo())                       │
│                                         │
│  Creates time entry                     │
│  Sends instant email notification       │
└───────────────┬─────────────────────────┘
                │
                ▼
┌─────────────────────────────────────────┐
│       time.tracker.send.to              │
│                                         │
│  user_ids ─────────────────────────────────► Email recipients
│  email_template_id ────────────────────────► Mail template
│  individual ───────────────────────────────► Daily vs Weekly
└─────────────────────────────────────────┘
                │
                ▼
┌─────────────────────────────────────────┐
│       Scheduled Cron Jobs               │
│                                         │
│  Daily: send_daily_team_hours_email()   │
│  Weekly: send_weekly_individual_hours() │
└─────────────────────────────────────────┘

Database Tables

Website Templates

Change History