LogoSupport Hub

Reports Documentation

This section contains documentation for all report scripts, organized by category. Each report includes detailed information about its purpose, parameters, output format, and usage instructions.

📂 Categories

Cancellation

  • Cancellation: Reports related to employee cancellations and history.

Core Business Reports

  • Coverage Budget: Coverage and budget analysis reports for workforce planning and cost management
  • Employee Information: Employee data reports including demographics, status, and organizational information
  • Incident Reports: Employee incident tracking, point systems, attendance monitoring, and corrective action reports
  • Pay Information: Pay and payroll reports for compensation analysis and payroll processing
  • Perfect Attendance: Perfect attendance tracking and recognition reports

Schedule & Time Management

  • Schedule: Schedule-related reports including shift assignments, time tracking, and scheduling analysis
  • WorkSync Schedules: WorkSync schedule reports

System Administration

  • System Information: System information reports for database administration and system monitoring
  • Users Information: User account reports covering access permissions, notifications, audit trails, and user management

📑 Report Structure

Each category contains:

  • README.md – Overview of the category and its reports
  • Individual report documentation – Detailed Markdown files for each SQL script, including:
    • Purpose and description
    • Parameters and usage examples
    • Output format and column descriptions
    • Technical implementation details
    • Notes and best practices

🚀 Getting Started

  1. Navigate to the relevant category folder
  2. Review the category README for an overview
  3. Select the specific report documentation you need
  4. Follow the usage instructions and parameter guidelines
  5. Refer to the corresponding SQL script in the scripts/reports/ directory

📊 Report Categories Overview

CategoryReport CountPrimary Use Case
Cancellation9 reportsEmployee cancellation and history tracking
Coverage Budget3 reportsWorkforce planning and budget analysis
Employee Information20 reportsHR data and employee management
Incident Reports10 reportsIncident tracking, point systems, and corrective actions
Pay Information11 reportsCompensation and payroll processing
Perfect Attendance5 reportsAttendance tracking and recognition
PPACA5 reportsAffordable Care Act (ACA) compliance reports
Schedule10 reportsTime and schedule management
System Information12 reportsDatabase and system administration
Table Query0 reportsAd-hoc data retrieval and analysis
Users Information9 reportsUser access, permissions, and audit trails
WorkSync12 reportsWorkSync integration and data synchronization reports

For technical support or questions about specific reports, refer to the individual documentation files or contact the database administration team.