Common URI parameters

Table 4‑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 iHub, 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 connects. This parameter overrides the volume from the __vp parameter if they are used together.
__vp	The name of a server configured in VolumeProfile.xml. Information Console uses the volume information in a VolumeProfile entry except when a volume parameter specifies a different one.

This URI lists the contents of the Training folder in the Encyc2 Encyclopedia volume on the Actuate BIRT iHub named server1 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.