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
- Navigate to the relevant category folder
- Review the category README for an overview
- Select the specific report documentation you need
- Follow the usage instructions and parameter guidelines
- Refer to the corresponding SQL script in the
scripts/reports/directory
📊 Report Categories Overview
| Category | Report Count | Primary Use Case |
|---|---|---|
| Cancellation | 9 reports | Employee cancellation and history tracking |
| Coverage Budget | 3 reports | Workforce planning and budget analysis |
| Employee Information | 20 reports | HR data and employee management |
| Incident Reports | 10 reports | Incident tracking, point systems, and corrective actions |
| Pay Information | 11 reports | Compensation and payroll processing |
| Perfect Attendance | 5 reports | Attendance tracking and recognition |
| PPACA | 5 reports | Affordable Care Act (ACA) compliance reports |
| Schedule | 10 reports | Time and schedule management |
| System Information | 12 reports | Database and system administration |
| Table Query | 0 reports | Ad-hoc data retrieval and analysis |
| Users Information | 9 reports | User access, permissions, and audit trails |
| WorkSync | 12 reports | WorkSync 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.