Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Connector for HART-IP

Global configuration file

  • Last UpdatedJan 06, 2023
  • 4 minute read

The connector uses a global configuration file to set fields that relate to the overall connector operation as well as settings that apply to all the data sources configured in the connector.

The global configuration file (ConnectorGlobal.config.json), is located in the install_path\HARTIP\Configuration\ directory. The file contains default settings that can be changed by the user when required. Changes to the file must be made manually. In other words, the connector UI does not contain a page to modify the global configuration file.

Note: The connector monitors for changes to the global configuration file during run-time operations after data collection has been started. However, changes to the file after data collection has been started may result in new PI points being created or certain PI points to stop updating. Therefore, changes to this file should be made prior to the start of data collection.

The global configuration file contains the following JavaScript Object Notation (JSON) format.

{
"connectorglobal": {
"ConfigObject": {
"CreateStatusTagAsStringType": false,
"UseAbbreviatedTagName": false,
"DoNotCreateBatteryLifeValue": false,
"CreateConnectorStatusElements": true,
"CreateFailoverStatusElements": false,
"PercentUp": 100
}
}
}

The contents of the global configuration file complies with the JSON standard and contains the following data fields field and type settings:

Field

Description

Data Type

Value Range

Default Value

CreateStatusTagAsStringType

Beginning in version 1.2 of the connector, "Status" type measurements are created as a digital type PI point with a naming convention <Variable> Status (E). Previous versions of the connector create Status type measurements as a string PI point with a naming convention <Variable> Status.

Note: When upgrading from a version prior to 1.2, the new digital type will be created and updated with real-time data values. The string type tags will no longer be updated with real-time data values and may be deleted from the PI System.

Users can opt to continue defining Status type measurements as a string type PI point by setting this option to true.

Boolean

true, false

false

UseAbbreviatedTagName

Setting this value to true will allow the connector to create PI points without the _variable identifier in the PI point name.

Example: Setting this option to true results in the following PI point that would be created as HARTIP Connector.2663 000FAE_PV.PV to be created as HARTIP Connector.2663 000FAE.PV

Boolean

true, false

false

DoNotCreateBatteryLifeValue

The connector will collect battery life data from the sub-device and create an associated Battery Life PI point.

Setting this option to true disables the collection of battery life data from the sub-device and disables the creation of the sub-device Battery Life PI point.

Note: Selecting to collect 6_Battery_Life_Status in the Status Flags to Collect picklist of the datasource configuration results in requesting the battery life from the sub-device in order to retrieve the status even if this option is set to true. In this case, the Battery Life Status PI point will be created. However, the Battery Life PI point will not be created.

Boolean

true, false

false

CreateConnectorStatusElements

Create the PI AF element representing the connector instance 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.

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.

By default, the above information is automatically generated by the connector. However, the ability to disable the creation of the connector instance PI AF element and associated PI points can be accomplished by setting this option 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 monitor configuration and status.

Boolean

true, false

true

CreateFailoverStatusElements

Creates the PI AF element representing the connector instance failover configuration and status.

The connector instance failover PI AF element is defined under the PI AF path of connector_root\Connector Installations\Hostname:Port\Failover.

This element contains information related to the connector failover configuration as well as real-time attributes to monitor Datasource Percent Up Actual, Failover Enabled, Peer Failover State, This Failover Connector Role, This Failover Datasource Status, and This Failover State.

By default, the option for creating the above information is disabled. However, the ability to enable the creation of the connector instance failover PI AF element and associated PI points can be accomplished by setting this option to true.

Note: If this option is enabled, the PI AF object representing the connector instance failover configuration and status element, and any associated PI points, will not be created or updated while the connector instance is in the Backup role. Therefore, the failover element of the connector instance in the Backup role is not reliable and cannot be used to determine failover status. The failover element of the connector instance in the Active role is reliable and should be used monitor failover configuration and status.

Boolean

true, false

false

PercentUp

This option is used when failover is enabled in the connector.

By default, this value is set to 100, which means the connector will set the failover status of the connector instance to Connected when the connector reports that all data sources are connected.

The valid range of this option is 0-100 percent. When set, the connector reports a failover status of Connected when the percent of connected data sources is greater than or equal to the defined value. The connector reports a failover status of Disconnected when the percentage of connected data sources falls below the defined value.

Number (Integer)

0-100

100

TitleResults for “How to create a CRG?”Also Available in