Page History

...

• 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

...

• 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
      and tag change events will not be captured.
      • - 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
tagagentsadvanced tagagentsadvanced

Tag Agents - Advanced

Image RemovedImage Added

• Send All Properties - added in 4.0.25
  • Send all properties, including default properties, in Sparkplug BIRTH messages
• Include Info & Control Folders - added in 4.0.30
  • Push all Node and Device Info and Control folder tags from MQTT Engine
• 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.

...