(Optional) Enable notifications of batch processes

Scheduler can monitor batch events and send notification by email when a batch process finishes or when a batch event starts.

Note: If servers that use different languages run batch events or send messages, the email can contain text in all of the languages.

  1. Select Administration > Application Setup > System Configuration > System Settings > Batch Service tab.
  2. Enable email:
    • site.BatchService.monitorService.enables

    • Select true.
  3. Send an email notification when the batch event starts:
    • site.BatchService.notifyLaunch

    • Select true.
  4. (Optional) Configure system settings

    • site.BatchService.monitorPollingInterval

      The polling interval, in milliseconds: 1000 = 1 second, 60,000 = 1 minute

    • site.BatchService.monitorMaximumReportErrors

      Enter the maximum number of error messages to include.

    • site.BatchService.monitorControllerName

      Name of the batch monitor controller daemon.

      Default = BatchMonitorService Controller

    • site.BatchService.monitorWorkerName

      Name of the batch monitor worker daemon.

      Default = BatchMonitorService Worker

    • site.BatchService.monitorOmitReportIds

      • False = Enable debugging.
      • True = Disable debugging.
  5. Restart the application.
  6. Update the silver data for email:
    1. In WPK.properties:
      • com.kronos.WFD.wfp.silverdata.loadateachstartup

      • Select true.

      Important: After you reload silver data, reset this property to false.

    2. Remove rows for the default batch events from the XMLData table.
    3. Remove all relevant rows from the tables:
      • RequestXMLData
      • EventMgrTask
      • EventTaskEntry
    4. Restart the application.
    5. The correct silver data loads. If needed, edit the silver data.
    6. For user-defined batch events configured before the upgrade, remove those events. Re-create the batch events.

Example email for a batch event failure

*Summary

Batch event name: multi-task run

Batch ID: 1251

Total number of tasks: 2

The number of tasks completed successfully: 0

The number of tasks failed: 2

*Details

**Tasks failed processing

Batch task name: PSE (Priority Scheduling Engine) assigns open shifts to employees according to sorting and matching rules.

Batch task ID: 1251

The name of the host machine that executed the batch task: kronosxp

Total number of task items: 1

The number of task items completed successfully: 0

The number of task items failed: 1

The number of task items did not process because dependent items failed: 0

Batch task item action name: Store 600 Bakery and Deli

Batch task item ID: 1951

Batch task item order number: 1

Batch task item status: Failed

***Error message

--- Error text not supplied

Batch task name: Volume Budget Engine Run

Batch task ID: 1252

The name of the host machine that executed the batch task: kronosxp

Total number of task items: 1

The number of task items completed successfully: 0

The number of task items failed: 1

The number of task items did not process because dependent items failed: 0

Batch task item action name: Corporate/Banner1/North/Region01

Batch task item ID: 1952

Batch task item order number: 1

Batch task item status: Failed

***Error message

--- The command line switch F must be specified.