Configure OT Connect Adapter Service

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

  1. On the OT Connect Process Data Server, open the <Install_Location>/appsettings.json file.
  2. Modify the configuration sections as described in the following table:
    Within this section...Make this changeNotes
    AdapterReplace TenantId with the name of the APM database to which you want to connect.None
    OtSourceReplace 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.
    Under FolderFilters, add a list of folders on the OPC server that you want to ignore when retrieving tags from the OPC server.
    For example:
    "OtSource": 
{
"Name": "Source T1002",
"FolderFilters": 
[
   "%OSI",
   "%OSI_MCN"
]
}
    		If you upgrade an OPC server, and if folders from the older version are retained, the OPC DA Adapter and OPC HDA Adapter traverse the folders in the OPC server. This can result in errors. To avoid this issue, specify the folders that you want to ignore when retrieving data from the OPC server.
    QueueOptionsSet 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.
    CacheOptionsReplace 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"
      "FolderFilters": 
      [
       "%OSI",
       "%OSI_MCN"  
      ]
    }
  },
  "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"
    }
  }
}