SCADAvantage Technical Description March 2012 revision 0.1
ABB Inc. SCADAvantage Blackfoot Corporate Center #110, 4411 6Th Street S.E. Calgary Alberta T2G 4E8 Canada +1 403 253 0271
SCADAvantage Technical Description
Revision: 2012
Table of Contents SCADAVANTAGE SYSTEM SOFTWARE .................................................................................................4 GENERAL SOFTWARE OVERVIEW ...................................................................................................5 STANDARD PACKAGES ................................................................................6 OPERATING SYSTEMS .................................................................................7 NEW SOFTWARE .........................................................................................7 DIAGNOSTICS .............................................................................................7 LANGUAGES ...............................................................................................7 UTILITIES ....................................................................................................7 DEVELOPMENT AIDS ...................................................................................7 APPLICATION PROGRAM INTERFACE (API) ...................................................8 SYSTEM SECURITY AND VIRUS PROTECTION................................................8 HIGH-LEVEL DEBUG ....................................................................................9 VIRTUALIZATION..........................................................................................9 DATABASES AND TOOLS ................................................................................................................9 REAL-TIME DATA ........................................................................................9 GENERAL DATABASE OVERVIEW ...............................................................10 DATABASE EDITOR ...................................................................................13 REAL-TIME DATABASES ............................................................................15 HISTORICAL DATABASE .............................................................................16 SCADAVANTAGE SYSTEM OPERATION ........................................................................................19 OPERATING SYSTEM START-UP AND SHUTDOWN .......................................19 SCADAVANTAGE SYSTEM START-UP AND SHUTDOWN ..............................20 BACKUP 20 DATA ACQUISITION ......................................................................................................................21 METHODOLOGY ........................................................................................23 DATA POLLING ..........................................................................................24 ERROR HANDLING ....................................................................................24 COMMUNICATION STATISTICS ....................................................................24 COMMUNICATION ALARMS .........................................................................25 RTU ON/OFF SCAN CAPABILITY ................................................................25 COMMUNICATION DATA ANALYSIS UTILITY .................................................25 PROTOCOLS .............................................................................................26 RTU TIME SYNCHRONIZATION ...................................................................26 DEVICE SCHEDULER .................................................................................27 PERFORMANCE AND CAPACITY..................................................................27 DATA PROCESSING FUNCTIONS ...................................................................................................27 COMMON DATA PROCESSING FUNCTIONS .................................................27 DIGITAL DATA ...........................................................................................31 ANALOG DATA ..........................................................................................32 ACCUMULATOR PROCESSING ....................................................................34 CONTROLS ...............................................................................................36 ALARM AND EVENT PROCESSING ..............................................................38 SPECIAL APPLICATIONS ............................................................................40 LOCAL AND OFF-SITE REDUNDANCY ............................................................................................42 LOCAL REDUNDANCY ................................................................................43 OFF-SITE BACKUP/DISASTER RECOVERY ..................................................44 Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
REPORTS ....................................................................................................................................45 REMOTE ACCESS ........................................................................................................................46 OPC SERVER ..............................................................................................................................46 GAS MEASUREMENT ....................................................................................................................46 REPLICATION ...............................................................................................................................47 REAL-TIME ...............................................................................................48 SQL SERVER ...........................................................................................48 GRAPHICAL USER INTERFACE (GUI).............................................................................................49 DATABASE MANAGEMENT .........................................................................55 LICENSING...................................................................................................................................57 SOFTWARE PATCHING .................................................................................................................57 SCADAVANTAGE PATCHING ........................................................................................................57 MONTHLY MICROSOFT SECURITY UPDATES..................................................................................60 APPENDIX A – MICROSOFT AND OTHER TECHNOLOGY SUPPORT......................................................62 APPENDIX B – SCADAVANTAGE APPLICATIONS, TOOLS AND UTILITIES ............................................63 GLOSSARY ........................................................................................................................................67
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
SCADAVANTAGE SYSTEM SOFTWARE ABB has developed SCADAvantage specifically for the oil and gas industry, the system is the result of feedback from operators and engineers that have use it for years. ABB Oil and Gas business unit invests research and development funds each year into the SCADAvantage product. As a result SCADAvantage is positioned as the industry leader in upstream, pipelines and gas distribution SCADA for the petroleum industry in many countries in the world. The strategy has always been to produce a flexible, scalable system that serves from a simple HMI to the complexity of enterprise SCADA. For this, the system supports open international standards of connectivity and it is easily distributed in layers of servers to ensure availability and performance. Other area of investment is the asset optimization using Foundation Fieldbus, HART and Profibus. This brings the benefits of SCADA to a new level to enhance our current offering to the oil companies. For advanced optimization applications, we integrate best-in-class 3rd party applications either directly into SCADAvantage, or pass field data to corporate IT data warehouses for analysis at that level. The SCADAvantage System is built with special focus on operations where high reliability and availability are essential. Additionally, most system components (I/O, communications, remote devices, servers, clients and networks) can be configured with redundancy to achieve even higher levels of system reliability. The focus on high reliability is reflected in the design of all units; in system architecture, hardware with rugged units for industrial environments, and in the software design. The SCADAvantage system was designed to be an enterprise SCADA system; therefore, high number of client workstations can be configured at no additional cost. Since the Client Application Manager server (CAM) comes standard, there is no additional effort to distribute screens or any file to the corporate client workstations. The SCADAvantage client workstation software installs in your regular desktop computer eliminating the need of a separate expensive computer to monitor real-time operations and data. System security, resistance to vulnerabilities and safe control are areas of focus in the development process to keep SCADAvantage at the forefront of the industry. Finally we are strategically teaming up with other groups in ABB to offer integration to safety systems as well as the DCS system; this allows companies to have a seamless integrated environment to tackle all aspects of automated production operations.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
General Software Overview The ABB SCADAvantage software was designed for various system architectures and scales extremely well from a single host running a small HMI to a full distributed system connecting hundreds of sites together with full disaster recovery. For local gas distribution or small gas pipeline management, the following figure represents a typical architecture for a Primary Control Center.
A polling engine connects to a variety of Communication Equipment to monitor data from field devices using the most common industry protocols. This polling engine is typically started on the same computer as the real-time database, but can be started remotely. The real-time database is configured in a redundant pair where the computers are located close together for high speed failover. A private JCP network between the real-time databases provides high-speed transaction journaling. The real-time database includes a built-in historian with archiving capabilities. A SQL-Server database stores meter history and scheduled reports. A number of operator or engineering workstations can display live data from the real-time database. A decision support/utility server maintains a live copy of the real-time database to provide data for web access via Citrix or 3rd party business systems. This component is optional for smaller systems or can be an OPC Server. All components are connected by a redundant LAN. All user authentication is from a local domain controller. All time is synchronized using a local GPS clock. Any software modules that require development by ABB to meet the requirements for a project become standard features in the next version of SCADAvantage. Any custom applications specific to the project are delivered with source code and instructions on how Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
to recompile and maintain. ABB does not guarantee these custom applications shall not require further development in later versions of the baseline software package.
STANDARD PACKAGES SCADAvantage is a powerful, scalable and flexible SCADA software system designed for today’s oil & gas companies and for the future. It is a user-friendly system that is easy to configure, maintain and support, and one that integrates smoothly with other systems. All features are installed from the product DVD; nothing is hosted externally. The system includes online, searchable help and a detailed description of the database model. Some of the distinguishing features of SCADAvantage are as follows: •
A network-accessible, object-oriented, relational non-proprietary database enforcing data integrity and responding to standard SQL.
•
A device interface (DVI) that is capable of collecting data from multiple device types and from automation systems produced by other vendors; the DVI (polling engine) can poll multiple devices with different protocols at the same time through one serial port. This feature enables the SCADA system to collect data from many different RTU’s during one scanning cycle.
•
Network-capable configuration tools to browse and configure data, either point-by-point or in bulk, and provide low-level system access a full-featured runtime environment with extensive graphics capabilities.
•
A simple graphical design environment based on Microsoft Visual Studio; no user programming is required to create fully featured front ends for operations.
•
Optimized HMI data acquisition done using publish and subscribe technology that minimizes network traffic by pushing from the server only modified values.
•
Ability to interface to EFM’s beyond simple polling of real-time "end of day" values; this includes managing history records, AGA parameter upload/download, gas composition upload/download and events and alarms from the EFM with storage/manipulation of EFM data according to API 21.1 and EUB Directive 17 standards.
•
A Windows Explorer-type interface to provide global access to SCADAvantage system configuration allowing system administrators to carry to any workstation their roaming profile. The ability to import and export some or all parts of the system configuration is also provided by this tool.
•
Multiple alarm states (more than 50) provide advanced diagnostic information so you can fully monitor the process and avoid costly downtimes.
•
Real-time server redundancy allowing the system to run with an active/standby configuration.
•
Real-time and embedded historian full online system backup for disaster recovery.
•
Multiple communication routes for networks and devices (RTU’s, PLC’s); when the system detects route failures, it automatically switches the network or device to another available communication route.
•
Ability to handle a large database with large number of client workstations.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
•
Business Object Templates (BOT) for configuring large amounts of similar devices (RTU’s, EFM’s) in a very short time. This feature saves upfront engineering costs. With a few mouse clicks, you can add and delete devices after the system is commissioned for a huge savings in operation and maintenance costs.
•
Plug-in applications, designed for the oil and gas industry.
During the warranty period and through annual software maintenance/subscription, any new features and updates are provided for all customers maintaining valid licenses through ABB.
OPERATING SYSTEMS Appendix B lists the current Microsoft operating systems and other versions of technology supported by SCADAvantage.
NEW SOFTWARE ABB’s commitment to the support of standards results in an active participation in the OPC foundation new OPC UA standards. Our existing connectivity added to other ABB products such as Enterprise Connectivity Solutions allows SCADAvantage to interface with enterprise systems such as SAP, Maximo, PI and any others. Our commitment is to strongly support these interfaces in the future.
DIAGNOSTICS SCADAvantage includes several diagnostic tools. For protocols, the built-in communication analyzer is included with features such as: packet decoding, hex code highlighting, recording to file, and advanced filtering. For system diagnostics, an event log and diagnostic text files are included. Most system components include options to enable additional debugging. For network, hardware and resource diagnostics, information is stored as real-time values in the database for alarming and trending. When Windows Authentication is enabled, the Windows Security Event Log can be used for diagnostics.
LANGUAGES SCADAvantage is written and developed in C++ (version 10) and C# (version 3.5) using Microsoft Visual Studio 2010.
UTILITIES Appendix B lists all the SCADAvantage 5.4.0 applications, tools and utilities included on the standard DVD and installed depending on the features selected. These utilities are used for deployment, maintenance, backup and recovery, operation and development.
DEVELOPMENT AIDS In order to provide a consistent and upgradable system, the real-time database schema and business logic specific to SCADAvantage is not open for customization. While it is possible to add auxiliary tables and views for custom applications, it is not possible to add custom business logic.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
In a non-production environment, the real-time database does allow an internal debugging service to be enabled. Using a telnet client, this debugging service provides the usual debugging capabilities such as code stepping, breakpoints, tracing and diagnostics. SCADAvantage uses Visual Studio for HMI graphic development. This same tool can be used for custom application development, SQL-Server database development and debugging. The Ultimate edition of Visual Studio includes additional tools for Application Lifecycle Management (ALM) like revision control, requirements management, test management and automated testing. API documentation to develop a custom protocol is currently not supplied on the product DVD. It is recommended to have ABB develop any custom protocol so that it can be maintained and delivered in future versions of the product by ABB. API documentation to further customize internal calculations, control sequence commands or functions used in software expressions is currently not supplied on the product DVD. Using API documentation, templates and examples included on the DVD, it’s possible to write additional system services in Visual Studio using any .NET programming language to monitor the database for specific changes, perform calculations and either write back to the database or interface to a 3rd party system. This is the recommend method to add new functionality to the system. The tools used during SCADAvantage product testing can be requested customers. These tools include additional low level diagnostics, test configuration and data generation, and performance testing under specific conditions.
APPLICATION PROGRAM INTERFACE (API) SCADAvantage includes libraries to support development for both server and client applications against the real-time and measurement databases. Examples and documentation are included on the product DVD.
SYSTEM SECURITY AND VIRUS PROTECTION ABB recommends all current Microsoft patches and security enhancements be installed on each SCADAvantage server on a monthly basis. Since there is no direct internet connection to the SCADAvantage servers, ABB recommends copying the required patches to an internal server first before deploying to the operations network. Updates are performed manually by the administrator as needed or on a monthly basis. ABB tests SCADAvantage using McAfee Virus Scanner. Daily virus updates must be copied to an internal server. From there the administrator can distribute the updated virus definitions. SCADAvantage includes file exceptions for scanning large files to avoid performance degradation. Updates to the virus definitions do not interfere with normal daily operations. For highly secure systems, ABB recommends Industrial Defender software and hardware solution. Using this solution, all SCADAvantage applications are configured as trusted to avoid tampering.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
ABB recognizes the threat of cyber-attacks against control systems as real and probable, as a consequence it has submitted SCADAvantage to our Corporate Research Centre in India to conduct intense vulnerability tests, and the results are as follows: 1. There were no vulnerabilities reported against the SCADAvantage application that was installed on Windows Vista Operating System. However there were several TCP and UDP ports which were in Open state. These include ports TCP/1025 to TCP/1029, TCP/2869, UDP/123, UDP/500, UDP/1900, UDP/4500, UDP/5355. It is recommended to close these ports if a similar configuration is present on the Windows Operating System. The system that was used was updated regularly and hence it was not vulnerable to any Operating System related vulnerabilities. It is recommended to update the Windows Operating System with security patches regularly. For all other tests SCADAvantage met the pass criteria.
HIGH-LEVEL DEBUG Visual Studio allows interactive debugging during HMI development for C# and VB.Net languages. On a non-production environment, such as a QA environment, server applications support command line or configuration settings to enable debugging. In addition, the real-time database supports interactive, text-based debugging of internal business logic. In some cases, ABB recommends Windows debugger to be installed in a QA environment for capturing faults within C++ applications.
VIRTUALIZATION SCADAvantage can be installed on real hardware or hosted in a virtual environment. VMware and Microsoft Hyper-V are supported. To avoid any performance issues, a SCADAvantage server running in a VM should not be allocated any CPU, memory or hard-disks that are shared with other VMs. If converting from a physical to virtual environment, it’s important to keep the same MAC address for the Central Licensing Server. The Central License software does not support any attempt to spoof the MAC address. If keeping the MAC address is not possible, please contact ABB sales or support to have your central license assigned to the new virtual MAC address. Licensing by USB dongle is not supported in a virtual environment at this time.
Databases and Tools REAL-TIME DATA On a 32-bit system the database is limited to 2GB of memory. On a 64-bit system, the database is limited to available physical memory. SCADAvantage has been tested to 250,000 tags in a redundant system with Disaster Recovery. It has been tested to 10,000 active devices and 10,000 networks. The database
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
has been tested to 100 concurrent HMI users. SCADAvantage has also been tested to 4,000 meters. The largest SCADAvantage replication deployment is distributed over 174 sites in a 3-tier network topology. 159 local sites gather information with a combined telemetry of 280,000 points. Typically, 10-15 of these sites replicate a partial copy of the telemetry to a regional site. There are 12 regional sites with a combined telemetry of 180,000 points. These regional sites replicate a partial copy of the telemetry to the Main Control Centre. The Control Centre is sized for 100,000 tags. The total tag count for the entire system is 660,000 tags. All sites are redundant. This system has been in production since 2007. The largest centrally-licensed system is sized for 265,000 tags distributed across 20 servers. Archiving of historical data online is limited only by memory and available disk space. However, typically data is maintained online for 12-24 months. A searchable online help file describing the complete database structure is installed from the product DVD on the database server. The 3rd party SqlSpec utility (http://www.elsasoft.org/) ABB uses to document the database can be purchased to document any additional custom defined tables or views.
GENERAL DATABASE OVERVIEW The SCADAvantage real-time database offers the following features: • • • • • • • • • • • • • • •
Memory resident data allowing very high speed storage, access and update A notification mechanism providing clients with information on data changes in the server ANSI Standard Structured Query Language (SQL 92), with extensions to support the object oriented features of the database Device interface for an external service to acquire data changes and rapidly store in the database Built-in historian where online and archived data can be queried as a virtual database table Compiled language for custom business logic and additional referential integrity during a transaction Mechanism to snapshot database and historical logs for backups with no downtime Mechanism to journal transactions to redundant standby server or several read-only replica copies Extensive ad-hoc query capabilities Multiple simultaneous user support Optimistic concurrency to avoid the overhead of locking and deadlocking The ability to import/export database configuration to text files The ability to import/export historical trend data to text files Database views provide security by restricting access to rows and columns of a table Standard methods to maintain security privileges are includes (such as grant and revoke)
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Using these features, the SCADAvantage real-time database provides five important functions: 1. All database operations are subject to user privileges, and enforce referential integrity. It is impossible to make a change in the database that results in a system failure or orphaned records. 2. Maintains all SCADA database configuration information, default startup values and parameters, alarm/event histories, trend data and operational information. 3. Monitors, processes and manages information acquired from remote sites. 4. Maintains historical data online for several years. Older data can be archived to multiple locations and automatically taken offline. The archived data can be stored offline for an indefinite period and brought online with no system downtime or performance impact. Tools to manage archives are included on the product DVD. 5. Provides secure access for user-interface applications or other services on the network to display or exchange data. A 64-bit database is limited to half of the available memory on the server. The other half is used by services and nightly database backup. The database has no practical limit for the number of tables and views or the number of row or columns within a table. The database supports the following data types, field sizes and value ranges: • • • •
integer - is a 32-bit signed number with a range of positive and negative whole numbers (-231 to 231 -1). integer8 - is a compact form of integer. It is treated exactly the same as an integer type, but only 8 bits are stored. integer16 - is a compact form of integer. It is treated exactly the same as an integer type, but only the least significant 16 bits are stored. varchar - is an array of ASCII characters and has no limit on the size of the array.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
• • • • •
float is a double precision (64-bit) floating point number with a range of positive and negative numbers (small +/- 10-307, large +/- 10308). float32 is a single precision floating point number. datetime contains the date and time. The information is encoded into a 64-bit value and has a resolution of micro-seconds. bool contains a value of true or false. binary is a sequence of raw bytes of data.
Database errors are displayed either to the user requesting data or to a diagnostic log for background applications. The system continues to operate reliably and predictably regardless of errors.
DATABASE ARCHITECTURE AND SYNCHRONIZATION Each SCADAvantage real-time database can be configured in a fault-tolerant pair to ensure continuous client operation, keeping the databases synchronized during normal operation, and maintaining transaction integrity. The standby database is continually informed about changes from the master. This enables the standby to take over immediately when it receives notification of a master failure. On startup, the standby automatically re-synchs the real-time and historical data from the master. Failover is either automatic due to the system detecting a critical process or resource failure or manually requested by an administrator. The real-time database includes an interactive tool for displaying query results as text, processing SQL files, and importing and exporting text-based data. SCADAvantage includes a tool for querying data and displaying it in a grid format. Information in the grid can be exported text files and Microsoft Excel. Also, tools and scripts are included for maintaining the database including upgrading from older versions and migrating from 3rd party systems.
POINT NAMING CONVENTION Every data point in the system has a unique ID that is used to refer to the corresponding tag. ABB works with customers to establish a naming convention that best suits the customer's needs. There is no limit to the length of a tag name. Any multi-byte character supported by Microsoft Windows is also supported in a tag name. This allows multiple languages to be used concurrently across HMI clients. However, tag name are casesensitive. The system provides a method to reference all of the point’s fields and attributes via standard SQL.
DATABASE ACCESS SCADAvantage provides methods to access any and all elements in the real-time and historical databases via high-level languages and functions including, but not limited to, ODBC, OLE-DB, text files, .Net languages and SQL 92 queries. ABB includes library routines to develop custom applications to access database configuration and historical data. It is also possible to access the database using common business tools such as Microsoft Office, SQL Server and text-based editing tools.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
DATA SECURITY AND INTEGRITY System security is treated in SCADAvantage with high priority, particularly in the gas distribution environment, the following features are included: •
• • • •
Database views provide security by restricting access to rows and columns of a table. Standard methods to maintain security privileges at the database level are included (such as grant and revoke) A multi-level security system that maintains a history on each user’s access to objects, attributes, data, displays, production areas and controls. Supports digital signatures and audit trail to avoid data tampering in the historical database. Zones and zone groups access control, re-routing of alarms for areas unattended by an operator and inactivity logout Independently tested by ABB Corporate research centre against Nessus tool to withstand external unauthorized access Microsoft Active Directory support for centralized security with a password policy managed by IT group such as strong passwords, Automatic password expiry, Password re-use, Account lockout on repeat violations, Password length and Login auditing.
USER-DEFINED DATABASES SCADAvantage includes licenses, software, and tools to allow Customers to define, construct, and maintain user-defined tables and views in the real-time environment. In addition, custom historical logs and views can be defined. User-defined tables/views are treated in the same manner as the standard product tables and views with regard to creation, access, editing, and distribution of data. The system allows for application programs to perform create, read, update, and delete operations on user-defined tables and views. Standard tools allow for database configuration and maintenance of user-defined tables and views. ABB does not recommend customizing the real-time database. Additional costs shall be incurred by the customer on future upgrades due to these types of database customizations.
MIGRATION OF EXISTING DATABASES TODO
DATABASE EDITOR SCADAvantage Explorer is the client application for configuring SCADAvantage real-time database online. It is based on the same style as Windows Explorer and provides global, secure access to browsing, configuring and diagnosing distributed SCADAvantage servers from any workstation. System administration and configuration operations can also be performed using SQL. SCADAvantage Explorer follows the Microsoft Windows Explorer standards for navigation, look and feel, and item selection allowing users to learn the system quickly. The main screen of SCADAvantage Explorer contains menu bar, tool bar, tree structure, summary list and logon dialog.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Trusted Users: This feature allows trusted users to log onto an RTRDB in the normal way and then automatically logon (without the need to enter a username/password combination) to other RTRDBs and APPRDBs. Roaming Profiles: This feature makes user preferences information (such as trend display preferences) roam with the user from machine to machine. Login Restrictions: This allows the system administrator to force users to have valid passwords, enable password expirations, enable inactivity logouts, and forcibly disconnect clients from the server. Each user with access to the SCADAvantage Explorer Client is assigned a case sensitive User ID and password. This dual function security system must be used to logon to any SCADAvantage server. The security system restricts a user in two ways: limiting what Zones the user can access and limiting what Control actions that user can perform within authorized zones. SCADAvantage Explorer also supports command-line options that govern its startup behavior. It is possible to access the following capabilities using either drop-down menus, popup menus (available from the server, category, class or object level), or equivalent tool bar icons: • • • • • • • • • •
Connect to any SCADAvantage server on the network Manage any number of simultaneous connections to the same server, or multiple servers Browse through objects within a class using sort, filter, and find tools Create, delete, rename, and edit objects within a class View and print various logs such as the alarm summary, event summary, message log and communications analyzer Control points and acknowledge and clear alarms View real-time and historical trends Import and export all, or parts of the database Print reports for objects in the summary table Access bulk configuration abilities through the Object Factory
All changes made from any workstation using the SCADAvantage Explorer are stored in the Maintenance Log of the real-time database for auditing purposes. The standard event summary displays the maintenance events and allows analysis through filtering on several fields including: timestamp, object, user, values, or comments. SCADAvantage configuration forms provide a structured view for configuring all objects within the database. This has many advantages over typical grid-based configuration. Specific configuration screens are provided for each type of object in the database. When objects have common configuration, a common tab within the configuration form is used to maximize design efficiency and simplify the user experience. Within the configuration form, each field includes data validation checking depending on the field type. Drop-down lists are used when referencing existing and related objects within
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
the database. Some drop-down lists include the ability to add new values. Grids are provided for entering lists of related information, for example: polling registers and timing. Grids support both filtering and sorting criteria. Default values are presented to the user whenever possible. Configuration changes including create, read, update, delete and rename are supported. When saving, error messages provide useful information to direct the user on which field is in error.
DATABASE POINT GROUPS The Point Assignment function relates one or many points to a point group. A point can be associated with any number of different point groups. Once grouped in this way, it is possible to easily work with a set of points and perform global operations. TODO • Definition • Assignment
REAL-TIME DATABASES After installation of a server a real-time database, preconfigured with standard features, is automatically started. The real-time database provides the following high-level capabilities: • • • • • • • • •
Remote data acquisition and processing Upload and download of hourly and daily measurement values High performance calculated data values Control sequences Built-in historian with archiving Secure authentication and auditing of all configuration and operational changes Real-time and historical alarm and event processing, including call-out Host metering Partial or full replication of configuration, data and history
All configuration changes performed from Engineering workstations are made online and do not require any database restart. Configuration changes are committed to all in-memory copies of the database for the save to be successful. By default the in-memory database is saved every hour but the frequency can be customized. All real-time data changes recorded to historical logs are committed to in-memory buffers. All copies of the database are then immediately synchronized (within 1 second). The data is flushed to disk as buffers are filled, or if maximum time has been exceeded. This way, no information is lost in the event of a system failure, user shut-down or restart. TODO 1.1.1.1 Server Configuration 1.1.1.2 Trusted Server Configuration 1.1.1.3 Host Configuration 1.1.1.4 System Performance 1.1.1.4.1 Capacity 1.1.1.4.2 Bandwidth Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.1.1.4.3 Concurrent Clients 1.1.1.5 Scheduled Tasks
HISTORICAL DATABASE The real-time database includes an integral historian that reads the live process values and records successive values, events and communications statistics into logs that provide a history over time. SCADAvantage polls the field for real-time data acquisition. The historical database is only limited by data collection frequency, and storage space. Missing data can be back filled automatically depending on the collection method. The historian is part of the core system and does not require additional licenses. The historian is also capable of recording any other database object derived from the point table, such as: calculated values, resource monitoring values, host calculated meters, and communication statistics. Trending in SCADAvantage is easy to use and flexible. The system stores data values for points on a periodic exception or a combination of periodic and exception basis. Once data is collected, the historical values are available for direct query (via ODBC and OLEDB), or for analysis in reports and on trend displays. When enabled, this feature provides complete hourly or daily rollup traces by repeating the last recorded value for a time period where an inconsistent number of trend data rollups are present. In addition to the raw collected values, rollups are available for each hour and day. SCADAvantage calculates the minimum, maximum, and average values for the rollup period. Standard deviation is also supported in all trends.
HISTORICAL STORAGE Data is written into these logs via memory buffers, such that the system need not constantly update the disk as new values occur. Once the memory buffers are full (or on a scheduled basis when a historian checkpoint occurs), the buffer is written to the disk. If the buffer was full, a new buffer is started. These logs are a circular queue arrangement. That means that the oldest data is eventually be overwritten by the newest data, but the files sizes remain fixed.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Log File Log-2 Log-3 Log-4 Log-5
Log-6 Log-7
Log-8
Log-9
Log-10 Log-11 Log-12 Log-13 Log-14
Log-15
Log-16
Log-17
Log-18 Log-19 Log-20
Description Message Log which contains diagnostic messages. Old Event Log which is not used in new SCADAvantage installations but is necessary to support archive files from pre-5.0.0 SCADAvantage systems. Maintenance Log which records all configuration changes to the system. Communication Analyzer Log which allows the server’s built-in protocol analyzer to record communications traffic for a device or communications channel. Communications Statistics Log which provides hourly communications statistics for each device or communications channel Old Raw Trend Data Log which is not used in new SCADAvantage installations but is necessary to support archive files from pre-5.0.0 SCADAvantage systems Old Hourly Trend Data Log which is not used in new SCADAvantage installations but is necessary to support archive files from pre-5.0.0 SCADAvantage systems Old Daily Trend Data Log which is not used in new SCADAvantage installations but is necessary to support archive files from pre-5.0.0 SCADAvantage systems Daily Communications Statistics Log which provides daily communications statistics for each device or communications channel. Monthly Communications Statistics Log which provides monthly communications statistics for each device or communications channel. Old Replication Update Log used to store updates as they are being processed by the replication servers and clients. Replication Log which stores event diagnostics related to the optional replication servers and clients. Communication Timespan Statistics which provides the average time between queries and replies for each device or communications channel. Daily Communication Timespan Statistics which provides the average time between queries and replies for each device or communications channel for each day. Monthly Communication Timespan Statistics which provides the average time between queries and replies for each device or communications channel for each month. Raw Trend Data Log which records process values either periodically or whenever the value changes significantly. This log provides individual data point values for trends of recent history Hourly Trend Data Log which summarizes the raw trend data into hourly statistics of avg/max/min values Daily Trend Data Log which summarizes the raw trend data into daily statistics of average/minimum/maximum values Short Term Alternate Trend Log which stores externally sourced summarized trend data (e.g. OPC HDA data). The short term log stores
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Log-21
Log-22
fine resolution data (e.g. minutely) online for a relatively short time Long Term Alternate Trend Log which stores externally sourced summarized trend data (e.g. OPC HDA data). The long term log stores coarse resolution data (e.g. daily) online for a relatively long time Event Log which records alarms, state changes, operator actions and server parameters/performance events
TODO 1.1.1.5.1 Collection/Backfill 1.1.1.5.1.1 Polled 1.1.1.5.1.2 File Upload 1.1.1.5.1.3 Settings 1.1.1.5.2 Processing 1.1.1.5.3 Monitoring 1.1.1.5.4 Expansion
ARCHIVING In addition to the RTRDB Historian log files, SCADAvantage can also write historical data for events, maintenance events, short and long term alternate trend logs, raw, hourly, and daily trend data into archives that can supplement and preserve data in the logs. On a configurable time interval, the system can be configured to copy data that has been written into the online circular logs to an external "archive" file. This archive file can be maintained and accessed for as long as required. Using archives, data that has been overwritten in the circular log buffers is not lost and can still be maintained and accessed by the users. Archive files can be written to writeable CD/DVDs and network file servers. Each file contains a defined time period of data for one of the log types mentioned, constrained to a maximum file size. These archives are accessed automatically by trends and event summaries so this allows a large amount of history to be kept on-line. Once the archive file is created, it is not changed so it is possible to incrementally back-up this data and only capture the few new files created since the last backup. TODO 1.1.1.5.5 Devices 1.1.1.5.6 Files 1.1.1.5.7 Streams 1.1.1.5.7.1 Trends 1.1.1.5.7.2 Alarms and Events 1.1.1.5.7.3 Other 1.1.1.6 Performance and Capacity
HISTORICAL DISPLAY The trend screen is available in the Client Environment and through SCADAvantage Explorer. The trend screen shows the real-time or historical trend for any point or group of points in an historical graphic X-Y plot. There is a maximum of 12 pens per trend display is Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
supported. Both real-time trends and historical trends (augmented with real-time data) are supported. Pan, zoom, dipstick and many other features are also included. As an option, retrieval logic can fill in missing values, and interpolate between them, to return a predictable number of points. Missing values are returned as last good values. Trend displays have the ability to retrieve data either using a relative time period, such as last 15 minutes or last hour, or between two specific timestamps. Trend traces can be colored either automatically (by letting the system choose the color), the user assigning a specific color, or by using the defined state limit color associated with each plotted value. Data on the trend can be printed, displayed in tabular form, or exported to text files for use in Microsoft Office and other 3rd party applications. Operator assignable trend groups allow ad-hoc creation of trend displays. Each user may create their own trend displays combining values that are of interest at the time. These displays may be kept either private to a specific user, or made public for all users. The following trend screen shows the real-time or historical trend for any point or group of points. Pan, zoom, dipstick and many other features are also included.
SCADAvantage System Operation OPERATING SYSTEM START-UP AND SHUTDOWN SCADAvantage runs on various 32-bit and 64-bit Microsoft operating systems. The SCADAvantage installation takes care of installing, or providing instructions for installing, any prerequisites needed for the SCADAvantage software to operate correctly. This includes roles and features provided by Windows such as: domain controllers, web servers, file sharing, application services, and distributed file system. Identical redundant server pairs ensure that the shutdown of a single server does not result in the loss of any data or configuration settings. Each pair of servers is configured identically, except for any names and/or network addresses.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
SCADAVANTAGE SYSTEM START-UP AND SHUTDOWN Following a SCADAvantage server installation, the system is installed as Microsoft Windows service. By default, the system must be started manually; however this can be changed to automatic in the configuration settings. The service manager appears as a colored icon (ball) in the Windows system tray, located in the lower right-hand corner of the screen. The icon provides a right-click menu with commands to interact with the system such as: start, stop, failover, and diagnostics. In addition, a window can be opened to display more details about the current system status. SCADAvantage includes an additional layer for managing starting and stopping of all features necessary to operate the host. This includes customer-developed application and/or interfaces to 3rd party systems. These features can be automatically or manually loaded on startup, and optionally started on the standby server. This list of processes to start is stored in the database and saved to all copies of the database ensuring identical configuration across all servers and preventing loss of any data or configuration if a single server is shutdown.
BACKUP SCADAvantage emphasizes the “no data loss” concept by supporting recovery from: • • •
Remote devices that support history retention with the unique data backfill technology ensuring no data loss in case of communications outages Higher to lower level servers data acquisition by using replication integrity checks after power or communications outages Fully automated backup and disaster recovery
SCADAvantage includes a mechanism and detailed documentation to back up the entire system (redundant systems and disaster recovery sites). By default, the real-time database is backed up every hour. By default, the historical logs are backed up daily. All permanent files containing database configuration, historical logs, archives or system configuration are included in the total system backup. ABB recommends Windows backup or similar 3rd party backup software for backups and offline storage. The tools are capable of restoring individual files or the complete system in a single operation from the backup media. These tools are also capable of creating bootable system snapshots for restoring the system in the event of a catastrophic failure. It is not necessary to shut down a server in order to create backup. ABB recommends installation of the server and maintaining historical data on RAID hardware. In order to prevent the loss of real-time or historian information on a SCADAvantage server it is important to backup certain files. This being done, a server can be restored in a very short period of time in the event of a catastrophic failure. The system automatically creates backups of its critical files onto the server, but like any other computer system, it is important to backup files to a location other than the local server disk. The backup media might be a CD-ROM drive, a tape drive, another machine on the network, and so on. Backups may be performed manually, or may be scheduled using the scheduled task function which is a class listed under the System branch in the SCADAvantage tree
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
structure. During installation two default Scheduled Tasks are created to perform hourly and daily backups. Customization of these backup schedules, creation of additional backup schedules, and backup to media other than the local server disk are the responsibility of the customer or specifically defined in the project detail specification. The RTRDB is a memory resident database which contains the system configuration (devices, tags, polling addresses, inhibits, alarms and plot objects) as well as the most recent process values. The default scheduled tasks ensure the real-time database is backed up on both an hourly and daily basis. Online backups are only useful so long as there is no catastrophic failure such as a disk crash. The previous hour’s configuration file is saved and at the end of the day is saved as a daily file. In addition, the system keeps a series of hourly and daily backups as compressed files (*.gz) files. Real-time database backups are first saved to temporary files and these temporary files are compressed before being renamed to their more permanent file names. As a result, there is a very low likelihood of these files being in use and unavailable when a backup program used for creating offline backups is executed. The frequency and timing of the backups can be adjusted by editing the existing scheduled tasks. In addition, new scheduled tasks can be created. To restore an older version of the real-time database is as simple as: •
Stop the SCADAvantage server using the service manager Icon
•
Decompress the desired backup and rename the resulting file to be rtrdb.dat.
•
Restart the server using the service manager Icon
•
SCADAvantage starts with that older copy of the real-time database.
The RTRDB server includes several other directories and files that may optionally be backed up. These are typically part of the software installation and not dynamically modified after installation so it is not necessary to include in daily backups as long as a copy is kept with the original software installation. Also, since these files are generally static, there are no special considerations in backing up these files. The critical logs for backup are typically logs 4, 17, 18, 19, 22 and these are also the ones typically expanded to larger sizes from defaults. Logs 20 and 21 are not used in all installations but are generally critical when they are used. Other logs are optional but are typically small so backing up the entire Historical\snapshot directory is generally recommended.
Data Acquisition The SCADAvantage system utilizes remote drivers that provide communication ports that can be located on the server or multiple remote PCs. Communication network that connect to field devices can be set up to utilize various telecommunication technologies such as TCP/IP, RS232, RS485, Radio, Satellite and GPRS.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
A network is a logical grouping or collection of devices that can communicate over one or more routes where a route is often a shared communication media, such as a multidropped radio network. Each network has the ability to define communication timing and settings such as: baud rate, number of bits, stop bits and error checking used by all devices. However, these timings and settings can be overwritten on a device-by-device basis. The SCADAvantage data acquisition philosophy defines one or more polling engines and logical to physical mappings to customer's communications network. Within a polling engine each logical network can use various routes to telecommunication technologies such as TCP/IP, RS232, RS485, radio, satellite and GPRS to connect to field devices. Multiple networks can be associated with each device and a cost associated with the underlying technology. This allows the lowest-cost communication to be selected and alternate, higher-cost communication to be used in the event of a failure. When a failure occurs the system automatically attempts to establish communication with the lower-cost route, and switches back when it is available. The device interface (DVI) is capable of collecting data from multiple device types and from automation systems produced by other vendors; the DVI (polling engine) can poll multiple devices with different protocols at the same time through one serial port. This feature enables the system to collect data from many different RTUs during one scanning cycle. Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Multiple protocols and baud rates can be used on a single communication route. Drivers available include TotalFlow, Modbus ASCII and RTU (binary), Enron Modbus, PEMEX Modbus, Modbus TCP, Cameron Adept, BSAP, Fisher ROCtalk, HP, Kimray, Galvanic, Eagle, Mercury, DNP3, Allen Bradley DF1, and IEC 870 serial and TCP protocols. SCADAvantage also supports OPC connectivity via OPC DA, AE and HDA Server and OPC Client is available to interface to 3rd party products and devices. The product development team has many years of experience and expertise developing protocol drivers. ABB can quote the cost to develop additional protocols as part of a system replacement or upgrade. SCADAvantage devices reference actual physical field equipment such as RTUs (Remote Terminal Units), FCUs (Flow Computer Units) and PLCs (Programmable Logic Circuits). The SCADAvantage device stores information about the current status of the physical device including device address, communication status, alarm state, scan status, and protocol-specific mappings and settings. Loss of communication to the device is reflected in the device status using various hardware and software status codes and messages. During loss of communication, the system makes continuous attempts to re-establish communication until either an operator manually inhibits scanning or normal communication is restored. Through its association with a SCADAvantage network, each device can have multiple communication paths. When an alternate/backup communication path is in use, the device status reflects this. When the primary path becomes available, the system automatically (or on demand) switches back to it. An operator can manually redirect communication to use the alternate path. Even when not in use, the alternate communication path status is monitored and maintained. Appropriate alarm/event messages are recorded to indicate changes in communication status, as well as corresponding operator/user actions. As part of the standard product, SCADAvantage Explorer provides a structured view to configure networks, routes, and devices. Summary displays, which support filtering and sorting, are included to provide an overview of all field communications. Explorer provides easy access to the protocol analyzer, communication statistics, and alarm and event logs.
METHODOLOGY The typical communication mode for networks with devices is in a master/slave or peer-topeer arrangement. The polling engine sends a request for information to the device, devices that have information then transmit a response (i.e. a query-response arrangement). Devices within a network are polled individually and sequentially in a roundrobin arrangement. Occasionally, additional device status information is requested in between data polls such as accumulator information, read time, synchronize clock, and device-specific statuses. TODO 1.1.1.7 Routes 1.1.1.8 Modems 1.1.1.9 Modem Pools 1.1.1.10 Networks 1.1.1.11 Devices
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
DATA POLLING The system polls devices for any tag, or any group of continuous tags, using a time interval on a continuous basis (in seconds, minutes and hours), or at specific time (e.g. relative interval or absolute interval) using the device scheduler. Raw values from the sensors associated with the field device, or from calculations performed in the field device are stored in the device’s memory. SCADAvantage device types map segments of the overall memory within the field device. In addition, time synchronization and method, and the maximum number of analogs and digitals supported in a single poll, can be defined. By default, each device is associated with one of the pre-defined device types. Additional polling ranges define what data is retrieved during each poll, how often the poll occurs, and the ability to enable/disable a polling range. Device types provide a simple way to check if polling range definitions are valid. TODO 1.1.1.12
Settings
ERROR HANDLING As each response to a poll is received, the data is checked for validity. The data is validated using the following checks: response received before timeout, response has correct length, cyclic redundancy check (CRC) security code is valid, data values are correct type, data values are within operating limits, and status codes are valid. When any one of the above checks fails, the last good value for the corresponding tag is retained. The status of each tag mapped within a bad response is updated accordingly. The tag status and value is available to operator HMI displays, reports, and 3rd party interfaces.
COMMUNICATION STATISTICS All device communication states are initially reported as numeric codes that are translated to text via the state limits. For each state limit, a separate communication statistic is recorded. Thus, the system records the count of CRC errors, “No Reply” messages, and even protocol specific conditions such as Modbus exception code. In addition to these individual statistics, the system records the total normal, total abnormal, percent successful and average response time. SCADAvantage records two sets of statistics representing “physical communications” and “logical requests”. For instance, if a single request of a device fails on the first two attempts but succeeds on the third attempt (assuming two or more retries configured) the “physical communication” statistics show 33% success and the “logical request” statistics show 100% success. Communication statistics are recorded for each device and aggregated for every other communication object in SCADAvantage (network, modem, modem pool, route). Communication statistics are recorded as separate hourly, daily and monthly historical logs. These values are automatically reset at the beginning of each of these periods. The communications summary is useful for monitoring and diagnostics of the field communication network. Both operator HMI displays and SCADAvantage Explorer provides easy access to the communication statistics. The communication summary Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
provides filtering and sorting of statistics. Statistics can be viewed on an hourly, daily or monthly basis. The following statistics are provided: •
Current normal percentage (for time period)
•
Current abnormal percentage (for time period)
•
Previous normal percentage (for time period)
•
Seconds in normal state
•
Count of connection failures
•
Average response time
•
Count of communication error
•
Count of illegal message
•
Seconds of no response (for time period)
•
Seconds of total normal (for time period)
•
Seconds of total abnormal (for time period)
•
Seconds of abnormal (for time period)
COMMUNICATION ALARMS The systems records an alarm message when the status of communication with any device or route changes. The message includes communication outage status, communication restored status, security violations, and data quality. The ability to delay alarms is user configurable by route and by device. All objects within the database, including communication alarms, share a common alarm monitoring process using state limits and state limit groups described elsewhere.
RTU ON/OFF SCAN CAPABILITY The system provides the ability to manually place any device in an off-scan state. When in off-scan state a device is not scanned by the polling engine. Any report-by-exception (device-initiated connections) is also ignored. Device quality is flagged as unreliable and scan-inhibited. Once the device is manually placed back on-scan, data is requested and/or processed. On operator HMI displays and SCADAvantage Explorer a scan-inhibited device (like all other database objects) is displayed in its state text as strikethrough text. External applications retrieving data from SCADAvantage can also request the off-scan state.
COMMUNICATION DATA ANALYSIS UTILITY Communication Analyzer is a software protocol analyzer within SCADAvantage. It is used for communication data analysis during verification, testing, and troubleshooting periods. It has a GUI that shows queries from SCADAvantage native polling engine (DVI) to RTUs, and Responses from RTUs to DVI. Queries and responses are shown in Hexadecimal and ASCII formats. The ability to decode or display protocol-specific structure is currently not Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
supported. Communication analyzer has a recording feature for recording communication data in a text file for further analysis. Communication analyzer is flexible - it allows users to analyze single/multiple communication network/routes at the same time. The communication analyzer can be used for all protocols. The communication analyzer has a configurable view: it allows a user to change text font, enable/disable message highlighting, hide/unhide columns, and hide/unhide message types. It also has an advanced search utility for searching specific kind of messages/responses within the GUI. The system automatically verifies CRC (security codes) in the underlying response, and also displays incorrect security codes as invalid messages.
PROTOCOLS TODO 1.1.1.13
Settings
RTU TIME SYNCHRONIZATION SCADAvantage Time Synchronization reads the current date/time from supported devices based on a configured minimum default interval of 1 hour. The read is performed as part of a normal data poll. When read, the current time is recorded in the device to allow for optimized time synchronization. Protocol specific information required to read the date/time from the device (e.g. memory location) is configurable on a protocol specific basis. When a device does not support reading the current date/time, optimization is disabled. Optimizations include: •
Minimum device clock read interval
•
Time last read from device (and when it was read)
•
Device time zone
•
Minimum and maximum clock difference
•
Prevent synchronization around hour boundary
•
Adjust device clock for Daylight Savings
The following protocols support time synchronization: • Adept •
BSAP
•
Eagle
•
Fisher ROCtalk
•
GasMicro
•
HexRepeater
•
IEC 870-5
•
Kimray
•
Mercury Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
•
Modbus
•
PLC5
•
Totalflow
•
DNP3
The following protocols support optimized time synchronization: •
Eagle
•
GasMicro
•
Fisher ROCtalk
•
Mercury
•
Bristol ENRON Modbus
•
Totalflow
•
DNP3
DEVICE SCHEDULER TODO 1.1.1.14 1.1.1.15 1.1.1.16 1.1.1.17 1.1.1.18
Settings Schedules Device Management Monitoring Failure Management
PERFORMANCE AND CAPACITY TODO
Data Processing Functions SCADAvantage provides data processing for the following data types: • • • •
Digital alarms and device status Analog measurements and alarms Accumulated volume information (counters) Analog and digital device controls and parameter downloads
COMMON DATA PROCESSING FUNCTIONS Data processing functions are common to all point-derived types within the real-time database.
FIRST PASS PROCESSING When a device is brought online after an outage, certain device status changes that result in alarms can be inhibited. However, these status changes are still recorded as events Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
unless inhibited. This reduces the number of nuisance alarms presented to the operator after system startup. SCADAvantage supports the inhibiting of any alarm condition included those that result from a normal control operation. However, first-pass processing of alarms due to other conditions such as system startup or device commands is currently not supported.
DATA QUALITY INDICATORS SCADAvantage supports a large number of data quality and flags for a data value. These attributes are used to modify the graphical representation in the operator HMI display. The following table outlines each supported quality and their representation in operator HMI display: Data Quality Alarm Requires Acknowledge Abnormal Value Manual Override Unreliable Value Clear Alarm from Display Data In Alarm Bad Transducer/Invalid Data High Alarm Active High/High Alarm Active Low Alarm Active Low/Low Alarm Active
HMI Representation Alarm state text blinking Alarm state text in bold font Alarm state text in italics font Alarm state text in strikethrough font Hides alarm (only on grid display) Text string of alarm state Text string of alarm state Text string of high alarm state Text string of high/high alarm state Text string of low alarm state Text string of low/low alarm state
The following data flags are supported for a data value (but do not appear as indicators on an operator display): Data Quality Inhibit All Abnormal Alarms Control Inhibited Device History Collection Enabled Inhibit All Events Inhibit Temporary (Fleeting) Alarms Rate-of-Change Alarm Active (time) Rate-of-Change Alarm Active (value) History Enabled Inhibit Manual Override Events Inhibit All Alarms & Events Alarm Inhibited Alarm Inhibited for First Pass
Configuration Flag Abnormal Alarm Inhibit Command Inhibited Device-Sourced History Value Collection Enabled Event Inhibit Fleeting Limit Processing Inhibit Fleeting Limit, Timed Deviation Fleeting Limit, Timeless Deviation Host Historical Value Collection Enabled Manual Event Inhibit Master Inhibit Normal Alarm Inhibit Normal Alarm Inhibit Copyright © ABB Inc. 2003-2012
Flag Column in Database abnormalinhibit commandinhibit historydevsrcenable eventinhibit fleetinginhibit
historyenable manualinhibit masterinhibit normalinhibited normalinhibited
SCADAvantage Technical Description
Revision: 2012
Processing Auto-Acknowledge Return to Normal Deactivated/Scan Inhibit Select Before Operate
RTN Alarm Acknowledge
Scan Inhibit Select-Check Before Operate Calculated Point/State Software Point Override Inhibits for Alarm Callout Suspend Suppression Rules Delete Pending Exclude Point from Replication History Backfill Select Before Operate Override Select Before Operate Requested
enablertnautoack scaninhibit scboenable software suspendsuppressionrules deletepending excludefrombackfill scbolockoverriderequest scbolockrequest
Only manual, scaninhibit, and abnormal (in alarm) are carried through to all subsequent calculations using the logical "OR". Reliable uses a logical "AND" in all subsequent calculations. The following quality indicators and flags are stored in history along with each value: Data Quality Abnormal Value Manual Override Unreliable Value Data In Alarm Bad Transducer/Invalid Data High Alarm Active High/High Alarm Active Low Alarm Active Low/Low Alarm Active Alarm Priority Deactivated/Scan Inhibit
Historical Data Column abnormal manual reliable statetext statetext statetext statetext statetext statetext statewincolor scaninhibit
ACTIVATE/DEACTIVATE SCADAvantage allows value updates to a tag to be activated and deactivated by an operator using the scan inhibit flag. All operator changes to activate/deactivate are recorded in an audit trail (Maintenance Log). Groups of tags can be activated and deactivated via a single update SQL command. When a tag deactivated, all attempts to update the value are rejected and no alarms or event are generated. SCADAvantage Explorer includes a standard summary which allows filtering to show all deactivated tags. This same summary is available in the operator HMI display. The data in the summary display can be printed, exported to text file, and included in reports. Scan inhibit appears on operator displays as an unreliable value with strikethrough font. Scan inhibit is recorded in history with each value and the unreliable flag is propagated to any calculated points.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
INHIBIT/ENABLE SCADAvantage allows the operator (with sufficient privilege) to inhibit and enable the alarm processing for any tag. The operator may inhibit/enable any group of tags in the system with a single SQL update command. When a tag is inhibited, it is processed as normal except no alarms are generated to the operator. Tag alarms remain inhibited until the operator manually enables alarming. Timed alarm inhibit is not currently supported. All operator changes to inhibit or enable tag alarms are recorded in an audit trail with an appropriate message (Event Log). SCADAvantage Explorer includes a standard summary which allows filtering to show all inhibited tag alarms. This same summary is available in the operator HMI display. The data in the summary display can be printed, exported to text file, and included in reports. Tag alarm inhibit is not recorded in history and not propagated to any calculated points. When importing historical data, data is handled using the normal alarm processing. However, when the tags inhibit alarms flag is enabled, historical alarms are not generated.
SILENT ALARM/NORMAL ALARM Audible alarms can be configured for any tag in the system. The configuration allows a sound file to be played to various types of audio equipment. Sounds can be either played once or continuously until acknowledged. The operator may silence any group of tags in the system with a single SQL update command. When a point is in the silent alarm mode, normal alarm processing takes place except the audible alarm remains silent. If multiple alarm messages have been configured with different associated sounds, the highest priority, oldest unacknowledged alarm is the one annunciated. All operator changes to silence tag alarms are recorded in an audit trail with an appropriate message (Event Log). Tag silence alarm is not recorded in history and not propagated to any calculated points. Operator HMI has the ability to mute all audible sounds from the main display screen for that workstation. A single click silences the current alarm, and a double-click mutes all sounds.
MANUAL DATA OVERRIDE The operator can override scanned data from any device with a manually entered value on a tag-by-tag basis. It is not necessary to stop scanning the device in order to override a value. The manual override flag in the database indicates a tag has a manual value. The manual value is used for all display and calculation functions. Currently, it is not possible for the operator to view the current value (non-overridden value from the device) while the tag is manually overridden. SCADAvantage Explorer includes a standard summary which allows filtering to show all manually overridden tags. This same summary is available in the operator HMI display. The data in the summary display can be printed, exported to text file, and included in reports. Each time a tag value is manually overridden it is recorded in history and propagated to any calculated points. All operator changes to manually override tag values are recorded in an audit trail with an appropriate message (Event Log).
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
The system allows the operator to change the manually override a tag at any time. When the manual override flag is cleared, the system resumes polling the device.
HIGH-LEVEL CONDITIONS SCADAvantage provides high-level settings in order to prevent invalid operation of the system. For example, control sequences and triggers can be configured to monitor and initiate emergency shutdown when certain operational conditions are met. In another case, replication control modes can prevent two operators from controlling at the same time. Finally, select-before-operate also prevents two operators from controlling at the same time. In all cases, configuration of these scenarios is maintained by administrators and operators with sufficient privileges. TODO • Fast Scanning • Report-by-Exception • Unit Conversion and Scaling
DIGITAL DATA SCADAvantage supports processing for digital inputs that enter the system as single bit binary data, and multiple bit digital values consisting of contiguous or non-contiguous groups of binary data using bitmasks. An unlimited number of inputs can be associated with digital value. SCADAvantage evaluates the state of a digital using “State Limit” functionality. State limits are defined in the database and can be associated with a specific tag, or more typically, shared between many tags. State limits allow a list of conditions to be defined that specify the appropriate state for a point. For instance, a 2 bit valve indicator might be defined by the state limit where “Equal 0” evaluates to “valve transit” and “Equal 1” evaluates to “valve open”. Each state can be independently flagged with abnormal, inhibit, or state delay times. Digital values are updated in the database with current discrete data from the device as it is polled. This live information is available to operator HMI displays, calculations and 3rd party applications. This concept extends to all tags in the SCADAvantage including analogs and even device states. Device states are evaluated using state limits. Communication errors are reported back as an integer which is translated to language specific text using state limits. In many cases a range of integers is grouped together as “Communication Error” but the underlying value is also available for debugging purposes.
TWO-STATE VARIABLES SCADAvantage state limits allow two-state values to be defined and supports the case where 1 = On and 0 = Off, as well as the case when 1 = Off and 0 = On. When a digital value from the device matches a state with an alarm, the alarm is generated using standard alarm processing. The following lists some of the possible state limit definitions: • • • • •
Alarm one way (0 to 1 transition) Alarm one way (1 to 0 transition) Alarm two ways (0 to 1 and 1 to 0 transition) 1 = Alarm, 0 = Normal 1 = Normal, 0 = Alarm Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
MULTIPLE-STATE VARIABLES Digital input processing extends to all tags in the SCADAvantage including analogs and even device states. Digital device states are evaluated using state limits on any number of bits used to encode their status which do not have to be contiguous. Communication errors are reported back as an integer which is translated to language specific text using state limits. In many cases a range of integers is grouped together as “Communication Error” but the underlying value is also available for debugging purposes.
ANALOG DATA Each analog tag in the database stores a floating point value, an engineering unit, and optional methods for conversion and scaling from the raw value. Default conversions for imperials and metric are included, but these conversions can be customized. SCADAvantage supports the following floating point data types: 12-Bit (0xffff), Adept Timestamp, BCD 1 byte, BCD 2 bytes, BCD 3 bytes, BCD 4 bytes, BCD Kimray 2 bytes, Barton Modbus Float, Barton Modbus Timestamp, Cameron LCD, DEC Float, DMS Timestamp, Float, Modbus Long, Real, Roc TLP, Signed Byte, Signed Long, Signed Short, Unsigned Byte, Unsigned Long, Unsigned Short, VarChar BP, VarChar BP/NT, VarChar Enron, VarChar NP, VarChar NP/NT, VarChar NT. Byte ordering is handled by default within each protocol. In addition, byte ordering can be forced by selecting the appropriate bits in the desired order using a bitmask. SCADAvantage Explorer includes a standard summary which shows all analog tags and allows filtering and sorting. The data in the summary display can be printed, exported to text file, and included in reports. This live information is available to operator HMI displays, calculations and 3rd-party applications. When an analog transducer failure occurs, configurable settings prevent erroneous engineering unit conversions and also limit alarms. Clamped value (enforced limits), when enabled, allows minimum and maximum operational value limits to be configured. When the minimum value is configured and the input value falls below the minimum, the following occurs:
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
• • •
The analog value is clamped at the specified minimum value (it does not keep the last good value) The tag is marked unreliable and suspends processing of bad readings The failure reason on the tag indicates an operational value limit violation
Similarly if a maximum value is configured and the input value exceeds the maximum, the following occurs: • • •
The analog value is clamped at the specified maximum value (it does not keep the last good value) The tag is marked unreliable and suspends processing of bad readings The failure reason on the tag indicates an operational value limit violation
While clamped, the system propagates the min/max value and unreliable status in all calculations. When the analog input value falls within the limits configured, the tag is subsequently marked reliable and the failure reason is cleared.
LIMIT VIOLATION CHECKING State limits for analog points allow the following limit violation checks to be defined: • • • • •
Low limit Low-Low limit High limit High-High limit Transducer Failure/Invalid Data
Additional limits can be defined as needed. All limit checks are performed in engineering units. Each state limit group allows a "return to normal" dead band to be defined for alarm filtering to prevent excessive alarming around limit thresholds. The filter is shared for each tag that references the state limit group. For instance, at a high limit of 100.0 the analog alarms at any value over 100.0. However, if the dead band is 5.0 then the analog doesn’t leave the high state until the value transitions below 95.0.
RATE OF CHANGE CHECKING SCADAvantage allows definition of "timed" and "timeless" deviations as fleeting limits. Timeless deviations are used to monitor values that should not change (such as a closed tank). If the value changes by more than the delta, even over several months, an alarm is raised. Timed deviations are rate based. If the rate of change exceeds the defined limit, an alarm is raised. Only the changes between the current and previous value are used to establish the alarm condition (not passed scans on a rolling basis). The following rate of change conditions are supported: • •
Individually configurable time period used for the ROC calculation Individually adjustable rate of change alarm thresholds in engineering units
The following rate of change conditions are not currently supported:
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
• • • •
Ability to inhibit rate of change alarms when there are predictable changes, such as startup and shut down operations, valve manifold changes and set point changes Individually adjustable inhibit timers Ability to inhibit the reoccurrence of a rate of change alarm for a specified period following its first annunciation Separate adjustable limits for positive and negative violations of change thresholds
***(The system’s first pass processor inhibits analog rate of change alarms when an RTU is brought on-scan after an outage, or when the system is brought on-line after a total shutdown and restart.)*** THIS IS NOT SUPPORTED
GRADIENT ALARM PROCESSING (ENHANCEMENT) Gradient alarm processing provides alarm management capability based on demand prediction patterns of analog data. A large number of nuisance alarms generated by analog limit violations can be reduced by maintaining pre-defined trends of analog data as reference prediction patterns. A profile pattern of predicted values (e.g. pressure profile) can be loaded for any point in the system (includes analogs, digitals, calculated points). The profile pattern defines absolute date and time as well as predicted value and optional dead band. Each tag automatically calculates the difference of its current value and the predicted value using linear interpolation. The difference is recorded as a separate value on the point and optionally output to a calculated tag. The output difference may either be an absolute variance or percentage variance. When output to a calculated tag the value may have separate alarm limits and trending enabled. The predicted values are automatically deleted once the relevant time range has passed. Loading of profile points up to one week in the future (configurable) is supported. An interface is provided for loading profile points from a 3rd party system. SCADAvantage Explorer provides screens to load, administer, view and edit profile trends and dead band. Pattern trends can be viewed in graphical or tabular format.
ACCUMULATOR PROCESSING SCADAvantage provides logic to process accumulator data from devices, plus accepting raw data values without further processing. Resetting accumulators does not result in lost volumes due to differences between the last accumulated values before a reset, or differences in the first values after a reset is performed. All accumulator data processing and related calculations are performed using double precision arithmetic to minimize errors. Processed information is available for both application programs and for operator HMI display purposes. SCADAvantage maintains both processed and corrected accumulator data in standard units, configurable by the user on a point-by-point basis. These configurable units can be changed at any time by both administrators and operators with sufficient privileges. Settings are provided for configuring the beginning accumulation time (counter reset) and the accumulation period on an individual tag basis. SCADAvantage includes preconfigured default hourly, daily, monthly, yearly, and unlimited accumulated values. As well, two configurable periods are possible. The current and previous accumulated values are maintained for each time period.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
In addition, SCADAvantage includes integration and summation calculations for the same time periods.
SOFTWARE ACCUMULATORS SCADAvantage analog and digital tags support software accumulators derived from device inputs. Each tag is configured with its own rollover point, such as 10,000,000. SCADAvantage can display accumulation on an hourly, daily, monthly, yearly, user-defined, and unlimited time period. Software accumulations and rollovers operate independently of the hardware.
DELTA CALCULATIONS (SOME ENHANCEMENT) SCADAvantage software accumulations are based on delta calculations. The computed delta compensates for differences between the reported value and internal accumulated value. SCADAvantage does not currently support delta compensation for communication failure, and server restarts or failovers.
HARDWARE/SOFTWARE ROLLOVER HANDLING SCADAvantage supports hardware accumulator rollover handling. Hardware accumulator handling is configured and displayed in the same way as software accumulator handling.
RECOVERY AFTER COMMUNICATION OUTAGES (ENHANCEMENT) During first-pass processing, SCADAvantage prevents false accumulated jumps after a device failure or during system start-up. After a communication failure, the accumulator can compensate for up to 24 hours.
VOLUME CALCULATIONS (SOME ENHANCEMENT) SCADAvantage calculates volumes based on flow rates acquired from the device. Host-calculated orifice and turbine meters are supported. However, ultra-sonic meters are not currently supported. For both supported meter types, each time the flow rate is received from the device the corresponding accumulation between the current reading and the previous reading is calculated and added to the software accumulator. AGA8 corrections are currently not supported for host-calculated meters.
REASONABILITY CHECKING SCADAvantage provides a user-defined threshold on a per-tag basis to verify the difference between volumes acquired from the device and the current accumulated value. An alarm is generated when the difference exceeds this threshold. TODO 1.1.1.19 Other Calculations 1.1.1.19.1 Tag Calculations 1.1.1.19.2 Operator-Initiated Calculations 1.1.1.19.3 Scheduled Calculations 1.1.1.19.4 Periodic Calculations Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.1.1.19.5 Performance and Capacity
CONTROLS SCADAvantage includes analog and digital control and provides appropriate feedback to the operator in the event that any given control action fails. Operators can initiate control manually for a single tag, or control can be scheduled/on-demand for one or multiple tags via application programs. Also, the ability to command can be inhibited on a per-tag basis. When inhibited, each attempt to command is recorded in the operator log (Event Log). The control pop-up window includes the current status of the tag. For analog tags the window provides manual value entry and a slider-bar with values between configured operating limits. For digital tags a list of configured control action can be selected. A checkbox allows a control pop-up to remain open after control is executed. A system setting can enable each control action to be verified before it is executed. After control is executed the tag is scanned more quickly to provide responsive feedback. An alarm is generated if the control action fails to reach the commanded state or value within a configurable timeout period (defaulted to 1 minute). It is also possible to configure a command warning message (“tagging” a point) to prevent the control action from being executed. However, an operator with sufficient privilege can override in order to execute a command. This override is recorded in the operator log (Event Log). By commanding points, the following features are provided: • • • • •
Eliminating nuisance alarms Verifying commands are received at the device (via device status) Verifying commanded device is changing in the field Show intermediate values using fast-scan Inhibit alarms and/or events when a tag returns to normal
The current status of any device (commanded or otherwise) is always reflected in the device status. The ability to add, modify, and delete control configuration on a per-tag basis can be done online without requiring the database to be restarted.
SECURITY AND TRACKING SCADAvantage “Select-Check-Before-Operate” functionality is an interlock that prevents more than one operator from controlling a single point simultaneously. It is configured on a tag-by-tag basis and available for both analog and digital points. When the control pop-up is displayed the control point is “locked” for output and a green indicator is shown. If another operator attempts to control the tag they receive a message indicating the lock is granted to another operator and the indicator displays in yellow. The lock times out after a configurable period (defaulting to one minute) and the indicator turns red. At this point, another operator can click the “Request Lock” to lock the tag. A sufficiently privileged operator may also override or remove the lock. Each override is recorded in the operator log (Event Log) and includes details such as the date/time the lock occurred, the workstation name, and the operator name. “Select-Check-Before-Operate” can be used from the operator HMI displays or external application programs.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
DISCRETE CONTROLS (COMMANDS) Operators are able to enter digital control commands (e.g. valve open/close, pump start/stop) from the operator HMI display for devices within their appropriate area of responsibility. The following control actions are tracked: • • • •
Verifying commands are received at the device (via device status) Verifying commanded device is changing in the field Show intermediate values using fast-scan Verify the device reached the desired final controlled position
Each controllable tag includes a control timeout period. An alarm is generated if the controlled device fails to reach the commanded state within the configured time period. State limits for each state transition allow inhibiting alarms and/or events. As a result, an alarm or event is optionally generated at each control state transition indicating success or failure of the control action. For a device, state limits can be configured to enable/inhibit alarms for each generated transition. As a result device status changes only generate messages to the Event Log indicating that the transition was observed, unless the alarm is enabled.
TWO-STATE DEVICES Digital tags can be configured to control two-state devices (1-bit). Either the 1 or 0, or both conditions can be defined and controlled.
MULTIPLE-STATE DEVICES (SOME ENHANCEMENT) Digital tags can be configured to control multi-state devices (greater than 1-bit). An example is a valve that moves from closed to travel to open when commanded to open. Alarming of un-commanded device changes is not currently supported.
ANALOG CONTROLS (SET POINTS) Analog tags control by translating the value in current engineering units to the units supported by the device. Each Analog in the system allows configuration of a confirmation dead band as well as optional change confirmation timeout and optional command confirmation timeout. For instance, if the current set point is changed from 2000 to 2500, the current operating value is 2018 and the confirmation dead band is 50, the change confirmation is successful when the value transitions above 2018 + 50 and the entire command is successful when the current value reaches 2450 to 2550. Each confirmation has a separate enable and timeout value for each tag. When a timeout occurs an alarm is generated. Analog control can be used from the operator HMI displays or external application programs.
CONTROL SEQUENCES SCADAvantage can be configured to create, edit, and delete pre-defined sequences of commands with parameters. Any combination of discrete and analog controls can be executed with a single command from the operator via a button on the HMI display. Thus any action an operator can perform, a control sequence can perform. The sequence of Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
commands is executed sequentially and waits for the successful completion of each command before issuing the next command in the sequence. It is also possible to introduce a delay between commands (in fractional seconds, e.g. 1.5 = 1500 milliseconds). Control sequence triggers specify when the control sequences should execute, the parameters to execute with, and the action that triggers the control sequence to execute. The triggers are variable expressions similar to those used for defining calculated points in SCADAvantage. If the control sequence cannot be successfully completed due to communication problems, devices being “tagged” or failure to achieve final state within the configured time period, the control sequence is aborted and an alarm is generated. Control sequences in SCADAvantage are programmed as event driven actions so they are not continuously executing. For instance, to pump off a tank when it reaches a certain level there is one control sequence to start the pump that is triggered whenever the tank transitions above a certain level and another control sequence to stop the pump whenever the tank transitions below a certain level. This way, each control sequence executes for a few milliseconds resulting in no additional load on the CPUs. Events are generated when the control sequence is started and successfully completed. These events can be inhibited; normal events occur for each command in the sequence. TODO 1.1.1.19.6 Definition 1.1.1.19.7 Triggering 1.1.1.19.8 Performance and Capacity
ALARM AND EVENT PROCESSING SCADAvantage alarms provide a complete and accurate overview of all device and software conditions, statuses and failures. Alarms are the result of changes in the system that requires operator attention. All alarms are a subset of events. Operator HMI displays provides a visual indicator that shows current alarm information for each tag. In addition, an alarm summary provides an overview of all alarms from highest to lowest priority. Alarms within the summary can be filtered and sorted. Events provide a complete and accurate history of all system activities for auditing purposes and include: • All alarm conditions that have not been inhibited • Changes in the state of discrete inputs which are results of a control action • Passage of analog values or rate of change resulting in a new state limit • Change in a point’s data quality attributes • Change to point data values by local or remote operator entry • Change in the status of any part of the communication system • Any change in the network or hardware resource availability, or process status • Operator logging on or off of workstation • Successful or unsuccessful control actions • Changes in area of responsibility Not every change in a point's data attributes results in an event. For instance, loss of communications with a remote results in a single event, not one event per tag.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Applications can generate both alarms and events into the standard event and alarm logs. 1.1.1.20 Definition 1.1.1.20.1 State Groups 1.1.1.20.2 State Limit Groups 1.1.1.20.3 Fleeting Limits
MESSAGE CONTENT Each alarm includes the following information: • • • • • • • • • • • • •
Date and time of occurrence in UTC (displayed in local time) Tag type (analog, digital, device, network, route, modem) Alarm name (tag name) Alarm description (tag description) Alarm text message (description of alarm) Old state (tag state before alarm) New state (tag state currently) Current value (of tag) Units (of current value) Alarm type (state, fleeting, system, and control) Alarm priority Area of responsibility (zone) Device type (device associated with alarm)
1.1.1.21 1.1.1.22 1.1.1.23 1.1.1.24 1.1.1.25 1.1.1.26 1.1.1.27
Routing Priorities Alarm Acknowledge Audible Alert Re-Alarming Capability Summary Displays Groups
ALARM CALLOUT SCADAvantage alarm callout is an integrated telephony and messaging system within SCADAvantage and offers real-time intelligent alarm notification. It allows users remote access to critical specific alarms & events via telephone voice (PSTN or cellular), radio, pager (numeric and alpha-numeric) and e-mail. The Alarm call out application enables users to reduce their operational costs by allowing them to remotely monitor critical alarms and dial in to acknowledge a the alarm. Users can listen to and acknowledge alarms, hear exact value of variables via telephone from remote locations saving valuable time and money. Alarm call out can be configured to generate a call out based on a defined escalation list that defines a number of SCADAvantage system users who are to be contacted by any of
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
the above call out methods (telephone, pager, e-mail and text messaging) in case the call out is not acknowledged within a configurable period of time. Alarm callout is also useful for instrument and communications technicians as the system can be used to notify network outages or instrument failures where supported by SNMP, HART or FF. 1.1.1.27.1 Communication Devices 1.1.1.27.1.1 Email 1.1.1.27.1.2 Text Messaging 1.1.1.27.1.3 Audio 1.1.1.27.2 Reports 1.1.1.27.3 Mobile Users 1.1.1.27.3.1 Blackout Schedule 1.1.1.27.3.2 Distribution 1.1.1.27.3.3 Groups 1.1.1.27.3.4 User Location 1.1.1.27.4 Dynamic Status 1.1.1.28 Performance & Capacity
SPECIAL APPLICATIONS GAS PIPELINES LINE PACK/DRAFTING The line pack application calculates an estimation of the quantity (volume) of commodity (for example, natural gas) within a physical pipeline segment/network. The line pack value is not an actual value but rather an estimated value for several reasons: • • •
Actual pressure and temperature gradients within a pipeline segment are assumed to be linear (which they are not unless the pipeline segment has been in steady state conditions for a long period of time) Actual pressure and temperature within a pipeline segment are assumed to be steady state (which they are not due to transients resulting from ongoing flow conditions) The composition of the commodity with a pipeline segment is assumed to be homogenous (which it is not due to potential variations in composition)
For the purposes of estimating line pack (inventory levels) within a pipeline network, an estimated value is deemed sufficient for operational needs where leak detection or complex transient models are not required. Line pack values are calculated for individual pipeline segments using the available geometry, telemetry and calculation parameters on a periodic basis. The resulting line pack and change in line pack is stored on the pipeline network, pipeline segment and optionally configured analog points.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
A summation of the calculated line pack and change in line pack values for each individual pipeline segment assigned to a pipeline network is performed. This provides operators with an updated inventory level for one or more pipeline networks. Changes to line pack values are also calculated on a periodic basis over several defined line pack delta periods using the prior period line pack value – this provides operators with insight into the rate of change of the inventory level for one or more pipeline networks and the constituent pipeline segments. The line pack delta periods used may vary from several minutes to several hours and the real-time line pack application tracks the changes for each individual period. Thresholds can be applied to the calculated changes in line pack for a pipeline network or pipeline segment using state limits which, when violated, generate alarms in the alarm summary to notify operators of potential problems and also make available alarm color information that can be presented graphically in the HMI. Line pack and changes in line pack calculated values for pipeline networks and pipeline segments are optionally available for trending purposes using the Historian to collect and maintain historical values.
GAS SCHEDULE TRACKING Gas schedule tracking calculations are performed on a periodic basis to establish the forecast EOF (end of day) contract quantity and the required flow rate to meet the contract quality for each configured contract in the application. The forecast EOF contract quality calculation uses real-time input analog points to specify the accumulated volume and current daily flow rate for the current gas day at a particular metering point (receipt or delivery) in a pipeline network and extrapolate the anticipated total volume (or energy) using a linear projection or load distribution profile based projection configured for the contract (metering point). The required flow rate calculation for a contract uses a real-time input analog point to specify the accumulated volume and the currently specified contract quality for the metering point and the time remaining in the current gas day to determine the flow rate required to meet the contract. The contract quality is subtracted from the forecast EOF (end of day) contract quality and the resulting variance is available to written to a configured analog point for alarming, trending and display purposes. The required flow rate calculation result is also written to a configured analog point for alarming, trending and display purposes. This allows operators to receive alarms indicating potential operational problems when the required flow rate exceeds certain specified conditions or the difference between the forecast EOF contract quality and the contract quality are outside of a specified tolerance. EOD forecast quantities are produced by the application in conjunction with profile scheduling performed on a gas day basis. Model profiles can be configured in the application and scheduled by the day of the week or specific date on a profile schedule. A profile schedule can be assigned on a contract by contract basis, enabling the application to obtain the profile for a given gas day without requiring operator intervention. The profile schedule supports use of an established schedule Saturday-to-Sunday allowing for profiles to be re-used within a profile schedule and amongst multiple profile schedules. Where customized profiles are required for a Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
contract on certain gas days, the operator has the ability to manually configure a profile or import a profile from an external source for a contract. 1.1.1.28.1 Gas Inventory (Stock) Data 1.1.1.28.2 Gas Balance Calculation 1.1.1.28.3 Leak Detection 1.1.1.28.4 Performance and Capacity 1.1.1.29 EFM Commands 1.1.1.29.1 Alarm and Event History Upload 1.1.1.29.2 Trend File Upload/Backfill 1.1.1.30 Host Metering 1.1.1.30.1 Orifice Metering 1.1.1.30.2 Turbine Metering 1.1.1.30.3 Performance and Capacity 1.1.1.31 Dyno Cards 1.1.1.31.1 Controller Types 1.1.1.31.2 Diagrams 1.1.1.31.3 Uploading Cards 1.1.1.31.4 Downloading Controller Configuration 1.1.1.32 Inferred Production (Heavy Oil) 1.1.1.33 Variable Frequency Drives (VFD) 1.1.1.34 Flow-Cal 1.1.1.34.1 Sending Analysis 1.1.1.34.2 Downloading Analysis 1.1.1.34.3 Desktop Edition vs. Enterprise Edition 1.1.2 Calculated Data 1.1.2.1 Creation and Maintenance 1.1.2.2 Processing 1.1.2.3 Limit Violation Checking 1.1.2.4 Linkage to Alarm Processing 1.2 System Error Processing 1.2.1 System Error Detection 1.2.2 Process Monitor 1.2.3 Resource/Network Monitor
Local and Off-Site Redundancy Business continuity is an extremely important requirement for pipeline companies. As a result, a backup system is always required at a remote location and connected to the primary center over a WAN. The Backup Control Center can have an identical architecture to the primary control center. However, it’s more typical to have the most critical systems with less redundancy as show in the following figure.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Backup Control Center Operator Console
Operator Console
Engineering Workstation
Configuration Workstations Administration Workstations
... Projectors Black/White Printer
Technical Workstations Support Workstations
Color Printer
...
10/100/1000 Base-T
10/100/1000 Base-T
WAN GPS Clock
IP Routers Firewalls Disaster Recovery Main Center
Windows Domain Controller Offline Archive File Server DFS Server for Archive Sync SCADAvantage HMI Deployment and/or Central License Server
Real-time Database And Historian (Master)
Decision Support / SQL-Server Utility Meter History Real-time Database (Primary) And Historian
IP Routes Firewall To Communication Equipment, Gateways or Remote Management Sites
DMZ
Citrix Server
Internet
IP Routers Firewalls
Field Devices
Corporate LAN
The decision to failover from one site to the other is manually initiated from either site. The decision is based on one or more critical systems failing or a schedule test of the backup system. The failover mechanism can be customized to provide automatic failover under specific conditions. Real-time and SQL-Server databases at the backup site are continuously updated with changes from the primary site. When a site failover is requested, the backup servers can immediately become active. When a site failover occurs, each operator HMI automatically switches over to the servers at the backup site. Once the cause for failover has been corrected, the primary site can be started as the backup site. Depending on the WAN bandwidth, packet delays and length of down-time, the backup site typically takes 1-2 hours to be fully synchronized. Synchronization includes a current snapshot of the databases, updates to trends, historical alarms and events, archives and SQL-Server transaction logs. Once online, a manual failover back to the primary center can be scheduled. A tool is provided to manage the computers, servers, commands and steps to start and stop each system within a disaster recover site. An overview display shows the progress of each server including the duration, current step and total number of steps to complete startup or shutdown.
LOCAL REDUNDANCY Each SCADAvantage real-time database can be configured in a fault-tolerant pair to ensure continuous client operation, keeping the databases synchronized during normal operation, and maintaining transaction integrity.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
When a failover occurs, each operator HMI automatically switches over to the new master. ABB recommends using network teaming for communication between all servers and clients.
ARBITRATION The standby database is continually informed about changes from the master. This enables the standby to take over immediately when it receives notification of a master failure.
SYNCHRONIZATION On startup, the standby automatically re-synchs the real-time and historical data from the master.
FAILOVER Failover is either automatic due to the system detecting a critical process or resource failure or manually requested by an administrator.
PERFORMANCE AND CAPACITY TODO
OFF-SITE BACKUP/DISASTER RECOVERY 1.2.3.1 Management Functions 1.2.3.1.1 Operator Overview 1.2.3.1.2 Site Failover 1.2.3.1.2.1 Manual 1.2.3.1.2.2 Automatic
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.2.3.2 Failover 1.2.3.2.1 Arbitration 1.2.3.2.2 System Services 1.2.3.2.3 Operator Displays 1.2.3.2.4 Field Data Sources 1.2.3.2.5 Control and Parameter Change Records (Auditing) 1.2.3.3 Synchronization 1.2.3.3.1 Real-Time Database 1.2.3.3.2 Historian and Archives 1.2.3.3.3 SQL Server 1.2.3.3.3.1 Log Shipping 1.2.3.3.3.2 Mirroring 1.2.3.3.4 Other Services 1.2.3.3.4.1 Domain Controllers 1.2.3.3.4.2 Shared Files 1.2.3.3.4.3 Web Services 1.2.3.3.4.4 OPC Servers 1.2.3.3.4.5 3rd Party Systems 1.2.3.4 Performance and Capacity 1.3 Communications with External Systems 1.3.1 HT and Orion Systems 1.3.2 Real-Time Model 1.3.3 SAP PM 1.3.4 Geminis 1.3.5 Other… 1.3.6 Leak Detection 1.3.7 Batch Tracking 1.3.8 Asset Monitoring 1.3.9 Training Simulator
Reports Reports can be built using as a data source with either the embedded historian which supports raw, hourly, daily and monthly data or the external production history database (PDH). Reporting from the embedded historian is handled by ABB, however if the customer requires their own customization of reports, data can be exported to MS Excel. Reports from PDH are accessible and can be distributed using existing e-mail infrastructure and hardcopies printed on existing printers. Access to both historical and real-time data is accessible using SQL, ODBC, and OLEDB standards and utilizes standard Microsoft expandable/collapsible navigation trees and menus. Based on specifications and collected data, reports can also be generated and distributed for specific alarms, events or on scheduled times. The system generates both engineering and accounting style reports. Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.3.10 1.3.11 1.3.12 1.3.13 1.4 Trends 1.4.1 1.4.2 1.4.3 1.4.4
Report Definition Report Destination Report Scheduling Report Printing and Exporting Trend Summarization Trend Groups Trend Application Settings Performance and Capacity
Remote Access The SCADAvantage HMI can be deployed to a Citrix Server for remote desktop access from a web browser. The benefit is a single solution for operator and remote users without sacrificing performance. 1.5 User Configuration and Management 1.5.1 Authentication 1.5.1.1 Native 1.5.1.2 Windows 1.5.2 Permissions 1.5.2.1 Control Type 1.5.3 Areas of Responsibility 1.5.3.1 Zone 1.5.3.2 Zone Group 1.5.4 Trusted Server 1.5.5 Distribution Lists
OPC Server The SCADAvantage OPC Server provides OPC DA, AE and HDA connectivity between SCADAvantage SCADA system and OPC clients. The DA Server can support up to 300,000 points at 60,000 changes per minute. The OPC server can be installed either directly on the SCADAvantage Server computer, or on a separate PC (possibly the machine running the OPC client application or a completely independent computer). 1.5.6 Data Access (DA) 1.5.7 Alarms and Events (AE) 1.5.8 Historical Data Access (HDA) 1.5.9 XML 1.5.10 Unified Architecture (UA) 1.5.11 Performance and Capacity
Gas Measurement SCADAvantage production data history (PDH), based on Microsoft SQL Server, is designed to be the source of production data for oil and gas companies. PDH is tightly coupled with Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
the SCADAvantage real time database so that hourly and daily production data upload from the RTU’s or flow computers is automated complying with API 21.1 recommendations. Gas composition and parameters such as orifice plate size can be uploaded and downloaded directly from PDH to the remote field device. PDH supports trending for any entity that can be numerically defined and tracked over time for e.g. daily values, time on production and gas-oil ratios. A reporting tool is built into PDH to display reports either in SCADAvantage clients or the reports can be saved in HTML format. PDH supports redundancy at the software level providing a hot/standby environment with automatic failover for systems requiring high availability. 1.5.12 Time-Effective Configuration and Retrieval 1.5.13 Electronic Flow Measurement (EFM) Commands 1.5.13.1 Hourly and Daily Uploads 1.5.13.1.1 Data Validation 1.5.13.2 Meter Parameter Upload/Download 1.5.13.3 Gas Analysis Upload/Download 1.5.14 Meter Types 1.5.14.1 Gas 1.5.14.2 Liquid 1.5.14.3 Water 1.5.15 Device Connectivity 1.5.15.1 Facilities 1.5.15.2 Transfer Points 1.5.15.3 Well Test 1.5.15.4 Junctions 1.5.16 Reporting 1.5.16.1 EUB Compliance 1.5.16.2 API 21.1 1.5.17 Settings (Application Device Types - ADT) 1.5.18 Performance and Capacity
Replication SCADAvantage was designed for the unique requirements of the oil and gas industry. Other systems must be manipulated and become a complex engineered solution. A SCADAvantage solution is simple, significantly easier to support and faster to implement. SCADAvantage is scalable and can be applied across a corporation providing an HMI for field SCADA hosts, multiple hosts, and a corporate data consolidation system: All with the same software core. SCADAvantage can start small and expand to meet growing needs. SCADAvantage replication enables separate SCADAvantage systems to share configuration and real-time data. Analogs and digitals configured at one system may be automatically replicated to another system. The polled values are also replicated from one system to another. Set points and digital out commands may then be commanded at either system and the commands are sent to the physical device via the system actively polling the device.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Data consistency between systems is maintained via integrity updates on connect, update by exception, and periodic integrity updates, or a subset of the three. The number of real time exception updates may be reduced by dead banding or only sending values periodically. SCADAvantage replication supports a variety of topographies. Replicated systems may be peers sharing some or all data, master/sub-master systems concentrating data to a single point, or even backup offsite systems ready to take over control in the event of a failure (onsite backup is usually performed via SCADAvantage redundancy which provides more automatic failover). Replicated systems may form complete circles without causing an endless chain of replicated updates. Also, replicated systems may replicate data from a nearby system rather than the original source system in order to reduce bandwidth requirements (data hopping). Data may be selectively replicated to remote systems by either limiting which points (e.g. analogs and digitals) are replicated to a remote system, or by limiting the type of data replicated to a remote system (e.g. configuration, operator configuration, or real-time data). The replication data stream may be compressed for additional efficiency in low bandwidth environments. Publish and Subscribe or “push” technology SCADAvantage uses push technology to optimize the communication between a SCADAvantage client and a SCADAvantage server. Push technology is a type of exception reporting established between the client and the server. When a SCADAvantage client boots up and makes a connection with a SCADAvantage server, the server makes a list of all the points the client needs. The server sends the current status of all of these points during this client start-up. After the first burst of information, the server only “pushes” new information to the client as it changes. The SCADAvantage client does not periodically poll the server for all information as many other systems with client/server architecture do. The use of “push” technology allows SCADAvantage to use low bandwidth communication lines like 19.2K baud phone lines to connect a SCADAvantage client to a SCADAvantage server and still get good performance. Other systems that do not use ‘push’ technology cannot make this claim.
REAL-TIME 1.5.18.1 1.5.18.2 1.5.18.3 1.5.18.4 1.5.18.5 1.5.18.6 1.5.18.7
Publisher Subscriber Monitoring Inclusion/Exclusion of Tags Control Mode Settings Performance and Capacity
1.5.18.8 1.5.18.9
Publisher Subscriber
SQL SERVER
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.5.18.10 1.5.18.11
Settings Performance and Capacity
Graphical User Interface (GUI) The SCADAvantage Client (HMI) is built using Microsoft Visual Studio and includes a set of tools that allow the user to create graphical user interfaces (GUIs) for SCADAvantage. The Client (HMI) supports single and multiple display screens (up to 4 per computer). The graphic interfaces can be as simple as tabular lists of device names and values or as complicated as alarm displays combined with station graphics, real-time values and trend elements on a single screen. Using SCADAvantage client, it is easy to define the look and feel of SCADAvantage to match a company standard. Display builders use Microsoft Visual Studio and the SCADAvantage data objects to build the client environment. The objects are network-ready and are placed on forms by drag-and-drop methods and property settings. Most objects provide advanced data access and control options when a user employs the right-click and flyover functions (the flyover function displays the point name, value, and other information such as failure reasons). The right-click function ability is dependent on the point type and user access and is similar to the right-click features in Windows Explorer. A client executable can connect to many SCADAvantage servers at the same time; system security ensures appropriate access is granted to each server.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
The following objects are available in the SCADAvantage client environment: • • • • • • • •
• •
• • • • •
Alarm Summary – allows access to SCADAvantage alarms. Users can view, acknowledge, and clear alarms. Command Button – allows a number of functions such as screen navigation, device commands, access to trend screens and access to reports. Transparent Command Button- used to create “hot spots” on graphic displays. Event Summary – allows access to SCADAvantage events. Flood Bar – fills a rectangle based on an analog value. This often represents the level in tanks or vessels. Gauge – represents an analog value in a gauge or speedometer format. Grid – displays the tabular results of an SQL query; the grid can use either static or active queries. Infopad – provides an electronic notepad that is used by operators to make operational notes. Template Viewer – This may be used to display templates for wells, compressor stations, valve sites, or any other common display that is reused. Graphic templates save many hours of display building and testing. GISmap – displays database objects on a map and provides a powerful graphical navigation tool for operators. Image – displays a bitmap with coloring based on the associated point’s state. Label – enables the display and input of text and numeric values from the database, for example, a point’s units or value. Slider Bar – enables numeric data entry into the database. Users can enter a value directly or use the slider to enter a value. Status – displays a point’s current value and data quality. Time – displays the current time and date.
A calculation engine is available in the client environment and is used to manipulate database values and create new values in the client executable. The engine is capable of performing mathematic and logic sequences with numbers as well as manipulating and displaying strings and Boolean values.
1.6 General Overview 1.6.1 Display Names and Files 1.6.2 Dynamic Display Files 1.6.3 External Data Access 1.7 Display Component Overview 1.7.1 Full Graphic Capability 1.7.2 Color Palate 1.7.3 Blink 1.7.4 Area Fill 1.7.5 Screen Painting Performance 1.7.6 Cursors 1.7.7 Windows 1.7.8 Alphanumeric Characters 1.7.9 User-Defined Symbols Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.7.10 1.7.11 1.7.12 1.7.13 1.7.14 1.7.15 1.7.16 1.7.17
Graphic Support Pan and Zoom Graphic Element Import Navigation Between Displays Navigation Within Displays Graphic Animation Display Cycling Map Navigation 1.7.17.1 Smart Map
GIS MAP The SCADAvantage GIS Map provides the ability to blend geographic data in the form of maps or satellite imagery with telemetric data provided by a SCADAvantage real-time database. Geographic data sources can deliver geographic data as either bitmap images known as tiles or as vector data consisting of point, line, and area geometry.
The GIS Map uses the ESRI Map Control at its core. The ERSI Map Control is a powerful and feature rich component with panning and zooming features in common with Internet map controls such as Bing Maps and Google Maps. The SCADAvantage GISmap shows operators an overview of the wells, pads or pipelines and devices connected in the field. Symbols or pipes are color coded based on alarm and flash while unacknowledged. A quick search by station name or tag is also included. All information is updated live from the real-time database. A configuration is added to the database, elements are automatically added to the map with no manual refresh needed. When configuration is deleted from the database, elements are automatically removed from the map.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Zooming includes automatic de-cluttering of well or pipelines as the map zooms out. A numeric symbol summarizes the number of elements in a region. Color and flashing is based on the highest priority of any element in alarm. When zooming out on a pipeline network, smaller details are removed from the map. Zooming in shows individual well head or pipeline station details with easy click access to alarms, trends or control actions. The map also supports panning in any direction and limiting the map to stay within a bounded region. The GIS map can display data from commercial GIS Map servers like ArcGIS from ESRI. However, it can also superimpose vector shape data from custom shape files or shape files generated from public GIS map services. The GISmap has also been optimized for touch screen interaction. 1.7.17.2 Plot Object Types 1.7.17.2.1 Wells 1.7.17.2.2 Pipes 1.8 Dynamic Data Type Support 1.8.1 Floating Point Data 1.8.2 Integer Data 1.8.3 Text Data 1.8.4 Digital Status Data 1.8.5 Date and Time Information 1.8.6 Bar Charts 1.8.7 Trends and X/Y Plots 1.8.7.1 Range Selection 1.8.7.2 Groups
DIPSTICKS SCADAvantage trending facility provides for detailed analysis of graphical representations of historical and/or real-time data. This analysis is possible via a mechanism known as a dipstick, which is a vertical line created on the trend graphic area at a date/time of interest. This vertical line is positioned via a single left-click on the trend background and is accompanied by a popup window that contains the data analysis values. The following image shows a simplified view of dipstick analysis:
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
The trend also allow for calculations on values defined by the intervals created by multiple dipsticks. The following image illustrates this:
In the image shown above, four dipsticks have been added to the trending display, yielding three intervals of samples. The calculations pertaining to these intervals are displayed as a column of data between each respective dipstick. 1.8.7.3 Exporting and Printing 1.9 Display Annotations 1.9.1 Required Display Attributes Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.10
1.11
1.9.2 Default Attribute Sets 1.9.3 Data Quality Indicators 1.9.4 Display Annotation Priorities Graphic Displays 1.10.1 Custom Displays 1.10.1.1 Well Monitoring 1.10.1.1.1 Navigation 1.10.1.1.2 Well Types 1.10.1.2 Remote Calibration of Smart Devices 1.10.1.3 Dyno Cards 1.10.1.3.1 Display Dyno Card Diagram 1.10.1.3.2 Managing Reference and Overlay Cards 1.10.1.3.3 Exporting Data 1.10.1.3.4 Printing 1.10.2 External Applications Support 1.10.3 Display Hardcopy Requirements 1.10.4 GUI Reports GUI Operator Functions 1.11.1 Security 1.11.1.1 Passwords 1.11.1.2 Operator Privileges 1.11.1.3 Event Tracking 1.11.1.4 Areas of Responsibility 1.11.2 Feedback 1.11.3 Point Selection Technique 1.11.3.1 Identification of Selectable Fields 1.11.3.2 Pointing Device 1.11.3.3 Selecting a Point with Smart Tabbing 1.11.3.4 Point Select Cancel 1.11.4 Device Control Technique 1.11.4.1 Control Security 1.11.4.2 Validating Controls 1.11.5 Data Entry/Editing Technique 1.11.5.1 Full Screen Editing 1.11.5.2 Editing Functions 1.11.5.3 Cursor and Tab Support 1.11.5.4 Reasonability Checking 1.11.5.5 Audit Trail 1.11.6 Messaging 1.11.6.1 Shift Change via Infopad 1.11.6.2 Instant Messaging 1.11.7 Web Access 1.11.8 Gas Measurement 1.11.8.1 History Editor
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
1.12
1.11.8.2 Gas Analysis 1.11.8.3 Meter Parameters 1.11.8.4 Reports 1.11.8.5 Trends 1.11.8.6 Exporting Data GUI Engineering Functions
TODO For source control on project and product development, ABB uses Microsoft Visual SourceSafe for version or Microsoft Team Foundation Server depending on the needs. ABB recommends some form of source control during HMI display development. While SourceSafe is no longer available to purchase, other revision control systems are available. A comparison of revision control software can be found on Wikipedia. 1.13 1.13.1 GUI Management 1.13.1.1 Templates 1.13.1.2 Projects 1.13.1.3 Controls
DEPLOYMENT The Client Application Manager (CAM) simplifies the process of installing SCADAvantage software on hundreds of operator or web desktops and keeping it up to date. This is especially useful as a SCADAvantage system grows to include multiple servers and multiple clients or when clients are spread across a region or area. CAM ensures lower start-up and maintenance costs for users of SCADAvantage by automatically distributing updated client environment files (typically executable and library files) to client PCs over the network. 1.13.1.3.1 CAM Server 1.13.1.3.1.1 Applications 1.13.1.3.1.2 Elements 1.13.1.3.1.3 Groups 1.13.1.3.2 CAM Client 1.13.1.3.3 Patches and Updates
DATABASE MANAGEMENT BUSINESS OBJECT TEMPLATES (BOTS) A Business Object Template (BOT) is a powerful tool that allows the convenient addition of entire database entities such as well site, valve station or metering station to a SCADAvantage system without requiring the server to be restarted. A BOT appears as a screen with fields to fill in by the user.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Typical fields to be entered in a gas well BOT (for example) are: • • • • • • • •
Area Name Land location Meter number Network communication address RTU device communication address Security Zone Well display name Plot Location
Once these fields are entered and the BOT is executed, the following occurs: 1. 2. 3. 4. 5. 6. 7. 8. 9.
The automatic generation of all the appropriate tags in the database The automatic generation of a new well symbol on the smart map The automatic linking of the symbol to the appropriate well template display The connection of the well tags with the well template display The connection of all links to other displays like trends or point displays The addition of RTU device communication setup and addition to polling schedule The automatic generation of alarm limits The inclusion of buttons to display pre-configured trends and reports The inclusion of pre-defined control sequences
Essentially the new entity is added to the system and is fully functional as if it had been part of the original implementation of the system. Using the BOT, entities can also be removed easily when are abandoned or sold. A bulk number of entities can also be loaded using a spreadsheet with the required information and format.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
BOTs also allow connections to external databases to load and unload information related to the well. When this isn’t enough, there’s also the ability to execute a custom application to load and unload information in a 3rd party system related to a well or metering station. TODO 1.13.1.3.4 Definition 1.13.1.3.4.1 Components 1.13.1.3.4.2 Variables 1.13.1.3.4.3 External Applications 1.13.1.3.4.4 Collections 1.13.1.3.4.5 Toolkit 1.13.1.3.5 Load/Unload
LICENSING Software Licensing Structure 1.13.2 Per-Server Licensing 1.13.3 Site Pool Licensing 1.13.4 Corporate Central Licensing
Hardware Licensing Structure 1.13.5 USB Dongle 1.13.6 MAC Address
Expansion SOFTWARE PATCHING SCADAvantage Patching The following answers some Frequently Ask Questions about SCADAvantage software patches. In all cases, the Caller is an ABB customer who has contacted Product Support with a problem report. When is a Patch provided? Patches are only provided when a suitable work-around with the installed software is not possible. In addition, the following conditions apply: • The Callers version of SCADAvantage must be in the Active phase of the product lifecycle. • The problem has not been previously corrected in a newer service pack or product version. Once the Callers version is in the Classic or Limited phase of the product lifecycle, the Caller must upgrade to the latest service pack or product version before a patch is issued. What’s needed before a Patch is created? Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Before a patch is created, the problem is investigated either by Product Support or a Software Tester. If the problem can be repeated using steps provided by the Caller, the problem is recorded in the bug tracking system and forwarded to Software Development. Otherwise, more information is requested and assigned back to Product Support who: • •
Directly contacts the Caller with additional questions to isolate the problem Directly contacts the Caller to try diagnostic versions of software in order to isolate the problem and/or a solution
Any correspondence between ABB personnel and the Caller is recorded using the
[email protected] e-mail address in order to track progress. How are changes in a Patch managed? With the problem repeated, a solution is created by the Software Developer. When the solution is working and appears to have no side effects, the developer checks in the changes. If the problem can be repeated internally by ABB, the changes are first checked into the next build of a future product release. Otherwise, if the problem requires the Callers environment to test, the changes are first merged into the Callers version of the product. In both cases, the files are checked into source code revision control system. ABB uses Microsoft Visual SourceSafe for version 5.3.1 or older and Microsoft Team Foundation Server for version 5.4.0 or newer. How is the Patch Created? On the computer that originally built the final release of the Callers version of the product, the Software Release Manager carefully gets the specific changes merged into the revision control system. The specific components and any dependencies from other patches are compiled. The resulting changed components and files are combined in a patch folder marked “InDev” to indicate “In development”. A description of what is fixed by the patch plus any side effects and instructions for installing the patch are written. The patch folder is released for testing. Until the patch is released, the build changes are not committed. How is the Patch Tested? In some cases, the Caller may be assigned as the Software Tester to test a patch. This typically happens when the Caller has a specific hardware or firmware version or a complicated communication system (like Satellite) which is not available to ABB. In some cases, the Support Person is assigned as Software Tester since they have remote access to the system that needs patching. However, when ABB can repeat the problem, using a computer with the Callers version of software, the Software Tester follows the instructions to install the “InDev” patch. The Software Tester confirms the problem is corrected. If the problem is not corrected or there are unwanted side effects, the issue is assigned back to the Software Developer or Software Release Coordinator to correct. How is the Patch release managed?
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Once the patch is confirmed to work, the instructions are updated with any additional information found during testing and the patch file updated with the current date. The “InDev” is removed from the patch folder. The files in the patch folder are compressed to a .zip file and marked read-only. A document containing the history of all patches for the corresponding software version is updated to include details about the patch. The machine used to build the patch is committed so future patches include these changes. Finally, if the patch hasn't already been installed, the Support Person emails the patch to the Caller. How does ABB ensure the changes in the Patch are in a future version of the product? Using a computer with the Callers version of software that demonstrates the problem, the Software Tester installs the next build of a future product release. Any database upgrades or HMIs are re-compiled. The Software Tester confirms the problem is corrected. If the problem is not corrected or there are unwanted side effects, the issue is assigned back to the Software Developer or Software Release Coordinator to correct. When both the patch and future product version is confirmed to correct the problem, the resolution in the bug tracking system is set to Closed and Verified. Any recording of the software while it was tested is also associated with the bug. What’s contained in a typical Patch? The following files are common to all patches: • PatchReadMe.txt – a description of what is fixed, any side effects and instructions for installing the patch • GetExistingVersion.vbs – this determines you are running the correct version of the product before installing the patch • PatchInstall.bat – a script file that makes backups and copies new files depending on the SCADAvantage features installed. What happens when a Patch is installed? Before each new file in the patch is copied, a backup of the original file is copied to %SVHOME%\SupportFiles\Upgrade\.BAK folder. Once all files have been updated, the file %SVHOME%\SupportFiles\Upgrade\CurrentHotfixes.txt is modified to indicate this patch has been installed. When a server is started, the contents of CurrentHotfixes.txt are copied at the beginning of the SCADAvantage.txt diagnostic log. When diagnostics are requested by ABB, this helps to determine which patches are already installed. How is a Patch Deployed using CAM? CAM is an optional method for deploying HMI updates to a large number of desktops. Currently, deploying a patch is a very manual process. If the patch includes files for any of the SCADAvantage Client Features (CAM client, Client runtime, Administrator Tools or HMI developer tools), the patch first needs to be installed on the HMI development workstation. Using the files backed up when installing the patch as a guide, the CAM server needs with File Elements for each of these updated files. A CAM group needs to be created which includes all these File Elements. Finally, the CAM group needs to be associated with any CAM application. The HMI application and any templates need to be recompiled and Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
refreshed to the CAM server. The next time a HMI is started, the new files from the patch plus the updated HMI are deployed to the desktop. Other Patch Considerations The Caller is responsible to track the order in which patches are installed. If a SCADAvantage system needs to be re-installed, patches should be installed oldest to newest. The file %SVHOME%\SupportFiles\Upgrade\CurrentHotfixes.txt is updated each time a patch is installed. It’s possible to use this file to determine the order in which patches were installed. Patches may be limited to a real-time server, application server or a client and should only be applied on such a system as directed in the instructions that accompanies the patch. Only systems exhibiting the problem should be patched unless a broader distribution of the patch is recommended by ABB. Patches are for a specific version. Once a newer version of the product is installed on a computer, older patches for the prior version should not be applied. While a patch makes a backup of the original files, there is no automatic undo. ABB recommends testing the patch in a QA environment which supports snapshots and restore capability such as a virtual machine environment like VMware or Hyper-V.
Monthly Microsoft Security Updates
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
Each month Microsoft releases security fixes on the second Tuesday of the month. Other Microsoft product updates are also available at the same time, but are not tested by ABB. TODO – provide more details Below is an example email sent to those customers either under warranty or with active annual maintenance subscriptions. Impact of Microsoft Security Updates for Tuesday, February 14, 2012 on SCADAvantage. You are receiving this e-mail because you have been identified as the IT contact person for ABB's SCADAvantage product within your company. Microsoft released 9 security updates on Tuesday, February 14, 2012. Four of these updates are rated by Microsoft as Critical in severity, and five are rated as Important. ABB's internal testing was completed on SCADAvantage version 5.3.1. ABB has discontinued impact testing of version 5.3.0 starting December 2011 and 5.1.1 and 5.2.0 starting January 2012. Please plan to upgrade accordingly.
MS12-008 - Vulnerabilities in Windows Kernel-Mode Drivers Could Allow Remote Code Execution (2660465) For further details refer to http://www.microsoft.com/technet/security/Bulletin/MS12-008.mspx This update is defined by Microsoft as Critical in severity. This update affects all editions of Windows supported by SCADAvantage. Vulnerability addressed in this update: This security update resolves a privately reported vulnerability and a publicly disclosed vulnerability in Microsoft Windows. The more severe of these vulnerabilities could allow remote code execution if a user visits a website containing specially crafted content or if a specially crafted application is run locally. An attacker would have no way to force users to visit a malicious website. Instead, an attacker would have to convince users to visit the website, typically by getting them to click a link in an email message or Instant Messenger message that takes them to the attacker's website. SCADAvantage impacts: This update affects the Windows Kernel which is always running under Microsoft Windows and therefore it could potentially affect SCADAvantage. ABB's internal testing has not identified any negative impact to the normal operation of SCADAvantage.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
APPENDIX A – MICROSOFT AND OTHER TECHNOLOGY SUPPORT Microsoft Technology Windows XP SP2 Windows XP SP3 Windows Server 2003 SP1 Windows Server 2003 R2 Windows Vista SP1 Windows Vista SP2 Windows Vista SP2 - 64-bit Windows 7 Windows 7 - 64 bit Windows 7 - SP1 Windows 8 Windows Server 2008 Windows Server 2008 - 64-bit Windows Server 2008 R2 Windows Server 2008 R2 SP1 Office 2003 SP2 Office 2007 Office 2010 Internet Explorer 6.0 SP1 Internet Explorer 7.0 Internet Explorer 8.0 Internet Explorer 9.0 Internet Explorer 10 SQL Server 2005 SP2 - 32-bit SQL Server 2005 SP3 - 32-bit SQL Server 2005 SP4 - 32-bit SQL Server 2008 - SP1 - 32-bit SQL Server 2008 - SP1 - 64-bit SQL Server 2008 - SP2 - 32-bit SQL Server 2008 - SP2 - 64-bit SQL Server 2008 R2 - 32-bit SQL Server 2008 R2 - 64-bit SQL Server 2012 .NET 3.5 .NET 4.0 .NET 4.5 Visual Basic 6 SP6 Visual Studio 2008 SP1 Visual Studio 2010 Visual Studio 2010 SP1 Visual Studio 2012 Polyhedra Version
SCADAvantage 5.4.0 N Y N Y N Y Y Y Y Y N Y Y Y Y N Y Y N N Y Y N N N N Y Y Y Y Y Y Y Y N N Y Y Y Y Y 8.5.x
Copyright © ABB Inc. 2003-2012
Year when feature supported 2004-2008 2009 2010 2011 2012
SCADAvantage Technical Description
Revision: 2012
APPENDIX B – SCADAVANTAGE APPLICATIONS, TOOLS AND UTILITIES Tool or Utility
Location
Category
Description
SVSetup.exe
DVD
Installation
Product installation launch screen on the DVD
CLSSoftware\setup.exe
DVD
Installation
InstallSheild installer for ABB Central Licensing Software
InstallDisk\setup.exe
DVD
Installation
InstallSheild installer for SCADAvantage Software
3rdParty\dotnetfx11.exe
DVD
Installation
3rdParty\dotnetfx35.exe
DVD
Installation
Microsoft .NET 1.1 runtime required for Central License Server Microsoft .NET 3.5 runtime requires for SCADAvantage
3rdParty\vcredist_x64_90.exe
DVD
Installation
Visual C++ 32-bit runtime
3rdParty\vcredist_x86_90.exe
DVD
Installation
Visual C++ 64-bit runtime
UpgradeRTRDB.exe
Installed
Upgrade
Real-time database upgrade tool
gacutil.exe
Installed
Installation
SVCpwReset.exe
Installed
Maintenance
fileutil.exe
Installed
Diagnostics
Microsoft utility for registering assemblies in Global Assembly Cache Utility to reset the SCADAvantage service account password Utility to check integrity of historical logs and archives. Launched during nightly backup to confirm backup is good.
Upgrade\420SP1R2\rtrdb.exe
Installed
Upgrade
Upgrade\420SP2\rtrdb.exe
Installed
Upgrade
Upgrade\420SP3\rtrdb.exe
Installed
Upgrade
Upgrade\420SP4\rtrdb.exe
Installed
Upgrade
Upgrade\420SP5\rtrdb.exe
Installed
Upgrade
Upgrade\420SP6\rtrdb.exe
Installed
Upgrade
Upgrade\500\rtrdb.exe
Installed
Upgrade
Upgrade\510\rtrdb.exe
Installed
Upgrade
Upgrade\511\rtrdb.exe
Installed
Upgrade
Upgrade\520\rtrdb.exe
Installed
Upgrade
Upgrade\530\rtrdb.exe
Installed
Upgrade
Upgrade\531\rtrdb.exe
Installed
Upgrade
Upgrade\531\x64\rtrdb.exe
Installed
Upgrade
ABB.Scada.CAM.Assistant.exe
Installed
Desktop Runtime
Version of real-time database shipped with SCADAvantage 4.2.1 Rollup 2 Version of real-time database shipped with SCADAvantage 4.2.2 Version of real-time database shipped with SCADAvantage 4.2.3 Version of real-time database shipped with SCADAvantage 4.2.4 Version of real-time database shipped with SCADAvantage 4.2.5 Version of real-time database shipped with SCADAvantage 4.2.6 Version of real-time database shipped with SCADAvantage 5.0.0 Version of real-time database shipped with SCADAvantage 5.1.0 Version of real-time database shipped with SCADAvantage 5.1.1 Version of real-time database shipped with SCADAvantage 5.2.0 Version of real-time database shipped with SCADAvantage 5.3.0 Version of real-time database shipped with SCADAvantage 5.3.1 - 32-bit version Version of real-time database shipped with SCADAvantage 5.3.1 - 64-bit version
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
CAMAttrib.exe
Installed
Desktop Runtime
Performance any privileged operations during auto-update of client desktop including the ability to reboot the computer. Utility to export measurement data (hourly, daily, analysis and events) to PGAS 6.1 XML file format.
PDHtoPGasExport.exe
Installed
Export
SVAnnunSvr.exe
Installed
Desktop Runtime
HMI runtime application to playback highest alarm sounds to sound card and silence.
SVCAM.exe
Installed
Desktop Runtime
Auto-update desktop runtime or operator HMI before launching. Interactive version.
SVCAMCmdLine.exe
Installed
SVExplorer.exe
Installed
Desktop Runtime Configuration
SVLogin.exe
Installed
Desktop Runtime
Auto-update desktop runtime or operator HMI before launching. SCADAvantage database configuration tool (real-time and measurement) HMI runtime application to authenticate and cache connections to real-time or measurement databases.
SVMessage.exe
Installed
Desktop Runtime
SVPolySetup.exe
Installed
Installation
SVSession.exe
Installed
SVVarServer.exe
Installed
Desktop Runtime Desktop Runtime
HMI runtime variable server for sharing state between HMI forms, users and applications.
TemplateLicMgr.exe
Installed
HMI Development
Utility for registering and licensing OCX controls for use by HMI template viewer.
pdhChopXMLFile.exe
Installed
Export
Utility to break up a large export of measurement data in an XML file into smaller XML files.
pdhExport.exe
Installed
Export
pdhImport.exe
Installed
Import
APPRDBMake.exe
Installed
AppRdbDataService.exe
Installed
DANSrvAE.exe
Installed
HDANSrv.exe
Installed
SVAPPRDBExecutorEngine.exe
Installed
Database Creation Server Runtime Server Runtime Server Runtime Server Runtime
Utility to export measurement data to SCADAvantage XML file. Utility to import measurement data from SCADAvantage XML file. Utility to create the measurement databases.
SVApplicationProcessor.exe
Installed
Server Runtime
SCADAvantage server for hosting general SCADAvantage features written as DLLs.
SVArchive.exe
Installed
Maintenance
Utility to manage archives within the real-time database. Utility can generate, mount and take offline archives. Utility is periodically run by the SCADAvantage Task Scheduler
HMI runtime application to display a popup message from the real-time database for system or administrator generated messages. One time setup of Windows Performance Monitor counters for .NET for Server runtime applications written in .NET.
Windows Service to convert measurement data into standard SQL tables. OPC DA and AE server. OPC HDA server. SCADAvantage server for monitoring real-time tables for actions to perform against the measurement database.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
SVArchiveMerge.exe
Installed
Maintenance
Utility to merge many small archive files into fewer large archive files to optimize database memory.
SVCalcEngine.exe
Installed
Server Runtime
SCADAvantage server that performs tag based software calculations based on configured expressions.
SVCtrlSeqEngine.exe
Installed
SCADAvantage server that performs control sequences
SVDVI.exe
Installed
Server Runtime Server Runtime
SVDatabaseManagerEXE.exe
Installed
Server Runtime
SCADAvantage server that optimizes communication between SVDVI and real-time database.
SVDavisonCMMSIF.exe
Installed
Server Runtime
SCADAvantage server that interfaces with 3rd party Davison Maintenance Management package.
SVDbSave.exe
Installed
Maintenance
SVEFMDataImporter.exe
Installed
Import
Utility to backup database and historical log files, compress and keep collection of backups and verify backups are good. Utility for loading Totalflow measurement data in XML files into the measurement database
SVEventPrinter.exe
Installed
Server Runtime
SCADAvantage server for printing alarm and event logs to line or laser printers
SVExternalProcessor.exe
Installed
SCADAvantage server for emailing callout reports
SVFlowCal.exe
Installed
Server Runtime Server Runtime
SVHostMeterEngine.exe
Installed
Server Runtime
SVImportExport.exe
Installed
Maintenance
Utility to import or export real-time database configuration to .CSV text files.
SVMonitor.exe
Installed
Server Runtime
SCADAvantage server for monitoring network hardware, Windows WMI and performance monitor values and service status and recording in real-time database for trending.
SVRE.exe
Installed
SVReplicationServer.exe
Installed
SVReportSched.exe
Installed
SCADAvantage server for generating instances of scheduled reports SCADAvantage server for publishing real-time data for replication SCADAvantage server for scheduling reports
SVSeqProcessor.exe
Installed
SVSequence.exe
Installed
SVService.exe
Installed
SVServiceCtrl.exe
Installed
Server Runtime Server Runtime Server Runtime Server Runtime Server Runtime Server Runtime Server Runtime
SCADAvantage server that loads protocols to poll real-time database, perform supervisor control and EFM commands.
SCADAvantage server for generating Flow-Cal CFX files. Works with Enterprise version of Flow-Cal via Oracle database. SCADAvantage server for performing hourly and daily Orifice and Turbine meter calculations and storing data in the measurement database.
SCADAvantage server for processing control sequences SCADAvantage server for executing control sequence steps Windows Service to start and stop the SCADAvantage server runtime Utility to auto-restart a SCADAvantage standby server after a network failure.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
SVSysTrayMon.exe
Installed
Server Runtime
SVTaskSched.exe
Installed
Server Runtime
Utility to display a colored ball in the Windows System Tray area. Utility can be used to monitor, stop, start and failover a real-time database. SCADAvantage server to schedule tasks on startup, at a specific time or on a periodic basis.
SVTrendSummarizer.exe
Installed
Server Runtime
SCADAvantage server to calculate or recalculation hourly and daily aggregate values of raw trend history.
SqlReplicaDestination.exe
Installed
SqlReplicaSource.exe
Installed
apprdbMonitor.exe
Installed
rolloverFile.exe
Installed
SCADAvantage server for subscribing to replication of SQL-Server data. SCADAvantage server for publishing SQL-Server data changes. SCADAvantage server for monitoring measurement database availability. Utility for keeping a history of diagnostic logs.
sleep.exe
Installed
Server Runtime Server Runtime Server Runtime Server Runtime Installation
gzip.exe
Installed
ModbusSim.exe
Installed
Server Runtime Diagnostics
General compression utility to compress files such as database backups. Utility to simulate a device that communicates using the Modbus protocol.
merge.exe
Installed
Maintenance
rtrdb.exe
Installed
sqlc.exe
Installed
APPRDBPatchApply.bat
Installed
Server Runtime Server Runtime Upgrade
Utility to merge many small archive files into fewer large archive files. Real-time database engine.
SQL2000to2005cleanup.bat
Installed
Upgrade
Script for cleaning up measurement database after upgrade from SQL-Server 2000 to 2005.
SQL2005to2008cleanup.bat
Installed
Upgrade
Script for cleaning up measurement database after upgrade from SQL-Server 2005 to 2008.
XPFirewallSetup.bat
Installed
Maintenance
expandlogs.bat
Installed
Maintenance
SCADAVisionstartup.cmd
Installed
Server Runtime
Script file to add exceptions to Windows firewall for SCADAvantage servers that communicate over TCP sockets. Script for expanding default historical logs included on the DVD. Script launched by SCADAvantage service on startup to perform any non-standard, project specific commands.
SVServiceRestart.cmd
Installed
Standby.cmd
Installed
SVRefreshFiles.VBS
Installed
Server Runtime Server Runtime Installation
GetExistingVersion.vbs
Installed
Upgrade
Utility to allow delays in Windows batch files.
Utility for running SQL scripts against the real-time database Measurement database upgrade tool.
Script to restart SCADAvantage service after failure. Script to backup historical logs on real-time standby server before restart. Script file for installing or repairing SCADAvantage product features. Script file to determine version of SCADAvantage before upgrade or patching.
Copyright © ABB Inc. 2003-2012
SCADAvantage Technical Description
Revision: 2012
GLOSSARY ADO API APPRDB ASCII CAM CDPD CRC client COM CSV CTS DCOM DVI ESP flyover GUI Hz I/O IP ODBC OLE OLE-DB OPC PC PLC RPM RTRDB RTS server SP TCP user VFD WAV
Active-X Data Object Application Programming Interface Application Relational Database American Standard Code for Information Interchange Client Application Manager Dellular Digital Packet Data Cyclic Redundancy Check A PC running the software that a person uses to run the SCADAvantage applications, Client and Explorer Component Object Model Comma-Separated Value (a file type commonly used by Microsoft Excel) Clear To Send Cistributed Component Object Model Device Interface Electric Submersible Pump The text, with brief information about a tool bar icon, that appears when you hold the cursor on the icon; also known as a tool tip Graphical User Interface Herz (frequency unit) Input / Output Internet Protocol Open Database Connectivity Object Linking and Embedding Object Linking and Embedding–Database OLE for Process Control Personal Computer Programmable Logic Controller Revolutions Per Minute Real-time Relational Database Request To Send The PC that is running the SCADAvantage database Service Pack Transport Control Protocol The person who is running the SCADAvantage software Variable Frequency Drive A format for a PC sound file
Copyright © ABB Inc. 2003-2012
