| Name | Description | |
|---|---|---|
 | Action | The startup action for the Web Application to take when accessed via the GetUrlParamString Method. It may indicate to execute a report or open Exago directly in to the Report Designer or Report Wizard. The main menu in the user interface is disabled for all wrApiActions except Home. |
| AppPath | The virtual path to the Exago BI web application. This is set in the Api Constructor methods. |
| DataSources | A collection of Data Sources in the current configuration. Data Sources are DataSource objects, and are managed via a DataSourceCollection object accessible through this property. |
| Entities | A collection of Entities (Data Objects) that exist in the current configuration. Data Objects are Entity objects, and are managed via an EntityCollection object accessible through this property. |
| General | The General Settings (settings that fall under the General heading in the Admin Console) that exist within the current configuration. Modifying the General property to change settings on a per-user basis can be used as an alternative or a supplement to Roles. The settings are held in a General object, accessible through this property. For definitions of all available settings, see the General class. |
 | IsLogCustomConfigure | Set to true if your application uses Apache log4net. If set to false, Exago will configure log4net itself which may cause problems with application logging. This property should be set before instantiating the Api object. |
| Joins | The collection of Joins that exist in the configuration. Joins are Join objects, and are managed via a JoinCollection object accessible through this property. |
| PageInfo | The PageInfo object for this API session. |
| Parameters | Parameters are used throughout the Exago application to store values. Although parameters can be created and given a default value in the Administration Console, parameters are designed to be set at runtime through the API. Parameters are Parameter objects and are managed through a ParameterCollection object, accessible through this property. |
| ReportManagement | The ReportManagment property provides access, by way of a ReportMgmtBase object, to the contents of the Report Tree in the full user interface. Folders and reports may be renamed, saved, moved and deleted. |
| ReportObjectFactory | The ReportObjectFactory is used for all interactions loading and saving reports and other content to the system. |
| ReportScheduler | Provides access to scheduled report executions by means of a ReportScheduler object. The API object's ReportScheduler object provides access to all Scheduler Service hosts and jobs in the system configuration, despite its singular name. |
| Roles | Roles are used to provide security in the application. With a Role, a user can be restricted from accessing certain Data Objects, certain rows of Data Objects or report folders and can override some of the General Settings. Use this property to retrieve a RoleCollection object, a collection of all of the Roles in the system configuration. From there, a specific Role can be retrieved or manipulated. |
| SetupData | Retrieve the SetupData object for this API session. SetupData contains all of the session’s configuration settings including Functions, Parameters, Data Objects, Joins, Roles, etc. Several of the SetupData properties are also available as Api properties. |
| ShowTabs | Whether to show the Tabs, including the |
| SuppressFiltersInterface | Set to True to suppress the Filters menu for the Report Wizard and Report Designer when the Api Action is New[*]. Prevents users from adding filters at the report level. |
| SuppressSortsInterface | Set to True to suppress the Sorts menu for the Report Designer when the Api Action is New[*]. Prevents users from adding sorts at the report level. |
| TempPath | The absolute path that Exago BI uses to store temporary files. Warning: Do not change the TempPath value in the API. Changing this value will cause sessions to fail due to a reference path mismatch, because the API object representation is stored in the original TempPath upon instantiation. |
| WebReportsBaseUrl | The URL string that points to the Exago BI web application. |
Exago .NET API Documentation
Api Class Properties
User Preferences and 
Context-Sensitive Help icons at the top of the User Interface. Useful for decluttering the interface when the Tab bar would not be necessary, such as when executing or editing a single report.