The Actuate JavaScript API enables the creation of custom web pages that incorporate Actuate BIRT reports. The Actuate JavaScript API classes functionally embed BIRT reports into web pages using div elements. To use the Actuate JavaScript API, deploy the BIRT Viewer Toolkit web application and reference the JSAPI libraries in the HTML script markup that uses JSAPI functions.

The Actuate JavaScript API uses the Prototype JavaScript Framework. The following directory contains the Actuate JavaScript API source files:

The base class in the Actuate JavaScript API is actuate. The actuate class is the entry point for all of the Actuate JavaScript API classes. The actuate class establishes connections to the Actuate BIRT Viewer Toolkit application services. The Actuate JavaScript API uses HTTP requests to retrieve reports and report data from an Actuate web service. The subclasses provide functionality that determines the usage of the reports and report data.

Many functions in the Actuate JavaScript API use a callback function. A callback function is a custom function written into the web page that is called immediately after the function that calls it is finished. A callback function does not execute before the required data or connection has been retrieved from the server.

Many of the callback functions in the Actuate JavaScript API use a passback variable. A passback variable contains data that is passed back to the page by the calling function. A callback function that uses an input parameter as a passback variable must declare that input parameter.