Connecting UVC to UVMS

This section details Univiewer Console, Univiewer Web Console, and Univiewer Console Web start connection to UVMS, as well as telemetry management.

Connecting Univiewer Console Standalone

UVC can only be launched if the JAVA_HOME system environment variable is set to the bin directory containing the java executable.

Connecting Univiewer Web Console

Once Univiewer Web Console has been deployed, open UVC as follows:

  1. Open a Web browser
  2. Type the Univiewer Web Console URL. For example:
  3. http://localhost:8080/univiewer_webconsole_v6.<m.bb>
  4. The URL will trigger the optional download of UVC java applet and start it on the user’s PC
  5. The connection dialogue will be displayed where the user can specify the UVMS and the Login to be used

The communication between the user’s computer and the Univiewer Web Console is in HTTP or HTTPS. The communication between the Univiewer Web Console and server components (UVMS, UJ, DUAS and Reporter) is proprietary.

For performance reasons, make sure the Web server is installed close to the server components.

Connecting Univiewer Console Web Start

To launch Univiewer Console Web Start from a remote Web browser, enter the appropriate URL to the Web browser:

For example

http://myserver.domain.com:8080/univiewer_console_webstart_v6.<m.bb>

The server name and port numbers must correspond to those provided in the uvc.jnlp file located in the application root directory.

When starting UVC from Web Start in Internet Explorer, the log file folder is located in the personal user folder (C:\Users\%userprofile%\univiewer_console\logs).

Java 11 does not support Web Start technology.

Connection Parameters

On the first connection, the Login window will require the following elements to determine the target UVMS and authenticate the user:

Click Connect to establish the connection or Exit to close the window without trying to connect.

If the connection cannot be established with the targeted UVMS, a message is displayed to inform the user. If several UVMS are declared in UVC, the message contains the list of target hosts: the user can then cancel the connection attempt. If the message windows is kept, the connection will be established automatically as soon as possible. The duration of a connection attempt with a host can be modified with the node setting UVMS_UVC_RECONNECTION_TIMER.

If the following message is displayed: "The telemetry settings are not configured. Please contact your administrator to proceed.", refer to section Telemetry.

Connection History

By default, the data specified at the first connection is stored in connection history (locally on the user’s workstation) in the following directory:

Directory of Connection Parameters

By default, UVC uses the user.home java variable to determine the directory for storing user preferences in Univiewer Console.

To change this default directory, the uphd variable should be valued with the directory name where UVC creates a univiewer_console subdirectory containing user preferences.

This directory can contain system variables enclosed in $ characters.

On Windows, a \ character must be doubled: \\.

Examples:

uphd=$HOMEPATH$

uphd=Z:\\users\\$USERNAME$

<property name="uphd" value="Z:\\users\\$USERNAME$"/>

Refer to one of the following paragraphs below (according to the UVC installation mode) to determine the method of setting this variable.

User Preferences

User preferences group:

User preferences are stored locally to UVC (in the directory described above) in two files:

User preferences can be centralized into UVMS at the user's request when connecting to UVC, according to the rules described in the section Connection Parametersabove.

If user preferences are centralized, they are saved locally and into UVMS as soon as the change is saved. If the connection to UVMS is temporally impossible, when reconnecting, the user will have to manually register any user preference (preference, bookmark or filter) so that the pending preferences are saved.

UVMS commands are available to act upon user preferences centralized in UVMS: delete, import and export. Refer to section User Preferences.

UVC Connection to a UVMS Failover

By default, the Univiewer Console connects to the requested UVMS node.

If the node is not accessible in a UVMS failover, UVC can be automatically connected to the available UVMS node.

For this the following configuration must be performed (only once). In the UVC login window:

By performing this configuration, the Univiewer Console now recognizes all the failover nodes.

As of version 6.10.41, documentation new updates are posted on the Broadcom Techdocs Portal.
Look for Dollar Universe.