Scroll

JavaScript API

The Exago JavaScript (JS) API allows Exago functionality to be embedded directly into HTML div containers.

Divs can inherit code and styles from the host application. Since CSS cascades down to Exago, as well as up to the parent app, this allows you to maintain a single base of styles rather than separate ones for the host app and for Exago. And the Exago DOM is accessible from the host application, so custom scripting is possible without being limited to Action Events.

 

Background

The JS API implements asynchronous calls to Exago functionality in the client browser. Besides the advantages of being able to embed in divs and interact programmatically, the API also allows for multiple calls to happen without needing to generate a new session for each one. As sessions are created only once per page load, this can increase the feeling of responsiveness in the host application.

Because the JS API runs on the client-side, it is not standalone. You are still required to generate session objects with either the .NET or REST APIs. Session objects must include any relevant user permissions and configuration settings.

A parameter called the ApiKey encodes the session object in a string, which is passed from the server-side API to the JS API. The JS API then initializes a JS API object, which is analogous to an Exago user session.

Note: JS API objects are static and single-use. They cannot persist between page loads, and you cannot have multiple JS API objects active on the same page.

The JS API object provides a set of functions that are used to implement elements of Exago functionality.

 

Setup and Configuration

These steps describe how to configure your environment to use the JS API, as well as how to implement it in an application.

Create the Session

First you need to use the .NET or REST API to set up security and permissions for the session. Make all your configuration changes here, as these settings cannot be changed once the JS API object is loaded.

Set the WebAppBaseUrl property to the virtual directory where Exago BI is installed:

.NET

api.SetupData.WebAppBaseUrl = "http://server/Exago/";

REST

Do one of the following:

  • PATCH /Rest/Settings?sid={sid}, Payload:
    { "WebReportsBaseUrl" : "http://server/Exago" }
  • Add to the web service config file ({WebService}/Config/WebReportsApi.xml):
    <webreportsbaseurl>http://server/Exago/</webreportsbaseurl>

The JS API has no concept of an Active Report or an API Action, so do not set these as they will have no effect. The action and report are specified by the individual JS function calls.

Note: A side-effect of this is that you cannot make per-session report changes in memory, since the JS API function can only act on saved reports. You will need to save any changes to disk instead.

When the session is ready, get the ApiKey. This encodes the session settings to pass to the JS API.

.NET

return api.GetApiKey();

REST

GET "Rest/Sessions/{sid}", then get the ApiKey property from the response object:

{
 ...
 "ApiKey": "encodedAlphanumericApiKey"
}
Note: This is not the UrlParamString / AppUrl.

 

JS API Object

Load the JS API library into the host web application via a script tag:

<script src="http://server/Exago/WrScriptResource.axd?s=ExagoApi"></script>
Note: WrScriptResource.axd is not a file on the file system, it is a virtual file that contains the necessary scripts to load the API. "http://server/Exago" is the URL to the virtual path of your Exago web application.

Using the ApiKey, initialize a JS API object.

var api = new ExagoApi(ExagoBaseURL, ApiKey, onLoadCallback, [showErrorDetail]);
  • ExagoBaseURL - URL to the installation of Exago BI
  • ApiKey - key generated when the session was created
  • onLoadCallback - function to execute once the JS API has been fully loaded and is ready for use
  • Optional: showErrorDetail - set to True to see more detailed application error messages. (Default: False).
Note: ApiKeys are one-use. Multiple instances are not supported nor necessary. Functions can be called against the object for the duration of the session.

 

Functions

The following functions are available for loading and managing Exago functionality.

Note: Functions can only be used once the JS API is fully loaded. Wait for the onLoadCallback to indicate that the API is ready.
Caution: Due to a known issue, the callbacks mentioned in the following JavaScript API functions only work as described as of v2018.1.12+ or v2018.2+.

LoadFullUI(container)

Load the full User Interface in a div.

Parameter Description
container Div container to place the full UI into
Note: The Full UI being loaded will block almost all other actions, so while the Full UI is displayed on screen, the host application cannot perform any other actions such as executing reports or creating new reports.

 

