Versions Compared

Key

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

...

Anchor
Records
Records
Records

Image Removed

The configuration sections available are Tag Settings, Sparkplug Settings and Advanced Settings.

...

Within MQTT Transmission, a record is a collection of tags under an Ignition folder which are treated as a single entity and published on demand. They are usually used for, but not restricted to, sending flow computer records such as events, alarms and history data.

Each record will have an associated boolean tag that will trigger the record publish. The location of this boolean tag is defined in the Record - Advanced Settings section.

Records are published via an MQTT client using a Sparkplug-like format such as spBv1.0/Group/NRECORD/Edge or spBv1.0/Group/DRECORD/Edge/Device  

Image Added

The configuration sections available are Tag Settings, Sparkplug Settings and Advanced Settings.

Anchor
RecordsTagSettings
RecordsTagSettings
Records - Tag SettingsImage Added

  • Tag Provider
  • Tag Provider
    • Free form field for the name of the tag provider (i.e. default)
  • Tag Folder Path
    • Free form field for the path to the tag folder under specified tag provider.
    • Do not include the provider name. For a tag path of [default]Edge Nodes/G1/E1/MyRecord, enter Edge Nodes/G1/E1/MyRecord
  • Record Type
    • Free form field for the type name of record represented by the tags in the folder paththe tag provider (i.e. default)
  • Tag Folder Path
    • Free form field for the path to the tag folder under specified tag provider.
    • Do not include the provider name. For a tag path of [default]Edge Nodes/G1/E1/MyRecord, enter Edge Nodes/G1/E1/MyRecord
  • Record Type
    • Free form field for the type of record represented by the tags in the folder path
    • This will be included in the NRECORD or DRECORD data and used by MQTT Recorder when creating DB tables or filtering the data inserted into the DB

Anchor
RecordsSparkplugSettings
RecordsSparkplugSettings
Records - Sparkplug Settings

To publish records, MQTT Transmission needs a Transmitter set upMQTT Transmission uses a configured Transmitter. The properties entered into the Sparkplug settings for Group ID, Edge ID and Device ID (optional) must match an existing Transmitter configuration. Image Modified

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

...

    • The Group ID as configured for an existing Transmitter configuration.
  • Edge Node ID
    • The Edge Node ID as configured for an existing Transmitter configuration.
  • Device ID
    • The Device ID as configured for an existing Transmitter configuration. (Optional)

Anchor
RecordsAdvancedSettings
RecordsAdvancedSettings
Records - Advanced Settings

Each record will have an associated boolean tag that is used to trigger the on demand publish of the record. The Advanced settings manage the location and naming of this boolean tag.Image Added

  • Override Publish Tag
    • When unchecked, the tag used to control the record publish will be created within the record defined folder path and named "Publish"
    • When checked, the tag used to control the record publish will be created using the Publish Tag Path property
  • Publish Tag Path
    • Defines the tag path for the boolean tag used to control the record publish
    • This can be used to simple create a tag in the record defined file folder with an alternate name to "Publish" or to have the tag located in a separate folder
    • The full tag path, including the tag provider, needs to be used for example: [default]Edge Nodes/G1/E1/RecordControl/PublishEvents or [default]Edge Nodes/G1/E1/D1/Alarm/PublishAlarms
  • Override Publish Tag
    • Checkbox to override the default 'Publish Tag' in the Record defined folder path 
  • Publish Tag Path
    • Overrides the default 'Publish Tag' in the Record defined folder path 

Anchor
Files
Files
Files

The 'Files' tab allows for the configuration to publish files which are transferred using Sparkplug over MQTT.

...