Classes


Namespace actuate

Actuate JS API library.
Entry point to the Actuate JS API library.
Call the load() method with the required module names. Then, call the initialize() method to initialize the API.
The initialize() method does the authentication and loads the required resources.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Entry point to the Actuate JS API library.
Field Summary
Field Attributes Field Name and Description
<static>  
Constructs an AuthenticationException object.
<static>  
Constructs an object that represents an exception occuring when a connection to a server fails.
<static>  
Constructs a Dashboard object to contain gadgets such as reportlets, charts, and parameter selectors.
<static>  
Contains the Dashboard classes.
<static>  
Contains the data-related classes.
<static>  
Constructs a DataService object.
<static>  
Constructs an Exception object.
<static>  
Contains the highcharts classes.
<static>  
Constructs a Parameter object for a page, initializing the parameter component.
<static>  
Contains the Parameter classes.
<static>  
Constructs a ReportExplorer object to view the contents of the file repository such as an iHub volume.
<static>  
Contains the ReportExplorer classes.
<static>  
Constructs attributes that describe a repository on a given iHub volume.
<static>  
Constructs a report viewer.
<static>  
Contains the viewer classes.
<static>  
Constructs an Interactive Crosstab viewer.
Method Summary
Method Attributes Method Name and Description
<static>  
authenticate(iportalUrl, requestOptions, userId, password, credentials, callback, errorCallback)
Authenticates the given user on the given Information Console URL.
<static>  
getDAViewer(elementId)
Returns an Interactive Crosstab viewer instance containing the given bookmark element.
<static>  
Returns the default service URL.
<static>  
Returns the default request options.
<static>  
Returns the user name of the logged-in user that was supplied to authenticate( ).
<static>  
Returns the Information Console version.
<static>  
getViewer(elementId)
Returns a viewer instance containing the given bookmark element.
<static>  
initialize(iportalUrl, requestOptions, userId, password, callback, errorCallback)
Initializes the Actuate JS API library.
<static>  
isConnected(iportalUrl, requestOptions)
Returns whether a given Information Console URL is connected.
<static>  
Returns whether the JS API library is already initialized.
<static>  
load(moduleName)
Specifies an API module for intialize( ) to load.
<static>  
logout(iportalUrl, requestOptions, callback, errorCallback)
Logs out the given user from the given Information Console URL.
Namespace Detail
actuate
Entry point to the Actuate JS API library.
Call the load() method with the required module names. Then, call the initialize() method to initialize the API.
The initialize() method does the authentication and loads the required resources.
See:
actuate.load()
actuate.initialize()
Field Detail
<static> {actuate.AuthenticationException} AuthenticationException
Constructs an AuthenticationException object.

<static> {actuate.ConnectionException} ConnectionException
Constructs an object that represents an exception occuring when a connection to a server fails.

<static> {actuate.Dashboard} Dashboard
Constructs a Dashboard object to contain gadgets such as reportlets, charts, and parameter selectors.

<static> {actuate.dashboard} dashboard
Contains the Dashboard classes.

<static> {actuate.data} data
Contains the data-related classes.

<static> {actuate.DataService} DataService
Constructs a DataService object. The DataService class represents a data service binding with an iportal service, and can download data from a report available from that service

<static> {actuate.Exception} Exception
Constructs an Exception object. The exceptions are divided into three types, which determine the contents of the Exception object. These types are:

<static> {actuate.highcharts} highcharts
Contains the highcharts classes.

<static> {actuate.Parameter} Parameter
Constructs a Parameter object for a page, initializing the parameter component.

<static> {actuate.parameter} parameter
Contains the Parameter classes.

<static> {actuate.ReportExplorer} ReportExplorer
Constructs a ReportExplorer object to view the contents of the file repository such as an iHub volume.

<static> {actuate.reportexplorer} reportexplorer
Contains the ReportExplorer classes.

<static> {actuate.RequestOptions} RequestOptions
Constructs attributes that describe a repository on a given iHub volume. The attributes iServerUrl and volume are only used when the repository type is ENCYCLOPEDIA. If the repository type is STANDALONE, they are ignored.

