Page History

...

• Array-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).
• Totalflow 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 Mappings
  • Periodic 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. 

...

• 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. 
• Array-Register Totalflow Applications Definitions (Device)
  • These are a subset of the global
  Array-Register definition
  • Totalflow Applications Definition files that apply to a specific device.
• Array-Register Definitions (Device)
  • These are a subset of the global Array-Register definition files that apply to a specific device.
• Array-Register Templates
  • Array-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.
• Poll Groups
  • Poll 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.

There are nine eleven basic steps to getting all of the data available from a ABB Totalflow into Ignition

1. Define/upload the global Array-Register definitions available for all Totalflow devices in this Ignition instance
2. Define/upload the global Totalflow applications definitions available for all Totalflow devices in this Ignition instance. Note that this step is optional since lots of application definitions are provided by the driver by default.
3. Define/upload the EFM Mappings for all Totalflow devices in this Ignition Instance
4. Create the base device connection to the ABB Totalflow unit.
5. 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'. Go to the 'Totalflow Applications' configuration panel and verify that applications are there. Note that polling on all meter applications (i.e. TUBE applications) will be enabled by default. If device is configured with auto-discovery disabled, import application information from a 'Totalflow Applications' CSV file that contains correct information on applications instantiated on a Totalflow device the driver is connected to.
6. If device is configured with the 'Add All Array-Register Totalflow Application Definitions' option turned on, navigate to the 'Array-Register Totalflow Applications Definitions' configuration panel and verify that all global applications definitions are added to this device definition automatically. If this configuration option turned off, manually add global applications definitions that apply.
7. If device is configured with the 'Add All Array-Register Definitions' option turned on, navigate to the 'Array-Register Definitions' configuration panel and verify that all global Array Array-Register definitions are added to this device definition automatically. If this configuration option turned off, manually add global Array-Register definitions that apply.
8. If device is configured with the 'Auto-Generate Templates and Poll Group' option turned on, default Array-Register templates and default poll group will be generated. Navigate to the 'Array-Register Templates' and 'Poll Groups' configuration panels and verify templates have been created correctly. There are a few important points to note here:
   1. 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.
   2. If there are no enabled applications at the time auto-discovery runs for the first time, no Array-Register templates will be created.
   3. 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. 
9. Go to device configuration and disable all three options under the 'Auto Setup' category. Disabling auto-discovery will allow to get to the polling mode right after device connection is re-established. Disabling default templates auto-generation will allow to delete default templates and poll group without driver trying to regenerate them.
10. 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'.
11. Use Ignition Designer to pull tags into a tag provider.

...

When creating a new device you will see the following:

Image Added

Image Added

Image Added

Image AddedImage Removed

The following describes the parameters that can be set here:

...

• Enable auto-discovery
  • Enables ABB Totalflow driver to run application auto-discovery at startup and re-configuration.
• Add All Totalflow Application Definitions
  • Automatically add all Totalflow Applications definitions configured within the ABB Totoalflow driver module.
• Add All Array-Register Definitions
  • Automatically add all the Array-Register definitions configured within the ABB Totoalflow driver module.
• Auto-Generate Templates and Poll Groups
  • Automatically generates default Array-Register templates and default poll group on startup and reconfiguration. Note that default Array-Register template will be generated for specific application type (enumeration ) if polling is enabled (see the 'Totalflow Applications Panel' below) for at least one of applications of this type. Another requirement for the default Array-Register template to be generated is that there should not be no any custom template for this application type.    for the default Array-Register template to be generated is that there should not be no any custom template for this application type.

Import Policies

• Array-Register Template Import Policy
  • UPDATE - update existing Array-Register Templates
  • REPLACE - replace existing Array-Register Templates
• Poll Group Import Policy
  • UPDATE - update existing poll groups
  • REPLACE - replace existing poll groups

DB2 Protocol

• Station ID
  • Station ID of this ABB Totalflow device
• Keep Alive
  • Time interval (in seconds) between 'keep-alive' polls that may be required to maintain PERSISTENT connection if ABB Totalflow device is configured to disconnect on inactivity. To disable 'keep-alive' polls, set to 0. 
• Host Timeout
  • Timeout (in milliseconds) to wait for a reply from the host. The default value is 3000 milliseconds.
• Poll EOT Timeout
  • Time (in milliseconds) to wait to ensure there are no more packets to receive. The default value is 700 milliseconds.
• Auto-Discovery EOT timeout
  • Time (in milliseconds) to wait to ensure there are no more packets to receive during auto-discovery. The default value is 2000 milliseconds. 
• Number Retries
  • Number of retries if DB2 request is NAKed.
• Supervisory Frames
  • Number of DB2 supervisory frames.
• Password
  • DB2 Protocol Security Code. If device is set with default security code of 0000, leave blank.

...

• RBAC Enabled
  • Enables Role-Based Access Control (RBAC) is enabled on the device and therefore the X_RBAC frame needs to be included in the DB2 request message.
• Operator ID
  • Operator ID.  If RBAC is not enabled on the device, leave blank.
• Password
  • Operator password. If RBAC is enabled on the device, leave blank.

Date/Time

• Date Time Offset
  • The date time offset of the Totalflow device clock from the Ignition system running this driver in seconds.

Records

• Alarm Source

  • Alarm source selector.

    • PERIODIC-HISTORY_RECORDS - alarms are obtained from Periodic History records.
    • ALARM_LOG_RECORDS - alarms are obtained form Alarm Log records.
• Alarm Scan Rate
  • The rate in seconds that Alarm Log Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Alarm polls, set to -1.
• Event Scan Rate
  • The rate in seconds that Event Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Event polls, set to -1. 
• Periodic History Scan Rate
  • The rate in seconds that Periodic History Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Periodic History polls, set to -1.
• Daily History Scan Rate
  • The rate in seconds that Daily History Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Daily History polls, set to -1.
• Record Info Scan Rate
  • The rate in seconds for the 'Record Info Registers' (i.e. History, Event and Alarm record capacity, last sequence number, etc.) to be scanned.
    If new Event, History, or Alarm Log records are detected, respective poller(s) will be notified. To disable 'RecordInfo' polls, set to -1. Set to 0 for one-shot 'Record Info' poll.
• Max. Records to Read
  • Maximum number of records to read in one poll.
• Periodic Mapping
  • The mapping of Totalflow LOG_PERIOD and DAILY structures to Flowcal Meter Periodic Transactions.

...

• Group ID
  • An ID representing a logical grouping of Edge Nodes and Devices
• Edge Node ID
  • An ID representing an Edge or Network (EoN) Node
• Device ID
  • An ID representing a Device

Miscellaneous

• Use INI Categories
  • Enables appending INI Category names to tag folder paths

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.

...