Configuration and status monitoring
- Last UpdatedJan 06, 2023
- 5 minute read
The connector creates a PI AF element representing the connector instance configuration and status under the PI AF path of connector_root\Connector Installations. By default, the connector instance configuration and status PI AF element is created. However, element creation can be disabled by setting the CreateConnectorStatusElements field in the global configuration file (ConnectorGlobal.config.json) to false.
Note: If failover is enabled, this element and any associated PI points, will not be created or updated while the connector instance is in the Backup role. Therefore, the element of the connector instance in the Backup role is not reliable and cannot be used to determine status. The element of the connector instance in the Active role is reliable and should be used to monitor configuration and status.
The connector instance PI AF element is defined using connector installation Hostname:Port under the PI AF path of connector_root\Connector Installations\Hostname:Port.
This element contains information related to the connector installation, global configuration, and version information, as well as real-time attributes to monitor Connector Status, Heartbeat, Number of Datasources Configured, and Number of Datasources Connected.
The connector PI AF element representing the connector instance configuration and status contains the following attributes:
|
Attribute |
Description |
Value Type |
PI Point |
Value Range |
|---|---|---|---|---|
|
Connector Admin URL |
URL to connector admin UI. |
URL |
No |
URL |
|
Connector Status |
Overall status of the connection to the connector data sources. Updated once a minute or on-change. |
String |
Yes |
System Digital: Good, Not Connect or String representing status of the connector |
|
Connector Type |
Name of connector type. |
String |
No |
HARTIP |
|
Connector Version |
Version of connector. |
String |
No |
Version |
|
Framework Version |
Version of connector framework. |
String |
No |
Version |
|
Global Configuration Properties |
When expanded, shows the fields defined in the global configuration file. Updated on-change. |
Boolean and Int |
No |
Specific to field type |
|
Heartbeat |
Connector heartbeat. Only updates when data collection has been started. The heartbeat cycles from 1-15 and is set to 0 when data collection is stopped. |
Int32 |
Yes |
0 - 15 |
|
Host |
Connector host name. |
String |
No |
Host |
|
Host IPv4 Address |
Comma separated list of host resolved IPv4 address(es). |
String |
No |
Host_1, Host_2, ..., Host_n |
|
Number of Datasources Configured |
Number of data sources configured in the connector. Updated once a minute or on-change. |
Int32 |
Yes |
0 - MaxInt |
|
Number of Datasources Connected |
Number of connected data sources. A data source is considered Connected if the connector can communicate with the HART gateway defined for the data source. Updated once a minute or on-change. |
Int32 |
Yes |
0 - Number of data sources configured |
|
Port |
Connector configured endpoint port. |
Int32 |
No |
Port |
The PI AF object representing the connector instance configuration and status for the TestHost:9876 connector instance is shown below:
Each datasource is represented as a PI AF element under the associated connector instance with a path of connector_root\Connector Installations\Hostname:Port\DatasourceName.
This element contains information related to the datasource configuration as well as real-time attributes to monitor Datasource Status, Device Scan Time, Scan Time, Time Last Value Received, and Total Number of Measurement Received Last Scan.
The connector PI AF element representing the connector datasource configuration and status contains the following attributes:
|
Attribute |
Description |
Value Type |
PI Point |
UoM |
Value Range |
Default Value |
|---|---|---|---|---|---|---|
|
Access Point Short Address |
Access point short address assigned to the gateway. |
Int32 |
No |
(-1) - 63 |
-1 |
|
|
Battery Check Interval (in days) |
The battery life check interval rate in days. Setting the value to 0 disables the battery life check. |
Double |
No |
days |
0 - 31 |
7 |
|
Collect Non-Dynamic Device Variables |
When this option is set to true, the connector will attempt to collect Dynamic Variables as well as other device variables that are configured to burst data to the gateway as returned by Command 105. By default, the connector will only collect the Dynamic Variables: PV, SV, TV, and QV. |
Boolean |
No |
false or true |
false |
|
|
Connector Type |
Connection type to the HART gateway. |
String |
No |
TCP or UDP |
TCP |
|
|
Datasource Status |
Overall status of the connection to the data source. Updated once a minute or on-change. |
String |
Yes |
System Digital: Good, Not Connect or String representing status of the data source |
||
|
Description |
Data source description. |
String |
No |
Description |
||
|
Device Scan Time |
Time in milliseconds to call and gather data from the HART gateway. This does not include the amount of time to write the values to PI. Updated each scan interval. |
Int32 |
Yes |
ms |
0 - MaxInt or System Digital: Not Connect |
|
|
Gateway Name |
Name of connected gateway. |
String |
No |
<GatewayName> |
Not configured |
|
|
Hostname of IP Address |
The host name or IP address of the HART-IP device. |
String |
No |
<aaa.bbb.ccc.ddd> |
||
|
Port |
The communication port of the HART-IP device. |
Int32 |
No |
<Port> |
5094 |
|
|
Scan Time (in milliseconds) |
Time in milliseconds to scan the device and write values to PI. Updated each scan interval. |
Int32 |
Yes |
ms |
0 - MaxInt or System Digital: Not Connect |
|
|
Status Flags Collect Configuration |
When expanded, shows the status flags collect and do not collect selections. Updated on-change. |
Boolean |
No |
<Selection> |
||
|
Time Last Value Received (HHMM) |
Time last value received from gateway in hour and minutes stored in an integer. Format is HHMM where HH = 0-23 hours and MM = 0-59 minutes. Updated each scan interval. |
Int32 |
Yes |
0 - 2359 or System Digital: Not Connect |
||
|
Total Number of Measurements Received Last Scan |
Total number of measurements received last scan. Updated each scan interval. |
Int32 |
Yes |
0 - MaxInt or System Digital: Not Connect |
||
|
Use Long Tag Name |
If selected, the connector will create device-specific PI AF elements using only the device long tag name. If unselected, the device-specific PI AF element names will consist of a combination of long tag name and the unique address, and the PI points will contain the unique address. |
Boolean |
No |
false or true |
false |
The PI AF object representing the connector datasource configuration and status for the 10.12.127.196 datasource for host TestHost:9876 is shown below.
