Global Event: OnScheduledReportComplete

This server event is available in version 2017.1 and later.

The OnScheduledReportComplete server event occurs when a scheduled report execution completes, regardless of whether it was successful or not. It precedes creation of the output file. The schedule job object is passed in the args array so the job can be examined for potential errors.

Signature

For custom code the args array is structured as follows:

args[] contains one argument, a SchedulerJob object representing the completed scheduled execution.

For .Net Assemblies the method signature is as follows:

  bool EventHandlerName(SessionInfo sessionInfo, SchedulerJob job)

Expected Return

The OnScheduledReportComplete server event expects a boolean return value to indicate whether to create the report output for the job. Returns TRUE if the report output should be created, returns FALSE if the report output should not be created.