Payroll Background Logging and Monitoring Flow

Use the Payroll Background Logging and Monitoring flow to identify and help resolve payroll queries for features that use the payroll background flow.

This flow helps you track the status of a process and troubleshoot issues. It's useful for those who manage customer environments, test payroll processes, and troubleshoot issues with payroll processes. For example, your system administer can use this flow to generate log files for features that uses the payroll background flow such as Anytime Pay.

Note: These are the payroll features that use the payroll background flow:
  • Anytime Pay
  • Event Notification Processing that has rate events enabled

The payroll background process is an ESS process that runs continuously in the background to improve the performance of payroll features. Since it runs continuously, it’s not required for the ESS server to start or stop whenever you submit a process, such as the submission of the QuickPay process for Anytime Pay.

When you submit the flow, leave the Legislative Data Group field blank.

Use the Action field to perform any of these actions on the flow.

  • Start Process: When called by a feature, the background payroll ESS process starts automatically and will continue to run. Use this option to override this default behavior and manually start the process.
  • Stop Process: Use this option to stop the background payroll ESS process. Any process that's already running using the payroll background process will complete, but the next process in queue will not start.
  • Report: Use this option to report on the status of the background payroll ESS process.
  • Resubmit Process: Use this option to resubmit a process submitted using the background payroll ESS process and is in error.

Use the Job Identifier field to identify a process that’s submitted using the payroll background and that needs a log file or must be resubmitted. Each background process has a job ID number, similar to an ESS job number.

Use the Report Type field to select the type of report you want to generate using this flow. You can use these reports to identify the root cause of an issue. The types of reports you can generate are:

  • Processing Report: This report displays all processes that are currently running or are in the payroll background queue for the day. For example, a QuickPay has been submitted for Anytime Pay but no results are generated for the employee. Use this report to check if the QuickPay is stuck in a queue of processes waiting to be completed by the payroll background process.
  • Scheduled Report: This report identifies all pending processes in the payroll background queue for the specified date range.
  • Error Report: This report identifies all error messages for the payroll background process. For example, you have submitted a QuickPay for Anytime Pay but no results are generated for the employee. Use this report to check if the payroll background process has hit an error that stopped the submission.
  • Log File: Use this option to enable detailed logging information for a process submitted using the payroll background process.