Page History

...

The connection status of each server can be seen in the 'Status' column .with options:

• Connected
• Disconnected
• Not Licensed

The configuration sections available are Main, TLS, Advanced and Advanced Legacy State

...

Selecting Edit for Elecsys will bring up two three tabs - General, Sets and Filters

Selecting Edit for Sparkplug A will bring up two three tabs - General, Sets and Filters

Selecting Edit for Sparkplug B will bring up four five tabs - General, Sets, Filters, Files and String Conversions

Selecting Edit for Xirgo will bring up one two tabs - General and Sets

Anchor
NamespacesDefaultGeneralNonSparkplugB NamespacesDefaultGeneralNonSparkplugB

Namespaces Default Non Sparkplug B - General

...

• Name
  • A friendly name of the namespace to easily identify it.
• Enabled
  • Whether or not the namespace is enabled. 
  • If enabled, MQTT Engine will subscribe to the topics necessary to provide support for devices and data associated with that namespace.  If disabled, MQTT Engine will unsubscribe from those topics and no longer support the devices and data associated with that namespace.
• Default Tags Enabled
  • Included in release 4.0.23 and newer
  • Enable MQTT Engine tags in the 'Edge Nodes' folder prefixed by the Sparkplug IDs
• UNS Tags Enabled
  • Included in release 4.0.23 and newer
  • Enable MQTT Engine tags in a specified folder using the metric path as the tag path
• UNS Folder Prefix
  • Included in release 4.0.23 and newer
  • The MQTT Engine folder prefix to use for UNS tags

Anchor

...

NamespacesDefaultSets

...

NamespacesDefaultSets

Namespaces Default -

...

Sets

From release

Namespace filters allows you to specify Group or Group/EdgeNode combinations which will be included in the MQTT Engine subscriptions for this specific namespace.

From MQTT Engine 4.0.16 and newer, it also allows for the filters to be applied to specific MQTT Servers.

Image Removed

...

• The Group ID to be included in the MQTT Engine subscriptions for this specific namespace. 

26, a specific Server Set(s) can be associated with the Namespace

Image Added

• Server Set
  • A dropdown list of the existing sets configured under MQTT Engine Settings > Sets

Anchor
NamespacesDefaultFilters NamespacesDefaultFilters

Namespaces Default - Filters

Namespace filters allows you to specify Group or Group/EdgeNode combinations which will

...

be included in the MQTT Engine subscriptions for this specific namespace.

...

• A comma separated list of MQTT Server names to apply the filter to. If left blank, it will apply to all MQTT Servers

From MQTT Engine 4.0.16 and newer, it also allows for the filters to be applied to specific MQTT Servers.Image Added

• Group ID
  • The Group ID to be included in the MQTT Engine subscriptions for this specific namespace. 
• Edge Node ID
  • Edge Node ID to be included in the MQTT Engine subscriptions for this specific namespace.
• MQTT Server List
  • A comma separated list of MQTT Server names to apply the filter to. If left blank, it will apply to all MQTT Servers

Additional detail on the default namespaces is available here.

Anchor
NamespacesDefaultFiles NamespacesDefaultFiles

Namespaces Default - FilesImage Added

• Main
  • Ignore Files
    • Default

Additional detail on the default namespaces is available here.

...

Image Removed

• Main
  • Ignore Files
    • Default: Unchecked.
    • If checked, all published files will be ignored
  • File Host Type
    • Default: ACTIVE. Host will send message ACKs back to MQTT Transmission acting as an Active Host
    • Options are ACTIVE and PASSIVE

Image Added

• Location
  • Base File Directory
    • The directory to store files when 'Ignore Files' is unchecked
  • Add Topic Tokens
    • Default: Checked. If selected, appends the Group ID, Edge Node Id and device ID to the Base File Directory when storing files
  • File Storing Policy
    • The file policy for storing incoming files. Options are REPLACE_EXISTING_FILE and KEEP_EXISTING_FILE
    • Default: REPLACE_EXISTING_FILE
  • File Attributes Policy
    • The policy for handling basic file attributes such as CreationTime, LastModifiedTime and LastAccessTime of incoming files. Options are IGNORE, APPEND_TO_FILENAME, UPDATE_FILE_ATTRIBUTES and APPEND_AND_UPDATE
    • Default is IGNORE

...

Each custom namespace configuration has two three parts - General, Sets andString Conversion. 

Anchor
NamespacesCustomGeneral NamespacesCustomGeneral

Namespaces Custom General

...

Anchor
NamespacesCustomGeneralMain NamespacesCustomGeneralMain

Namespaces Custom - General MainImage Added

Image Removed

• Name
  • A friendly name of the namespace to easily identify it.
• Subscriptions
  • A comma separated list of subscriptions and supports both the multi-level (#) and single level (+) wild card characters.

  • (+) is a a single level wildcard that matches any name for a specific topic level. This can be used instead of specifying a name for any topic level in the topic filter.

  • (#) is a multi level wildcard that can only be used at the end of the topic filter as the last level and matches any topic whose first levels are the same as the topic levels specified at the left-hand side of the # symbol.

...

...

Anchor
NamespacesCustomGeneralOptional NamespacesCustomGeneralOptional

Namespaces Custom - General Optional

Image Added

• Root Tag Folder
  • A name of a folder where all tags will be stored.  If configured, this folder will be the base folder where all tag paths will start.
• Tag Name
  • A tag name to be used for all tags.  If not configured, the last token in the topic will represent the tag.
• JSON Payload
  
  • Optional flag to indicate that the content of the string based payload is a JSON object.
• Encoding Charset
  
  • The encoding format to use when not parsing as JSON.

Anchor
NamespacesCustomGeneralAdvanced NamespacesCustomGeneralAdvanced

...

Namespaces Custom - General

...

Advanced

Image Removed

• Root Tag Folder
  • A name of a folder where all tags will be stored.  If configured, this folder will be the base folder where all tag paths will start.
• Tag Name
  • A tag name to be used for all tags.  If not configured, the last token in the topic will represent the tag.
• JSON Payload
  
  • Optional flag to indicate that the content of the string based payload is a JSON object.
• Encoding Charset
  
  • The encoding format to use when not parsing as JSON.

...

Image Added

• Writable Tags
  • Enables writes on tags created by the Custom Namespace.
  • This will only make the tags writable and does not result in outgoing MQTT messages. Review this tutorial for writing back to an Edge device from a custom namespace tag.
• Numbers as Floats (added 4.0.28)
  • Treat all numbers as decimal numbers when creating tags. 

Anchor
NamespaceCustomSets NamespaceCustomSets

Namespaces Custom - Sets

From release 4.0.26 a specific Server Set(s) can be associated with the NamespaceImage Added

• Server Set
  • A dropdown list of the existing sets configured under MQTT Engine Settings > Sets
  Writable Tags
  • Enables writes on tags created by the Custom Namespace. Note: This will only make the tags writable; it will not result in outgoing MQTT messages.

Anchor
NamespacesCustomStringConversion NamespacesCustomStringConversion

Namespaces Custom - String Conversion

...