Skip to main content

Global Event: OnAfterReportExportSuccess

  • Updated

Global Event: OnAfterReportExportSuccess

The OnAfterReportExportSuccess event (v2018.2.14+, v2019.1.1+) is called after a report execution export file has been generated for a specified report. The server event implementation may load the export file from disk using the supplied file path, exportFilePath, modify the file, then save the changes back to disk. If the server event implementation saves changes to the export file, the file must be saved with the same file name that is passed in as the exportFilePath.

red exclamation point

If the file is saved to a different path, modifications will not be honored by Exago.

This server event will be called for all report execution export files generated, including those generated via:

  • Execution in the web app process (remote execution disabled)
  • Remote execution
  • Scheduled execution (including those using the Scheduler Queue)
  • Batch scheduled executions
  • GetExecute()

It is compatible with HTML, PDF, RTF, Excel, and CSV export types.

Signature

For custom code the args array is structured as follows:

args[] contains two arguments: args[0] should contain a string representing the file path of the exported report, and args[1] should contain a wrExportType object representing the export type of the report.

For .NET Assemblies the method signature is as follows:

void EventHandlerName(SessionInfo sessionInfo, string exportFilePath, wrExportType exportType)

Expected Return

The return value of this event is ignored.