Page History

...

The first tab contains the general settings for the AWS Injector module.Image RemovedImage Added

The general configurations options available on this tab are listed below:

...

The next tab is the list of AWS Kinesis Stream endpoints that the module should connect to to push Tag data.Image RemovedImage Added

One or more AWS Kinesis Stream endpoints can be configured on this tab. The configuration options for an AWS Kinesis Stream connection are listed below.

...

Clicking on the "Create new Kinesis Stream SettingStream Setting..." link will bring up the following form for adding a new AWS Kinesis Stream endpointStream endpoint.Image RemovedImage Added

Anchor
dynamodb dynamodb

DynamoDB Databases

The third tab is the list of AWS DynamoDB Database endpoints that the module should connect to to push Tag data.Image RemovedImage Added

One or more AWS DynamoDB Database endpoints can be configured on this tab. The configuration options for an AWS DynamoDB Database connection are listed below.

...

Clicking on the "Create new DynamoDB Setting..." link will bring up the following form for adding a new AWS DynamoDB Database endpoint.Image RemovedImage Added

Anchor
sets sets

Sets

The Sets tab contains a list of AWS Sets.  Each set represents a grouping of AWS endpoints.  When a set is referenced by a Tag Agent the Agent will push Tag data to all AWS endpoints contained within that Set. The Sets are disjoint, meaning that a single AWS Kinesis Stream or DynamoDB Database endpoint cannot be in more than one set.  Out of the box the AWS Injector module will have one "Default" set defined.Image RemovedImage Added

Additional Sets can be configured for situations where multiple Tag Agents will need to push to different AWS endpoints. The configuration options for Sets are listed below.

...

Clicking on the 'Create new AWS Set...' link will bring up the following form to add a new Set.

...

Image Added

Anchor
tagagents tagagents

Tag Agents

Tag Agents are the workers within AWS Injector that monitor tag events, convert them to a JSON representation, and push them to one or more AWS endpoints. Out of the box the AWS Injector module will have one "default" Tag Agent defined.Image AddedImage Removed

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 RemovedImage 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 current data value 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 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 RemovedImage 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.

...

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.

...