Versions Compared

Key

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

...

Tag Agents are configured to point to a single folder.  All Tags within that folder will be monitored by the Tag Agent. 

Clicking on the 'Create new Tag Agent Settings..' link will bring up a form to add a new Tag Agent.

Tag Settings

Image Added

  • 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 data for all tags associated with the Agent every 'Tag Pacing Period'
      • HYBRID - will push change events as EVENT_DRIVEN but will also push non changed events on the same tag pacing period.
  • 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.

Sparkplug Settings

Image Added

  • 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.

...

As you can see, the Sparkplug settings can be used to either hard-code these IDs, or leave them blank so that the Agent will scan and discover them based on the tag tree layout. For more information see the Cloud Injector Tag Agents and Tag Trees document.

Advanced

Image Added

  • Send All Properties - added in 4.0.25
    • Send all properties, including 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.

Clicking on the 'Create new Tag Agent Settings..' link will bring up the following form to add a new Tag Agent.

...