Common URI parameters
All Visualization Platform URIs have the parameters shown in Table 25‑3. 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 Visualization Platform authentication using cookies.
Table 25‑3 Common Visualization Platform 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 Visualization Platform security manager class, set forceLogin=true to force the Visualization Platform Login module to call the security manager to perform the login operation.
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 Visualization Platform 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 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 Visualization Platform 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. Visualization Platform uses the volume information in a VolumeProfile entry except when a volume parameter specifies a different one.
The following Visualization Platform URI shows most of the common URI parameters in use:
http://127.0.0.1:8700/iportal/dashboard?folder=/Training
&volume=Encyc2&locale=en_AU&userID=Mike&password=pw123
&serverURL=http://server1:8000&timeZone=Australia/Perth
This URI lists the contents of the Training folder in the Encyc2 Encyclopedia volume on the 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.
If the server and volume information for server1 above is configured as a Volume Profile, you can use a simplified URL as shown in the following lines:
http://127.0.0.1:8700/iportal/dashboard?folder=/Training
&__vp=server1&locale=en_AU&userID=Mike&password=pw123
&timeZone=Australia/Perth