Predefined Content Guide › Business Logic Modules › General Features

General Features

The following are general features that are generic to all modules.

• Debugging

  If the metric supplies a parameter called Debug and its value is Yes the module writes messages to the log. The messages are written in every event handler and in various strategic places in the module.

• Callbacks

  The Success Calculations module allows the extension of the basic functionality of the module by way of callbacks. The callbacks are supported in the following places:

  • Before Period Start
  • After period start
  • Before timeslot enter
  • After timeslot enter
  • Before event
  • After event
  • Before on load
  • After on load
  • Before result
  • After result
  • Period end
  • On metric changed
  • Timeslot exit
  • On registrations

  The callbacks that are performed before the events can return true in which case the rest of the execution of that event handler will be skipped. This allows the user to replace the functionality of the event handler with one of his/her own.

  In the Before result callback, the alternate value for Result is set in the callback function.

  In the After result callback, the calculated result (received as a parameter) is already set and therefore the information can be used in the callback.