Scheduling the Recalculate Task

  1. Select Maintenance > System Administration > Job Scheduler.
  2. Add a schedule for the Recalculate Task.
    See Adding tasks to the Job Scheduler.
  3. Fill in the remaining fields to complete adding the task to the schedule.
    See Adding tasks to the Job Scheduler.
  4. Click Submit.
  5. Click OK.
  6. In the Task Schedule list, click Parameters next to the Recalculate Task you created.
  7. Configure the task by selecting values for the appropriate parameters:
    Override Types
    Select the override types you expect will affect business rule day dependent calculations and that would cause recalculation, for example, Work Detail override.
    Range
    Select the time period that is recalculated from the drop-down list:
    • Week: Recalculates all records for the week in which the overrides occur.
    • Pay Period: Recalculates all records in the pay period in which the overrides occur. The pay period start and end dates are determined dynamically for each employee.
    • Blank: Select the Infinite check box to recalculate the records for all days from the change into infinity.
    Check Pending Overrides
    Select this check box to recalculate any pending items for these override types automatically:
    • HOLIDAY_TYPE
    • LTA_TYPE
    • POSTCALC_WORKDETAIL_TYPE
    • PRECALC_WORK_PREMIUM_TYPE
    • POSTCALC_WORK_PREMIUM_TYPE
    • SCHEDULE_TYPE
    • TIMESHEET_TYPE
    • WORK_DETAIL_TYPE
    • WORK_SUMMARY_TYPE
    Calculation Thread Count
    Specify the number of threads that are used by the Recalculate Task. The default is 1, but you can multithread the Recalculate Task if there are enough CPU resources. You can increase the number of threads as you increase the number of available CPUs. A performance analysis is required to balance the number of threads with the number of CPUs to optimize the Recalculate Task.
    Rollout Date
    Specify the first date the task begins recalculating employee records. This date should be set as close to the deployment date as possible. This date is only used the first time the task is run. For subsequent runs, the Recalculate Task recalculates records from the last time the task ran.
    Batch Process Size
    Specify the number of days that are retrieved from the database and processed by the Recalculate Task at a time. Use the default value of 90 days unless the Recalculate Task is taking too long and exiting with a timeout error. If timeout errors occur, lower the number. The value should not be greater than 90.
    Process No Show Employees
    Select this check box to recalculate each scheduled employee without clocks (no timesheet activity) since the last time the task ran.
    Process Job Rate Updates
    Select this check box to recalculate any job rate changes.
    Process Calc Group Definition Changes
    Select this check box to recalculate any calculation group changes.
    Process Entitlement Policy Changes
    Select this check box to recalculate retroactive changes to employee entitlement policies.
    Process Processed Clocks
    Select this check box to recalculate employee clock swipes. Employees who have clocks and overrides specified in the Override Types field are only calculated once, even if both options are selected.
    Apply to Calc Groups
    Select the calculation groups to include or exclude from the recalculation using the lookup.
    Apply to Calc Groups Inclusive
    Select this check box to include the selected calculation groups in the Apply to Calc Groups field in the Recalculate Task.
    Auto Recalc
    Select whether the Recalculate Task uses the Auto Recalc settings of the calculation group, if defined, when recalculating employee records to determine what time period is recalculated. Select one of these options:
    • TRUE: Uses the Auto Recalc settings of the calculation groups.
    • FALSE: Ignores the Auto Recalc settings of the calculation groups.
    Note: The value of the Auto Recalc task parameter is superseded by the RULEENGINE_AUTORECALC registry parameter. If the parameter is set to True, then Auto Recalc settings of calculation groups are used, even if the Auto Recalc task parameter is set to FALSE.
    Process Future Balance Dates
    Select whether the Recalculate Task processes future balance dates when recalculating employee records. Select one of these options:
    • TRUE: Recalculates the future values of balances when recalculating records. Balance values are recalculated into the future.
    • FALSE: Prevents the Recalculate Task from processing balance values in the future. Balance values are not recalculated into the future.
    • Default: Defers to the value of the AUTO_RECALC_FUTURE_BALANCES registry parameter.
    Log Task Progress
    Select this check box to enable progress tracking for the Recalculate Task.
    Logging interval (min)
    Provide a positive numeric value, in minutes, for the interval for the progress tracking.
    Note: These two options must be used together. These fields are hidden by default.

    To enable these fields, see Using config mode.

  8. Click Submit.
  9. Click OK.

To view the progress of the Recalculate Task, click the Log button for the task. From there, you can view whether the task is still in progress. Additionally, the log displays:

  • The number of records processed out of the total number.
  • The percentage completed.
  • The estimated time remaining before completion.