Versions Compared

Key

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

...

  • 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 occurs, and no pending push exists, tag events will be aggregated for the 'Tag Pacing Period' before being pushed
      • PERIODIC - will push current data value for all tags associated with the Agent every 'Tag Pacing Period'. 
        • This 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 can only be set if 'Convert UDTs' is false  
    • Whether or not to push the UDT Definitions in the the NBIRTH messages
  • Optimize UDTs
    • This can only be set if 'Convert UDTs' is false
    • Whether or not to 'convert UDTs' only for DATA messages.
  • Set
    • The Set of AWS endpoints that the Tag Agent will push to.

...

Tip
For more information see the Cloud Injector Tag Agents and Tag Trees tutorial.

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.

...