Page History

...

...

The configuration section available is Main. Image Removed

• Enabled
  • Sets whether the module is enabled or disabled.  If disabled, the Tag Agents will not run and now data will be pushed to any configured endpoints.

...

Anchor
general general

General

The configuration section available is Main. Image Added

• Enabled
  • Sets whether the module is enabled or disabled.  If disabled, the Tag Agents will not run and now data will be pushed to any configured endpoints.

Anchor
azureiothubs azureiothubs

Azure IoT Hubs

The Azure IoT Hubs The Azure IoT Hubs tab has two parts - Settings and Certificates

...

Azure IoT Hub Settings - Advanced Store & Forward

• H2 Database Port
  • TCP Port to connect to H2 Database for Disk_Backed History Store

...

• Directory - added in 4.0.25
  • Directory to store the H2 Database in. Applicable for Disk-backed history store only
  • The default base path for Linux is ~yourIgnitionInstance\data\modules and the database will be included in the Ignition GWBK
  • The default location for Windows Linux is ~yourIgnitionInstance\data\user-lib and the database will not be included in the Ignition GWBK
  • The database file will be created in this directory under the base path com.cirrus-link\com.cirruslink.injector.azure.gateway\h2
• H2 Database Port
  • TCP Port to connect to H2 Database for Disk_Backed History Store

Anchor
azureiothubscertificates azureiothubscertificates

Azure IoT Hubs - Certificates

This tab provides a list of the certificate or private keys if loaded and available for certificate based authentication.

This will include the CA Certificate that signed the SSL cert being used on the IoTHub server along with any device(s) certificate and private key files.

Image Added

Clicking on the 'Create new Certificate ..' link

This tab provides a list of the certificate or private keys if loaded and available for certificate based authentication.

This will include the CA Certificate that signed the SSL cert being used on the IoTHub server along with any device(s) certificate and private key files.

Image Removed

Clicking on the 'Create new Certificate ..' link will bring up the following form to add a new Certificate. The Certificates tab contains a single Main section.

...

Azure IoT Edges Settings - Advanced Store & Forward

• H2 Database Port
  • TCP Port to connect to H2 Database for Disk_Backed Store & Forward

...

This tab provides a list of the certificate or private keys loaded and available for certificate based authentication. This should generally include the root CA for your IoT Edge, the client certification file and the client private key file.

Image Removed

Clicking on the 'Create new Certificate...' will bring up the following form to add a new certificate. The Certificates tab contains only a single Main section.

...

Image Removed

• Certificate File Upload
  • Browse to the certificate or private key to upload
• Friendly Name
  • The friendly name of the certificate file or private key
• File Description
  • The description of the certificate file or private key

...

• Directory - added in 4.0.25
  • Directory to store the H2 Database in. Applicable for Disk-backed history store only
  • The default base path for Linux is ~yourIgnitionInstance\data\modules and the database will be included in the Ignition GWBK
  • The default location for Windows Linux is ~yourIgnitionInstance\data\user-lib and the database will not be included in the Ignition GWBK
  • The database file will be created in this directory under the base path com.cirrus-link\com.cirruslink.injector.azure.gateway\h2
• H2 Database Port
  • TCP Port to connect to H2 Database for Disk_Backed Store & Forward

Anchor
azureiotedgecertificates azureiotedgecertificates

Azure IoT Edges - Certificates

This tab provides a list of the certificate or private keys loaded and available for certificate based authentication. This should generally include the root CA for your IoT Edge, the client certification file and the client private key file.

Image Added

Clicking on the 'Create new Certificate...' will

This tab provides a list of Azure Event Hub endpoints that the module should connect to to push tag data. One or more Azure Event Hub endpoints can be configured on this tab. Image Removed

Clicking on the 'Create new Azure Event Hub ..' link will bring up the following form to add a new Azure Event Hubcertificate. The configuration sections available are Main, Store & Forward and AdvancedCertificates tab contains only a single Main section.

Anchor

...

azureiotedgescertificatesmain

...

azureiotedgescertificatesmain

Azure

...

IoT Edges Certificates - Main

...

• Setting Name
  • This is a friendly name of the Azure Event Hub used to easily identify it.  This must also be unique.
• Enabled
  • Whether or not this connection is enabled.
• Password/Connection String
  
  • This is the Azure Event Hub connection string used to connect. 
  • NOTES: Be sure to provide the connection string for the EventHub itself and not the EventHub Namespace. They both have connection strings, but the one for the EventHub will be of the form -

    Endpoint=<YOUR_ENDPOINT>;SharedAccessKeyName=<YOUR_KEYNAME>;SharedAccessKey=<YOUR_KEY>=;EntityPath=<YOUR_EVENTHUB_ENTITYPATH>

    The Namespace connection string will not contain the entity path.

