Page History

...

The ABB Totalflow driver module provides a configuration section to the Ignition Gateway.  These can be seen in the Configure section of the Ignition Gateway web UI on the left panel near the bottom. Once in the configuration screen there will be a link to create new global Array-Register definitions.  Click the link shown below to create a new one.

Image RemovedImage Added

Note that it is the best practice to add global Array-Register definitions before any Totalflow device connections are defined. If an Array-Register definition is added later, it needs to be added to a device connection manually. Even if device connection has the 'Add All Array-Register Definitions' option turned on, new global Array-Register definition will not be applied unless either added manually or device configuration is re-submitted.

When creating a new global Array-Register definition, only a name and a Totalflow INI file(s) needs to be specified.  The name can be any unique name that describes the Array-Register definitions included in submitted file(s). Totalflow INI files are configuration files for use with
PCCU and G2-G5 and NGC devices. Note that multiple Totalflow INI files need to be supplied in a ZIP archive. 

Image RemovedImage Added

Note that definition archive file may contain lots of INI files. For example, the ArrayRegisterDefinitions.zip file shown above contains 1477 files.  So it worth explaining how the ABB Totalflow driver selects which files to parse...  When global Array-Register definitions are applied to a device connection, the driver uses application revision information obtained during the 'auto-discovery' process described later in this document and selects INI file names that match application revision and variant numbers.  As an example, below is application information obtained during the auto-discovery:

...

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

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.

...