Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
azureiothubsettingsstore&forward
azureiothubsettingsstore&forward
Azure IoT Hub Settings - Store & Forward

...


Note

From release 4.0.19, major improvements have been made to the disk-backed History Store.

As a result, the Message Capacity has been deprecated and History Max Age added

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 maximum number of messages to store before dropping the oldest historical messages
  • 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
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 folder path under the Tag provider where the root folder of the Tags can be found.
  • 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 and tag change events will not be captured.
  • 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.

...