<static> {actuate.Viewer} Viewer
Constructs a report viewer. For example, to assign the viewer to display in a <div id='containerName' /> tag on the page, use the following constructor call:
	var myViewer = new actuate.Viewer("containerName");

<static> {actuate.viewer} viewer
Contains the viewer classes.

<static> {actuate.XTabAnalyzer} XTabAnalyzer
Constructs an Interactive Crosstab viewer.
Method Detail
<static> authenticate(iportalUrl, requestOptions, userId, password, credentials, callback, errorCallback)
Authenticates the given user on the given Information Console URL. Use authenticate( ) to connect to additional Information Console applications after calling initialize( ).
If no userId and password are provided, the existing authentication for this Information Console URL is used. If no authentication exists for the current user or the authentication failed, a login dialog appears requesting the user for valid credentials. After the user chooses OK, the authentication process is retried using the new credentials.
If no requestOptions is provided, default settings are used. To connect to an iHub volume, use this parameter to specify the repository type and volume:
var reqOps = new actuate.RequestOptions( );
reqOps.setVolumeProfile( "Default Volume" );
reqOps.setRepositoryType( actuate.RequestOptions.REPOSITORY_ENCYCLOPEDIA );
Parameters:
{String} iportalUrl
Information Console URL to authenticate, for example, https://myhost.mycompany.com:8700/iportal
{actuate.RequestOptions} requestOptions
Optional instance of actuate.RequestOptions
{String} userId
Optional user ID, or null if using single sign-on
{String} password
Optional password, or null if using single sign-on
{String} credentials
Optional information to support checking user credentials on an externalized system such as LDAP
{Function} callback
Optional callback to call when authentication completes.
The callback takes the following arguments:
  • iportalUrl: The same as the passed iportalUrl argument
  • userId: The authenticated user ID
  • iserverUrl: The iHub URL
  • volume: iHub volume
{Function} errorCallback
Optional callback to call if an exception occurs. The callback receives one of the following exception instances:
  • actuate.ConnectionException: The resource loading failed due to an invalid iportalUrl value.
  • actuate.AuthenticationException: The authentication failed.
  • actuate.Exception: Other exceptions.
See:
actuate.Exception
actuate.ConnectionException
actuate.AuthenticationException

<static> {actuate.XTabAnalyzer} getDAViewer(elementId)
Returns an Interactive Crosstab viewer instance containing the given bookmark element. To use this method, load the "xtabAnalyzer" module before calling initialize().
Parameters:
{String or Object} elementId
The name of the bookmark of a crosstab element or the DOM htmlelement object for the HTML div element that contains an Interactive Crosstab viewer
Returns:
{actuate.XTabAnalyzer} Interactive Crosstab viewer instance or null if no Interactive Crosstab viewer was found
See:
actuate.XTabAnalyzer.getViewer()

<static> {String} getDefaultIportalUrl()
Returns the default service URL.
Returns:
{String} The default service URL for the current connection

<static> {actuate.RequestOptions} getDefaultRequestOptions()
Returns the default request options.
Returns:
{actuate.RequestOptions} The default request options

<static> {String} getUserId()
Returns the user name of the logged-in user that was supplied to authenticate( ).
The following sample code displays the user name in an alert box:
alert("User name: " + actuate.getUserId( ));
Returns:
{String} The user name provided to actuate.authenticate( ). Null or an empty string if authenticate was not used to log in.

<static> {String} getVersion()
Returns the Information Console version.
Returns:
{String} Information Console version in the format "#version# (Build #buildnumber#)"

<static> {actuate.Viewer} getViewer(elementId)
Returns a viewer instance containing the given bookmark element. To use this method, load the "viewer" module before calling initialize().
Parameters:
{String or Object} elementId
The name of the bookmark or the DOM htmlelement object for the HTML div element that contains a viewer
Returns:
{actuate.Viewer} A Viewer instance or null if no viewer was found
See:
actuate.Viewer.getViewer()

