11.2 Dashboard Server internal settings file (usrconf.properties)

To use Dashboard Server, you must specify settings in the Dashboard Server internal settings file (usrconf.properties). This section discusses how to create a Dashboard Server internal settings file, explains the keys that can be set, and provides a coding example.

Organization of this section
(1) How to create the file
(2) Keys that can be set
(3) Example

(1) How to create the file

We recommend that you use the sample file provided during installation to create a server internal settings file. The sample file is stored in the directory shown below. Copy the file and then edit the copy.

installation-directory\samples\httppacket\web\containers\uCSDPAF_Server\usrconf\

The only keys in the sample file that you should edit are the REFRESH_INTERVAL and RETRY_NUM keys; no other keys should be edited.

Store the created server internal settings file in the following directory:

installation-directory\psb\CC\web\containers\uCSDPAF_Server\usrconf\

(2) Keys that can be set

The table below lists and describes the keys that can be set in the server internal settings file.

Table 11-2 Keys that can be set in the server internal settings file

No.Key nameDescriptionDefault value
1REFRESH_INTERVALSpecifies the interval (in milliseconds) at which Dashboard Server is to access the dashboard output connector and refresh the dashboard-display data, as an integer from 0 to 600000.2000
2RETRY_NUMSpecifies the number of retries that will be permitted when Dashboard Server's refreshing of the dashboard-display data fails, as an integer from 0 to 100.0

You specify these settings in the server internal settings file in the Java property format (key=value).

(3) Example

The following shows an example of specifying the settings in the server internal settings file:

REFRESH_INTERVAL=2000
RETRY_NUM=0

This example sets the refresh interval to 2000 (milliseconds) and the retry count to 0.