Versions Compared

Key

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

...

  • timestamp
    • The time stamp the payload was created
  • metrics
    • An array containing data specific to the message type being published
    • Each object in the array will Parameters include:
      • name
        • Included in BIRTH and DATA messages
        • Set to null in DATA messages if aliasing used
      • timestamp
        • Included in BIRTH and DATA messages
      • dataType array
        • Included in BIRTH and DATA messages
      • value
          Optional parameters included in the object include:
            • Included in BIRTH and DATA messages
          • alias
            • Included in BIRTH and DATA messagesTied
            • Set to name on null in BIRTH and included in all later DATA messages  DATA messages if aliasing not used  
          • isHistorical
            • Included in BIRTH and DATA messages
            • Flag denoting the metric represents a historical value
            • Set to null for live data and True for historical data 
          • isTransient
            • Included in BIRTH and DATA messages
            • Flag denoting the metric is a transient value
            • Set to null 
          • isNull
            • Included in BIRTH and DATA messages
            • Flag denoting the metric has a null value
          • metaData
            • Included in BIRTH messages
            • Includes Tooltip and Documentation if they have been changed from the Ignition default. See the Ignition Tag Properties reference for all available properties.
          • properties
            • The Quality property
              • May be included in BIRTH and DATA messages
              • If the Quality property is not included, the quality of the tag data is considered Good. See the Ignition Tag Quality Code Reference for the Data Quality value reference
            • Additional property values
              • Only included Included in BIRTH messages
              • Included if they have been changed from the Ignition default or if they are custom properties. See the Ignition Tag Properties reference for all available properties.
      • seq
        • The message sequence number used to ensure that messages are processed in the correct order
      • uuid
        • Set to null
      • body
        • Set to null

      ...