Exago Logo
Search
Generic filters
Exact matches only
Server Events

Global Event: OnParameterSqlStatementConstructed

Called after a parameter dropdown object is constructed. Allows for modifying the object SQL. Signature For custom code the args array is structured as follows:args[] contains one object, the SQL string which is passed to the server to construct the parameter dropdown.For .NET Assemblies ...

Global Event: OnRenameFolderEnd

The OnRenameFolderEnd Event occurs after user has renamed a folder.SignatureFor custom code the args array is structured as follows:args[] is contains two strings, the first represents the fully qualified old folder name, the second is the new folder name.For .Net Assemblies the method ...

Global Event: OnAfterLoadReportsList

Occurs after reports created in Exago have been loaded into the Report Tree, but before the Report Tree is drawn into the user interface. Signature For custom code the arguments array is structured as follows:args[] contains one object:a WebReports.UI.Controls.TreeNodeCollection, a list ...

Global Event: OnRenameFolderStart

The OnRenameFolderStart Event occurs when a user attempts to rename a folder. This event happens before the folder is renamed permitting you to stop the renaming if desired. Signature For custom code the args array is structured as follows:args[] contains two strings:the fully qualified ...

Global Event: OnAfterReportExportSuccess

The OnAfterReportExportSuccess event (v2018.2.14+, v2019.1.1+) will be 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 ...

Global Event: OnReportExecuteEnd

The OnReportExecuteEnd Event occurs at the end of the Report Execution process. This Event could be used to track which report executions return data.This event will be called for all report execution types, including those via:Execution in the web app process (remote execution ...

Global Event: OnConfigLoadEnd

The OnConfigLoadEnd Event occurs after all API changes are made and the host application container is redirected to Exago. If entering Exago directly this event occurs immediately after OnConfigLoadStart. If the API is being used but the host application does not redirect to Exago (such as ...

Global Event: OnReportExecuteInit

Available in v2019.1.9+The OnReportExecuteInit Event occurs at the beginning of the report execution process similar to OnReportExecuteStart, but triggers before the Report Viewer's rendering information metadata file has been created and sent to the client. This is in contrast to ...

Global Event: OnConfigLoadStart

The OnConfigLoadStart Event occurs after the configuration file is loaded. This may happen in the API when the API object is initialized or in Exago when entering the application directly. This event can be used to change any configuration information on-the-fly via the SessionInfo object, ...

Global Event: OnReportExecuteStart

The OnReportExecuteStart Event occurs at the beginning of the Report Execution process. This Event could be used to check and modify properties of a report and log or stop execution.This event will be called for all report execution types, including those via:Execution in the web app ...

Global Event: OnDataCombined

The OnDataCombined Event allows the inspection and/or modification of the raw data set after retrieval from the Data Sources and initial combining within Exago. A common use of this event is to modify or blank sensitive data fields in a Report depending on the authorizations available to the ...

Global Event: OnReportFailValidation

This server event is available in version 2017.1 and later.The OnReportFailValidation server event occurs when a user attempts to edit or run a report which has errors. When a user edits a report which fails validation, a message dialog shows the user the list of errors with the report. This ...

Global Event: OnDataFieldsRetrieved

The OnDataFieldsRetrieved Event occurs after Data Fields are retrieved for a specific Data Object. This event is commonly used to change the order Data Fields are displayed in the Data Menu of the Report Designer. Signature For custom code the arguments array is structured as follows:args[] ...

Global Event: OnReportSaveStart

The OnReportSaveStart Event occurs at the beginning of the save process for Advanced Reports, CrossTabs, Dashboards, Chained Reports and ExpressViews.Support for Dashboards and Chained Reports was added in v2019.1.26, v2019.2.12 and v2020.1.1.Signature For custom code the arguments ...

Global Event: OnExceptionThrown

OnExcpetionThrown is called when an application exception is thrown in the user interface. Generally used to pass additional or different information to the log file. Signature For custom code, the args[] array is structured as follows:the System.Exception object the ...

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 ...

Global Event: OnExecuteSqlStatementConstructed

The OnExecuteSqlStatementConstructed Event occurs just before SQL is sent to the Data Source to retrieve data for report execution. This Event could be used to inspect, log or modify the SQL that is being used for report execution. Signature For custom code the arguments array is structured as ...

Global Event: OnScheduledReportExecuteStart

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.

Global Event: OnExportCsvCell

Called prior to exporting a CSV cell for the purpose of overriding the standard export results. If the server event is defined, it is called for every visible cell in a report on CSV export. Allows for customizing cell contents on a cell-by-cell basis. Signature For custom code the args array ...

Global Event: OnScheduledReportExecuteSuccess

The OnScheduledReportExecuteSuccess Event occurs when a scheduled report execution is finished. This event can be used to create an audit log of scheduled reports. Signature For custom code the args array is structured as follows:args[] is empty.For .NET Assemblies the method signature is ...