Collector Instance Parameters

This topic provides a list of the parameters that you must provide when you add or modify a collector instance.
Table 1. Destination: Historian
Parameter Description
CollectorDestination The type of the configuration to specify the tags whose data you want to collect.
  • If you want to use Historian Administrator to specify the tags for data collection, enter Historian. For information, refer to About Tags.
  • If you want to specify the tags using an offline tag configuration file, do not enter a value. By default, this file is available in the following location: <installation folder of Historian>\GE Digital\<collector name>. For information, refer to Creating Offline Configuration XML file.
winUserName The username to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
winPassword The password to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
CollectorSystemName The name of the machine on which you have installed the collectors. A value is required.
InterfaceName The interface name of the collector instance. A value is required and must be unique per destination. The following characters are not allowed in the interface name:
  • < (less than)
  • > (greater than)
  • : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  • ? (question mark)
  • * (asterisk)
InterfaceDescription The description of the collector instance.
InterfaceSubType The subtype of the collector. For information, refer to Collector Type and Subtype.
Type The type of the collector. For information, refer to Collector Type and Subtype. A value is required.
DataPathDirectory The folder in which you want to store the collector log files. If you do not enter a value, by default, C:\\Proficy Historian Data is considered.
mode Identifies whether creating the collector instance requires a specific user account credentials. Enter one of the following values:
  • 1: Creates the collector instance with the credentials of the local user.
  • 2: Creates the collector instance with the credentials of a specific user. If you choose this mode, you must enter values for the winUserName and winPassword parameters.

Installation parameters for an iFIX collector to send data to Historian

{
               "mode": 2,
               "CollectorSystemName": "<host name>",
               "InterfaceDescription": "iFIX collector for unit 1",
               "DataPathDirectory": "C:\\Proficy Historian Data",
               "CollectorDestination": "Historian",
               "winUserName": "<host name>\\<user name>",
               "winPassword": "<password>",
               "InterfaceSubType": "",
              "DestinationHistorianUserName": "<user name>",
               "DestinationHistorianPassword": "<password>",
               "DestinationHistorian": "<host name>",
               "General1": "",
               "General2": "",
               "General3": "FIX",
               "General4": "",
               "General5": "",
               "Type": 1,
               "InterfaceName": "collector_unique_name"
}
Table 2. Destination: Predix TimeSeries
Parameter Description
ClientID The collector when interacting with Predix Time Series. This is equivalent to the username in many authentication schemes. The client must exist in the Proficy Authentication instance identified by the identity issuer, and the system requires that the timeseries.zones. {ZoneId}.ingest and timeseries.zones.{ZoneId}.query authorities are granted access to the client for the Predix Zone ID specified. Your Predix Time Series administrator can provide this information.
ClientSecret The secret to authenticate the collector. This is equivalent to the password in many authentication schemes.
CloudDestinationAddress The URL of a data streaming endpoint exposed by the Predix Time Series instance to which you want to send data. Typically, it starts with “wss://”. This value is used as part of the interface name and default tag prefix of the collector. Your Predix Time Series administrator can provide this URL.
CollectorDestination The type of the cloud destination. For Predix TimeSeries, enter Predix.
CollectorSystemName The name of the machine on which you have installed the collectors. A value is required.
DataPathDirectory The folder in which you want to store the collector log files. If you do not enter a value, by default, C:\\Proficy Historian Data is considered.
DatapointAttribute<number> The attributes for each data point whose values you want the collector to collect. You can specify maximum five attributes.
IdentityIssuer The URL of an authentication endpoint for the collector to authenticate itself and acquire necessary credentials to stream to the Predix Time Series. In other words, this is the issuer ID of the Proficy Authentication instance that you want to use to connect to Predix Time Series. Typically, it starts with https:// and ends with “/oauth/token”.
InterfaceName The interface name of the collector instance. A value is required and must be unique per destination. The following characters are not allowed in the interface name:
  • < (less than)
  • > (greater than)
  • : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  • ? (question mark)
  • * (asterisk)
