Payroll - Planning Integration
Bridge planning schedules with payroll processing
The Payroll - Planning module bridges the gap between employee planning schedules and payroll processing. It allows you to view and verify the planning slots that contribute to work entries for hourly-paid employees directly from their payslips.
The module automatically counts and displays the number of published planning slots within the payslip period, handles timezone accurately, and provides quick access to the planning calendar from payslips.
Key Features
Key points
• Planning Slot Visibility: View published planning slots linked to each payslip
• Smart Button Integration: Quick access to planning calendar from payslip
• Automatic Counting: Displays the number of planning slots within the payslip period
• Timezone-Aware: Correctly handles planning slots across different employee timezones
Use Case
Key points
• Use Planning to schedule hourly-paid employees
• Generate work entries from planning slots
• Need to verify scheduled hours before processing payroll
• Want transparency between planning and payroll data
User Roles & Permissions
Key points
• Note: The planning slot smart button is only visible to users with the Planning Manager group
Role Permissions
| Role | Permissions |
|---|---|
| Planning Manager | Full Access - View planning slot count and access planning calendar from payslips |
| Payroll Manager | Standard - Process payslips (planning slot button visible if also Planning Manager) |
| HR Officer | Standard - View payslips (planning slot button visible if also Planning Manager) |
Getting Started
Prerequisites:
Key points
• Planning Module is installed and configured
• Payroll Module is installed and configured
• Work Entry Planning integration is active
• Employees are configured with: correct timezone settings, planning slots published, work entry source set to "Planning" in their payroll version
Viewing Planning Slots on Payslips
Key points
• Visibility rules: Only appears if planning_slot_count > 0, only visible to Planning Managers, only shown for payslips where work entry source is "Planning"
• Opening the planning calendar: Click the Planning smart button, system opens employee's planning calendar filtered to: employee, state (published slots only), date range (slots overlapping payslip period), month scale view (default)
Steps
1. Navigate to Payroll → Payslips
2. Open a payslip for an employee using planning-based work entries
3. Look for the Planning smart button in the top-right button box
4. The button displays: Tasks icon, label "Planning", count of published planning slots within the payslip period
Understanding the Integration
How planning slots become work entries:
Key points
• Work entry source configuration: For this integration to work, the employee's payroll version must have Work Entry Source set to "Planning"
• Timezone handling: The module correctly handles timezone differences - planning slots are stored in UTC, employee timezone is used for date calculations, slot counts are grouped by day in employee's local timezone
Steps
1. Planning Slot Created
2. Slot Published
3. Work Entry Generated (via hr_work_entry_planning)
4. Work Entry Included in Payslip
5. Planning Slot Count Displayed on Payslip
Workflow
Standard payroll process with planning:
Steps
1. Planning Phase: Planning Manager creates shifts for employees, shifts are published in Planning module, published slots automatically generate work entries
2. Payslip Generation: Payroll Manager generates payslips for the period, system calculates hours from planning-based work entries, planning slot count is computed and displayed
3. Verification: Payroll Manager reviews payslip, clicks Planning smart button to verify scheduled hours, compares planning slots with payslip worked days, confirms hours match expectations
4. Processing: Once verified, payslip is confirmed, payroll is processed as normal
Troubleshooting
Key points
• Planning Button Not Visible: User doesn't have Planning Manager access, no planning slots exist for the period, work entry source is not set to "Planning", planning slots are not published. Solutions: Verify user has planning.group_planning_manager group, check if planning slots exist and are published, verify employee's payroll version uses "Planning" as work entry source
• Planning Slot Count is Zero: Check if planning slots are published (draft slots don't count), do slots overlap with payslip date range, is the employee assigned to the slots, is the work entry source set to "Planning"
• Planning Slot Count Doesn't Match Expected: Timezone differences causing day boundary issues, slots span multiple days, some slots are not published. Solution: Click the Planning smart button, manually count visible slots in the calendar, check slot start/end times in employee timezone
• Work Entries Don't Match Planning Slots: This module only displays planning slots; it doesn't generate work entries. If work entries don't match planning, check hr_work_entry_planning module configuration, verify work entry generation has run, ensure planning slots were published before work entry generation
Best Practices
Key points
• For Planning Managers: Publish slots early before payroll processing to ensure work entries are generated, verify before payroll to catch scheduling errors, use consistent timezones to avoid day boundary issues, regular audits to verify planning slots match payslip hours
• For Payroll Managers: Always verify by clicking the Planning button to verify scheduled hours before confirming payslips, check discrepancies if planning slot count seems wrong, coordinate with Planning Managers to resolve scheduling issues, document issues between planning and payslip
• For System Administrators: Configure work entry source for employees using planning, set accurate timezone for all employees, monitor integration that planning slots generate work entries correctly, train users about the integration
• Common pitfalls to avoid: Don't forget to publish (draft planning slots don't generate work entries), don't ignore timezone (incorrect timezone can cause day boundary issues), don't skip verification (always verify planning slots before confirming payslips), don't mix sources (don't use both Planning and Attendance as work entry sources for the same employee)
Frequently Asked Questions
Key points
• Can I edit planning slots from the payslip? No, the Planning button opens a read-only filtered view. Edit slots in the Planning module
• Why do I see more/fewer slots than expected? The count includes all published slots that overlap the payslip period, even partially. Check slot start/end times
• Can I use this for salaried employees? This module is designed for hourly-paid employees using planning. Salaried employees typically use calendar-based work entries
• What if planning slots change after payslip generation? The planning slot count is computed in real-time. If slots change, the count updates, but work entries may not. Regenerate work entries if needed
• Does this module generate work entries? No, work entry generation is handled by hr_work_entry_planning. This module only provides visibility