Define the Cross-Database Hyperlinks Settings

On ViewX clients, a hyperlink to another system will work as long as the ViewX client can connect to its local system and the other system (and the client-server connections are healthy). However, on Original WebX clients, the hyperlinks can only be used if:

• A WebX client license is available for use on the server on which the 'target' display is located (see Understanding the License Details Window in the ClearSCADA Guide to Server Administration)
• The server to which the Original WebX client is connected can identify and locate the 'target' display. To do this, the server needs to be configured to have appropriate Cross-Database Hyperlinks settings, so that it can match the system name in a hyperlink to the node name and port of a server in the system that contains the ‘target’ display.

The Cross-Database Hyperlinks settings allow Original WebX users to use hyperlinks to access 'target' displays that are stored on ClearSCADA systems other than the system to which the Original WebX client is connected. The 'target' displays can comprise 'file' type objects or Lists. For example, Mimics can contain hyperlinks that allow users to access:

• other Mimics
• Trends
• X-Y Plots
• Lists
• Alarms Lists
• Crystal Reports.

To configure the Cross-Database Hyperlinks settings:

1. Access the ClearSCADA Server Configuration Tool (see Accessing the ClearSCADA Server Configuration Tool).

   You need to configure the Cross-Database Hyperlinks settings on:

   • The server to which the Original WebX client connects. This is the 'local system' for the Original WebX client.
   • The servers that run the databases that contain the 'target' displays. This only applies if the 'target' displays have hyperlinks to items that are stored in other databases (either back links to the Original WebX client’s 'local system' or forward links to other displays stored on other systems).
2. Expand the System Configuration branch of the tree-structure.
3. Select WebX to display the WebX section.
4. In the Cross-Database Hyperlinks section, right-click on the list to display a context-sensitive menu.
5. Select the Add option to display the Add Hyperlink window.

   

6. Configure the settings as follows:
   • System Name—Enter the name of the ‘target’ system (the name of the database that contains the displays to which the hyperlinks connect).
   • Node Name—Enter the name or IP address of the server that runs the 'target' system (the server that runs the database that contains the ‘target’ display).
   • HTTP Port—Enter the number of the non-secure web server port (XML) used by the ‘target’ system. This typically has to match the number configured in the HTTP port field in the WebX settings for the ‘target’ system (see Define the Ports Settings for WebX Clients in the ClearSCADA Guide to Security). The exception to this is if your system uses a proxy server or proxy firewall for communications between the WebX server and Original WebX clients (see Define the Proxy Settings for the WebX Server) and the Original WebX clients communicate with ClearSCADAvia the proxy. With such a setup, you typically specify the non-secure port on the proxy server that maps through to the WebX server port - that is, the proxy port number that matches the Mapped HTTP Port configured in the WebX Proxy settings for the 'target' system (see Define the Proxy Settings for the WebX Server).

     With a system that uses a proxy server or proxy firewall for Original WebX communications you can specify the HTTP port used by the 'target' system's WebX server, but we do not recommend this as the WebX server can be identified from this information.

   • HTTPS Port—Enter the number of the secure web server port (XML) used by the ‘target’ system. This typically has to match the number configured in the HTTPS port field in the WebX settings for the ‘target’ system (see Define the Ports Settings for Original WebX Clients). The exception to this is if your system uses a proxy server or proxy firewall for communications between the WebX server and Original WebX clients (see Define the Proxy Settings for the WebX Server) and the Original WebX clients communicate with ClearSCADAvia the proxy. With such a setup, you typically specify the secure port on the proxy server that maps through to the WebX server port - that is, the proxy port number that matches the Mapped HTTPS Port configured in the WebX Proxy settings for the 'target' system (see Define the Proxy Settings for the WebX Server).

     With a system that uses a proxy server or proxy firewall for Original WebX communications you can specify the HTTPS port used by the 'target' system's WebX server, but we do not recommend this as the WebX server can be identified from this information.

7. Select the OK button to confirm the hyperlink settings and close the Add Hyperlink window. The hyperlink settings you have defined are shown in the list in the Cross-Database Hyperlinks section.
8. Repeat steps 4-7 inclusive for each system as appropriate.
9. Put the changes you have made into effect by right-clicking on the system name and selecting the Apply Changes option from the context sensitive menu.

   Example 1:

   A Mimic named 'Pipeline 6' is created in ViewX on a system named 'ControlSiteA'.

   

   The 'Pipeline 6' Mimic is configured to contain a hyperlink to a Mimic named 'Valve Controls' on another system called 'Site44'.

   

   The node name of the server that runs the 'Site44' database is 'Pd16' and it uses port 80 for its non-secure, XML web connection and port 443 for its secure XML web connection (the web server ports are defined in the WebX settings on the Server Configuration Tool on the 'Site44' server).

   

   A user logs on to a Original WebX client that connects to the ‘ControlSiteA’ server. The user displays the ‘Pipeline 6’ Mimic and selects the hyperlink to the ‘ValveControls’ Mimic that is stored in the database of the ‘Site44’ system. However, as the Cross-Database Hyperlinks settings have not been configured correctly on the ‘ControlSiteA’ server, the ‘ControlSiteA’ server cannot determine which system contains the ‘target’ display for the hyperlink. As a result, the ‘target’ display cannot be shown and a diagnostics message is displayed.

   The Cross-Database Hyperlinks settings are reconfigured on the ‘ControlSiteA’ server. They are configured so that the System Name is Site 44, the Node Name is Pd16, the HTTP Port is 80 and the HTTPS Port is 443. These match the system name, node name and port settings (for the WebX server) of the ‘Site44’ server.

   With the corrected Cross-Database Hyperlinks settings in place, the user re-displays the Mimic on the Original WebX client and selects the hyperlink to the ‘Valve Controls’ Mimic. As the ‘ControlSiteA’ server now has the correct Cross-Database Hyperlinks settings, it can use the information in the hyperlink to identify the location of the ‘target’ display as being the ‘Site44’ server. As a result, the ‘target’ display (the ‘Valve Controls’ Mimic) is displayed on the Original WebX client.

   Example 2:

   With the ClearSCADA system mentioned in Example 1 above, security measures are reviewed. Among other security tightening measures, a proxy server is installed between each WebX server and Original WebX clients. The Server Configuration is updated accordingly (the mapped Proxy settings are defined as part of the WebX settings on the Server Configuration Tool on each server). Additionally, the Original WebX clients are configured to communicate with ClearSCADA via the proxy servers rather than directly via the WebX server (see Connect to the System via a Original WebX Client or an XML Client).

   With the 'Pipeline 6' Mimic, the Cross-Database Hyperlinks settings are reconfigured on the 'ControlSiteA' server so that they match the proxy settings that exist on the 'Site44' server (the server on which the 'target' Mimic is located). The settings include the Proxy Server name 'LocalProxy', the Mapped HTTP proxy port 851, and the Mapped HTTPS proxy port 8842, as well as the Node Name of the proxy server.

   

   With the updated Cross-Database Hyperlinks settings in place, when a user displays the 'Pipeline 6' Mimic on the WebX client and selects the hyperlink to the 'Valve Controls' Mimics, the 'target' display (the 'Valve Controls' Mimic) is displayed on the WebX client as expected. The user is unaware that a proxy server is in use (although the Original WebX client's address URL and other settings now contain the proxy server's details rather than the WebX server's details).