The Tivoli Enterprise Portal client has several dozen parameters that you can set to affect behavior and performance at user computers. As well, the Tivoli Enterprise Portal Server has an environment file that you can edit to adjust or add variables to affect all portal clients connected to it and its interaction with the Hub Tivoli Enterprise Monitoring Server.
Tivoli Enterprise Portal client configuration settings
The Tivoli Enterprise Portal client has parameters that affect its performance, such as the maximum size of files attached to event acknowledgements and for how long to keep the common event list in the cache.
Editing the client parameters
Changes you make to the browser client are applied globally because they are downloaded automatically through the HTTP server that is installed with the portal server. If users are deploying the desktop client themselves through Java Web Start, the changes will also be applied globally. Otherwise, desktop client changes must be made on each computer where it is installed.
About this task
Complete these steps to adjust the client parameters:
1.
Start Manage Tivoli Monitoring Services. For the browser client and Web Start, this is the computer where the portal server is installed; otherwise, it is where the desktop client is installed.
Click Start → Programs → IBM Tivoli Monitoring → Manage Tivoli Monitoring Services.
Change to the <itm_install_dir>/bin directory and enter: ./itmcmd manage.
2. Right-click Tivoli Enterprise Portal – Desktop or Tivoli Enterprise Portal – Browser, and click Reconfigure.
The Configure Application Instance window is displayed for the desktop client (also used for Java Web Start); the Configure Tivoli Enterprise Portal Browser window is displayed for the browser client.
3. Double-click the parameter value you want to change.
4. To activate the parameter, type a value and select In Use in the Edit Tivoli Enterprise Portal Parm window.
5. After you are finished editing the parameters, click OK to save your changes.
Your changes will take effect the next time users log on to the portal server.
Users already logged on will see no change until they exit, and log on again.
Related reference
“Portal client parameter list”
Portal client parameter list
Most of the Tivoli Enterprise Portal client parameters are left unchanged from their default values. Edit the client parameters to effect a specific behavior.
Some parameters pertain to the desktop client only, to the desktop client and Java WebStart client only, or to the browser client only and are noted as such.
browser.cache.memory.capacity
Indicates the maximum amount of memory in KB to be used to cache decoded images and other features by Browser views (a positive non-zero integer). Specify a value of 0 to disable memory caching. Default: -1, whereby the capacity value is automatically decided based on the total amount of memory.
Physical memory Memory cache in KB
32 MB 2048
64 MB 4096
128 MB 6144
256 MB 10240
512 MB 14336
1 GB 18432
2 GB 24576
4 GB 30720
8 GB and beyond 32768
cnp.agentdeploy.timeout
This is the time that should pass before the agent deploy request times out.
Default: 1800 seconds (30 minutes).
cnp.attachment.segment.maxsize
For transmission across the network, file attachments are broken into segments then reassembled at the Tivoli Enterprise Portal Server. For example, an 8 MB file is transmitted in eight segments of 1 MB. Adjust this parameter for the segment size that best suits your environment. Enter the maximum size in bytes, such as 250000 for 250 KB. Default: 1000000 (1 MB).
This parameter is also available as a portal server environment variable.
See “Controlling the size of event attachments” on page 40.
cnp.attachment.total.maxsize
Use this parameter to set the maximum size of each file attached to an acknowledgement. Enter the maximum size in bytes, such as 2500000 for 2.5 MB. Default: 10000000 (10 MB).
This parameter is also available as a portal server environment variable.
See “Controlling the size of event attachments” on page 40.
cnp.authentication.skip_dns
Value: ″N″. This determines whether the server certificate validation tries to resolve and match the host DNS name.
cnp.browser.installdir
The WebRenderer Java browser component is used for browser view functionality in the Tivoli Enterprise Portal. The first time a user creates a browser view, a subdirectory is created automatically on the user’s computer.
%HOMEPATH%\wr<WebRendererVersion>\.webrendererswing.
Example: C:\Documents and Settings\Administrator\wr4.2.14\
.webrendererswing
%HOME/wr<WebRendererVersion>/.webrendererswing
This subdirectory is where the browser jar files are extracted to and where certificates and other WebRenderer artifacts are created for browser views.
Use this parameter to specify a different path for the browser view files to be saved on user computers. A different path is required if users will be running multiple instances of the portal client and possibly logging on to different versions of the portal server.
cnp.commonevent.cache.timeout
Number of minutes to retain the cache for the common event console when the user has switched to a workspace that does not contain the common event console view (which means the cache is not being used). If this time period ends before the cache is used again, the cache is cleared.
The cache is then rebuilt when it is needed by a common event console view.
A value of -1 means always retain the cache, even when it is not being used. A value of 0 means immediately clear the cache when the user has switched to a workspace that does not contain the common event console view. Default: 30.
cnp.databus.pageSize
In the portal user interface, the Properties editor has a field for adjusting the page size for individual query-based views. This parameter sets the number of rows to fetch in single logical page for all query-based views.
Default: 100 rows. Although there is no limit to what you can set here, the larger the page size, the more memory required at the portal client and server.
You might, for example, want to set a larger page size for the searching in the table view over a larger number of rows. Or you might want fewer pages to scroll through when interacting with views that retrieve a large number of rows (or instances). You need to make sure, however, that you have sufficient resources on the portal client and server to handle the additional data being packaged, transported, and ultimately rendered as a result of increasing the page size value. Probably the best way to find the right number here is to increase it gradually (such as increments of 100) until response time across a good sampling of workspaces begins to suffer.
At that point, you might want to reduce the number by the last increment (such as 100 rows fewer) as that will be close to the optimal value for the environment.
Another setting that affects query-based view response time is KFW_REPORT_NODE_LIMIT, which is a portal server environment variable.
cnp.drag.sensitivity
Number of pixels the mouse must move before drag operation begins.
Default: 7.
cnp.encoding.codeset
String encoding code set identifier.
cnp.eventcon.autoresume.delay
The number of seconds to wait before automatically resuming updates to the Situation Event Console and the Common Event Console after they have been paused due to scrolling. Default: 60 seconds.
cnp.heartbeat.interval
Heartbeat ping interval between the portal client and server. An increase in
the interval means that the client will take longer to detect when the portal server is offline. A shorter interval means the client will be notified sooner but it also increases the traffic between client and server. Default: 30 seconds.
cnp.history.depth
Number of workspaces to maintain in the back / forward history navigation stack. Default: 20.
cnp.http.proxy.password
Password used for proxy authentication using Browser view.
cnp.http.proxy.user
Userid used for proxy authentication using Browser view.
cnp.http.url.host
Desktop client and Java WebStart client only: URL host for IOR fetch.
cnp.http.url.path
Desktop client and Java WebStart client only: URL path for IOR fetch.
cnp.http.url.port
Desktop client and Java WebStart client only: URL port for IOR fetch.
cnp.http.url.protocol
Desktop client and Java WebStart client only: URL protocol for IOR fetch.
cnp.http.url.DataBus
Desktop client and Java WebStart client only: The URL for the cnps.ior file, which is required for the portal server to locate the graphic view images and style sheets. The default setting, which does not show, assumes the integral HTTP server. If it has been disabled for some reason, you must enter the URL for the integral HTTP server. See the IBM Tivoli Monitoring Troubleshooting Guide for details. When this parameter is set, it overrides the settings of the other cnp.http.url parameters for protocol, port, and path.
cnp.pipeline.factor
Databus to Server Pipeline monitoring factor (in Heartbeat cycles). Default:
2.
cnp.playsound.interval
Number of seconds before the same sound file can be played again. If events open frequently, this setting provides sound pause. Default: 10 seconds.
cnp.publishurl.delay
Browser mode only: When you make a workspace switch, allows the user interface rendering to complete before the browser initializes the new applet and destroys the old applet. Default: 1 second.
Important: Modify this parameter only after consulting IBM Software Support.
cnp.systemtray.offset
Tivoli Enterprise Portal factors in the Windows task bar at the bottom of the screen when sizing menus and windows for display. Default: true.
cnp.terminal.cache.entries
Maximum number of active terminal emulator sessions. Default: 50.
cnp.terminal.host
Default terminal emulator host name.
cnp.terminal.port
Default terminal emulator port number. Default: 23.
cnp.terminal.script.entries
Maximum number of user terminal emulator scripts that can be saved.
Default: 256.
cnp.terminal.type
Default terminal emulator type. When specifying a terminal type, enclose the terminal type within double quotes and enter one of these supported names:
IBM 3270 (24x80) IBM 3270 (32x80) IBM 3270 (43x80) IBM 3270 (27x132) IBM 5250 (24x80) VT100 (24x80)
cnp.view.change_remove.warning
Warning message when the user is about to change or remove a view.
Default: True. The message is displayed. Change the setting to False to stop the message from being displayed.
cnp.workspace.switch.rate
The minimum amount of time that must pass before the workspace can be replaced by the next one selected. Default: 1000 (1 second).
cnp.workspacerender.delay
Browser mode only: Workspace post render delay in milliseconds.
http:agent
Defines the name of the integral HTTP server. If it or its proxy requires a different browser identity before it enables the browser view to access the Internet, you can enter a one-word name for the browser. It can be any name so long as it is not rejected by the proxy server. You normally do not need to add an http name definition unless users get an error when they attempt to access the Internet through a workspace browser view.
http.nonproxyhosts
When Enable HTTP Proxy Server Requestsis selected, the servers in this list bypass the proxy. Separate each server name with a vertical line (|). See “Enabling the HTTP proxy server” on page 35.
http.proxyHost
Browser client: Used to specify the host name or IP address of the http proxy server if one is used.
http.proxyPort
Browser client: Used with the http.proxyHost parameter to specify the listening port number for the HTTP proxy server. Port 80 is the default for third-party HTTP servers.
kjr.browser.default
This is the path and name of the browser application to use when
launching contextual help. To open the help with a specific browser or one other than the default, enter the path and the application name, such as C:\Program Files\Mozilla Firefox\firefox.exe.
kjr.trace.file
File name of RAS1 trace log if trace mode is LOCAL.
kjr.trace.mode
The RAS1 tracing option. Default: LOCAL.
kjr.trace.params
RAS1 trace options. Default: ERROR.
kjr.trace.qdepth
Sets the tracing thread queue depth to 15000 by default.
kjr.trace.thread
Determines whether trace calls are threaded. Default: true.
legacy_lifecycle
With Sun Java versions 1.6.0_10 or higher, a new plug-in architecture was introduced and established as the default plug-in. IBM Tivoli Monitoring browser clients do not run with this new plug-in architecture. To use the Sun 1.6.0_10 (or higher) JRE, set this parameter to true.You will also need disable the next-generation Java plug-in on the computer where the browser client is being run: Launch the Java Control Panel for the Sun JRE. In the Advancedtab, expand the Java Plug-in branch. Clear the Enable the next-generation Java Plug-in (requires browser restart) check box.
sun.java2d.noddraw
When the Tivoli Enterprise Portal is run as a client image in an emulation environment that does not support the DirectDraw screen-writing function, turn off the function by setting this variable to true in both the browser and desktop clients. Otherwise, users encounter conditions of high CPU usage because the Java process attempts to write to the screen. Default:
true.
user.language
Specifies the language code of the user’s locale preference (de, en, es, fr, it, ja, ko, pt, zh). As well as the language, the time, date, currency, and number separator formats are converted for the locale. You can create another instance of the desktop client and change this variable (and user.region) to another locale. In this way, you can have two or more instances of the desktop client running on the same computer, each in a different language. If you specify an unsupported locale, the failover is to en_US. Browser mode users can enter the text below directly into their Java plug-in runtime parameters if they do not want to change these environment variables or their operating system locale.
-Duser.language=xx -Duser.region=XX
where xx is the language and XX is the locale: de_DE, en_US, en_GB, es_ES, fr_FR, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW (such as pt_BR for Brazilian Portuguese and zh_TW for Traditional Chinese).
Note: The portal client uses cascading style sheets to render the application text. If no localized version of a style sheet, such as ws_press.css, is available, the English version will be used.
user.region
Specifies country code of user’s locale preference (DE, US, UK, ES, FR, IT, JA, KR, BR, CN, TW). See also the description for user.language.
Related tasks
“Editing the client parameters” on page 29
“Controlling the size of event attachments” on page 40
“Starting the browser client on another portal server” on page 24 Related reference
“Portal server environment variables” on page 38
Enabling the HTTP proxy server
Environments that use an HTTP proxy server require additional client
configuration to enable URL access from the browser view in a Tivoli Enterprise Portal workspace.
About this task
To enable the HTTP proxy server, complete these steps on every computer where the Tivoli Enterprise Portal client is used that also uses an HTTP proxy for the browser view:
1. Open a workspace that contains a browser view or add a browser view to the current workspace.
2. In the browser view’s address box, type: about:config
3. In the filter field that appears at the top of the page, enter the following to see the network proxy fields: network.proxy
4. Out of the reduced set shown, the following three entries are of interest.
Double-click an entry or select it and press Enter to modify its values:
network.proxy.http
Enter the DNS identifier or the IP address of the proxy host to use for the HTTP protocol.
network.proxy.http_port
Enter 80, the default port number, or a different number used by the proxy host.
network.proxy.no_proxies_on
Append any fully qualified host names or IP addresses that should be accessed without the proxy. For example, this setting bypasses the proxy server for any files on your local system and on the portal server (myteps.uk.ibm.com) that are accessed from the browser view:
localhost,127.0.0.1, myteps.uk.ibm.com.
Results
After you click OK on the property edit panel, the change is saved on the Tivoli Enterprise Portal client.
Setting application properties for Linux and UNIX
To change a property such as the location of the Web browser that the Tivoli Enterprise Portal browser client launches in UNIX, update the shell script file or files that are run and the template that is used when the browser client is configured to create the script file or files that are run.
About this task
You might have to update one or more of the following files:
Note: All file paths are relative to your install_dir directory where you installed IBM Tivoli Monitoring.
Table 1. File locations for changing application properties for UNIX and Linux
File location Purpose of file
bin/cnp.sh The default shell script that launches the
Tivoli Enterprise Portal browser client.
bin/cnp_instance.sh The shell script for a specific instance you have created, where instance is the name of the instance that launches the Tivoli Enterprise Portal browser client.
platform/cj/original/cnp.sh_template The template from which the bin/cnp.sh and bin/cnp_instance.sh shell scripts are generated during configuration, where platform is the code for the operating system platform on which IBM Tivoli Monitoring is installed. For example: li6243 for Linux 2.4 on a 32-bit Intel®CPU).
If you only change bin/cnp.sh or
bin/cnp_instance.sh and do not change this template, the next time you configure the client, a new version of the script is created without the changes you made to
bin/cnp.sh or bin/cnp_instance.sh.
To change the location of the Web browser you must change the above file or files to include a new property:
1. Go to the <itm_install_dir>/bin/cnp.sh and edit the cnp.sh shell script.
2. Add your Web browser location to the last line of the file. In the example below, the Web browser location is /opt/foo/bin/launcher.
-Dkjr.browser.default=/opt/foo/bin/launcher
Important: The line is very long and has various options on it, including several other –D options to define other properties. It is very important to add the option in the correct place.
If the last line of your bin/cnp.sh originally looked like the following:
${JAVA_HOME}/bin/java -showversion -noverify -classpath ${CLASSPATH}
-Dkjr.trace.mode=LOCAL -Dkjr.trace.file=/opt/IBM/ITM/logs/kcjras1.log -Dkjr.trace.params=ERROR -DORBtcpNoDelay=true -Dcnp.http.url.host=
-Dvbroker.agent.enableLocator=false -Dhttp.proxyHost=
-Dhttp.proxyPort=candle.fw.pres.CMWApplet 2>& 1 >> ${LOGFILENAME}.log
To set the browser location to /opt/foo/bin/launcher, change the line to look like the
To set the browser location to /opt/foo/bin/launcher, change the line to look like the