AutomationStandardsManual Volume3
AutomationStandardsManual Volume3
Process Control
System Standards
and Conventions Manual
Volume 3 – Interface Development Standards
Revision 4.2
July 2021
This page intentionally left blank.
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents
Volume 3 Contents
Volume 3 Contents ......................................................................................................................i
1.0 Revision History .............................................................................................................. 1
2.0 Introduction ..................................................................................................................... 2
3.0 Abbreviations................................................................................................................... 3
4.0 Overview ......................................................................................................................... 5
5.0 Network Architecture ....................................................................................................... 5
5.1 Server and Software Architecture ................................................................................ 5
5.2 PCS Network Architecture ........................................................................................... 6
5.3 Virtual Local Area Networks ......................................................................................... 6
5.4 Network Management .................................................................................................. 7
6.0 Applications ..................................................................................................................... 7
7.0 Wonderware Key Concepts ............................................................................................. 8
8.0 Graphics Display Hierarchy ............................................................................................. 9
8.1 Overview.....................................................................................................................10
8.2 Graphic Screen (Process Unit)....................................................................................11
8.3 Faceplate Display .......................................................................................................13
9.0 Graphics Display Security ..............................................................................................13
9.1 Platform/Application Security ......................................................................................13
9.2 Galaxy Security Role – Default ...................................................................................14
9.3 Galaxy Security Role – 18_Opers (Incinerator Group) ................................................14
9.4 Galaxy Security Role – 2798_Opers (General WWTP Operator Group) .....................15
9.5 Galaxy Security Role – Facility_Managers ..................................................................15
9.6 Galaxy Security Role – HMI Programmers/Domain Programmers/REF Programmers 16
9.7 Galaxy Security Role – Administrator/Administrators/Automation Admins...................17
9.8 Wonderware System Platform – Common Functions (InTouch) ..................................17
9.9 Wonderware System Platform – Electronic Records ...................................................17
10.0 Graphics Logic State Descriptors and Text.....................................................................17
11 Graphics Tags ...................................................................................................................18
11.1 Tag Name Standard....................................................................................................18
11.1.1 Direct Reference Tags .........................................................................................18
11.1.2 HMI Tags .............................................................................................................18
11.1.3 Orphaned Tags ....................................................................................................19
11.2 Tag Configuration Standard ........................................................................................19
12.0 Graphic Symbols and Object Library ..............................................................................19
12.1 Scripting......................................................................................................................20
12.1.1 Base Template Library .........................................................................................20
12.1.2 General Coding Practices ....................................................................................21
i
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents
ii
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents
iii
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents
Tables
Table 5-1 - Existing VLAN .......................................................................................................... 7
Table 5-2 Typical VLAN Subnet ................................................................................................. 7
Table 10-1 Static Text Formatting .............................................................................................18
Table 16-1 Alarm Summary Display Colors...............................................................................25
Table 16-2 Alarm Element Descriptions ....................................................................................27
Table 16-3 Alarm Element Descriptions ....................................................................................27
Table 17-1 Alarm Screamer Element Descriptions ....................................................................29
Table 18-1 Alarm Logging Service Element Descriptions ..........................................................29
Table 18-2 Redundancy Element Descriptions..........................................................................30
Table 18-3 R/W Interrupt Element Descriptions ........................................................................30
iv
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents
Figures
Figure 5-1 Typical HMI Architecture at Processing Sites ............................................................ 5
Figure 5-2 Typical PCS Network Architecture ............................................................................ 6
Figure 8-1 Graphics Display Hierarchy ......................................................................................10
Figure 8-2 Overview Graphic Screen Example..........................................................................11
Figure 8-3 Process Unit Screen Example..................................................................................12
Figure 8-4 Faceplate Example ..................................................................................................13
Figure 12-1 Display Example ....................................................................................................19
Figure 12-2 Mouse-Over Example ............................................................................................20
Figure 12-3 BTL Template Architecture ....................................................................................21
Figure 12-4 Script Header Template .........................................................................................22
Figure 13-1 Faceplate Example ................................................................................................22
Figure 14-1 Alarm Priorities Colors and Symbol Example .........................................................23
Figure 16-1 Alarm Footer Example ...........................................................................................26
Figure 16-2 Alarm Summary – Facility Screen Example ...........................................................26
Figure 16-3 Alarm Summary - System Screen Example ...........................................................27
Figure 17-1 Alarm Screamer - System Screen Example ...........................................................28
Figure 18-1 DB Logger Graphic ................................................................................................31
Figure 19-1 Navigation Graphic ................................................................................................33
Figure 20-1 PID Trend Group....................................................................................................35
Figure 22-1 Standard Piping Colors ..........................................................................................41
Figure 22-2 Standard Row/Column Navigation Diagram ...........................................................42
Figure 22-3 PanelView Plus Main Screen .................................................................................43
Figure 22-4 PanelView Plus Standard Navigation .....................................................................43
Figure 22-5 PanelView Plus Alarm Summary Navigation ..........................................................44
v
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents
Appendices
Appendix A - PCS Network Architecture
vi
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Revision History
1
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Introduction
Update
Revision Revision Date Author Description
Section
4 12/30/2019 NEORSD/PJM 22.4.4 • Deleted 12” PanelView. 7” PV
allowed only with approved
NEORSD deviation request.
4 12/30/2019 NEORSD/PJM 22.4.5.4, • Two subsections on PV keypads
22.4.5.5 deleted. No longer apply for
touch screen only PVs.
4 12/30/2019 NEORSD/PJM 23.0 • Revised title of “NEORSD
Process Control Narrative
Design Standard” to “NEORSD
Process Control Description
Design Standard” and added
reference to PCS Manual, Vol.
5, Sections 22.1 and 23.0 and
Appendix A.
2.0 Introduction
This manual is a compilation of The Northeast Ohio Regional Sewer District’s (NEORSD)
standards for Process Control System (PCS) programming, configuration and design. It is
intended to be applied by the District’s contractors, consultants and in-house personnel when
developing or modifying any portion of the District’s PCS. The PCS is a utility-wide system of
hardware and software that spans the wastewater collection system and all three wastewater
treatment facilities. This document must be treated as both requirements and guidance for PCS
work.
Volume 1 contains an introduction to the Process Control System Standards and Conventions
Manual. It also comprises District policies and procedures that apply to the use and
management of the PCS, including approvals and practices for applying and documenting
changes to hardware and software, code changes, alarm management requirements,
2
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Abbreviations
contractor’s responsibilities related to work performed on the PCS and other related topics. This
volume also contains the standards deviation request form.
Volume 3 is similar in scope to Volume 2 but focuses on operator interfaces and the PCS
subsystem that provides Human-Machine Interface (HMI) functionality. Volume 3 includes the
requirements for programming and configuration of the Area Control Stations (ACSs),
historians, servers and the related network infrastructure. Standards for programming and
display development for Operator Interface Terminals (OITs), industrial operator interfaces
typically located in the field PLC panels, are included in this volume.
Volume 4 is similar in scope to Volumes 1 and 2 but focuses on reports, databases and other
PCS interconnected software,
Volume 5 includes design standards for PCS including panel design, Process and
Instrumentation Diagrams (P&ID), network architecture, and security.
Compliance with the standards and conventions outlined in the manual are required for all
projects that add to or modify the PCS. If a contractor or District staff member identifies a need
for an addition or modification to the standards for a specific project, or if in the course of the
work it is found that some part of the standards cannot be adhered to, a Standards Deviation
Request may be submitted in accordance with the requirements of that section.
Refer to section 14.0 for a complete list of all NEORSD standards and forms, and industry
standards and best practices referenced in this manual.
3.0 Abbreviations
The following is a list of applicable acronyms and definitions which are utilized throughout the
Automation Standards and Conventions Manual.
3
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Abbreviations
4
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Overview
4.0 Overview
The following sections detail the required standards and provide development guidance for the
HMI and OIT platforms components of the PCS. These screens allow process operators to
perform the required process control and monitoring functions from Area Control Stations (ACS)
located throughout the plant.
Replicated Historian
SQL Server
Historian
SQL Server DA Server (Pri) DA Server (Back) SQL Server Thin Manager Thin Manager
5
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Network Architecture
6
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Applications
Westerly VLAN12
Easterly VLAN16
Southerly VLAN20
REF VLAN28
VLAN Subnet
PCS 192.168.14.XX
Network Management 192.168.12.XX
Using the network switch configuration software, enable SNMP. All available alarms shall be set
for SNMP trap and SNMP system location name shall be set to match the name of the
enclosure in which the switch is installed.
Example: ENCLOSURENAME_SW_#, where the number is unique for each switch in the
enclosure. Refer to Process Control System Standards and Conventions Manual, Volume 5,
Section 7.3 for Control Panel (Enclosure) Identification conventions.
6.0 Applications
All new HMI screens are required to be developed using the latest available NEORSD provided
Galaxy .cab file (or equivalent). This file will contain all the currently available (released)
standard library objects from the Wonderware System Platform application to support
development activities.
This export will be re-created periodically as functional elements are added and/or enhanced.
Additionally, other exports will be created as required in order to maintain an appropriate level of
application consistency between the NEORSD master galaxy and any standalone in
development.
Each project shall request, via email to District project manager (or assigned District Process
Controls and Automation (PC&A) contact), a copy of the current Galaxy .cab file immediately
prior to initiating programming activities. Programmer will be directed to a specific file and
location on the District Galaxy server for use. Although updates to the standard may
occasionally occur, the file provided on request date shall be utilized throughout the project.
Only those updates which are determined mission critical (have severe consequences to
7
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Wonderware Key Concepts
operations, life or equipment safety) will be handled on a case by case basis through direct
notice to programmers by PC&A.
The NEORSD Wonderware System Platform HMI is a managed InTouch application which has
been developed using custom NEORSD developed library template objects. Refer to the
NEORSD Standard Object Library Programming Guideline for details on the currently available
object template library or submit an email request to the District project manager.
Note: No InTouch tags (placeholders) are to be used without NEORSD pre-approvals. All
operator screens shall be constructed using NEORSD template objects and graphic symbols.
All new applications must be developed within software environments that use matching
application software revisions, service packs, patches etc. to those at NEORSD. Software
developed using outdated revisions will not be accepted for import into the NEORSD galaxy.
Current supported version list is available on PC&A SharePoint site or by request to PC&A
manager.
To work on that application off-site, the programmer will need to have their own Wonderware
license to open it and work on it. If the application was worked on off-site on a contractor
computer or laptop, the application will need to be transferred back to the District-provided
laptop before returning on-site. When the District-provided laptop is connected to the District
control network, it will again automatically be assigned a license.
A deviation request can be submitted to reserve a license for an extended period of time if the
programmer’s organization is unable to provide one.
At NEORSD there is a SuiteLink client instance for each PLC in the system (ControlLogix,
PLC5/SLC500, or ModbusTCP).
• For PLC5 or SLC500, the specific SuiteLink client instances contain a mapping
conversion table that provides the link between standard object attributes and the PLC
data registers. The DASABTCP I/O server is used.
8
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Hierarchy
• For ControlLogix, the SuiteLink communicates via DASABCIP I/O server directly to the
tag names in the processor without the need for the mapping conversion table or PLC5
SuiteLink client instances. The DASABCIP I/O server is used.
• For ModbusTCP, the specific SuiteLink client instances contains a mapping conversion
table that provides the link between standard object attributes and the PLC data
registers. The DASMBTCP I/O server is used.
In order to successfully connect a PLC to Wonderware, the DA servers must be set up to poll
the PLC using the appropriate protocol (DASABTCP or DASABCIP), and the PLC must have a
properly configured SuiteLink instance within the NEORSD Galaxy.
Wonderware System Platform objects run within engines that are hosted on application servers.
The application servers are load sharing redundant servers (two per site hosted in different
physical locations for physical equipment redundancy) and are capable of completely running
the system in the event of a server failure. InTouch applications providing the runtime process
screens are deployed to individual clients within the galaxy. The system runs in a server-client
configuration where the application servers host the galaxy objects (Wonderware System
Platform database) and the clients display the information.
9
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Hierarchy
OVERVIEW
GRAPHIC
SCREEN
(PROCESS
UNIT)
EQUIPMENT
EQUIPMENT
CONTROL
DETAIL (FACEPLATE)
ALARM
SUMMARY
8.1 Overview
The overview provides a bird’s eye view of the entire plant/facility and all sub-areas (unit
processes) are accessible from this level. The overview screen has graphic pushbuttons which
the user can navigate to a specific sub-area or unit process area. The user cannot monitor or
control any equipment belonging to the sub-areas from the overview screen. The overview is a
means to displays a static descriptive image of the plant/facility and a means to navigate down
to any specific sub-area.
Figure 8-2 is an example of an overview graphic screen for the Southerly Wastewater
Treatment Plant (WWTP) which is the first graphic displayed when the HMI application is
initiated.
10
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Hierarchy
11
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Hierarchy
The unit process screens shall be developed using the P&IDs to define the layout of the
displays. All PCS controlled processing equipment shall be shown on the screens. Hand valves
and other ancillary equipment should only be shown when necessary to clarify the process flow.
NEORSD Standard Object Library shall be used for all animated display components. All
process pipes shall be colored to match color standard defined in Section 22.4.3 of this volume.
12
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Security
The security schema managed in a Galaxy is a three-level configuration model to create and
maintain the following:
13
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Security
Default
NEORSD\HMI Programmers
NEORSD\18_Opers
NEORSD\2798_Opers
NEORSD\Facility_Managers
NEORSD\Domain_Programmers
NEORSD\REF_Programmers
NEORSD\Administrators
NEORSD\Automation_Admins
• User ID and password authentication = OS group based
• By default, setpoint changes are allowed by normal operator access
14
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Security
15
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Security
16
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Logic State Descriptors and Text
• Default Wonderware user with full control of the Wonderware System Platform and
InTouch.
• Access level = 9999 (unchangeable)
• General permissions = All
• Operational permissions = All
• Inactivity Warning – If someone is logged into the system for more than 59 minutes
without any activity on the HMI node, the system will warn the user of a pending
inactivity automatic logout
• Inactivity Timeout – if someone is logged into the system for more than 60 minutes
without any activity on the HMI node, the system will automatically log the user off the
system
• Disable ALT, ESC and Windows keys if the currently logged in user is not an
administrator
17
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Tags
For equipment tags, all text must be uppercase. For all other text, each word in a text string
must begin with an uppercase letter and the subsequent letters must be lowercase. All new
words must begin in uppercase letters. All equipment must carry the same tag name as shown
on the P&IDs.
All static text shall adhere to the settings shown in Table 10-1.
Animated or dynamic objects are associated with an equipment specific status such as on or off
or in maintenance (offline), etc., or with analog values such as flow, level, pressure,
temperature, etc. Dynamic objects can also be a graphic pushbutton, touch area (applicable for
touchscreens only), or static text highlighted against a dynamic object (to indicate alarms or
statuses).
District approved dynamic objects are contained in the NEORSD Standard Object Library; any
exceptions shall submit a PCS Deviation Request Form (Reference Volume 1, Section 12) for
District review and approval prior to implementation.
11 Graphics Tags
This section contains the requirements for HMI tags and is intended to provide consistent usage
throughout the District.
Direct reference tags are used to maximize the runtime performance of tag read/write
operations, minimize tag memory consumption, and remove the added HMI layer for
configuration of basic display read and write operations.
18
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphic Symbols and Object Library
The NEORSD Standard Object Library provides a set of ready to use HMI objects for use in the
development of HMI graphics. The object library makes it easy to create an interface that is
more consistent in both appearance and function. Some standard HMI objects include:
• Pushbuttons
• Selector switches
• Pilot lights
• Tanks and hoppers
• Pumps
• Motors
• Valves
• Red = Running
• Green = Stopped
• Yellow = Alarm
Graphical user interface (GUI) elements such as tooltips shall be Figure 12-1 Display Example
used to display mouse-over text. When the mouse is hovered over
an object, the associated tooltip shall be visible with a text describing the objects function. All
equipment objects shall be configured to display device tag name on mouse-over event (see
example in Figure 12-2).
19
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphic Symbols and Object Library
12.1 Scripting
Scripting is generally available within the HMI development environment. The District does not
utilize scripting unless it is part of the base template library (BTL). Control logic should be
completed within the PLC only. The HMI shall not calculate values or make decisions based
upon multiple inputs. All logic outside of basic scripting must be completed within the PLC.
Refer to PCS Standards and Conventions Manual, Volume 2 for PLC programming standards
and requirements.
Detailed information can be found in the BTL User’s Guide provided by Wonderware with the
utility. Not all of the provided BTL functionality is utilized in the templates derived in the
NEORSD application. In particular, the NEORSD application leverages the following:
20
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphic Symbols and Object Library
The BTL scripts and attributes are found on the “m” Figure 12-3 BTL Template Architecture
(master) and “a” (user) levels of the derived templates.
These have been developed and are maintained by Wonderware as part of the BTL. Template
levels are derived from these base levels, which is where development specific to the NEORSD
application occurs. These templates have the prefix of NEORSD to show they are created and
maintained by the District. This template architecture allows for changes made at the NEORSD
level to be cascaded to all further derived templates and instances.
Developers must avoid making any modifications to the Wonderware developed and supported
“m” and “a” templates and scripts. Where unavoidable, developers must submit and receive
approval of PCS Deviation Request (Reference Volume 1, Section 12). ANY changes made to
the templates MUST be documented and preserved such that they can be reapplied when the
next version of the BTL is imported; otherwise the modifications will be overwritten.
• Native InTouch or ArchestrA button commands, object animation, macros, events, etc.,
should be used to perform HMI functions. When using scripts the following practices
apply to InTouch, Wonderware System Platform and ArchestrA graphic scripts.
o All scripts should be annotated to clearly describe the functionality of the script.
Make use of the native comment capabilities of the software development
environment. To facilitate understanding and readability of the comments, make
use of upper and lower cases when commenting.
• Each written code module should contain a script header unless the script itself is basic
in nature using standard commercial off-the-shelf functionality. When possible, create a
header per the standard indicated in Figure 12-4 and contained in the supplied
developers galaxy:
o Module name
o Author name including company name supplying the code module
o Brief description of the module function
o Revision history
o Date the module was changed
o Name of the person making the change
o The example below shows a typical script header
'Description: Enter a meaningful description that summarizes the functionality (purpose) of the script
'History:
21
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Faceplates
''**********************************************************************************************************************************}
While writing scripts, it is important to apply consistent formats and structure. All scripts should
apply the following recommended practices:
• Large scripts should be separated into smaller functional elements with each major part
commented to indicate what it is doing.
• Show nesting structures clearly by making use of multi-line IF THEN ELSE coding
practices.
• Use consistent indentation to show nesting structures clearly. For example make use of
multi-line IF-THEN-ELSE and For-Next loops.
• If in-line comments are used make sure they line up to the right of the executable code.
• Add a blank line after the header, after variable declarations, and above and below
nested structures (IF-THEN_ELSE, For-Next etc.)
Dead code shall not be left in place. Dead code is defined as code that is resident in the
program but cannot execute. Code that has been commented out is considered dead code.
Comments that explain the function of the code are not considered dead code.
22
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Alarms
[Location][Building number]_[System/Process]_[Description]
Example: W84_PEPS_OVERVIEW
Where:
• W = Westerly
• 84 = Building number
• PEPS = system process, primary effluent pumps
• Overview = description
Reference Process Control System Standards and Conventions Manual, Volume 2, Section
12.1 for naming requirements including plant descriptors, area names and abbreviations.
All alarm messages shall be submitted for District approval prior to implementation.
23
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Configuration
It is important to note that although OIT and HMI system functions can be used to monitor and
generate alarms, in the District’s PCS process alarms shall be generated in the PLCs which will
be logged and displayed on the HMIs and OITs. HMI application shall not be configured to
perform alarm calculations. HMI generated alarms will be utilized only for alarms and events
initiated from within the HMI software such as software status alarms, loss of communications
with a PLC and other system level alarming.
Where necessary, alarm limits must be adjustable through the HMI graphics screens; however,
those alarm limits will be used by the PLC in determining if there is an alarm condition. The
nature of the distributed PCS is such that the PLC-based process control logic can and will
continue to operate, even if one or more HMIs become unavailable. As a result, the PLC must
be able to determine alarm conditions and act accordingly without the need for continuous
communication with the HMI system.
The NEORSD Standard Object Library and add-on instruction (AOI) standard library objects
shall be utilized for configuration of PLC and HMI.
24
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Graphics
Alarm priorities 950-999 are not shown on the alarm footer and by default are not shown on the
alarm summary window. These alarms are viewable on the alarm summary window by selecting
the appropriate filter.
16.2 Graphics
This section discusses how the alarm graphic displays are configured. These screens shall not
be modified without District Approval.
25
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Graphics
• AlarmFooter_Easterly
• AlarmFooter_Southerly
• AlarmFooter_Westerly
• AlarmFooter_EMSC
• AlarmSummary_Easterly
• AlarmSummary_Southerly
• AlarmSummary_Westerly
• AlarmSummary_EMSC
1 2 3 4 5
26
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Graphics
Table 16-2 describes the functions with numerical index in Figure 16-2.
• Alarm Summary_Easterly_System
• Alarm Summary_Southerly_System
• Alarm Summary_Westerly_System
• Alarm Summary_EMSC_System
3 4
2
Table 16-3 describes the functions with numerical index in Figure 16-3.
27
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Banner (Alarm Screamer)
Table 17-1 describes the functions with numerical index in Figure 17-1.
28
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Engine and Historian Configuration
18.1.3 General
Table 18-1 contains the required alarm logging parameter settings.
29
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Engine and Historian Configuration
18.1.4 Redundancy
Table 18-2 contains the required redundancy settings.
18.1.6 Attributes
Table 18-4 contains attribute settings for the alarm services.
18.1.7 Scripts
Table 18-5 contains a listing of scripts and execution types.
30
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Engine and Historian Configuration
Instances
• EngineForAlmLogService_E_AOS1
• EngineForAlmLogService_E_AOS2
• EngineForAlmLogService_S_AOS1
• EngineForAlmLogService_S_AOS2
• EngineForAlmLogService_W_AOS1
• EngineForAlmLogService_W_AOS2
• EngineForAlmLogService_C_AOS1
• EngineForAlmLogService_C_AOS2
18.2 Historian
18.2.1 Description
The historian object is used to trigger alarms based upon the historian’s condition.
18.2.3 Attributes
Table 18-7 describes the historian engine alarm attributes.
31
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Ancillary and System Status Screens
Instances
• Southerly_Historian
• Westerly_Historian
• Easterly_Historian
• EMSC_Historian
32
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Ancillary and System Status Screens
The District standard DIAGNOSTIC LIBRARY file contains symbols specific for generating the
maintenance overview display.
The District standard DIAGNOSTIC LIBRARY file contains PLC rack and chassis elements as
well as global object module symbols for use in generating the rack displays. Module symbols
require configuration.
Most diagnostic templates read RSLinx Enterprise and ControlLogix module defined tag data to
gather diagnostic information. Generally no ControlLogix AOI or programming is required.
If the diagnostic template for a specific module is not available in the District’s DIAGNOSTIC
LIBRARY file, the contractor shall create a new template, using one of the existing templates as
a model.
19.3 Navigation
NEORSD Wonderware application has been developed with a horizontal menu bar system for
navigation between graphics display. Projects that require new screens to be added or screens
to be removed are responsible for modification of the navigation menu bar. Menu bar groupings
are by plant and then process area, if new displays do not fit within a logical process area then
review and approval of proposed menu changes by District is required. Figure 19-1 contains an
example menu bar.
33
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Trends
New processing equipment requires new saved trend groups and addition of analog
instrumentation to existing equipment shall be incorporated into the existing equipment trending
group.
Pre-configured trend groups are required to display both individual equipment performance as
well as performance of the system. Trend groups shall be submitted to the District for approval
prior to factory acceptance testing (FAT) and functionality reviewed at the FAT.
Example groups:
• Equipment: Blower 1
o Blower Running
o Blower Amps
o Blower Temperature(s)
o Blower Vibration(s)
o Blower Discharge Pressure
• System: Blower System
o Blower 1, 2, x – Discharge Pressures
o Blower 1, 2, x – Discharge Temperatures
o Air Header Pressure
o Air Header Temperature
o Branch Pressures
34
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Trends
• Background, Black
• Text Color, White
• Grid (X,Y axis) , Dark Gray
• Pens, in increasing order, see below
Use of the default trend object pen colors established in the template (in increasing order: blue,
light green, red, magenta, white, dark green, yellow, light blue) is required.
35
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Reporting
21.0 Reporting
HMI (SCADA) data is transferred electronically from the Wonderware System Platform to the
operations data management system (ODMS). Transfer of data occurs daily and automatically.
Data transfer time of day shall be coordinated with the District Commissioning Manager. All
reports are generated from ODMS. Specific reporting requirements are contained in Volume 4
of this standard.
The practices outlined in this section shall be used in conjunction with the NEORSD Standard
Object Library Programming Guideline and base PanelView Plus 7 reference project file.
OITs shall be installed on a local PLC network separate from the distributed PCS network.
Installation on an isolated local network allows operations to control process equipment
connected to the OIT’s designated PLC in the event of a PCS network backbone failure.
OIT graphics shall contain functionality required to run process equipment in a designated OIT
mode as defined in the respective process control description (PCD) for the specific project.
All control functionality programmed on the OIT shall be duplicated at the HMI level.
The District standard is for PanelView Plus 7 Performance with touch screen.
36
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
The base PanelView Plus project also contains a set of global objects that provide the
foundation for PanelView Plus application development. The global objects templates are
designed to simplify PanelView Plus application development as well as promote consistency
on HMI interfaces both between systems and across PanelView Plus and Wonderware
platforms.
See the NEORSD Asset Tag Abbreviations File for site, location, and process abbreviations.
This file can be found at the NEORSD Engineering & Construction SharePoint web site at the
Consultant Contractor Resource Page. Use the link for “Equipment Tag Naming Standard”. The
first character in the three-character location code found in column B of the Asset Tag
Abbreviations File is the site designation. The next two characters are the location designation.
For the treatment plants, the location code component is typically a two-digit numeric. For
collection system sites, the location code is typically a two-character alpha. For example, for the
Superior Avenue Pump Station, the site designator is “P” and the “location code” is “SA” for
Superior Avenue. The three characters “PSA” represent the location code found in the Asset
Tag Abbreviations File for the Superior Avenue Pump Station.
[Location]_[System/Process][Train][Parallel]_OIT[Alpha]_[FTversion]
Where:
• Location = For the three treatment plants and EMSC, the initial letter represents
the specific facility (E, W, S, M). The next two numeric digits
represent the process area number/building number. The process
area/building number represents the physical location of the asset.
For the collection system, the initial letter represents the type of
collections facility (e.g., “P” for pump station or “C” for control
structure). The next two letters represents the geographic or street
location. See the Asset Tag Abbreviations File, described above, for
plant and collection system codes.
• Process = the character reference to the process or equipment area being
monitored and/or controlled. See the Asset Tag Abbreviations File,
described above.
37
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
• Train = the number associated with the equipment train (1, 2, 3, etc.), when
applicable. _CMN may be used when multiple trains use a common
PLC for auxiliary controls.
• Parallel = the alphabetical sequence (A, B, C, etc.) for parallel pieces of
equipment associated with the train, when applicable.
• Alpha = Unique alpha character identifying PanelView Plus views that
otherwise would have the same tag descriptor. Characters must be
assigned alphabetically. The alpha code is not required for process or
equipment with only a single PanelView Plus terminal.
• FTversion = The firmware revision of the target PanelView Plus terminal. Use “p”
for the decimal point. Ex: Version 6.1 would be expressed as 6p1
Examples:
• S57_CNT1A_OIT_6p1 (The PanelView Plus terminal associated with Southerly building
57, train 1, first centrifuge, version 6.1)
• S47_WSC3_OIT2_6p0 (The PanelView Plus terminal associated with Southerly building
47, wet scrubber, train 3, panel 2, version 6.0)
FactoryTalk Studio ME automatically sizes the display to match the window size of the target
PanelView Plus device designated in the project settings. Default window sizes are in Table 22-
1.
Device Size
7” Display models* 640x480
38
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
PanelView Plus synchronization is achieved by configuring the global connections (see Table
22-2) within the application:
The default global connection maximum update rate of one second should be maintained.
CLOCK refers to a double integer (DINT) tag array of length seven within the PLC. The array
must be populated through the use of the GSV WALLCLOCKTIME function within logic.
All onscreen functionality will be depicted within a single opened “replace type” screen. This
includes local display time, logged in user indication, the graphical depiction of the process, real
time tag values and control measurements, and screen navigation. Common functionality will be
repeated on each “replace type” screen, as needed.
“On-top” display types shall be used for faceplates and other overlay graphics as required by
the project. With the exception of faceplate graphics included as part of the standard template
library, “On-top” display types should be limited within the project.
39
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
Where:
• Column# = Based on the navigation layout on display 001 – MAIN, the 2-digit
column number of the associated display button. Displays related to
similar processes or functions should be grouped in the same column.
Valid range is from 01 to 39
• Row# = Based on the navigation layout on display 001 – MAIN, the row number
of the associated display button. Valid range is 1 through 9
• Area/Location Process or area description/abbreviation for the displays grouped
Desc = within the same [COLUMN#]. Use the abbreviations in the Asset Tag
Abbreviations File on the Consultant Contractor Resource Page on the
NEORSD SharePoint web site for a complete listing.
• Display Desc = Description identifying the display graphic
Note: If the [AREA DESC] or [DISPLAY DESC] is exceedingly long, try shortening it by using
standard abbreviations shown in the Asset Tag Abbreviations File for a complete listing.
Examples:
• 021 – FW – OVERVIEW
• 022 – FW – SOFTENERS
• 041 – DSP – OVERVIEW
• 044 – DSP – DSP STPTS
The display title shown in the upper left hand corner of each display should be updated with the
display name as outlined above.
Object Color
Background Light Gray (Use Base Project Default)
Header Background, Nav and Other Medium gray (use base project default)
Display Buttons
Process Piping Reference Figure 22-1 below.
Status Animations Reference Section 12.0 of this volume
(On/Off/Event/Fault)
Numeric Display, Numeric Input Light gray background, black font
Disabled
Numeric Input Enable White letters, black background
Label and Desc Text Black
40
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
Object Color
Background Light Gray (Use Base Project Default)
Inanimate, Unknown, or Static Medium gray, or gray shaded/gradient as provided in
Objects FactoryTalk Studio ME libraries
The District maintains an OIT graphic that contains the standard process piping colors, sizes,
and process arrows for use with OIT applications. Developers shall use these standard objects;
any deviations shall be submitted to District for approval.
Process piping shall run either horizontal or vertical and connect at right angles. Piping drawn
diagonally is prohibited.
22.4.4 Font
Labels, descriptions, numeric values, and other textual displays should all be a small sized yet
clearly readable font, Arial style, black, and bold by default. For 15” model PanelView Plus 7
terminals, font sizes 10-12 are acceptable. For PanelView Plus 7, 7” Model, sizes 8-10 are
acceptable. Seven inch screen PanelView allowed only with NEORSD approved deviation
request.
For titles or headings within the graphic display or other text that requires greater attention, the
text size may utilize font size 14-16 and shall be underlined.
For navigation and other functional buttons use text size 8 font, Arial style, black, and bold by
default.
41
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
22.4.5 Navigation
PanelView Plus applications shall follow the navigation standard set forth within the base project
example. Figure 22-2 illustrates the standard row/column navigation approach:
A1 A3 A4
D3 D3 D3
...
AREA 1
The last column of buttons are DISPLAY 2
reserved for any system
ALARM
configuration or system D1 D2 D3
SUMMARY
settings screens. These
screens will be accessible only Hist Stat
ALARM
when the user is logged in with HISTORY
AREA 1
proper security. DISPLAY 3
Hist Stat
22.4.5.1 MAIN
Each PanelView Plus
D1 D2 D3
screen configured as the initial Figure 22-2 Standard Row/Column Navigation Diagram
starting graphic (See Figure
22-3 Example Main Screen) when the application boots. The main screen will contain buttons to
navigate to an overview or primary screen for each process area in the project. Additionally, the
main screen will contain login/logout functionality (future), as well as a shutdown button to
access the terminals native configuration mode for those logged in with proper access rights
(See Section 22.6 for PanelView Security Privileges).
42
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
It is required to use an area overview screen as the first display for the area.
With the exception of calling faceplate and other on top display types, no other go to display
buttons may be placed within the graphic.
43
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
The alarm summary screen (See Figure 22-6) displays the currently active and
unacknowledged alarms. Closing the alarm summary screen returns the user back to the last
viewed process display screen.
44
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
From the alarm summary, the user may navigate to the alarm history screen and, if logged in
with proper rights, the alarm status screen. Closing these screen returns the user back to the
alarm summary, from which they can return back to the last viewed process display.
These displays should still follow the standard naming convention, using a [COLUMN#]
assignment of 30 and an [AREA DESC] description of “OEM”.
Examples:
System testing, debugging, and commissioning displays shall not be used for normal operation.
Screens designed for normal system operation must conform to the graphics standards set forth
in this volume. Access to system testing, debugging, and commissioning screens must be
removed after commissioning. These displays shall configured to only be accessible to users in
the “configuration” security group.
Other than the naming convention above, OEM graphics are not subject to the District standard.
Standard navigation to OEM screens is provided in the base application and should be used
when possible.
Direct reference tags are used to maximize the runtime performance of tag read/write
operations, to minimize tag memory consumption, and to remove the added OIT layer for
configuration of basic display read and write operations.
45
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
The remainder of this section describes the final security settings. Developers are required to
develop applications/screens that will make use of the security privileges and account profiles
detailed below.
46
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
• Enable view all process monitoring screens and additional process setpoint/limit screens
as configured
• Enable open and operate object faceplates for the purpose of device mode selection and
manual control
• Enable view and acknowledge configured alarms
• Enable enter values and change setpoints for select process control points
• Enable enter or change configuration type values on faceplate objects (e.g. alarm limits)
• Restrict access to PanelView Plus terminal settings
47
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
For additional security needs, the application developer should make an attempt to segregate
restricted controls or settings on screens accessible only to those with proper security levels.
The use of visibility animation on navigation buttons is required by the District. Visibility
animation should be evaluated using the CurrentUserHasCode( ) function.
The security code field part of display settings should not be used as a means to restrict access
to displays. The default setting (* - all users) should be retained for consistency.
The logout option on the main screen will logout the current user and login to the default (view
only) account. In order to switch to an operator, supervisor, or configure account, the user shall
be required to select the login option on the main screen.
New PanelView Plus projects are prohibited from providing other user account control functions
other than the default login/logout provided on the main screen in the base project. Set
password functions for logged in users during runtime is prohibited.
22.7 Alarming
22.7.1 Trigger Type
All configured alarm messages within the PanelView Plus application shall use the “bit trigger”
type as opposed to the value and least-significant bit (LSBit) methods. The bit trigger method
aids in reducing the number of alarm trigger tags, which can lead to optimized communications
overhead and memory usage within the running program.
PV_ALARM
Alarming bits on the trigger tag shall not be latched, but instead only held active as long as the
alarm is active. Alarm messages within the PanelView Plus application shall be generated when
the trigger bit value transitions from 0 to 1.
48
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
Several alarm message examples are shown below for a raw water softener skid with three
units:
Alarm messages must fully match across both the HMI and OIT displays as well as the
comments provided in the tag description in the PLC.
In general, the PLC programmers shall decide the alarm message, place the message as part
of the bit field comment of the alarm tag, and provide the same alarm message for OIT and HMI
developers to configure.
The default advanced alarm settings values are shown in Figure 22-8.
49
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
Active and/or unacknowledged alarms may be viewed from the alarm list object displayed on
the alarm summary graphic, which is accessible via navigation from all screens.
A historical log of generated alarms is accessible from a similar alarm list object displayed on
the alarm history graphic. This graphic is accessible from the alarm summary graphic.
The alarm status graphic displays configuration and diagnostic information regarding the alarm
setup for the PanelView Plus application. Alarm status information is only accessible to user
accounts with maintenance level or higher privileges.
No other alarm objects, including alarm lists or banners, shall be created within the PanelView
Plus application.
22.8 Trending
22.8.1 Trend Area Template
Developers shall use the trend template graphic provided with the base PanelView Plus
application for configuring trends within the trend areas. No other process object or other display
information should appear on these screens. Only one trend should appear on each screen.
Examples:
• 111 – TREND – INC TEMPERATURES
• 121 – TREND – FA BLOWER
• 122 – TREND – PA BLOWER
• 131 – TREND – WHB TEMPERATURES
• 132 – TREND – WHB STEAM DRUM
• 133 – TREND – WHB FW
Navigation through the trend screen area follows in a similar manner as process displays
described before. Display 101-Trend Main displays a directory of configured trends screens
from which the user during runtime may navigate between trend areas. When inside a particular
trend area, the user may navigate between trend displays in that area or return to the main
trend directory.
50
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
Trend Color
Background White
Text color Black
Grid (X,Y axis) Dark gray
Pens, in increasing order (See below)
Use of the default trend object pen colors established in the template (in increasing order: blue,
light green, red, magenta, black, dark green, yellow, light blue) is required.
General
Chart style Standard
Chart update mode Automatic
DISPLAY
Chart radix Decimal
Data point connection Connect data points
Display milliseconds Unchecked
Display pen icons Checked
Font Arial, 8, bold
Scrolling Allow
Scroll mode Continuous
Buffer for extra data 2000
51
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
PENS
Width 1
Marker None
X-AXIS
Display scale Checked
Display gridlines Checked
Grid lines 4 major, 0 minor
Y-AXIS
Isolated graphing Unchecked
Display scale Checked
Display grid lines Checked
Grid lines 4 major, 0 minor
Scale options Select each pen on independent scale
Use of data log models is required to provide trend history for all configured application trends.
52
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
The District standard DIAGNOSTIC LIBRARY file contain symbols specific for generating the
maintenance overview display.
The District standard DIAGNOSTIC LIBRARY file contains PLC rack and chassis elements as
well as global object module symbols for use in generating the rack displays. Module symbols
require configuration.
Most diagnostic templates read RSLinx Enterprise and ControlLogix module defined tag data to
gather diagnostic information. Generally no ControlLogix AOI or programming is required.
If the diagnostic template for a specific module is not available in the District’s DIAGNOSTIC
LIBRARY file, the contractor shall create a new template, using one of the existing templates as
a model.
The main maintenance screen (200 – MAINTENANCE OVERVIEW) should contain navigation
links to each PLC rack screen.
53
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal
For a complete list of the objects and instructions on their proper use, refer to NEORSD
Standard Object Library Programming Guideline.
Object instances are created using a drag and drop method onto the desired graphic. Each
instance requires, at a minimum, the associated object parameters shown in Tables 22-11 thru
22-15, generally presented in the following order:
54
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Reference Documents
Document Title
Control of Hazardous Energy (lockout/tagout) – 29 C.F.R. § 1910.147
ISA88, Batch Control Standard
ISA101, Human-Machine Interfaces Standard
NEORSD Asset Tag Abbreviations File
NEORSD Process Control Description Design Standard (See PCS Manual, Vol. 5,
Sections 22.1 and 23.0 and Appendix A)
NEORSD Standard Object Library Programming Guideline
One Point Lesson (OPL)
Selection and Use of Work Practices – 29 C.F.R. § 1910.333
End of Volume 3
55
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Appendix A - PCS Network Architecture
A
Appendix A - PCS Network
Architecture
NEORSD PCS Manual | Volume 3: Interface Development Standards
Appendix A - PCS Network Architecture
neorsd.org