Versions Compared

Key

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

...

  • Name
    • Unique name for the Transmitter
  • Enabled
    • Checkbox to enable/disable the Transmitter. Selected by default.
  • Tag Provider
    • The name of the tag provider that Transmission will monitor.  By default this is the Ignition 'default' provider.
  • Tag Path
    • Optional path to the root folder where the tag tree starts.
    • Transmitters also support a multi-tag path configuration. Reference the Transmitters with Multi-Tag Paths tutorial for configuration assistance.
  • Tag Pacing Period
    • The buffer period for outgoing Transmission messages in milliseconds.  The default is 1000ms.  This means when a tag change event is detected 1000ms will elapse before an MQTT message is sent.  This allows additional tag change events to be buffered and put into the message and in turn reduce the number of generated MQTT messages.
  • Set
    • The Set that the default MQTT Transmission client will connect to.
  • Discovery Delay
    • An optional startup delay, in milliseconds, to wait before scanning for Tags to monitor. This is useful when Tags are dynamically created on initial startup, as is the case when using the MQTT Engine module.
  • Aliased Tags
    • Checkbox to enable/disable using aliases for tag names when published data messages as tag values change in order to optimize payload size when publishing data. Not selected by default.
  • Compression
    • The algorithm to use to compress payloads before they are published to the MQTT Server.  If 'NONE' is selected then compression is disabled.
  • Convert UDTs
    • Checkbox to enable/disable converting 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. Selected by default.
  • Publish UDT Definitions
    • Checkbox to enable/disable publishing UDT Definitions in BIRTH. Selected by default and not editable.
  • Optimize UDTs
    • Checkbox to enable/disable optimizing UDT payload sizes in NDATA and DDATA payloads. Selected by default and not editable.
  • Enable Birth Caching
    • Checkbox to enable/disable caching birth requests for faster rebirth request response. Not selected by default.

...

  • History Store
    • The MQTT Transmission History Store to use with the Default Transmitter.
  • Enable History Storage by Default
    • Checkbox to enable/disable store and forward for all tags. Selected by default. 
    • Store and forward controls whether or not a tag is stored in the configured History Store when Transmission is offline. To override the global setting,individual tags will require a custom tag property 'StoreAndForward' (type: boolean) to be created and set to the reverse state of the global setting.
  • In-Order History
    • Checkbox to enable/disable the flush history in-order (synchronously) before live data resumes. Not selected by default.

...

  • Name
    • The name of the History Store.
  • Enabled
    • Checkbox to enable/disable the History Store. Not selected by default.
  • Type
    • The type of History Store.
  • Edge Node Tag Capacity
    • The maximum number of edge node tags tag change events to store (per edge node) before dropping the oldest currently stored tag value.
    • A tag change event is triggered by either a change in value or quality and results in the tag's Qualified Value (which has three attributes of value, quality and timestamp) being stored. 
    • The Edge Node Tag Capacity is independent, and in addition to, the Device Tag Capacity
  • Device Tag Capacity
    • The maximum number of device tags tag change events to store (per device) before dropping the oldest currently stored tag valuestored tag value.
    • A tag change event is triggered by either a change in value or quality and results in the tag's Qualified Value (which has three attributes of value, quality and timestamp) being stored.
  • Flush Quantity
    • The maximum number of tags to publish in a single message upon reestablishing communication.
  • Flush Period
    • The period to wait in milliseconds between publishes when flushing messages upon reestablishing communication.

...