• Set
  
  • The Set to associate this Azure Event Hub connection with.

...

Image Added

• Certificate File Upload
  • Browse to the certificate or private key to upload
• Friendly Name
  • The friendly name of the certificate file or private key
• File Description
  • The description of the certificate file or private key

Anchor
azureeventhubs azureeventhubs

Azure Event Hubs

This tab provides a list of Azure Event Hub endpoints that the module should connect to to push tag data. One or more Azure Event Hub endpoints can be configured on this tab. Image Added

Clicking on the 'Create new Azure Event Hub ..' link will bring up the following form to add a new Azure Event Hub. The configuration sections available are Main, Store & Forward and Advanced

Anchor
eventhubssettingsmain eventhubssettingsmain

Azure Event Hub - MainImage Added

• Setting Name
  • This is a friendly name of the Azure Event Hub used to easily identify it.  This must also be unique.
• Enabled
  • Whether or not this connection is enabled.
• Password/Connection String
  
  • This is the Azure Event Hub connection string used to connect. 
  • NOTES: Be sure to provide the connection string for the EventHub itself and not the EventHub Namespace. They both have connection strings, but the one for the EventHub will be of the form -

    Endpoint=<YOUR_ENDPOINT>;SharedAccessKeyName=<YOUR_KEYNAME>;SharedAccessKey=<YOUR_KEY>=;EntityPath=<YOUR_EVENTHUB_ENTITYPATH>

    The Namespace connection string will not contain the entity path.

• Set
  
  • The Set to associate this Azure Event Hub connection with.

Anchor
eventhubssettingsstoreandforward eventhubssettingsstoreandforward

Azure Event Hub Settings - Store & Forward

Image Added

• Store & Forward Enabled
  • Whether to enable Store & Forward capabilities for this endpoint
• Store & Forward Type
  • The type of the Store & Forward mechanism options: In_Memory and Disk_Backed (available in release 4.0.17 and higher)
  • Data stored with an In_Memory Store & Forward will not be persisted across a module configuration change, module disable/enable, module restart or power loss. 
  • Data stored with a Disk_Backed Store & Forward will persist across a module configuration change, module disable/enable, module restart or power loss
• Message Capacity - deprecated in 4.0.19
  • The maximum number of messages to store before dropping the oldest historical messages
• History Max Size
  • The maximum number of megabytes history can use before dropping the data
  • In_Memory Store & Forward will use the Ignition Java Heap memory
• History Max Age
  • The maximum number of minutes to store history before dropping the data
