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 Configure 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.
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.

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 UAA 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 UAA 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.
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.

Table 3. Destination: MQTT

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.
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 connct 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.

Table 4. Destination: Azure IoT Hub

CollectorDestination	The type of the cloud destination. For Azure IoT Huv, 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.
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.