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

List of Server Events

Server events categorized by activity Startup OnConfigLoadStart — Occurs when the configuration of Exago is initially loaded. Expects a void return. OnConfigLoadEnd — Occurs after the last API changes have been made to Exago's configuration. Expects a void return. OnGetUserPreferences — ...

Introduction to Server Events

This article applies to the Admin Console >  Extensions > Server Events settings. Server Event Handlers provide code that Exago can execute when certain events happen during the application runtime. This code can either come from a .NET Assembly or be written in a high-level ...

Global Event: OnWebServiceExecuteEnd

The OnWebServiceExecuteEnd Event occurs when data is returned from a Web Service Data Source. This Event could be used to decompress or decrypt data being returned from a Web Service Data Source. Signature For custom code the args array is structured as follows: Args[] contains a single ...

Global Event: OnSetUserPreferences

The OnSetUserPreferences Event is used to store user preferences when setting startup reports, saving interactive Report Viewer modifications as user reports or color chooser user colors. The event will only be called if the Admin Console > General > User Settings > User Preference ...

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

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: 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: 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: 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: 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: 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: 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: 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: OnRenameFolderEnd

The OnRenameFolderEnd Event occurs after user has renamed a folder. Signature For 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: OnOkParametersDialog

The OnOkParametersDialog Event occurs when a user clicks on the Ok button of the Parameter Prompt Window. The window will only displays if the report has a non-hidden parameter with a prompt text. This Event could be used to see what values the user is setting for each prompting ...

Global Event: OnOkFiltersDialog

The OnOkFiltersDialog Event occurs when a user clicks on the Ok button in the Filter Execution Window. This window only displays if prompt for value was checked for a filter. This Event could be used to see what filters are being used on the report and/or assure that a filter ...

Global Event: OnLoadReportParameters

The OnLoadReportParameters event passes a list of Parameter elements that can be reordered or modified before they are sent to the client for display. Called when report parameters are loaded, but before any processing has occurred. By default, parameters are sorted alphabetically by ...

Global Event: OnGetUserPreferences

The OnGetUserPreferences Event is used to retrieve user preferences when entering the application and when editing/executing reports. Signature For custom code the args array is structured as follows: args[] contains one object, a string with the user preference’s id. For .NET ...