InterfaceDescription The description of the collector instance.
InterfaceSubType The subtype of the collector. For information, refer to Collector Type and Subtype.
Proxy Identifies the URL of the proxy server to be used for both the authentication process and for sending data. If the collector is running on a network where proxy servers are used to access web resources outside of the network, then you must provide the proxy server settings. However, it does not affect the proxy server used by Windows when establishing secure connections. As a result, you must still configure the proxy settings for the Windows user account under which the collector service runs.
ProxyUserName The username to connect to the proxy server.
ProxyPassword The password to connect to the proxy server.
Type The type of the collector. For information, refer to Collector Type and Subtype. A value is required.
ZoneID Unique identifier of the instance to which the collector will send data.
winUserName The username to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
winPassword The password to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
mode Identifies whether creating the collector instance requires a specific user account credentials. Enter one of the following values:
  • 1: Creates the collector instance with the credentials of the local user.
  • 2: Creates the collector instance with the credentials of a specific user. If you choose this mode, you must enter values for the winUserName and winPassword parameters.

Installation parameters for an iFIX collector to send data to Predix TimeSeries

{
                "ClientID": "HistQA",
                "ClientSecret": "1234",
                "CloudDestinationAddress": "wss://abcd.run.123.predix.io/v1/stream/messages",
                "CollectorDestination": "Predix",
                "CollectorSystemName": "<host name>",
                "DataPathDirectory": "C:\\Proficy Historian Data",
                "DatapointAttribute1":"\"site\":\"site_1\"",
                "DatapointAttribute2": "",
                "DatapointAttribute3": "",
                "DatapointAttribute4": "",
                "DatapointAttribute5": "",
                "DestinationHistorian": "<host name>",
                "General1": "",
                "General2": "",
                "General3": "abc",
                "General4": "",
                "General5": "",
                "IdentityIssuer": "https://1234567.predix-Proficy Authentication.run.aws-usw02-pr.ice.predix.io/oauth/token",
                "InterfaceDescription": "1234",
                "InterfaceName": "123",
                "InterfaceSubType": "",
                "Proxy": "http://<host name>:<port number>",
                "ProxyPassword": "",
                "ProxyUserName": "",
                "Type": 1,
                "ZoneID": "123-456-789de-rft",
                "winPassword": "",
                "winUserName": "",
                "mode": 1
}
Table 3. Destination: MQTT
Parameter Description
ClientID The name of the MQTT client. A value is required and must be unique for an MQTT broker.
CollectorDestination The type of the cloud destination. For MQTT, enter MQTT.
CollectorSystemName The name of the machine on which you have installed the collectors. A value is required.
DataPathDirectory The folder in which you want to store the collector log files. If you do not enter a value, by default, C:\\Proficy Historian Data is considered.
DeviceSharedKey The device shared key of the MQTT broker.
HostAddress The host name of the MQTT broker to which you want the collector to send data. A value is required.
HostPort The port number to connect to the MQTT broker to which you want the collector to send data.
InterfaceName The interface name of the collector instance. A value is required and must be unique per destination. The following characters are not allowed in the interface name:
  • < (less than)
  • > (greater than)
  • : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  • ? (question mark)
  • * (asterisk)
InterfaceDescription The description of the collector instance.
InterfaceSubType The subtype of the collector. For information, refer to Collector Type and Subtype.
MQTTAutoRefresh Indicates that the password is automatically generated on expiry; you are not required to provide the password.
MQTTCloudSubtype The subtype of the MQTT broker.
MQTTUserName Enter the username to connect to the MQTT broker.
MQTTPassword Enter the password to connect to the MQTT broker.
Topic The MQTT topic to which you want the collector to publish data.
Type The type of the collector. For information, refer to Collector Type and Subtype. A value is required.
winUserName The username to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
winPassword The password to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
mode Identifies whether creating the collector instance requires a specific user account credentials. Enter one of the following values:
  • 1: Creates the collector instance with the credentials of the local user.
  • 2: Creates the collector instance with the credentials of a specific user. If you choose this mode, you must enter values for the winUserName and winPassword parameters.
Tip: To establish an MQTT connection with Alibaba Cloud, refer to https://www.alibabacloud.com/help/doc-detail/73742.htm. To generate a password to connect to Alibaba Cloud, use the utility located here.

Installation parameters for an iFIX collector to send data to Google Cloud

