This server event is available in v2018.1+. The OnScheduledReportExecuteStart Event occurs at the beginning of the Report Execution process when run by a Scheduler Service. Occurs for any job run by a scheduler service, including scheduled executions, remote executions, and execution cache rebuilds. This Event could be used to check and modify properties of a report and log or stop execution.
For custom code the args array is structured as follows:
args[] contains a SchedulerJob object at position 0, which can be used to access and modify properties of the active execution and schedule, including the report object, email and schedule information.
For .NET Assemblies the method signature is as follows:
string EventHandlerName(SessionInfo sessionInfo, SchedulerJob job)
The OnScheduledReportExecuteStart Event expects a string to be returned. Based on the string returned there are three possible results:
null
or whitespace then the report execution will continue as expected.The report being executed can be accessed through the ScheduleJob object by using job.Report. The schedule information can be accessed through job.ScheduleInfo.