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 data-related classes.
<static>  
The DataService class represents a data service binding with the specified report.
<static>  
Exception object.
<static>  
Contains the Parameter classes.
<static>  
Constructs a new Parameter object.
<static>  
The RequestOptions class contains attributes that describes a repository on a given iserver volume.
<static>  
The Viewer class represents a report viewer.
<static>  
Contains the viewer classes.
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>  
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.
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.data} data
Contains the data-related classes.

<static> {actuate.DataService} DataService
The DataService class represents a data service binding with the specified report.
This class can be used to handle data related service with report.

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

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

<static> {actuate.Parameter} Parameter
Constructs a new Parameter 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
The Viewer class represents a report viewer.

<static> {actuate.viewer} viewer
Contains the viewer classes.
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> {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} elementId
this string could be an id of a report element or a viewer div element id
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:
  • "dataservice": provides the actuate.dataService package and actuate.Dataservice class.
  • "viewer": provides the actuate.viewer package and actuate.Viewer class.
  • "parameter": provides the actuate.parameter package and the actuate.Parameter.
  • 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

    Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:26 GMT-0800 (PST)