{
               "InterfaceName": "<unique collector name>",
               "InterfaceDescription": "collector for unit 3",
               "Type": 1,
               "mode": 2,
               "CollectorSystemName": "<host name>",
               "DataPathDirectory": "C:\\Proficy Historian Data",
               "CollectorDestination": "MQTT",
               "HostAddress": "mqtt.googleapis.com",
               "HostPort": "8883",
               "ClientID": "projects/mygcpproject/locations/asia-east1/registries/testmqttgcpiot/devices/testdevice",
               "Topic": "/devices/gcptesting/events",
               "DeviceSharedKey": "",
               "MQTTCloudSubtype": "GOOGLE",
               "MQTTUserName": "testusername",
               "MQTTPassword": "testGoogleConnectiionstringPassword",
               "MQTTAutoRefresh": "NO",
               "MQTTCAFile": "",
               "MQTTCertificateFile": "",
               "MQTTPrivateKeyFile": "",
               "MQTTPublicKeyFile": "",
               "winUserName": "<host name>\\Admin",
               "winPassword": "<password>",
               "InterfaceSubType": "",
               "DestinationHistorianUserName": "<Windows user name of the destination>",
               "DestinationHistorianPassword": "<Windows password of the destination>",
               "DestinationHistorian": "<host name>",
               "General1": "",
               "General2": "",
               "General3": "FIX",
               "General4": "",
               "General5": ""
}
Table 4. Destination: Azure IoT Hub
Parameter Description
CollectorDestination The type of the cloud destination. For Azure IoT Hub, enter Azure.
CollectorSystemName The name of the machine on which you have installed the collectors. A value is required.
DataPathDirectory The folder in which you want to store the collector log files. If you do not enter a value, by default, C:\\Proficy Historian Data is considered.
DeviceConnectionString Identifies the Azure IoT device to which you want to send data. Enter a value in the following format: HostName=<value>;DeviceId=<value>;SharedAccessKey=<value>
DeviceId The ID of the Azure IoT device.
SharedAccessKey The shared access key of the device.
InterfaceName The interface name of the collector instance. A value is required and must be unique per destination. The following characters are not allowed in the interface name:
  • < (less than)
  • > (greater than)
  • : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  • ? (question mark)
  • * (asterisk)
InterfaceDescription The description of the interface.
InterfaceSubType The subtype of the collector. For information, refer to Collector Type and Subtype.
Proxy Identifies the URL of the proxy server to be used for both the authentication process and for sending data. If the collector is running on a network where proxy servers are used to access web resources outside of the network, then you must provide the proxy server settings. However, it does not affect the proxy server used by Windows when establishing secure connections. As a result, you must still configure the proxy settings for the Windows user account under which the collector service runs.
ProxyUserName The username to connect to the proxy server.
ProxyPassword The password to connect to the proxy server.
TrasportProtocol The protocol that you want to use to send data to Azure IoT Hub. Enter one of the following values:
  • HTTP
  • MQTT
  • AMQP
  • MQTT_OVER_WEBSOCKETS
  • AMQP_OVER_WEBSOCKETS
For information on which protocol to use, refer to Protocols and Port Numbers.
Type The type of the collector. For information, refer to Collector Type and Subtype. A value is required.
winUserName The username to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
winPassword The password to connect to the machine on which Historian Administrator is installed. A value is required only if:
  • You want to use Historian Administrator to specify the tags for data collection.
  • Historian security groups are used.
  • The mode is set to 2.
mode Identifies whether creating the collector instance requires a specific user account credentials. Enter one of the following values:
  • 1: Creates the collector instance with the credentials of the local user.
  • 2: Creates the collector instance with the credentials of a specific user. If you choose this mode, you must enter values for the winUserName and winPassword parameters.

Installation parameters for an iFIX collector to send data to Azure IoT Hub

{
               "InterfaceName": "collector_unique_name",
               "InterfaceDescription": "iFIX collector for unit 2",
               "Type": 1,
               "mode": 2,
               "CollectorSystemName": "<host name>",
               "DataPathDirectory": "C:\\Proficy Historian Data",
               "CollectorDestination": "Azure",
               "DeviceConnectionString": "HostName=abc.azure-devices.net;DeviceId=Device1;SharedAccessKey=xxxxxxxxxx",
               "TransportProtocol": "AMQP_OVER_WEBSOCKETS",
               "Proxy": "<host name>:<port number>",
               "ProxyUserName": "",
               "ProxyPassword": "",
               "winUserName": "<host name>\\<user name>",
               "winPassword": "<password>",
               "InterfaceSubType": "",
              "DestinationHistorianUserName": "<user name>",
               "DestinationHistorianPassword": "<password>",
               "DestinationHistorian": "<host name>",
               "General1": "",
               "General2": "",
               "General3": "FIX",
               "General4": "",
               "General5": ""
}