Installation of PHDBridge

The PHD Bridge service should be installed if you wish to create an interface to a Uniformance PHD Server through the HistoryTransporter objects.

PHDBridge is shipped as a zip archive in the \inmation.root\packages directory when installing system:inmation with the setup wizard. The zip files can also be provided by contacting inmation Customer Service.

Requirements

The following software components need to be installed on any computer running PHDBridge:

  • Microsoft .NET Framework 4.6.2

  • Uniformance PHD Client Interfaces (x86) R321.1

Installation

PHDBridge may be installed either via. the Package Management system or manually.

Installation via Package Manager

The Package Manager enables convenient deployment from a central system store to any of the remote Connector locations. Please see How to Install Packages for detailed step-by-step instructions.

Using DataStudio you will need to add a new PHDBridge Package element within the Package Installer Property Compound of the Connector and specify Package Name and Package Version property values exactly matching the distinctive name of the package .zip file in the system package store. The system package store is the packages directory in the inmation.root directory.

Install PHDBridge

The Configuration String property value is optional. When empty the default parameters will be used at install time. All parameters defined in the .exe.config file may also be set during installation using a JSON format string. Example Configuration String:

{
    "TCPPortClient":6959,"PhdServerHost":"PHDSVR01"
}

Manual Installation

To instead deploy the package manually, locate the PHDBridge zip archive and complete the following tasks:

Copy Files

  1. Create a folder for the files in the Program Files directory of the host machine. For example: "C:\Program Files\PHDBridge"

  2. Unzip and copy the files to the new folder

Register as a Windows Service

To register PHDBridge as a Windows service, perform the following steps:

  1. Open command prompt (cmd) as "Administrator"

  2. Run the following command (including correct paths depending on your system):

C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe "C:\Program Files\PHDBridge\PHDBridge.exe"

Start Windows Service

The PHDBridge can be started as a Windows service when correctly installed. It can also be started directly by calling the "PHDBridge.exe" file. In this case, the Windows service has to be stopped in advance.

Uninstallation

PHDBridge may be uninstalled either via. the Package Management system or manually.

Uninstallation via. Package Manager

Within DataStudio select the Connector hosting the Package, then expand the Package Installer Property Compound, expand Packages, click on the Trash Bin icon next to the Package you wish to uninstall, and finally click Apply.

Remove PHDBridge

Manual Uninstallation

To deregister PHDBridge as a Windows service, perform the following steps:

  1. Stop the "PHDBridge" Service

  2. Open command prompt (cmd) as "Administrator"

  3. Run the file "Uninstall.bat" or the following command:

C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe /u "C:\Program Files\PHDBridge\PHDBridge.exe"

Configuring the PHDBridge Service

The configuration files for the service can be found in the same directory ("PHDBridge.exe.config")

parameter description default setting

TCPPortClient

TCP port for communication with inmation.

6959

EndOfTransmissionSignal

String that signals the end of a TCP data transmission.

xEOFx

MaximalBufferSizeToSend

This Value sets the buffersize of the returning json telegram ATTENTION! This Value must be the same as in the esi-phdbridge

2048

MaxTCPConnectionQueues

Count of maximal allowed Connections.

100000

EndOfPHDBridge

Exit string. If data sent to the Bridge contains this string the Bridge service exits (stops). This string may also be used to exit the program when the Bridge runs as a console: in the console input this string and press enter.

EndOfPHDBridge

PhdServerHost

PHD Host Name.

localhost

PhdServerPort

PHD Port Number default is 3000 or 3100.

3100

PhdServerAPIVersion

PHD Server API Version used to communicate with the historian.

API200

PhdServerPassword

For 200 PHD Systems the Username and password are assigned after PHD has a valid NT security connection.

""

PhdServerUserName

For 200 PHD Systems the Username and password are assigned after PHD has a valid NT security connection

""

PhdServerWindowsPassword

A Windows user account password. It is only used by Remote API to make initial connection.

""

PhdServerWindowsUserName

A Windows user account name. It is only used by Remote API to make initial connection.

""

PhdServerRequestTimeout

The ConnectionTimeout property identifies the network timeout period used when attempting to connect to the PHD server. If the connection to the PHD server is established within the time period, the request is abandoned. It is in milliseconds.

1000

Configuring Service Logon Account

The PHD Bridge Windows Service will install using the LocalSystem account as the Service Logon account by default. Some PHD Historians may require the PHDBridge Service to run as a specific account. Specific account credentials may be provided during install via. the Package Manager Configuration String property value or set manually on the system hosting the Bridge.

key value example

username

Windows user name

DOMAIN\\USERNAME

password_clear

password using clear text

123456

password

password encoded using Base64

MTIzNDU2

Example Configuration String property value JSON string:

{
    "username":"DOMAIN\\USERNAME","password_clear":"123456"
}
Upgrade of the PHDBridge Package will reinstall the Windows Service and reset the Service Logon account.