ExecuteReport(container, exportType, reportPath, [udf], [updateCallback], [errorCallback])

Execute a report or dashboard to a specific output type in a defined container.

Parameter Description
container Div container to place the executed report into
exportType html|pdf|csv|excel|rtf
reportPath Relative path to report to execute
Example: "MyFolder\\MyReport"
udf Optional: Report UDF information for use with folder management
updateCallback (container, updateType) Optional: Callback to execute when the execution status changes, called when the report execution is starting and again when it is ready to be viewed.
  • Parameter ‘container’: The same container HTMLElement that was passed in to the call
  • Parameter ‘updateType’: The type of update as a string, either
The parameter 'updateType' will assume one of these string values:
  • “executionstart”: The report has been loaded and is starting execution, or
  • “initialcontentload”: The execution viewer has been loaded and populated with at least the first page of the report, if executing an Advanced Report or ExpressView to HTML)
Note: this callback will occur once for each status change unless errors occur.

errorCallback (container, errorMessage) => string

Optional: Callback to execute in the event an execution blocking error occurs
  • Parameter ‘container’: The same container HTMLElement that was passed in to the call
  • Parameter ‘errorMessage’: The error text

Return value: see errorCallback return values below.

 

ExecuteStaticReport(exportType, reportPath, udf, successCallback, [errorCallback])

Execute a report, and return its output to the successCallback function. Report is not interactive.

Parameter Description
exportType html|pdf|csv|excel|rtf|json
reportPath Relative path to report to execute
Example: "MyFolder\\MyReport"
udf Report UDF information for use with folder management

successCallback (executionData)

Callback to execute when execution request returns
  • Parameter 'executionData': a string containing the executed report’s data is passed as a parameter, whose formatting depends on the specified exportType. If the export type is “html”, “csv”, or “json”, the returned string will contain all of the data in the corresponding format. If the export type is “pdf”, “excel”, or “rtf”, the returned string will be partial URL to the file, e.g. “ExecuteExport.aspx?eid=…”. See the below example for prefixing the returned partial URL with the base address.
errorCallback (errorMessage)

Optional: Callback to execute in the event an error occurs.

  • Parameter 'errorMessage': The error text.
const container = ...
const exportType = ...
const reportPath = ...

api.ExecuteStaticReport(exportType, reportPath, null,
    (executionData) =>
    {
        if (exportType == "excel" || exportType == "rtf" || exportType == "pdf")
            container.innerHTML = "<iframe src="' + api.GetBaseAddress() + executionData + '"></ iframe>";
        else
            container.innerHTML = executionData;
    },
    (errorMessage) => 
    {
        container.innerHTML = errorMessage;
    });

 

ScheduleReportWizard(container, reportPath, [udf], [errorCallback])

Open the schedule report wizard for a report.

Parameter Description
container Div container to place the scheduled report wizard into
reportPath Relative path to report to schedule
Example: "MyFolder\\MyReport"
udf Optional: Report UDF information for use with folder management

errorCallback (container, errorMessage) => string

Optional: Callback to execute in the event an error occurs, such as the scheduler being disabled
  • Parameter ‘container’: The same container HTMLElement that was passed in to the call
  • Parameter ‘errorMessage’: The error text
Return value: see errorCallback return values below.

 

ScheduleReportManager(container, [errorCallback])

Open the schedule report manager.

Parameter Description
container Div container to place the scheduled report manager into

errorCallback  (container,  errorMessage) => string

Optional: Callback to execute in the event an error occurs, such as the scheduler being disabled

  • Parameter ‘container’: The same container HTMLElement that was passed in to the call
  • Parameter ‘errorMessage’: The error text
Return value: see errorCallback return values below.

 

LoadReportTree(successCallback, [errorCallback])

Load the report tree as JSON, returned to the successCallback method.

Parameter Description
successCallback (reportTree)

Callback to execute once the report tree has been loaded.

  • Parameter 'reportTree': A JSON object representing the report tree.
errorCallback (errorMessage)

Optional: Callback to execute in the event an error occurs

  • Parameter ‘errorMessage’: The error text

 

