Skip to content

Payrun

The payrun is the core execution engine of PayrollEngine. It processes employees for a given pay period, evaluates wage type expressions and collector assignments, and stores legally binding payroll results.

Section Description
Wage Types & Collectors Processing order, number ranges, result objects, additional results
Job Lifecycle Job status, job types (legal, forecast, preview), invocation
Execution Async processing, parallelism, restart, incremental runs, retro triggers
Period Totals Year-to-date accumulation — why it belongs in reports, not payruns
Retro Corrections Retroactive recalculation — engine model and reporting pattern

Creation Order

The creation of payrun objects requires that the case model is in place. The following procedure is recommended for modeling:

  1. Determine output values — payslip data, legally required data, downstream feeds
  2. Break down output values into wage types (one calculation step each) and collectors (aggregation values)
  3. Determine wage types with their processing order
  4. Determine collectors and assign wage types to them
  5. Determine clusters and assign them to wage types (optional)

See Also