Common URI parameters

All Actuate Information Console URIs have the parameters shown in Table 5-2. String values that are too long are truncated for all parameters. The web browser that you use determines the length of parameters. The common URI parameters support Actuate Information Console authentication using cookies.

**Table 5-2** Common Actuate Information Console URI parameters
URI parameter	Description
forceLogin	True to force a login, False to display the login page. The default is False. For example, when switching between Encyclopedia volumes and using an Information Console security manager class, set forceLogin=true to force the Information Console Login module to call the security manager to perform the login operation. The login operation is described in Understanding the authentication process.
iPortalID	The unique authentication ID assigned to the user upon successful login. Use this parameter in conjunction with the userID parameter to ensure that a user’s personalized settings appear in the Information Console pages.
locale	The current user’s locale, such as U.S. English (en-US).
password	The password associated with the userID.
serverURL	The URI that accesses the Actuate BIRT iServer, such as http://Services:8000.
timezone	The current user’s time zone.
userID	The user’s unique identifier, required to log in to the repository. Use this parameter in conjunction with the iPortalID parameter to ensure that a user’s personalized settings appear in the Information Console pages.
volume	The volume to which the user is connected.
VolumeProfile	The name of a server configured in VolumeProfile.xml. In general, Information Console replaces volume information in a URL with a VolumeProfile entry if one is configured.

The following Information Console URI shows most of the common URI parameters in use:

http://localhost:8700/iportal/getfolderitems.do

?folder=/Training&volume=Encyc2&locale=en_AU&userID=Mike

&password=pw123&serverURL=http://Seamore:8000

&timeZone=Australia/Perth

This URI lists the contents of the Training folder in the Encyc2 Encyclopedia volume on the Actuate BIRT iServer named Seamore at port 8000. The locale is set to Australian English and the time zone is Australia/Perth (GMT plus eight hours). The user is Mike and the password is pw123. The password is shown in plain text, as entered.

If the server and volume information for Seamore above is configured as a Volume Profile, you can use a simplified URL as shown in the following lines:

http://localhost:8700/iportal/getfolderitems.do

?folder=/Training&VolumeProfile=Seamore&locale=en_AU

&userID=Mike&password=pw123&timeZone=Australia/Perth