Classes


Namespace actuate

Entry point to the Actuate web 2.0 JS API library.
The load() method must be called first with appropriate module names, followed by a call to the initialize() method to initialize the API.
The initialize() method will do the authentication and load related resources. Entry point to the Actuate web 2.0 JS API library.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Entry point to the Actuate web 2.0 JS API library.
Field Summary
Field Attributes Field Name and Description
<static>  
AuthenticationException object.
<static>  
ConnectionException object.
<static>  
Contains the Dashboard classes.
<static>  
Constructs a new Dashboard object.
<static>  
Contains the data-related classes.
<static>  
Constructs a DataService object.
<static>  
Exception object.
<static>  
Constructs a Parameter object for a page, initializing the parameter component.
<static>  
Contains the Parameter classes.
<static>  
Contains the ReportExplorer classes.
<static>  
Constructs a new ReportExplorer object.
<static>  
The RequestOptions class contains attributes that describes a repository on a given iserver volume.
<static>  
Contains the viewer classes.
<static>  
The Viewer class represents a report viewer.
<static>  
The XTabAnalyzer class represents a XTab Analyzer 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 iportal URL.
<static>  
getDAViewer(elementId)
Returns a DA viewer instance containing the given bookmark element.
<static>  
Returns the default service URL.
<static>  
Returns the default request options.
<static>  
Returns the user id
<static>  
Returns the user password
<static>  
Returns the iportal version.
<static>  
getViewer(elementId)
Returns a viewer instance containing the given bookmark element.
<static>  
initialize(iportalUrl, requestOptions, userId, password, callback, errorCallback)
Initializes the iportal web 2.0 JS API library.
<static>  
isConnected(iportalUrl, requestOptions)
Returns whether a given iportal URL is connected.
<static>  
Returns whether the library is already initialized.
<static>  
load(moduleName)
Specifies the name of an API module to load.
<static>  
logout(iportalUrl, requestOptions, callback, errorCallback)
Logs out the given user from the given iportal URL.
<static>  
setProfile(profileName)
Set native app profile name
Namespace Detail
actuate
Entry point to the Actuate web 2.0 JS API library.
See:
actuate.load()
actuate.initialize()
Field Detail
<static> {actuate.AuthenticationException} AuthenticationException
AuthenticationException object.

<static> {actuate.ConnectionException} ConnectionException
ConnectionException object.

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

<static> {actuate.Dashboard} Dashboard
Constructs a new Dashboard object.

<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
Exception object.

<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
Contains the ReportExplorer classes.

<static> {actuate.ReportExplorer} ReportExplorer
Constructs a new ReportExplorer object.

<static> {actuate.RequestOptions} RequestOptions
The RequestOptions class contains attributes that describes a repository on a given iserver volume. The attributes iServerUrl and volume are only used when the repository type is encyclopedia. In standalone mode they are ignored.

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

<static> {actuate.Viewer} Viewer
The Viewer class represents 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.XTabAnalyzer} XTabAnalyzer
The XTabAnalyzer class represents a XTab Analyzer viewer.
Method Detail
<static> authenticate(iportalUrl, requestOptions, userId, password, Credentials, callback, errorCallback)
Authenticates the given user on the given iportal URL. If no userId/password are given, the existing authentication for this iportal URL will be used. If no authentication exists for the current user or the authentication failed, then a login dialog will appear asking the user to enter valid credentials. After the user hits the ok button, the authentication process will be retried with the new credentials.
Parameters:
{String} iportalUrl
iportal server URL to authenticate
{actuate.RequestOptions} requestOptions
optional instance of actuate.RequestOptions
{String} userId
optional user ID to use
{String} password
optional password
{String} Credentials
{Function} callback
optional callback to be called as soon as the authentication is finished.
The callback takes the following arguments:
  • iportalUrl: same as the passed iportal URL
  • userId: authenticated user ID
  • iserverUrl: iserver URL
  • volume: volume
{Function} errorCallback
optional callback to be called whenever an exception occurs. The callback will receive one of the following exception instances:
  • actuate.ConnectionException: if the resource loading failed, due to an invalid iportal URL.
  • actuate.AuthenticationException: the authentication has failed
  • actuate.Exception: other exceptions
See:
actuate.Exception
actuate.ConnectionException
actuate.AuthenticationException

