OT Connect Services

Install OT Connect Adapter Service

About This Task

This topic provides detailed instructions on installing the OT Connect Adapter Service using the OT Connect installer.

Procedure

On the system that will serve as the OT Connect Process Data Server, access the APM distribution package, and then navigate to the \Setup\OTConnect folder.
Double-click on the Setup.exe file.

Note: If an OT Connect Adapter Service is already installed on this server, the Existing Installed Instances Detected screen appears.
Select Next to accept and Install a new instance of this application.
The Welcome screen appears.
Select Next.
The License Agreement screen appears.
Read the License Agreement and, if you agree, select the I accept the terms of the license agreement check box, and then select Next.
The Instance Name window appears.

Note: The Instance Name is only used by the operating system to distinguish multiple adapters installed on the same OT Connect Process Data Server.
Enter a unique name related to the OT Source you want to connect this OT Connect Adapter Service to.
Note: The instance name is not linked to the OT Source Name in any way. Rather, it is the unique-per-service ID that is used to give each adapter a unique name:
- Folder
- Windows Service
- Add/Remove programs entry
It is recommended that the name given should be related to the server indicated in order to make troubleshooting easier.
Select Next.
Select Install.
The Setup Status window appears, displaying a progress bar that shows the progress of the installation process. After the progress bar reaches the end, a message appears, indicating that your server is being configured. After your server is configured, the Installation is Complete window appears.
Select Finish.
The installation is complete.

Configure OT Connect Adapter Service

About This Task

To use OT Connect Adapters, you must configure each OT Connect Adapter Service by modifying the appsettings.json configuration file on the OT Connect Process Data Server.

You can make the modifications by opening the file in an application that can modify JSON text (for example, Notepad). The following instructions provide details on making all required modifications at one time using the text editor.

Note: This configuration file defines several endpoints on the APM Server with URLs and ports that must be accessible from the OT Connect Process Data Server. Ensure that your firewalls are configured to allow this access.

Procedure

On the OT Connect Process Data Server, open the <Install_Location>/appsettings.json file.

Modify the configuration sections as described in the following table:


Within this section...	Make this change	Notes
Adapter	Replace TenantId with the name of the APM database to which you want to connect.	None
OtSource	Replace Name with a descriptive identifier for this Process Historian Source.	This Name must eventually match that of an OT Source system defined in the APM Database chosen above.
QueueOptions	Set ActiveMqHost with the fully qualified network address of the server that hosts the ActiveMQ Message Bus.	Typically, the Host of the ActiveMQ Message Bus is the APM Server.
	Set ActiveMqPort with the appropriate port of the ActiveMQ host.	The default port is 61616.
	Set Username with the user Id of an authorized user of the ActiveMQ instance on the MqHost.
	Set Password with the encrypted secret of the desired user Id of the ActiveMQ instance on the MqHost.
CacheOptions	Replace Host with the fully qualified network address of the server that hosts the Redis cache instance.	Typically, the Host of the Redis cache instance is the APM Server.
	Set Port to the defined port of the Redis cache instance.	The default port is 6379.
	Set Password to the Password of the Redis cache instance, if any.	By default, the password is blank.

The following content is an example of an appsettings.json file.

{
  "Adapter": {
    "TenantId": "V4040000_QA",
    "OtSource": {
      "Name": "Source T1002"
    }
  },
  "Logging": [
    {
      "Pattern": "*",
      "LoggingLevel": "Info",
      "LoggingMode": "All"
    }
  ],
  "MessageBus": {
    "QueueOptions": {
      "ActiveMqHost": "appserver",
      "ActiveMqPort": 61616,
      "Username": "admin",
      "Password": "admin"
    },
    "CacheOptions": {
      "Host": "appserver",
      "Port": 6379,
      "SyncTimeout": 15000,
      "Password": "admin"
    }
  }
}

Install OT Connect Conductor Service

About This Task

This topic provides detailed instructions on installing the OT Connect Conductor Service using the APM Server installer.

Note: Re-installing the OT Connect Conductor Service will reset its appsettings.json to the default settings.

Procedure

On the APM Server, access the APM distribution package, and then navigate to the \\Setup\Meridium APM Server and Add-ons folder.
Double-click on the Setup.exe file.
The Welcome window appears.
Select Next.
The License Agreement window appears.
Read the License Agreement and, if you agree, select the I accept the terms of the license agreement check box, and then select Next.
The Select Installation Location screen appears.
Select Next to accept the default location.
The Select the features you want to install window appears.
Select the OT Connect Conductor Service option.

Note: While additional options are available for selection, these options are not meant to be installed on the APM Server at this time. These instructions assume that you want to install only the OT Connect Conductor Service.
Select Next.
Select Install.
The Setup Status window appears, displaying a progress bar that shows the progress of the installation process. After the progress bar reaches the end, a message appears, indicating that your server is being configured. After your server is configured, the Installation is Complete window appears.
Select Finish.
The installation is complete.
Note: The OT Connect Conductor does not require additional configuration. It depends on the common settings in appsettings.Global.json and Datasources.