Exago .NET API Documentation
Api Class Members
Properties  Methods 

WebReports.Api Namespace : Api Class

The following tables list the members exposed by Api.

Public Constructors
Public ConstructorCreate a new API object, providing at a minimum the physical or virtual location of the Exago installation. Initializes an Api object and sets the AppPath Property and optionally the configuration file name and cloud storage connection string.  
Public Properties
Public Property

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.

Public PropertyThe virtual path to the Exago BI web application. This is set in the Api Constructor methods.  
Public PropertyA collection of Data Sources in the current configuration. Data Sources are DataSource objects, and are managed via a DataSourceCollection object accessible through this property.  
Public PropertyA 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.  
Public Property

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.

Public Propertystatic (Shared in Visual Basic)

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.
Public PropertyThe collection of Joins that exist in the configuration. Joins are Join objects, and are managed via a JoinCollection object accessible through this property.  
Public Property The PageInfo object for this API session.  
Public Property

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.

Public PropertyThe 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.  
Public PropertyThe ReportObjectFactory is used for all interactions loading and saving reports and other content to the system.  
Public PropertyProvides 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.  
Public Property

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.

Public PropertyRetrieve 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.  
Public Property

Whether to show the Tabs, including the 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.

Public Property

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.

Public Property

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.

Public Property

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

The URL string that points to the Exago BI web application.

Public Methods
Public Method

Returns the Api Key for use with the JavaScript API. This method is used instead of the GetUrlParamString Method for returning the session identifier to the client when embedding Exago BI components into divs instead of iframes.

See JavaScript API for more information.

Public Method

Returns the URL parameter string to redirect the browser or frame to Exago BI. Append this string to the web application base URL.

The URL param string uniquely identifies each session and its configuration settings. Most Api calls will alter the param string. So it must be returned only after setting all the session variables.

Once the Exago BI session URL is loaded by the browser, the session is closed to any further API changes.

Public MethodSaves configuration changes only for the current user session. Changes will not persist once the session ends.  
Public MethodSaves configuration changes to disk, optionally to the configuration file specified by the fileName argument.

If forceAllValues is True, all of the general configuration settings will be written to the file. If False, only those settings which differ from the defaults will be written to the file. Default value is False.  
See Also


Api Class
WebReports.Api Namespace