Infohub (Flow)Reference
Consumer Reference
All 13 Infohub data consumers and the properties each one declares.
A data consumer publishes Infohub data outward. Infohub ships 13 consumers, listed here with the properties each declares in this release.
For what a consumer is and how the send cycle works, start with What a Data Consumer Is.
Consumers at a glance#
| Consumer | Properties declared |
|---|---|
| Apache Kafka | 12 |
| AWS Kinesis Data Streams | 4 |
| Azure Event Hub | 6 |
| Canary | 5 |
| CSV | 10 |
| Endpoint Consumer | 13 |
| Flow Consumer | 15 |
| Microsoft SQL Database | 16 |
| MQTT Broker | 16 |
| MySQL Database | 13 |
| PostgreSQL Database | 14 |
| Snowflake | 19 |
| SparkplugB Broker | 20 |
Apache Kafka#
Connection
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Points Per Packet | Whole number | Connection | |
| Kafka Server | Text | Connection | |
| Kafka Port | Whole number | Connection | |
| Security | Choice | Connection | |
| Security Mechanism | Choice | Connection | |
| Username | Text | Connection | |
| Password | Text | Connection | Stored encrypted |
| SslCaLocation | Text | Connection | |
| Topic Format | Text | Connection | |
| Payload Format | Text | Connection |
General
| Property | Type | Applies to |
|---|---|---|
| Refresh Offset | Whole number | Connection |
| Key Format | Text | Connection |
AWS Kinesis Data Streams#
Connection
| Property | Type | Applies to |
|---|---|---|
| Stream name | Text | Connection |
| Region Endpoint | List | Connection |
| Source | Text | Connection |
| Payload Format | Text | Connection |
Azure Event Hub#
Connection
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Event Hub Name | Text | Connection | |
| Endpoint | Text | Connection | |
| SAS Policy Name | Text | Connection | |
| SAS Policy Key | Text | Connection | Stored encrypted |
| Entity Path | Text | Connection | |
| Payload Format | Text | Connection |
Canary#
General
| Property | Type | Applies to |
|---|---|---|
| Historian Server | Text | Connection |
| Dataset | Text | Connection |
| Client Timeout (s) | Whole number | Connection |
| Tagname | Text | Connection |
| Integration Option | Choice | Connection |
CSV#
General
| Property | Type | Applies to |
|---|---|---|
| File Path | Text | Connection |
| Segregate Backfill Data | Yes/No | Connection |
| Path (Backfill) | Text | Connection |
| CSV Delimiter | Text | Connection |
| File Retention Period | Whole number | Connection |
| Time Basis | Choice | Connection |
| Frequency | Whole number | Connection |
| Time Basis (Backfill) | Choice | Connection |
| Frequency (Backfill) | Whole number | Connection |
Connection
| Property | Type | Applies to |
|---|---|---|
| Payload Format | Text | Connection |
Endpoint Consumer#
Connection
| Property | Type | Applies to |
|---|---|---|
| Protocol | Choice | Connection |
| File Option | Choice | Connection |
General
| Property | Type | Applies to | Notes |
|---|---|---|---|
| File Location | Text | Connection | |
| URL | Text | Connection | |
| Url Port | Whole number | Connection | |
| Use https | Yes/No | Connection | |
| Timeout (seconds) | Whole number | Connection | |
| Proxy Server | Text | Connection | |
| Proxy Server Port | Whole number | Connection | |
| Use Default User | Yes/No | Connection | |
| Username | Text | Connection | |
| Password | Text | Connection | Stored encrypted |
Measure Consumer Properties
| Property | Type | Applies to |
|---|---|---|
| Body Text | Text | Connection |
Flow Consumer#
General
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Server | Text | Connection | |
| Instance | Text | Connection | |
| Server Key | Text | Connection | Stored encrypted |
| Server Port | Whole number | Connection | |
| Use https | Yes/No | Connection | |
| Timeout (seconds) | Whole number | Connection | |
| Proxy Server | Text | Connection | |
| Proxy Server Port | Whole number | Connection | |
| Use Default User | Yes/No | Connection | |
| Username | Text | Connection | |
| Password | Text | Connection | Stored encrypted |
| Namespace Filter | Text | Connection | |
| Measure Name | Text | Connection | |
| Measure ID | Text | Connection | |
| Time Scheme Name | Text | Connection |
Microsoft SQL Database#
General
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Server | Text | Connection | Connecting server name. |
| Database | Text | Connection | Connecting database name. |
| Username | Text | Connection | Username to connect to the database. |
| Password | Text | Connection | Stored encrypted. Password to connect to the database. |
| Encryption | Choice | Connection | SQL connection encryption negotiated with the server (SSMS "Encryption"). |
| Trust Server Cert. | Yes/No | Connection | Accept the server certificate without validating its chain (SSMS "Trust server certificate"). |
| Certificate Hostname | Text | Connection | Host name expected in the server certificate when it differs from the server name. |
| Timeout (seconds) | Whole number | Connection | Timeout specified between connections. |
| Definition | Editor | Connection | Simulator file definition. |
| Maximum Concurrent Connections | Whole number | Connection | Maximum number of concurrent connections allowed for a connector. |
| DateTime Precision | Choice | Connection |
Measure Consumer Properties
| Property | Type | Applies to |
|---|---|---|
| Value Query | Text | Connection |
| Attribute Query | Text | Connection |
| Comment Query | Text | Connection |
| Exception Query | Text | Connection |
| User Query | Text | Connection |
MQTT Broker#
Connection
| Property | Type | Applies to | Notes |
|---|---|---|---|
| MQTT Server | Text | Connection | |
| MQTT Port | Whole number | Connection | |
| TLS | Yes/No | Connection | |
| SSL Protocol | Choice | Connection | |
| Certificate Name | Text | Connection | |
| Username | Text | Connection | |
| Password | Text | Connection | Stored encrypted |
| Quality of Service | Choice | Connection | |
| Mqtt Version | Choice | Connection | |
| Protocol | Choice | Connection | |
| Group ID | Text | Connection | |
| Node ID | Text | Connection | |
| Payload Format | Text | Connection | |
| Topic Format | Text | Connection | |
| Path | Text | Connection |
General
| Property | Type | Applies to |
|---|---|---|
| Certificate Store | Choice | Connection |
MySQL Database#
General
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Server | Text | Connection | Connecting server name. |
| Database | Text | Connection | Connecting database name. |
| Username | Text | Connection | Username to connect to the database. |
| Password | Text | Connection | Stored encrypted. Password to connect to the database. |
| Timeout (seconds) | Whole number | Connection | Timeout specified between connections. |
| Definition | Editor | Connection | Simulator file definition. |
| Maximum Concurrent Connections | Whole number | Connection | Maximum number of concurrent connections allowed for a connector. |
| DateTime Precision | Choice | Connection |
Measure Consumer Properties
| Property | Type | Applies to |
|---|---|---|
| Value Query | Text | Connection |
| Attribute Query | Text | Connection |
| Comment Query | Text | Connection |
| Exception Query | Text | Connection |
| User Query | Text | Connection |
PostgreSQL Database#
General
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Server | Text | Connection | Connecting server name. |
| Database | Text | Connection | Connecting database name. |
| Port | Whole number | Connection | Timeout specified between connections. |
| Username | Text | Connection | Username to connect to the database. |
| Password | Text | Connection | Stored encrypted. Password to connect to the database. |
| Timeout (seconds) | Whole number | Connection | Timeout specified between connections. |
| Definition | Editor | Connection | Simulator file definition. |
| Maximum Concurrent Connections | Whole number | Connection | Maximum number of concurrent connections allowed for a connector. |
| DateTime Precision | Choice | Connection |
Measure Consumer Properties
| Property | Type | Applies to |
|---|---|---|
| Value Query | Text | Connection |
| Attribute Query | Text | Connection |
| Comment Query | Text | Connection |
| Exception Query | Text | Connection |
| User Query | Text | Connection |
Snowflake#
General
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Account | Text | Connection | account name. |
| Host | Text | Connection | Connecting server name. |
| Database | Text | Connection | Connecting database name. |
| Role | Text | Connection | |
| Warehouse | Text | Connection | |
| Authentication Type | Choice | Connection | |
| Username | Text | Connection | Username to connect to the database. |
| Password | Text | Connection | Stored encrypted. Password to connect to the database. |
| Key File Location | Text | Connection | |
| Key Password | Text | Connection | Stored encrypted |
| Timeout (seconds) | Whole number | Connection | Timeout specified between connections. |
| Definition | Editor | Connection | Simulator file definition. |
| Maximum Concurrent Connections | Whole number | Connection | Maximum number of concurrent connections allowed for a connector. |
| DateTime Precision | Choice | Connection |
Measure Consumer Properties
| Property | Type | Applies to |
|---|---|---|
| Value Query | Text | Connection |
| Attribute Query | Text | Connection |
| Comment Query | Text | Connection |
| Exception Query | Text | Connection |
| User Query | Text | Connection |
SparkplugB Broker#
Connection
| Property | Type | Applies to | Notes |
|---|---|---|---|
| Points Per Packet | Whole number | Connection | |
| MQTT Server | Text | Connection | |
| MQTT Port | Text | Connection | |
| Multiple Brokers | Yes/No | Connection | |
| MQTT Client ID | Text | Connection | |
| Mqtt Version | Choice | Connection | |
| TLS | Yes/No | Connection | |
| SSL Protocol | Choice | Connection | |
| Certificate Name | Text | Connection | |
| Username | Text | Connection | |
| Password | Text | Connection | Stored encrypted |
| Use Alias | Yes/No | Connection | |
| Wait for Host | Yes/No | Connection | |
| Group ID | Text | Connection | |
| Node ID | Text | Connection | |
| Device ID | Text | Connection | |
| Template Path | Text | Connection |
General
| Property | Type | Applies to |
|---|---|---|
| Certificate Store | Choice | Connection |
| Certificate Location | Choice | Connection |
| Refresh Offset | Whole number | Connection |