EditReport(container, reportPath, [udf], [errorCallback])

Load the report designer for a report.

Parameter Description
container Div container to place the report designer into
reportPath Relative path to report to edit
Example: "MyFolder\\MyReport"
udf Optional: Report UDF information for use with folder management

errorCallback (container,

errorMessage) => string

Optional: Callback to execute if the report fails to load

Parameter ‘container’: The same container HTMLElement that was passed in to the call

Parameter ‘errorMessage’: The error text

Return value: see errorCallback return values below.

 

NewReport(container, reportType)

Load the report designer for a new report.

Parameter Description
container Div container to place the report designer into
reportType advanced|express|dashboard|chained|expressview

 

DisposeContainerContent(container)

Disposes the contents of a container and resets the system state to be aware of what containers are open.

Parameter Description
container Div container to dispose

 

DisposePage()

Disposes the contents of a page, removing any event listeners added to the page and performing other cleanup necessary for complete removal of the ExagoAPI instance. After calling DisposePage(), the ExagoAPI instance should be considered "closed." Any new Exago JavaScript API calls must be performed on a new ExagoAPI instance. 

 

IsAllowedReportType(reportType)

Returns whether or not a specified report type is allowed for the session.

Parameter Description
reportType advanced|express|dashboard|chained|expressview

 

GetAllowedReportTypes()

Returns an array of the report types allowed for this session.

 

Example:

function RunReportJS() {
  var container = document.getElementById("ExagoDiv");
  api.ExecuteReport(container, "html", "Examples\\ClientReport");
}
Note: Container divs must be empty or disposed before loading. Additionally, you should specify size and position constraints for each div.
div#ExagoDiv {
  width: 1200px;
  height: 600px;
  position: relative;
}

 

Disposing Containers

It is important to properly dispose of containers when they are finished being used by explicitly calling the DisposeContainerContent(container) method.

Optionally, an OnDisposeContainer callback can be defined that will execute when a container has been disposed either implicitly or explicitly. This allows the host application to safely reset the container to whatever state necessary, or remove the container from the page entirely. When a user encounters an error that prevents the requested action, e.g., ExecuteReport(...), the container will auto-dispose and execute the OnDisposeContainer callback if one is defined.

Example:

api.OnDisposeContainer = function(container) {
  container.parentElement.removeChild(container);
};

 

Disposing Pages (v2018.2+)

Once an ExagoAPI instance has been instantiated, DisposePage() must be called before instantiating subsequent ExagoAPI instances. DisposePage() will dispose the contents of an entire page, thereby disposing each instantiated container. Furthermore, it will remove any event listeners added to the page by the ExagoApi instance and perform other cleanup necessary for complete removal of the ExagoAPI instance.

After calling DisposePage(), the ExagoAPI instance should be considered "closed." Any new Exago JavaScript API calls must be performed on a new ExagoAPI instance. 

 

errorCallback return value

Whenever an error occurs that prevents the JS API action from updating a container (such as an undefined report name in a call of ExecuteReport), the following will happen:

  • If errorCallback is not defined, an alert dialog will appear with the error message (or a placeholder error message, if the URL parameter 'showerrordetail' is set to false).
  • If errorCallback is defined, it will first be called. If errorCallback returns a string (either the original error message or a custom message), an alert dialog will appear with the given string, or a placeholder error message if the URL parameter 'showerrordetail' is set to false.
  • If errorCallback does not return a string, or the string is empty, no alert dialog will be shown and the DisposeContainerContent() method will run immediately.

Clicking on the error dialog’s dismiss button will close the dialog and call DisposeContainerContent(). The container’s content will be closed, the inner HTML will be cleared, and the OnDisposeContainer callback will be called.


Hidden Article Information

Article Author
Exago Development
created 2017-07-28 15:00:39 UTC
updated 2019-04-03 13:28:20 UTC

Labels
css, html, object, client, function, method, architecture, xss, cross, iis, apache, host, page, integrate, jscript, embed, iframe, container, key, script, browser, div, frame, single, SPA, JS, origin,
Have more questions? Submit a request