<static> {actuate.XTabAnalyzer} getDAViewer(elementId)
Returns a DA viewer instance containing the given bookmark element. This only works when the "xtabAnalyzer" module has been loaded.
Parameters:
{String or Object} elementId
this string could be an id of a crosstab element or a DA viewer div element id; it can be an html element object too
Returns:
{actuate.XTabAnalyzer} DA viewer instance or null if no DA viewer was found
See:
actuate.XTabAnalyzer.getViewer()

<static> getDefaultIportalUrl()
Returns the default service URL.
Returns:
default service URL

<static> getDefaultRequestOptions()
Returns the default request options.
Returns:
default request options (instance of actuate.RequestOptions)

<static> getUserId()
Returns the user id
Returns:
userid

<static> getUserPassword()
Returns the user password
Returns:
password

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

<static> {actuate.Viewer} getViewer(elementId)
Returns a viewer instance containing the given bookmark element. This only works when the "viewer" module has been loaded.
Parameters:
{String or Object} elementId
this string could be an id of a report element or a viewer div element id; it can be an html element object too
Returns:
{actuate.Viewer} viewer instance or null if no viewer was found
See:
actuate.Viewer.getViewer()

<static> initialize(iportalUrl, requestOptions, userId, password, callback, errorCallback)
Initializes the iportal web 2.0 JS API library. Authenticates the user using the given credentials, loads the API selected by the load() method, then calls the passed callback method. If an error occurred, the error callback will be called, if defined.
Parameters:
{String} iportalUrl
server base URL from where to load the needed resources.
{actuate.RequestOptions} requestOptions
optional requestOptions, can be null, missing, or an instance of actuate.RequestOptions.
{String} userId
userId, or null if using SSO
{String} password
password, or null if using SSO
{Function} callback
callback function to be called once the initialization of the API is complete.
The callback takes the following arguments:
  • iportalUrl: same as the passed iportal URL
  • userId: authenticated user ID
  • iserverUrl: iserver URL
  • volume: volume
{Function} errorCallback
optional callback function whenever an error occurred during initialization. The possible exceptions are the following:
  • actuate.ConnectionException: if the resource loading failed, due to an invalid iportal URL.
  • actuate.AuthenticationException: the authentication has failed/li>
  • actuate.Exception: other exceptions
See:
actuate.Exception
actuate.ConnectionException
actuate.AuthenticationException
actuate.load

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

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

<static> load(moduleName)
Specifies the name of an API module to load. This method must be called before initialize(). The available module names are the following:
  • "viewer": provides the actuate.viewer package and actuate.Viewer class.
  • "parameter": provides the actuate.parameter package and the actuate.Parameter class.
  • "dashboard": provides the actuate.dashboard package and the actuate.Dashboard class.
  • "reportexplorer": provides the actuate.reportexplorer package and the actuate.ReportExplorer class.
  • "xtabanalyzer": provides the actuate.xtabanalyzer package and the actuate.XTabAnalyzer class.
  • "dialog": provides the actuate.dialog package.
  • Parameters:
    {String} moduleName
    module name to import
    See:
    actuate.initialize()

    <static> logout(iportalUrl, requestOptions, callback, errorCallback)
    Logs out the given user from the given iportal URL. If the user was previously not logged in to this iportal URL, no error will be returned and the callback function will still be called.
    Parameters:
    {String} iportalUrl
    iportal server URL to authenticate
    {actuate.RequestOptions} requestOptions
    optional instance of actuate.RequestOptions
    {Function} callback
    optional callback to be called as soon as the logging out is finished.
    The callback takes the following arguments:
    • iportalUrl: same as the passed iportal URL
    • iserverUrl: iserver URL
    • volume: volume
    {Function} errorCallback
    optional callback to be called whenever an exception occurs. The callback will receive one of the following exception instances:
    • actuate.ConnectionException: if the resource loading failed, due to an invalid iportal URL.
    • actuate.AuthenticationException: the authentication has failed/li>
    • actuate.Exception: other exceptions
    See:
    actuate.Exception
    actuate.ConnectionException
    actuate.AuthenticationException

    <static> setProfile(profileName)
    Set native app profile name
    Parameters:
    profileName

    Documentation generated by JsDoc Toolkit 2.0.1 on Mon Dec 16 2013 06:58:33 GMT-0800 (PST)