Class actuate
Description
The entry point to the Actuate JavaScript API library. The actuate class uses load( ) to generate data, viewer, cross tab, parameter, explorer, and other components. The actuate class uses initialize( ) and authenticate( ) to connect to an Actuate web application service.
Use actuate.load( ) before calling actuate.initialize( ). The actuate.initialize( ) function loads all of the components added with load( ).
The initialize( ) function connects to an initial Actuate web application service. To connect to additional services simultaneously, use authenticate( ). Call initialize( ) before calling authenticate( ).
Constructor
The static actuate class loads when the a <script> element loads the Actuate JavaScript API.
Function summary
Table 4-2 lists actuate functions.
actuate.authenticate
Syntax
void authenticate(string iPortalURL, actuate.RequestOptions requestOptions, string userid, string password, function callback, string credentials, function errorCallback)Connects to the Actuate web application service that is addressed by iPortalURL and authenticates the connection.
Parameters
The iPortalURL parameter is a required string parameter that specifies the target Actuate web application URL.
The requestOptions parameter is an optional actuate.RequestOptions object. The requestOptions parameter defines the URL parameters to send with the authentication request, such as the iServer URL, Encyclopedia volume, or repository type. Functions in the RequestOptions class enable the addition of custom parameters to the URL. When requestOptions is null, authenticate( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in the Actuate web application’s web.xml file.The userid parameter is an optional string parameter that contains the login user id when the login user id is not provided in the session.
The password parameter is an optional string parameter that contains the login password when the login password is not provided in the session.
The credentials parameter is an optional string parameter. This parameter holds information that supports checking user credentials with an externalized system such as LDAP. The credentials parameter supports additional credential information for any additional security systems in place on the application server where the web service is deployed.
The callback parameter is an optional function to call after initialization. The actuate.authenticate( ) function passes the following variables to the callback function:
The errorCallback parameter is an optional function that specifies a function to call when an error occurs. The possible errors are actuate.ConnectionException, actuate.AuthenticationException, and actuate.Exception. The callback function must take an exception as an argument.
Example
To connect to an additional Actuate web service called digits, use code similar to the following:
actuate.authenticate("http://digits:8700/iportal", null, myname, mypassword, null, null, null);actuate.getDefaultIportalUrl
Syntax
Returns the default service URL.
Returns
String. The default service URL.
Example
This example calls actuate.getDefaultIportalUrl( ) to return the default service URL.
actuate.getDefaultRequestOptions
Syntax
actuate.RequestOptions getDefaultRequestOptions( )Returns the default request options.
Returns
actuate.RequestOptions object that contains the default request options.
Example
This example calls actuate.getDefaultRequestOptions( ) to return the default iServer URL.
alert ("The default iServer URL is " + actuate.getDefaultRequestOptions( ).getServerUrl( ));actuate.getVersion
Syntax
Returns the Actuate web application version.
Returns
String. The string contains the Actuate web application version in the format "#version# (Build #buildnumber#)".
Example
The following sample code displays the version in an alert box:
actuate.getViewer
Syntax
Returns a viewer instance containing the given bookmark element. Load the viewer module before calling actuate.getViewer( ).
Parameters
This string parameter contains the name of the bookmark to retrieve or the name of an HTML <div> element.
This parameter is the DOM htmlelement object for the HTML <div> element that contains a viewer.
Returns
An actuate.Viewer object that contains a viewer. When actuate.getViewer( ) does not find a viewer, the function returns null.
Example
To retrieve the viewer assigned to the first_viewer <div> element on the page, use code similar to the following:
actuate.initialize
Syntax
void initialize(string iPortalURL, actuate.RequestOptions requestOptions, reserved, reserved, function callback, function errorCallback)Connects to an initial Actuate web application service, loads all of the components added with load( ), and invokes a callback function.
Authentication is optional in initialize( ).
When using more than one service in one mashup page, use actuate.authenticate( ) to connect to additional services.
Parameters
String. The target Actuate web application URL.
actuate.RequestOptions object. Optional. RequestOptions defines URL parameters to send in the authentication request, such as the iServer URL, Encyclopedia volume, or repository type. It can also add custom parameters to the URL. If requestOptions is null, initialize( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in Actuate web application’s web.xml file.
Function. The callback function called after the initialization is done. The following variables are passed to the callback function:
Function. The function to call when an error occurs. The possible errors are actuate.ConnectionException, actuate.AuthenticationException, and actuate.Exception. errorCallback must take an exception as an argument.
Example
To initialize the client connection to a web service on myhost and then run the init( ) function, use the following code:
actuate.isConnected
Syntax
Returns whether a given Actuate web application URL is connected.
Parameters
String. The target Actuate web application URL.
actuate.RequestOptions object. Optional. RequestOptions defines URL parameters to send with the authentication request, such as the iServer URL, Encyclopedia volume, or repository type. It can also add custom parameters to the URL. If requestOptions is null, initialize( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in Actuate web application’s web.xml file.
Returns
Boolean. True if there is a connection to the given Actuate web application, False if there is no connection or if it is pending.
Example
The following sample code connects to the digits service using authenticate if not currently connected:
actuate.isInitialized
Syntax
Returns whether the library is already initialized.
Returns
Boolean. True if the library is already initialized.
Example
The following sample code initializes a connection with the actuate web service if one is not already initialized:
actuate.load
Syntax
Specifies a component to be loaded by actuate.initialize( ). The available components are:
Parameters
String. componentName is a case-sensitive parameter. Valid component names are listed above.
Example
To enable a page to use viewer, dialog, and parameters, call actuate.load( ) three times, as shown in the following code:
actuate.logout
Syntax
void logout(string iPortalURL, actuate.RequestOptions requestOptions, function callback, function errorCallback)Logs out from the given Actuate web application URL and removes authentication information from the session. If the application was previously not logged in to this Actuate web application, it generates no errors but still calls the callback function.
Parameters
String. The target Actuate web application URL.
actuate.RequestOptions object. Optional. RequestOptions defines URL parameters to send with the authentication request, such as the iServer URL, Encyclopedia volume, or repository type. It can also add custom parameters to the URL. If requestOptions is null, initialize( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in Actuate web application’s web.xml file.
Function. Optional. The callback function called after the logout is done.
Function. The function called when an error occurs. The possible errors are actuate.ConnectionException, actuate.AuthenticationException, and actuate.Exception. errorCallback must take an exception as an argument.
Example
The following sample code disconnects to the digits service if currently connected:
| (c) Copyright Actuate Corporation 2011 |
|