Installing the ADR Smart Client Driver

You can install the ADR Smart Client Driver under a NiagaraAX station Drivers node.

The ADR Smart Client connects to a DRAS server. The DRAS server and ADR Smart Client communication uses secured socket layer protocol (SSL). The Adr Smart Client depends on the crypto module, which helps establish secured communication.

The following sections describe how to install and configure the ADR Smart Client Driver. Perform the tasks in the order listed below:

Install the Crypto Service

The Crypto Service (CryptoService) is provided as part of the crypto module and is available in the crypto palette.

The target platform must be running NiagaraAX-3.5.25.2 or later.
The target platform must have the “adr” and “crypto” modules installed.
The target platform must have the “adr” and “crypto” features in its license.

The following tasks assume that the user has established a connection to the target platform using NiagaraAX-3.5.25.2 or later.

From the WorkbenchAX main menu, select Window->Side Bars->Palette.

If the Side Bar pane is not open, select Window->Side Bars->Show Side Bar from the main menu.
In the Palette side bar, click the Open Palette menu control.

The Open Palette dialog box opens.
In the Open Palette dialog box, select the “crypto” module and click the OK button.

The crypto palette displays in the palette side bar.
From the crypto palette, drag and drop the CryptoService component onto the target station’s Services node (Station->Config->Services).

Figure 1. Add the CryptoService under the Services node.

The CryptoService component displays under the Services node.
In the nav tree, double-click on the CryptoService component.

The CryptoService property sheet view displays in the view pane.
In the CryptoService property sheet view, expand the Ssl node and check the following properties, as required:
For the ADR Smart Client Driver, default settings, shown below, should never be changed.

Figure 2. CryptoService properties.
- Key Store
  
  The path to the file that contains the key entries for the ADR client. By default, this string value is file:!security/ssl.tks, which is under the security folder of the Niagara installation directory.
- Key Store Password
  
  The string password by which the keystore file is protected. The password is: “tridium”.
- Key Store Type
  
  The type of keystore file. This is preconfigured information. NiagaraAX key store file is of type “TKS”.
- Trust Store
  
  The file path containing the certificate entries. The entries in this file validate the secured server to which the client connects. By default this slot points to SSL.tks file located under the security folder of the Niagara installation directory.
- Trust Store Password
  
  The string password by which the trust store file is protected. The default password is “tridium”.
- Trust Store Type
  
  Type of the trust store file. This is preconfigured information. Niagara trust store file is of type “TKS”.
With all properties set as desired, click the OK button.

The property settings are saved.

The CryptoService installation is complete.

Install the ADR Network

The AdrNetwork is provided as part of the adr module and is available in the Adr palette or from the Driver Manager’s New dialog box.

The target platform must be running NiagaraAX-3.5 or later.
A platform connection exists between your WorkbenchAX platform and the target platform.

In the WorkbenchAX nav tree, double-click on the Drivers node.

The Driver Manager view displays.
At the bottom of the Driver Manager view, click the New button.

The New dialog box displays.
In the New dialog box, choose Adr Network from the Type to Add option list, enter “1” in the Number to Add field, and click the OK button.

A second New Dialog box displays.
In the New Dialog box, edit the name of the network, if desired, set the Enabled property to true and click the OK button.

The AdrNetwork entry appears in the Driver Manager view and the AdrNetwork component appears in the nav side bar under the Drivers node.

The AdrNetwork installation is complete.

Install the ADR Device

The AdrDevice component is provided as part of the adr module and is available in the Adr palette or from the Adr Device Manager’s New dialog box. You can add any number of AdrDevices under the network.

The target platform must be running NiagaraAX-3.5 or later.
The AdrNetwork is installed.
A platform connection exists between your WorkbenchAX platform and the target platform.

The Adr client is a “device-level” component. Each AdrDevice represents a client account configured on the target DRAS server.

In the WorkbenchAX nav tree, double-click on the AdrNetwork node.

The Adr Device Manager view displays.
At the bottom of the Adr Device Manager view, click the New button.

The New dialog box displays.
In the New Dialog box, edit the name of the device, if desired, set the Enabled property to true and click the OK button.

The AdrDevice entry appears in the Adr Device Manager view and the AdrDevice component appears in the nav side bar under the Drivers node.

The AdrDevice is installed. Default settings are sufficient for the device to be enabled.
When configuring the AdrDevice, User name and Password details entered on the AdrDevice property sheet view are mapped to a participant account on the target DRAS server.

For more information about property settings, see About the ADR Device.