Welcome to the Exago .NET API documentation!

Exago BI is a Business Intelligence solution designed to be embedded in SaaS products. Exago has two server-side APIs for programmatic creation of user sessions, which encapsulate tenancy and personalization's along many lines of stratification. Exago BI is built atop the Microsoft .NET Framework. The .NET API, documented in this guide, exposes a number of application classes that are designed to interface an embedding .NET-based host application. The REST Web Service API, documented elsewhere, is a web service API that acts as a layer to the .NET API, and can be interfaced from host applications built in most other languages.

In addition to session creation, Exago BI contains a suite of extensibility features that may require, to varying degrees, usage of the .NET API, including:

• server events —  custom written code snippets that are hooked into various areas of application functionality to track or modify built-in processes
• action events — often initiated by designated user actions, and can contain a combination of server- and client-side code
• custom functions — typically used for data display or transformation, and are exposed to end-users in the reporting interface
• custom aggregate functions — Custom Aggregate Functions will be available in any formula editor in which the existing built-in aggregate functions are also available.

The purpose of this guide is not to document how application integration or extensibility work. It is simply to define and explain the functionality of the public classes needed for typical usages of the .NET API. While not every public namespace and class is documented in this guide, this is because the .NET API is actually built for internal application development. Therefore there are a vast number of elements marked as public that are not necessarily intended for public consumption. This guide will attempt to provide a subset that is useful and understandable for 95% of development situations. Cases that are not covered here will be considered for future expansion of this guide. And please consider filing a support ticket if you have any questions about features that are not covered here.

Getting Started

Every class in this documentation is contained in one of two of the following assemblies: WebReportsApi.dll and WebReports.dll. The former contains the vast majority of API classes, and the latter contains only a handful, so in most situations you need only the WebReportsApi.dll file.

To use the .NET API, the host application must include a reference to these assemblies in its project:

• WebReportsApi.dll
• WebReportsAsmi.dll — only if the configuration includes an Assembly Data Source
• ExagoPuppeteerRasterizer.dll

When integrating Exago BI into a host application, ensure that the .NET API library version is the same as the Exago BI version, or else there will be runtime errors. When compiling an extensibility .dll that references the .NET API, you must ensure that it is compiled against the same version of Exago BI, or you will encounter similar problems.

Usage of the .NET API requires an application using .NET Framework 4.5 or higher.