• Flush Period
  • The period of time to wait (in

Image Removed

• Store & Forward Enabled
  • Whether to enable Store & Forward capabilities for this endpoint
• Store & Forward Type
  • The type of the Store & Forward mechanism options: In_Memory and Disk_Backed (available in release 4.0.17 and higher)
  • Data stored with an In_Memory Store & Forward will not be persisted across a module configuration change, module disable/enable, module restart or power loss. 
  • Data stored with a Disk_Backed Store & Forward will persist across a module configuration change, module disable/enable, module restart or power loss
• Message Capacity - deprecated in 4.0.19
  • The maximum number of messages to store before dropping the oldest historical messages
• History Max Size
  • The maximum number of megabytes history can use before dropping the data
  • In_Memory Store & Forward will use the Ignition Java Heap memory
• History Max Age
  • The maximum number of minutes to store history before dropping the data
• Flush Period
  • The period of time to wait (in milliseconds) between sending when flushing messages

...

• Max Message Size
  • The maximum message size for the Azure Event Hub. Default is 262144 bytes (256KB). Generally, this should match the max message size allowed by the Event Hub.
    • EventHub Basic: 262144 bytes (256KB)
    • EventHub Standard or better: 1048576 bytes (1MB)
• Content Encoding
  • The content encoding of the data to push to Event Hub.
  • Current options are UTF_8, UTF_16 and UTF_32
• Azure Date/Time Format
  • The date/time format to use when pushing messages to IoT Hub
    • LONG_MS_SINCE_EPOCH (default) - The timestamp values will all be as numbers in milliseconds since epoch (Jan 1, 1970) in UTC
    • STRING_AZURE_COMPAT - The timestamp will be pushed as described here. This is useful when wanting to use 'edge' timestamps in Azure Time Series insights.
  • See Pushing Data to Azure Time Series Insights tutorial for more detail

...

• • the Event Hub.
    • EventHub Basic: 262144 bytes (256KB)
    • EventHub Standard or better: 1048576 bytes (1MB)
• Content Encoding
  • The content encoding of the data to push to Event Hub.
  • Current options are UTF_8, UTF_16 and UTF_32
• Azure Date/Time Format
  • The date/time format to use when pushing messages to IoT Hub
    • LONG_MS_SINCE_EPOCH (default) - The timestamp values will all be as numbers in milliseconds since epoch (Jan 1, 1970) in UTC
    • STRING_AZURE_COMPAT - The timestamp will be pushed as described here. This is useful when wanting to use 'edge' timestamps in Azure Time Series insights.
  • See Pushing Data to Azure Time Series Insights tutorial for more detail

Azure Event Hub Settings - Advanced Store & ForwardImage Added

• H2 Database Directory - added in 4.0.25
  • Directory to store the H2 Database in. Applicable for Disk-backed history store only
  • The default base path for Linux is ~yourIgnitionInstance\data\modules and the database will be included in the Ignition GWBK
  • The default location for Windows Linux is ~yourIgnitionInstance\data\user-lib and the database will not be included in the Ignition GWBK
  • The database file will be created in this directory under the base path com.cirrus-link\com.cirruslink.injector.azure.gateway\h2
• H2 Database Port
  • TCP Port to connect to H2 Database for Disk_Backed Store & Forward

...

• Store & Forward Enabled
  • Whether to enable Store & Forward capabilities for this endpoint
• Store & Forward Type
  • The type of the Store & Forward mechanism options: In_Memory and Disk_Backed (available in release 4.0.17 and higher)
  • Data stored with an In_Memory Store & Forward will not be persisted across a module configuration change, module disable/enable, module restart or power loss. 
  • Data stored with a Disk_Backed Store & Forward will persist across a module configuration change, module disable/enable, module restart or power loss
• Message Capacity - deprecated in 4.0.19
  • The maximum number of messages to store before dropping the oldest historical messages
• History Max Size
  • The maximum number of megabytes history can use before dropping the data
  • In_Memory Store & Forward will use the Ignition Java Heap memory
• History Max Age
  • The maximum number of minutes to store history before dropping the data
• Flush Period
  • The period of time to wait (in milliseconds) between sending when flushing messages

...

• • use the Ignition Java Heap memory
• History Max Age
  • The maximum number of minutes to store history before dropping the data
• Flush Period
  • The period of time to wait (in milliseconds) between sending when flushing messages

Anchor
iotcentraladvanced iotcentraladvanced

Azure IoT Central - AdvancedImage Added

• Max Message Size
  • The maximum message size in bytes that any message can be when pushing to IoT Central.
• Azure Date/Time Format
  • The date/time format to use when pushing messages to IoT Hub
    • LONG_MS_SINCE_EPOCH (default) - The timestamp values will all be as numbers in milliseconds since epoch (Jan 1, 1970) in UTC
    • STRING_AZURE_COMPAT - The timestamp will be pushed as described here. This is useful when wanting to use 'edge' timestamps in Azure Time Series insights.
  • See Pushing Data to Azure Time Series Insights tutorial for more details

Azure IoT Central - Advanced Store & ForwardImage Added

• H2 Database Directory - added in 4.0.25
  • Directory to store the H2 Database in. Applicable for Disk-backed history store only
  • The default base path for Linux is ~yourIgnitionInstance\data\modules and the database will be included in the Ignition GWBK
  • The default location for Windows Linux is ~yourIgnitionInstance\data\user-lib and the database will not be included in the Ignition GWBK
  • The database file will be created in this directory under the base path com.cirrus-link\com.cirruslink.injector.azure.gateway\h2

• Max Message Size
  • The maximum message size in bytes that any message can be when pushing to IoT Central.
• Azure Date/Time Format
  • The date/time format to use when pushing messages to IoT Hub
    • LONG_MS_SINCE_EPOCH (default) - The timestamp values will all be as numbers in milliseconds since epoch (Jan 1, 1970) in UTC
    • STRING_AZURE_COMPAT - The timestamp will be pushed as described here. This is useful when wanting to use 'edge' timestamps in Azure Time Series insights.
  • See Pushing Data to Azure Time Series Insights tutorial for more details

...

• H2 Database Port
  • TCP Port to connect to H2 Database for Disk_Backed Store & Forward

...

Anchor
tagagentsadvanced tagagentsadvanced

Tag Agents - Advanced

• Send All Properties - added in 4.0.25
  • Send all properties, including non-default properties, in Sparkplug BIRTH messages
• Filtered Properties
  • A semicolon delimited list of Tag properties to filter/block from being published.  These should typically not be modified unless there is an explicit requirement that a specific property is needed to be added or removed from the default.

...