Common URI parameters

All Actuate Java Component 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 Java Component authentication using cookies.

Table 5-2

Common Actuate Java Component URI parameters

URI parameter	Description
forceLogin	True to force a login, false to display the login page. The default is false. 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 Java Component pages.
locale	The current user’s locale, such as U.S. English (en-US). Java Component locale names have the form nn_CC. nn is the language abbreviation and CC is the country code in both formats.
password	The password associated with the userID.
serverURL	Contains the URI that accesses the Actuate web application, 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 Java Component pages.
volume	The volume to which the user is connected.

The following Java Component URI shows most of the common URI parameters in use:

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

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

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

  &timeZone=Australia/Perth

This URI lists the contents of the Training folder on the application server 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. Note that the password is shown in plain text, as entered. If entered on a JSP or in a web form, it would be detected and encrypted.

Copyright Actuate Corporation 2012