Installation of Simatic Batch Bridge

The Simatic Batch Bridge service should be installed if you wish to create an interface to a PCS7 Simatic Batch Server through the Lua API. It uses the Simatic Batch API.

SimaticBatchBridge 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 Simatic Batch Bridge:

  • Microsoft .NET Framework 4.6.2

  • Simatic PCS7 OS Client for Batch

  • Simatic PCS7 Batch Client

The computer running Simatic Batch Bridge needs to be created as OS-Client in the PCS7 Simatic Manager, and permissions need to be set appropriately.

The API requires a license installation for every project on the SIMATIC BATCH project server. Without an API license, writing operations to the SIMATIC BATCH system will be blocked and an error will be returned.

Deployment Variants

The Simatic Batch Bridge can be deployed in 3 different ways.

Variant 1: Directly on Batch-Server
Figure 1. Directly on Batch-Server
Variant 2: Simatic Batch Bridge with Connector
Figure 2. Simatic Batch Bridge with Connector
Variant 3: Simatic Batch Bridge Standalone
Figure 3. Simatic Batch Bridge Standalone

Variant 1 and 2 have the following implications:

  • Automatic updates of Bridge-Service is possible.

  • Lua scripts can be executed on Connector, in the PCS7 environment.

Variant 3 has the following implications:

  • No package management is possible. The Simatic Batch Bridge service has to be installed manually.

  • No automatic updates are possible for the Simatic Batch Bridge service. Updates have to be done manually.

Installation

Simatic Batch Bridge 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 SimaticBatchBridge 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 Simatic Batch Bridge

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":7959,"ApiVersion": 820
}

Manual Installation

To instead deploy the package manually, locate the SimaticBatchBridge 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\SimaticBatchBridge"

  2. Unzip and copy the files to the new folder

Register as a Windows Service

To register SimaticBatchBridge 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\SimaticBatchBridge\SimaticBatchBridge.exe"

Start Windows Service

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

Uninstallation

Simatic Batch Bridge 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 SimaticBatchBridge

Manual Uninstallation

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

  1. Stop the "Simatic Batch Bridge" Service

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

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

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

Configuring the Simatic Batch Bridge Service

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

parameter description default setting

TCPPortClient

TCP port for communication with inmation.

7959

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

2048

MaxTCPConnectionQueues

Count of maximal allowed Connections.

100000

EndOfSimaticBatchBridge

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.

EndOfSimaticBatchBridge

ApiVersion

API version used by bridge service. To ensure backwards compatibility with older Batch-Servers, specify earlier version. Available version numbers: 613, 701, 707, 712, 800, 801, 810, 811, 820.

820

Configuring Authentication

The Simatic Batch Bridge Windows Service will install using the LocalSystem account as the Service Logon account by default. Some Simatic Batch deployments may require to use specific user credentials for function calls (SetCurrentUser). 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.

If esi-SimaticBatchBridge function calls are requested with the credentials argument, this will override the configuration file credentials. If no credentials argument is used when calling functions, the configuration file credentials are used.
key value example

UserName

PCS7 user name

Inmation

UserNameLong

Long PCS7 user name

Inmation

Password

Password encoded using Base64

MTIzNDU2

Domain

Computer domain

.

Example Configuration String property value JSON string:

{
    "UserName":"USERNAME","Domain":".", "Password_clear":"123456"
}
Upgrade of the SimaticBatchBridge Package will reinstall the Windows Service and reset the Service Logon account.