Page History

...

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:

...

Anchor
Definitions Definitions

Definitions

...

1. From the EFM ABB Totalflow Settings, define/upload the global Array-Register definitions available for all Totalflow devices in this Ignition instance
   
   

2. From the EFM ABB Totalflow Settings, define/upload the global Totalflow applications definitions available for all Totalflow devices in this Ignition instance.

   Note
   This step is optional since many application definitions are provided by the driver by default.

   
   

3. From the EFM ABB Totalflow Settings, define/upload the EFM Mappings for all Totalflow devices in this Ignition Instance
   
   
4. From the OPC UA Device Connections, create the base device connection to the ABB Totalflow unit.
   
   
5. Once the device is created, you should see it is listed in the devices section with a status of either 'Auto-discovery' or 'Connected' on success, or "Not Connected" or "Security Failed" on failure. If device is configured with the 'Enable auto-discovery' option turned on, wait for auto-discovery to complete. When auto-discovery is completed, the device status changes from 'Auto-discovery' to 'Connected'.
   
   
6. Navigate to the 'Totalflow Applications' configuration panel. If 'Auto-discovery' is enabled, that applications are there. If this configuration option is disabled, manually import the application information.
   
   
7. Navigate to the 'Totalflow Applications Definitions' configuration panel. If 'Add All Totalflow Applications Definitions' is enabled, verify that all global applications definitions are added to this device definition. If this configuration option is disabled, manually add global applications definitions that apply.
   
   
8. Navigate to the 'Array-Register Definitions' configuration panel. If 'Add All Array-Register Definitions' is enabled, verify that all global Array-Register definitions are added to this device definition. If this configuration option id disabled, manually add global Array-Register definitions that apply.
   
   

9. Navigate to the 'Array-Register Templates' configuration panel. If 'Auto-Generate Templates and Poll Group' is enabled, verify the default templates are added to this device definition. If this configuration option is disabled, manually import the templates that apply.

   Note
   How does the ABB Totalflow driver select which files to parse from the supplied INI file?

   
   

   Warning

   One default Array-Register template will be created per each application type (i.e. application enumeration) given that polling for at least one instance of this application type is enabled in the 'Totalflow Applications' panel. If there are no enabled applications at the time auto-discovery runs for the first time, no Array-Register templates will be created. If there are enabled applications but there are no Array-Register definitions applied to this device connection, or definitions that are applied have no applicable entries based of application enumeration; in this case, Array-Register templates will be created but those templates will have no entries. If applicable Array-Register definitions are added later, templates will be populated.

   
   

10. Navigate to the 'Poll Groups' configuration panel. If 'Auto-Generate Templates and Poll Group' is enabled, verify the default poll groups are added to this device definition. If this configuration option is disabled, manually import the poll groups that apply.
    
    
11. Go to device configuration and disable all three options under the 'Auto Setup' category. Disabling 'auto-discovery' allows faster transition from connection establishment to polling. Disabling 'Auto-generate Templates and Poll Group' will allow you to delete default templates and poll groups without the driver trying to regenerate them.
    
    
12. Navigate to the 'Poll Groups' configuration panel and follow the 'Edit Poll Group Contents' link for the 'Default Poll Group'. Check the 'Enabled' box for each default poll group entry and click the 'Save' buttons twice: one time to save poll group entries, and another time to save poll groups. The device status will shortly change from 'Connected' to 'Polling'.
    
    

...

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

• Setup an SQL database connection
• Configure MQTT Engine
  • Add/update the Server configuration to point to the MQTT server
• Configure MQTT Recorder and configure it to use SQL database connection (previously set up in the Ignition 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.