Versions Compared

Key

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

...

AARs are polled at a specified interval based on a poll rate and then made available via the OPC-UA interface.

  Alarms, events, and history are made available to MQTT Transmission to be published as immutable Record objects to an MQTT server.  Typically these would be received by the MQTT Engine and MQTT Recorder modules running on a central Ignition Gateway and inserted into a database for later use or to be made available to other third party systems.

Common File Exchange (CFX) can also be used for these record data.


The quickstart will guide you through setting up the EFM ABB Totalflow driver module and configuring the device connection to:

...

ModuleParameterDefinition
EFM ABB Totalflow SettingsArray-Register Definitions (Global)

The global Array-Register definitions made available to the EFM ABB Totalflow module.  They are uploaded to the Ignition instance either as individual INI files or as ZIP archives that contain INI files.  Note that INI files are text files that are read by PCCU or WinCCU to determine how to display data within an application. These global Array-Register definitions can be referenced by the configurations of the individual ABB Totalflow devices that they apply to. A single Ignition Gateway may contain multiple global Array-Register definitions files that are used to configure Array-Register Templates (i.e. templates that contain array, register, access type, data type, and register name info) for available application types (enumerations)

EFM ABB Totalflow SettingsTotalflow Applications Definitions (Global)

The global Totalflow Applications Definitions are uploaded to the Ignition instance as individual CSV files and contain the following information about Totalflow applications:

    • Enumeration number
    • Name
    • Type
    • An optional flag (SU) that indicates that this is a 'Selectable Unit' application 
    • Part number(s)
EFM ABB Totalflow Settings Mappings

The periodic mapping files are used for building up EFM Periodic and Daily History records.  They map various record fields to database column names so that user can adjust those column names to match requirements.  Periodic mappings also allow to exclude certain record fields to be used. They are uploaded to the Ignition instance in the form of specifically formatted CSV files

OPC UA Device Connection

Totalflow Applications

This is a list of applications (fields include respective name, slot number, enumeration, revision and type) that are currently installed on a Totalflow device. This list is obtained either by 'auto-discovery' process that takes place on  configuration/restart or by importing specifically formatted CSV file

OPC UA Device ConnectionTotalflow Applications Definitions (Device)

These are a subset of the global Totalflow Applications Definition files that apply to a specific device

OPC UA Device Connection

Array-Register Definitions (Device)

These are a subset of the global Array-Register definition files that apply to a specific device
OPC UA Device ConnectionArray-Register TemplatesArray-Register templates are logical groupings of AARs.  Generally, Array-Register templates would be created so that instances of them can be used by specifying a poll group with application slot number
OPC UA Device ConnectionPoll GroupsPoll groups use Array-Register templates in conjunction with application slot number to create a specific groups of register sets (i.e. sets of consecutive array registers) to be polled at a specified poll rate

...

  • Save poll group configuration and the device status should change from 'Connected' to "Polling"

  • At this point, custom Array-Register template and poll group can be exported as CSV files so that they can be reused
  • Open Ignition Designer and view the tags created:

Anchor
#ViewHistoryData
#ViewHistoryData

...

Viewing Record Data

Record data can be viewed in a couple of ways:

  • Using Common File Exchange (CFX)
  • Publishing as an immutable record object

Using Common File Exchange (CFX)

If using Common File Exchange (CFX), the record data will be stored/maintained in CFX.MD5 files on the local Ignition instance. See the ABB Totalflow Device Connection configuration for more details. 

These files can be transferred from the Edge device using any method you choose such as FTP but can also be published using the MQTT Transmission File Publishing option.

To do this, you will need to configure an MQTT Transmission File Record and set the CFX File Transfer parameter to point to that File Record and the CFX files can then be automatically published. See the Creating and Publishing Common Exchange File CFX tutorial for details.

Publish as an immutable record object

To publish and view record data which includes ABB Totalflow alarms, events, and history data you To view record data which includes ABB Totalflow alarms, events, and history data you must have MQTT Transmission installed on the instance with the EFM ABB Totalflow driver.

In addition, the following must be set up:

At the Central Gateway:

At the Edge Gateway:

  • previously set up in the Ignition Gateway)

At the Edge Gateway:

  • Configure MQTT Transmission
    • If you do not have a Transmitter configured, create an MQTT Transmitter and set the Sparkplug Settings to the unique Group and Edge Node ID values generated by the Device Connection configuration.

    • If a Transmitter already exists, for example to publish the polled/live data, you can edit the Group and Edge Node IDs to match the existing Sparkplug Edge Node created by the Transmitter.
    Configure MQTT Transmission
    • Add/update the Transmitter configuration and/or the Tag folders so that an Edge Node is reporting with a Group ID, Edge Node ID, and Device ID (for example: G1, E1, D1)
    • Add/update the Server configuration to point to the MQTT server
    • From Ignition Designer, use the MQTT Transmission 'Refresh' Mechanism to make sure it is connected and reporting.
  • Configure EFM ABB Totalflow ROC module
    • The Alarm, Event, and/or History poll rates in the Emerson ROC ABB Totalflow driver device configuration must be greater than zero depending on which data you wish to collect

...

    • For Events and/or History data set the respective poll rates to zero and set the 'Record Info Scan Rate' option to a positive number 

      Note

      Alarms can come from two sources:

      PERIODIC_HISTORY_RECORDS - Alarms are obtained from the Log Period records (Array 250) and in this case the 'Alarm Scan Rate' should be set to -1.

      ALARM_LOG_RECORDS - Alarms are obtained from only meters with the enhanced option turned on


      Warning
      Must have a Sparkplug Group ID , and Edge Node ID, and Device ID specified in the device Device Connection configuration that matches the a Sparkplug Edge Node /Device that MQTT Transmission is reporting on


...

As a result, a default Array-Register Template is generated by the driver for a specific application enumeration, and it contains all Array-Register points found in appropriate INI files.


Excerpt Include
CLDCLD80:FAQ: Ignition ModulesCLD
CLD80:FAQ: Ignition Modules
nopaneltrue

...