List of Server Events

Startup

Global Event: OnConfigLoadStart— Occurs when the configuration of Exago is initially loaded. Expects a void return.

Global Event: OnConfigLoadEnd— Occurs after the last API changes have been made to Exago’s configuration. Expects a void return.

Global Event: OnGetUserPreferences— Called to retrieve user preferences when entering the application and editing/executing reports.

Global Event: OnAfterLoadReportsListv2016.3+ — Occurs after reports created in Exago have been loaded in the report tree object, for the purpose of allowing additional items to be loaded in the report tree.

User Interaction

Global Event: OnDataFieldsRetrieved— Occurs after Data Fields are retrieved from specific Data Objects. Expects a Data Table to be returned to indicate how to display the Data Fields.

Global Event: OnFilterSqlStatementConstructed— Occurs before the data source is queried to populate the filter dropdown. Expects an SQL string to be returned.

Global Event: OnReportSaveStart— Occurs at the beginning of the report save process.

Global Event: OnRenameFolderStart— Occurs when a user attempts to rename a folder. Expects a string to be returned to indicate if execution should proceed.

Global Event: OnRenameFolderEnd— Occurs when a folder has been renamed. Any return value will be ignored.

Report Execution

Global Event: OnReportExecuteStart— Occurs when report execution begins. Expects a string to be returned to indicate if execution should proceed.

Global Event: OnLoadReportParameters— Passes a list of Parameter elements that can be reordered or modified before they are sent to the client for display.

Global Event: OnParameterSqlStatementConstructed — Occurs after a parameter dropdown object is constructed. Allows for modifying the object SQL.

Global Event: OnOkParametersDialog— Occurs when Okay is clicked on the Parameter Execution Window. Expects a string to be returned to indicate if execution should proceed.

Global Event: OnOkFiltersDialog— Occurs when Okay is clicked on the Filter Execution Window. Expects a string to be returned to indicate if execution should proceed.

Global Event: OnExecuteSqlStatementConstructed— Occurs before the data source is queried for report execution. Expects an SQL string to be returned.

Global Event: OnWebServiceExecuteEnd— Occurs when a web service data source returns data. Expects an xml string to be returned.

Global Event: OnDataCombined— Occurs when data is combined and initially processed. Expects a Data Table to be returned.

Global Event: OnReportExecuteEnd— Occurs when a report execution finishes. Return value will be ignored.

Global Event: OnExportCsvCell— Occurs prior to exporting a CSV cell for the purpose of overriding the standard export results.

Global Event: OnScheduledReportExecuteSuccess— Occurs when a scheduled report is executed. Expects a Boolean to be returned to indicate if the report should be sent as scheduled or intercepted.

Miscellaneous

Global Event: OnSetUserPreferences— Called to save user preferences when a user specifies startup reports or saves interactive HTML changes as a user report.

Global Event: OnExceptionThrown— Occurs when an exception is thrown in the user interface. Used to log additional information to the Accessing the Log File.