Versions Compared

Key

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

...

Anchor
General
General
General

MQTT Recorder receives records from MQTT Engine and automatically generates database tables and populates the rows within the tables with the records as they are received.

Records are published in a Sparkplug-like format on a topic such as spBv1.0/group/NRECORD/edgenode or spBv1.0/group/DRECORD/edgenode/deviceand a payload in JSON format containing the metric name as the Record Type and associated tags such as:

{"timestamp":1671052287150,"metrics":[{"name":"Event","timestamp":1671052286643,"dataType":"String","properties":{"Description":{"type":"PropertySet","value":{"fieldValue":{"type":"String","value":"MyEvent"}}},"RunNumber":{"type":"PropertySet","value":{"fieldValue":{"type":"Int32","value":1}}},"DataSource":{"type":"PropertySet","value":{"fieldValue":{"type":"String","value":"true"}}}}}],"seq":4}


These are the general MQTT Recorder configuration settings and there is a single Main section available.

...

  • Enabled
    • Checkbox to enable/disable the MQTT Recorder module. Selected by default.
  • Datasource
    • A dropdown list to select the database connection to use for record storage.  This list is populated with the database connections set up within the Ignition Gateway.
  • Partition Period
    • The partitioning period to use for record tables within database.  Each table name will be appended with a date indicating the partition time period.  For example, if table were created for "alarm" records on December 10, 2022 at 2:00 AM, the table name for each partition type would be:
      • None: tablename
      • Hourly: tablename_2022_12_10_02
      • Daily: tablename_2022_12_10
      • Weekly: tablename_2022_49
      • Monthly: tablename_2022_12
      • Yearly: tablename_2022

...

By default, a single table will be defined for MQTT Recorder with a table name of rs_${type}. With this single table definition, a separate table will be created for each unique record type however you can create custom table names using the additional filters described below. 

Anchor
TablesMain
TablesMain
Tables - Main

...