<static> initialize(iportalUrl, requestOptions, userId, password, callback, errorCallback)
Initializes the Actuate JS API library. Authenticates the user using the given credentials, loads the API selected by the previously called load( ) method, then calls the passed callback method.
If an error occurred, calls the error callback, if defined.
If no userId and password are provided, the existing authentication for this Information Console URL is used. If no authentication exists for the current user or the authentication failed, a login dialog appears requesting the user for valid credentials. After the user chooses OK, the authentication process is retried using the new credentials.
If no requestOptions is provided, default settings are used. To connect to an iHub volume, use this parameter to specify the repository type and volume:
var reqOps = new actuate.RequestOptions( );
reqOps.setVolumeProfile( "Default Volume" );
reqOps.setRepositoryType( actuate.RequestOptions.REPOSITORY_ENCYCLOPEDIA );
Parameters:
{String} iportalUrl
Information Console URL from which to load resources, for example, https://myhost.mycompany.com:8700/iportal
{actuate.RequestOptions} requestOptions
Optional instance of actuate.RequestOptions
{String} userId
Optional user ID, or null if using single sign-on
{String} password
Optional password, or null if using single sign-on
{Function} callback
Optional callback to call when initialization of the API completes.
The callback takes the following arguments:
  • iportalUrl: The same as the passed iportalUrl argument
  • userId: The authenticated user ID
  • iserverUrl: The iHub URL
  • volume: iHub volume
{Function} errorCallback
Optional callback to call if an exception occurs. The callback receives one of the following exception instances:
  • actuate.ConnectionException: The resource loading failed due to an invalid iportalUrl value.
  • actuate.AuthenticationException: The authentication failed.
  • actuate.Exception: Other exceptions.
See:
actuate.Exception
actuate.ConnectionException
actuate.AuthenticationException
actuate.load

<static> {boolean} isConnected(iportalUrl, requestOptions)
Returns whether a given Information Console URL is connected.
Parameters:
{String} iportalUrl
Information Console URL
{actuate.RequestOptions} requestOptions
Optional RequestOptions instance
Returns:
{boolean} true if there is a connection to the given Information Console, false if there is no connection or if the connection is pending.

<static> {boolean} isInitialized()
Returns whether the JS API library is already initialized.
Returns:
{boolean} true if the library is already initialized, false otherwise

<static> load(moduleName)
Specifies an API module for intialize( ) to load. Call this method before calling initialize( ). Available module names are the following:
  • "viewer": Loads the actuate.viewer and actuate.data packages and actuate.Viewer and actuate.DataService classes.
  • "parameter": Loads the actuate.parameter package and the actuate.Parameter class.
  • "dashboard": Loads the actuate.dashboard package and the actuate.Dashboard class.
  • "reportexplorer": Loads the actuate.reportexplorer package and the actuate.ReportExplorer class.
  • "xtabanalyzer": Loads the actuate.xtabanalyzer package and the actuate.XTabAnalyzer class.
  • To load multiple modules, call load( ) once per module:
    actuate.load("viewer");
    actuate.load("parameter");
    Parameters:
    {String} moduleName
    The name of the module to load
    See:
    actuate.initialize()
    actuate.dashboard
    actuate.parameter
    actuate.reportexplorer
    actuate.viewer
    actuate.XTabAnalyzer

    <static> logout(iportalUrl, requestOptions, callback, errorCallback)
    Logs out the given user from the given Information Console URL. If the user was previously not logged in to this URL, no error is returned and the callback function is still called.
    Parameters:
    {String} iportalUrl
    Information Console URL from which to log out
    {actuate.RequestOptions} requestOptions
    Optional instance of actuate.RequestOptions
    {Function} callback
    Optional callback to call when logging out completes.
    The callback takes the following arguments:
    • iportalUrl: The same as the passed iportalUrl argument
    • iserverUrl: The iHub URL
    • volume: iHub volume
    {Function} errorCallback
    Optional callback to call whenever an exception occurs. The callback receives one of the following exception instances:
    • actuate.ConnectionException: The resource loading failed, due to an invalid iportalUrl value.
    • actuate.AuthenticationException: The authentication failed.
    • actuate.Exception: Other exceptions.
    See:
    actuate.Exception
    actuate.ConnectionException
    actuate.AuthenticationException

    Documentation generated by JsDoc Toolkit 2.0.1 on Fri Feb 27 2015 14:31:49 GMT-0800 (PST)