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.
This server event is available in versions 2018.1 and later.
Signature
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)
Expected Return
The OnScheduledReportExecuteStart Event expects a string to be returned. Based on the return string there are three possible results.
- Null / Whitespace – If the string is null or whitespace then the report execution will continue as expected.
- LanguageId – If the string matches the id of any element in the language files then the string of that language element will be displayed as a message to the user and the report execution will terminate. For more information see Multi-Language Support.
- Other – If the string does not match the id of any element in the language files then the returned value will be displayed as a message to the user and the report execution will terminate.
Notes
The report being executed can be accessed through the ScheduleJob object by using job.Report. The schedule information can be accessed through job.ScheduleInfo.