Page History

...

The configuration for this module are located under the Configure tab Connections menu of the Ignition Gateway web UI in the left hand navigation pane under 'Azure Injector Settings'.Image Removed

Image RemovedImage Added

The configuration options for each of the seven tabs - General, Azure IoT Hubs, Azure IoT Edges, Azure Event Hubs, Azure IoT Central, Sets and Tag Agents - are detailed below.

...

The configuration section available is Main. Image Removed

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.

...

The Azure IoT Hubs tab has two parts - Settings and CertificatesImage Removed

Image Added

Anchor
azureiothubssettings azureiothubssettings

Azure IoT Hubs - Settings

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

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

Image Added

Anchor
azureiothubsettingmain azureiothubsettingmain

Azure IoT Hub Settings - MainImage Removed

• Setting Name
  • This is a friendly name of the Azure IoT Hub used to easily identify it.  This must also be unique.
• Enabled
  • Whether or not this connection is enabled.
• Protocol
  • The protocol to use when connecting to the Azure IoT Hub. 
  • Currently MQTT only is supported. 
• Set
  
  • The Set to associate this Azure IoT Hub connection with.

Anchor
azureiothubsettingsauthentication azureiothubsettingsauthentication

Azure IoT Hub Settings - Authentication

...

• Enable Certificate Based Authentication
  • Whether or not to use certificate based authentication.
  • This determines the authentication fields available for use.
• Password
  
  • Available if not using certificate based authentication
  • This is the Azure IoT Hub device connection string used to connect in the following format:
  • HostName=<Host Name>;DeviceId=<Device Name>;SharedAccessKey=<Device Key>
• MQTT Hostname
  • Available if using certificate based authentication 
  • This is the DNS endpoint name of your IoT Hub
• Device ID
  • Available if using certificate based authentication 
  • The Device ID to connect to as provisioned in the IoT Hub
• CA Certificate File
  • Available if using certificate based authentication
  • The CA certificate that signed the SSL certificate being used in the IoT Hub server. See this document for more information.
  • The drop down is populated from a list of files that have been uploaded to the IoT Hub/Certificates tab.
• Client Certificate File
  • Available if using certificate based authentication
  • The client certificate file as provisioned for the Device ID specified above. See this Connecting to Azure IoT Hub with Certificate Based Authentication for details on creating the client certificate
  • The drop down is populated from a list of files that have been uploaded to the IoT Hub/Certificates tab.
• Client Private Key File
  • Available if using certificate based authentication
  • The client private key file that was used in generating the certificate for the Device ID specified above. See this Connecting to Azure IoT Hub with Certificate Based Authentication for details on creating the client private key 
  • The drop down is populated from a list of files that have been uploaded to the IoT Hub/Certificates tab.
• Private key password
  • Available if using certification based authentication
  • The password used for the private key if one was specified for the Client Private Key File

Anchor
azureiothubsettingsstore&forward azureiothubsettingsstore&forward

Azure IoT Hub Settings - Store & Forward

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
  • Maximum number of megabytes history can use before dropping the data
  • An In_Memory History store 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

Anchor
azureiothubsettingsadvanced azureiothubsettingsadvanced

Azure IoT Hub Settings - Advanced

...

• Keep Alive
  • The MQTT keep alive timeout in seconds
• Max Message Size
  • The maximum message size in bytes that any message can be when pushing to IoT Hub. Generally, this should match the max message size allowed by IoTHub.
• Session Expiration
  • How long in seconds to specify for session token timeouts when not using certificate based authentication
• Content Type

  • The content type to include in the topic to Azure IoT Hub

    • NONE (default) - No content type header will be included with the message
    • APPLICATION_JSON - The application/json header will be included with the message and make the body of the message available for routing if content encoding is also not 'NONE'
  • See Using IoT Hub Message Based Routing tutorial for more details
• Content Encoding
  • The content encoding to include in the topic to Azure IoT Hub
    • NONE (default) - No content encoding header will be included with the message
    • UTF_8 - The 'utf-8' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
    • UTF_16 - The 'utf-16' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
    • UTF_32 - The 'utf-32' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
    • ISO-8859-1 - The 'ISO-5589-1' header will be included with the message and make the body of the message available for routing if the content type is also set to APPLICATION_JSON
  • See Using IoT Hub Message Based Routing tutorial for more details
• 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 Hub Settings - Advanced Store & Forward

...

• 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\user-lib\modules 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
tagagentsagentsettings tagagentsagentsettings

Tag Agents - Agent Settings

Image Modified

• Name
  • A unique name for the tag agent.
• Enabled
  • Sets whether the Tag Agent is enabled or disabled.  If disabled, the Tag Agent will not run and no data will be pushed to any configured endpoints.
• Tag Provider Name
  
  • The name of the Tag provider containing the tags.
• Tag Path
  • An optional path to the root folder where the tag tree starts.
• Push Trigger
  • Defines what triggers a push to the cloud endpoint
    • EVENT_DRIVEN (default) - when a tag change event (value or quality) occurs, and no pending push exists, tag events will be aggregated for the 'Tag Pacing Period' before being pushed.  
    • PERIODIC - will push the latest data for all tags associated with the Agent every 'Tag Pacing Period'.
      • With this option, only one event per tag will be sent - this may result in data loss if tags are changing more frequently than the 'tag pacing period'
    • HYBRID - will push change events as EVENT_DRIVEN but will also push non changed events on the same tag pacing period.
  • Review How the MQTT Injector Push Trigger affects data published for examples
• Tag Pacing Period
  • The buffer period, in milliseconds, that Tag events will be aggregated into a single payload before pushing.
•  Convert UDTs
  • Whether to convert UDT members to normal Tags before publishing.  If enabled the Tags representing the UDT member will retain their member path prefixed by the UDT Instance name.
• Publish UDT Definitions
  • This will only be used if 'Convert UDTs' is false  
  • Whether or not to push the UDT Definitions in the the NBIRTH messages
• Optimize UDTs
  • This will only be used if 'Convert UDTs' is false
  • Whether or not to 'convert UDTs' only for DATA messages.
• Set
  • The Set of Azure IoT Hub endpoints that the Tag Agent will push to.

...

Anchor
tagagentssparkplugsettings tagagentssparkplugsettings

Tag Agents - Sparkplug Settings

Image Modified

• Group ID
  • An ID representing a logical grouping of MQTT Edge Of Network (EoN) Nodes and Devices into the infrastructure.
• Edge Node ID
  • An ID that uniquely identifies the MQTT Edge Of Network (EoN) Node within the infrastructure.
• Device ID
  • An optional ID that uniquely identifies a Device within the infrastructure.

...