Installation of inmationPIBridge

The PI Bridge service should be installed if you wish to create an interface to an OSI PI system historian or batch record system through the Batch Record Datasource or HistorySink objects.

These are inmationPIBridge versions available, the recommended version depends on the PI-Server version being used:

  • inmationPIBridge used for PI-Server 2016+

  • inmationPIBridge.NET3.5 used for PI-Server 2010

inmationPIBridge 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 inmationPIBridge:

  • inmationPIBridge

    • Microsoft .NET Framework 4.6.2

    • PI AF Client 2018 SP3 Install Kit - Vers. 2.10.9.593

    • PI SDK 2018 Install Kit SP1 - Vers. 1.4.7.618

  • inmationPIBridge.NET3.5

    • Microsoft .NET Framework 3.5

    • PI SDK Install Kit - Vers. 1.3.6.361 (32-bit)

Installation

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

Installation via Package Manager

The Package Manager enables convinient 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 inmationPIBridge 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 inmationPIBridge

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":5959,"PIServerName":"PISVR001"}

Manual Installation

Locate the inmationPIBridge zip archive and then do the following:

Copy Files

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

  2. Unzip and copy the files to the new folder

Register as a Windows Service

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

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

  2. Run the file "Install.bat" or one of the following commands, depending on the version being installed (correct paths depending on your system):

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

or

C:\Windows\Microsoft.NET\Framework\v2.0.50727\InstallUtil.exe "C:\Program Files\inmationPIBridge\inmationPIBridge.NET3.5.exe"

Start Windows Service

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

Uninstallation

inmationPIBridge 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 inmationPIBridge

Manual Uninstallation

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

  1. Stop the "inmationPIBridge" 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\inmationPIBridge\inmationPIBridge.exe"

or

C:\Windows\Microsoft.NET\Framework\v2.0.50727\InstallUtil.exe /u "C:\Program Files\inmationPIBridge\inmationPIBridge.NET3.5.exe"

Configuring the inmationPIBridge Service

The configuration files for the service can be found in the same directory (either "inmationPIBridge.exe.config" or "inmationPIBridge.NET3.5.exe.config" depending on the version being installed)

parameter description default setting

TCPPortClient

TCP port for communication with inmation.

5959

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-pibridge

2048

MaxTCPConnectionQueues

Count of maximal allowed Connections.

100000

PIServerReconnectTimeSec

Time span (in seconds) in which reconnections to OSIsoft PI servers take place if a connection is lost.

30

PIServerName

Defines the network name of the standard PI server.

""

PIAFServerName

Defines the network name of the PI AF server.

""

PIDataBase

Defines the name of the standard PI AF database.

""

MaxEventToReturn

Defines the maximum count of event frames as result. This is a safety parameter, because payload can be huge.

1000

GetStatistics

inmation performance counter are returned for measuring and benchmarking purpose of inmationPIBridge.

true

AllowToDelete

Defines if OSIsoft PI Tags can be deleted by inmation. This is a security feature, not to lose history data.

true

EndinmationPIBridge

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.

EndinmationPIBridge

SubscriptionMaxItemsCount

Events are buffered by the PI Bridge until they are retrieved by the Connector. This is maximum number of events being buffered. If events are coming in faster then being retrieved by the Connector and this maximum number is reached, the buffer will overflow and data will be lost.

Default: 10.000

SubscriptionMaxReturnedItemsCount

When retrieving events from the PI Bridge buffer with one of the Lua functions provided (see below), they will be returned as an array. This setting defines the maximum number of events retrieved (=maximum array size returned) with one Lua call.

Default: 1.000

SubscriptionMaxGetEventsIntervalSeconds

Events have to be retrieved from the PI Bridge buffer regularly. Otherwise the corresponding DataPipe will automatically be removed. This setting defines the maximum time in seconds that the buffer and DataPipe will be held in memory without the Connector retrieving data.

Default: 60

SubscriptionRefreshRateSeconds

Events have to be fetched by the inmation PI Bridge from the OSI PI Server that buffers events itself. This is done periodically in the rate specified by this setting.

Default: 10

Configuring Service Logon Account

The inmation PI Bridge Windows Service will install using the LocalSystem account as the Service Logon account by default. Some PI Historians may require the inmationPIBridge 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 inmationPIBridge Package will reinstall the Windows Service and reset the Service Logon account.