OT Source Capability Utility

Working with the OT Source Capability Utility

The OT Source Capability Utility provides the option of interrogating a Process Historian or OPC Server to ensure it is available and determine which Capabilities it can support.

The OT Source Capability Utility is run from the command line, using the same executable as the OT Connect Adapter Service, but different configuration options. It will ignore all MessageBus and APM settings, and will not attempt to make any connection to APM.

Open C:\Program Files\Meridium\Services\OTConnect\Adapters\{name}\appsettings.json in a text editor, and configure it to connect to the process historian or OPC server you wish to investigate.
Open a Command Prompt, and invoke C:\Program Files\Meridium\Services\OTConnect\Adapters\{name}\APM.OTConnect.Adapter.exe check.
Note: If you are connecting to an OPC-HDA server, you must ensure that the command prompt is running in the same user as that of the OPC-HDA server.
Review the report

This report shows that we have successfully connected to the configured OPC-HDA server, and received both metadata and Readings for the provided TestTag.

This server supports all available OPC-HDA Capabilities.

Another use case for the OT Source Capability Utility is to run it without providing ProtocolConnection, in order to discover what ProgIds are available. Some of the examples are listed below:

Found Local Historical Data Access 1.XX Servers:

Proficy.Historian.HDA

OSI.HDA.1

OT Source Capability Utility configuration

All the settings to run the Adapter in Capability Utility mode are contained within the Adapter block.

Note that, as the Utility does not connect to APM, only the fields below are used. Any other fields will be ignored.

Table 1. Adapter
Field	Description	Default	Example	Required?
OtSource.Type	Type of the ProtocolAdapter to test with.	-	OpcHda	Yes
OtSource. ProtocolConnection	ProtocolAdapter specific configuration	-	"ProgId": "Proficy.Historian.HDA"	Yes
TestTag	Exact name of a Tag in the Process Historian to test against	-	SERVERNAME.Simulation00001	No

For example,

{
  "Adapter": {
    "OtSource": {
      "Type": "OpcHda",
      "ProtocolConnection": {
        "ProgId": "Proficy.Historian.HDA"
      }
    },
    "TestTag": "FIFTEENMIN.Simulation00001"
  }
}