Supported features for PI Interface for TCP Response

The following table describes features that this interface supports. Some features are described in more detail after the table.

* For more information, see the "OMF Health Messaging" topic in the PI Universal Interface (UniInt) Framework user guide.

1See paragraphs below for further explanation.

• Platforms

  The interface is designed to run on the above-mentioned Microsoft Windows operating systems and their associated service packs.

  Please contact OSIsoft Technical Support for more information.

• Uses PI SDK

  The PI SDK and the PI API are bundled together and must be installed on each PI interface node. This interface does not specifically make PI SDK calls.

• Source of time stamps

  The clock on the computer running the Data Archive provides the source of the time stamps for the data sent by TCPResponse. The Interface writes a time stamp that reflects the time at which it started the response time measurement.

• UniInt-based

  UniInt stands for Universal Interface. UniInt is not a separate product or file; it is an OSIsoft-developed template used by developers and is integrated into many interfaces, including this interface. The purpose of UniInt is to keep a consistent feature set and behavior across as many of OSIsoft's interfaces as possible. It also allows for the very rapid development of new interfaces. In any UniInt-based interface, the interface uses some of the UniInt-supplied configuration parameters and some interface-specific parameters. UniInt is constantly being upgraded with new options and features. The PI Universal Interface (UniInt) User Guide is a supplement to this manual.

• Disconnected startup

  The TCPResponse interface is built with a version of UniInt that supports disconnected start-up. Disconnected startup is the ability to start the interface without a connection to the Data Archive. This functionality is enabled by adding /cachemode to the list of startup parameters or by enabling disconnected startup using the ICU. Refer to the UniInt Interface User Manual for more details on UniInt Disconnect startup.

  Note: Using this feature is not recommended unless the network connection between the interface and Data Archive has very low bandwidth or high latency.

• SetDeviceStatus

  For a Health Tag whose Extended Descriptor attribute contains [UI_DEVSTAT], the Interface writes the following values:

  Value	Description
  "1| Starting "	The interface has started.
  "Good"	The interface has started successfully and is ready to measure response times; or, for all the points in the current scan class. The interface has successfully connected to the service (for example: FTP, HTTP) for which it needs to measure response time.
  "3| n device(s) in error"	For at least one of the points in the current scan class, the Interface cannot connect to the service (for example: FTP, HTTP) for which it needs to measure response time.
  "4 | Intf Shutdown | "	The interface was shut down.

  Note: Refer to the PI Universal Interface (UniInt) User Guide for more information on how to configure health points.