0% found this document useful (0 votes)
56 views

AutomationStandardsManual Volume3

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
56 views

AutomationStandardsManual Volume3

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 66

NEORSD

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

13.0 Graphics Faceplates.......................................................................................................22


13.1 Naming Convention ....................................................................................................23
14.0 Graphics Display Alarms ................................................................................................23
14.1 Alarm Displays by Priority Level ..................................................................................23
14.2 Alarm and Event Messages ........................................................................................23
14.3 Alarm Acknowledgement, Suppression and Shelving .................................................23
15.0 Alarm Configuration ........................................................................................................24
15.1 Overview.....................................................................................................................24
15.2 Nuisance Alarm Suppression Techniques ...................................................................24
15.3 Commissioning Requirements ....................................................................................24
15.3.1 Operational Readiness Review Meetings.............................................................24
15.3.2 Alarms in Active Commissioning State .................................................................24
15.3.3 Alarm and Event Acceptance Matrices.................................................................25
16.0 Alarm Graphics...............................................................................................................25
16.1 Colors .........................................................................................................................25
16.2 Graphics .....................................................................................................................25
16.2.1 Alarm Indications .................................................................................................25
16.2.2 Alarm Footer ........................................................................................................25
16.2.3 Alarm Summary ...................................................................................................26
16.2.4 Alarm Summary_System .....................................................................................27
17.0 Alarm Banner (Alarm Screamer).....................................................................................28
18.0 Alarm Engine and Historian Configuration ......................................................................29
18.1 Engine For Alarm Log Service ....................................................................................29
18.1.1 Description ...........................................................................................................29
18.1.2 Functional Details ................................................................................................29
18.1.3 General ................................................................................................................29
18.1.4 Redundancy ........................................................................................................30
18.1.5 R/W Interrupts......................................................................................................30
18.1.6 Attributes .............................................................................................................30
18.1.7 Scripts..................................................................................................................30
18.1.8 Graphics - DBLoggerConnection .........................................................................31
18.2 Historian .....................................................................................................................31
18.2.1 Description ...........................................................................................................31
18.2.2 Functional Details ................................................................................................31
18.2.3 Attributes .............................................................................................................31
18.2.4 Historian tags .......................................................................................................32
19.0 Ancillary and System Status Screens .............................................................................32
19.1 Overview.....................................................................................................................32
19.2 Screen Requirements and Architecture.......................................................................32
19.2.1 Maintenance Overview ........................................................................................32
19.2.2 PLC Rack Displays ..............................................................................................33
19.2.3 Module Faceplate Displays ..................................................................................33

ii
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents

19.3 Navigation ...................................................................................................................33


20.0 Graphics Display Trends ................................................................................................34
20.1 Trend Overview ..........................................................................................................34
20.2 Trend Groups..............................................................................................................34
20.2.1 PID Control Loops ...............................................................................................34
20.3 Trend Colors ...............................................................................................................35
20.4 Refresh Rate...............................................................................................................35
20.5 Trend History ..............................................................................................................35
20.6 Maximum Pens per Trend ...........................................................................................35
20.7 Custom Trends ...........................................................................................................35
20.8 Logging Data ..............................................................................................................36
21.0 Reporting........................................................................................................................36
22.0 Operator Interface Terminal............................................................................................36
22.1 Introduction .................................................................................................................36
22.2 PanelView Plus Framework ........................................................................................36
22.2.1 Overview..............................................................................................................36
22.2.2 Standardized Objects and Functions ...................................................................37
22.3 Project Settings...........................................................................................................37
22.3.1 PanelView Plus Application Name .......................................................................37
22.3.2 Project General Settings ......................................................................................38
22.3.3 Project Runtime Settings .....................................................................................38
22.3.4 Internal Clock Synchronization .............................................................................38
22.3.5 Other Global Connections ....................................................................................39
22.3.6 MER Files ............................................................................................................39
22.4 PanelView Plus Display Development.........................................................................39
22.4.1 Display Type ........................................................................................................39
22.4.2 Display Name ......................................................................................................40
22.4.3 Color Standards ...................................................................................................40
22.4.4 Font .....................................................................................................................41
22.4.5 Navigation ............................................................................................................42
22.4.6 System Testing, Debugging, and Commissioning Screens ..................................45
22.5 PanelView Plus Tag Reference and Usage ................................................................45
22.5.1 Direct Reference Tags .........................................................................................45
22.5.2 OIT Tags..............................................................................................................45
22.6 PanelView Plus Security .............................................................................................45
22.6.1 User Groups and Accounts ..................................................................................46
22.6.2 General Account Privileges and Restrictions .......................................................46
22.6.3 Configuring Security Access ................................................................................47
22.6.4 Account Login/Logout ..........................................................................................48
22.6.5 Auto Logout .........................................................................................................48
22.7 Alarming .....................................................................................................................48
22.7.1 Trigger Type ........................................................................................................48
22.7.2 Trigger Tag ..........................................................................................................48

iii
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Volume 3 Contents

22.7.3 ControlLogix Trigger Routine ...............................................................................48


22.7.4 Trigger Label........................................................................................................49
22.7.5 Message Guidelines ............................................................................................49
22.7.6 Advanced Settings ...............................................................................................49
22.7.7 Alarm Displays .....................................................................................................49
22.7.8 Alarm Filtering......................................................................................................50
22.8 Trending .....................................................................................................................50
22.8.1 Trend Area Template ...........................................................................................50
22.8.2 Trend Display Naming .........................................................................................50
22.8.3 Other Trends........................................................................................................51
22.8.4 Trend Colors ........................................................................................................51
22.8.5 Refresh Rate........................................................................................................51
22.8.6 Trend History .......................................................................................................51
22.8.7 Maximum Pens per Trend ....................................................................................51
22.8.8 Other Trend Settings............................................................................................51
22.9 Data Logging ..............................................................................................................52
22.9.1 Number of Models ...............................................................................................52
22.9.2 Maximum Data Points ..........................................................................................52
22.9.3 Logging Path........................................................................................................52
22.9.4 Log Triggers ........................................................................................................52
22.9.5 Tags In Model ......................................................................................................52
22.10 PanelView Plus I/O Diagnostic Screens ..................................................................52
22.10.1 Overview ..........................................................................................................52
22.10.2 Screen Requirements and Architecture ............................................................52
22.10.3 Area and Navigation .........................................................................................53
22.11 PanelView Plus Standard Control Templates ..........................................................54
22.11.1 Global Object Templates ..................................................................................54
22.11.2 General Usage Requirements ..........................................................................54
22.11.3 Global Object Default Values ...........................................................................55
23.0 Reference Documents ....................................................................................................55

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

Table 18-4 Attribute Element Descriptions ................................................................................30


Table 18-5 Script Element Descriptions ....................................................................................30
Table 18-6 DB Logger Element Description ..............................................................................31
Table 18-7 Historian Alarm Descriptions ...................................................................................32
Table 22-1 Default Window Sizes .............................................................................................38
Table 22-2 Global Connection Synchronization.........................................................................39
Table 22-3 Color Standards for Displays ...................................................................................40
Table 22-4 Advanced Alarm Settings ........................................................................................49
Table 22-5 Standard Trend Colors ............................................................................................51
Table 22-6 Standard Trend Settings .........................................................................................51
Table 22-7 Discrete Valve and Motor Objects ...........................................................................54
Table 22-8 Analog Objects ........................................................................................................54
Table 22-9 Discrete Objects ......................................................................................................54
Table 22-10 PID/PIDE Objects..................................................................................................54
Table 22-11 Diagnostic Module Objects ....................................................................................55
Table 23-1 Reference Documents.............................................................................................55

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

Figure 22-6 PanelView Plus Alarm Summary ............................................................................44

Appendices
Appendix A - PCS Network Architecture

vi
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Revision History

1.0 Revision History


Update
Revision Revision Date Author Description
Section
0 02/21/2017 HDR All DRAFT
• Modification as part of APM
Program. Restructured to 5
volumes and update to current
industry best practices.
• All sections contain updates
from ASCM
• Note optional text in { } for
recommended options to
incorporate
1 05/05/2017 HDR All FINAL
2 09/28/2017 HDR 5.3 VLAN Updates
2.1 12/12/2018 HDR 5.2 & DRAFT
Appendix • Network Diagram Updates
A
3 04/16/2019 HDR 9.5 • Updated Facility Manager’s role.

4 12/30/2019 NEORSD/PJM 3.0 • Added GUI to Abbreviations


4 12/30/2019 NEORSD/PJM 12.1, • Fixed typos for BTL abbreviation
12.1.1
4 12/30/2019 NEORSD/PJM 15.1 • Updated reference to District
Alarm Management Strategy to
Vol. 5, Section 12.
4 12/30/2019 NEORSD/PJM 22 Throughout Section 22:
• Updated OIT from “PanelView
Plus” to “PanelView Plus 7
Performance model with touch
screen”
• 7” PV for vendor packages only
with approved deviation request.
• Deleted references to 12” PVs.
• Deleted references to PV
keypads.
4 12/30/2019 NEORSD/PJM 22.1 • Revised title of Process Control
Narrative to Process Control
Description.
4 12/30/2019 NEORSD/PJM 22.3.1 • Added E&C SharePoint location
for NEORSD Asset Tag
Abbreviations File
• First bullet item for “Location” –
clarified that the two-digit
process area assigned to OITs
(and other PCS assets)
represents the physical location
of that asset.
4 12/30/2019 NEORSD/PJM 22.3.2 • Deleted 12” PanelView. 7” PV
allowed only with approved
NEORSD deviation request.

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.

4.1 11/30/2020 NEORSD/PJM 11.1.3 Whenever PLC hardware is


removed or demolished delete all
orphaned Wonderware configuration
and tags.

4.1 11/30/2020 NEORSD/PJM 18.2.4 Added requirement for application


programmer to update Tier 1 and
Tier 2 Wonderware Historian tags.
4.1 11/30/2020 NEORSD/PJM Appendix Revised the two control system
A network drawings. Added DLR.
4.2 07/27/2021 NEORSD/PJM 6.0 Added information on Wonderware
licensing.
4.2 07/27/2021 NEORSD/PJM 20.8 Added section “Data Logging” for
setting data precision using the
object attribute
DB_Precision_Group.

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.

This manual is divided into five main volumes:

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 2 addresses practices for development and programming of control processors,


primarily programmable logic controllers (PLCs) of various types, including requirements for
programming software, databases, alarm processing, networking, control loops, control logic
structure, I/O layout and signal processing, tagging and naming conventions.

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.

A2ALMDB Wonderware Alarm and Event Database


ACS Area Control Stations
AOI Add-On Instruction (RSLogix PLC)
AOS Application Object Server (Wonderware)
APM Automation Program Management
BTL Base Template Library (Wonderware Scripting)
CAD Computer-Aided Drafting
CAT Category - relates to communication cable types such as CAT5, CAT6, etc.
CIP Capital Improvement Project
CLX Allen-Bradley ControlLogix PLC
CPU Central Processing Unit
DAS Data Acquisition Server (Wonderware)

3
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Abbreviations

DASABCIP Data Acquisition Server – Allen Bradley IP Driver


DASABTCP Data Acquisition Server – Allen Bradley TCP driver
DASMBTCP Data Acquisition Server – Allen Bradley Modbus TCP driver
E&C Engineering and Construction
EMSC Environmental and Maintenance Services Center
FAT Factory Acceptance Test
FBD Function Block Diagram
GUI Graphical User Interface
HART Highway Addressable Remote Transducer (Communication protocol feature on some
instrumentation)
HMI Human Machine Interface
ID Identification
IO or I/O Input/Output - refers to process signals or signal processing equipment
IP Internet Protocol
ISA International Society of Automation
IT Information Technology
JSR Jump Subroutine
LAN Local Area Network
MOC Management of Change
NEORSD Northeast Ohio Regional Sewer District
O&M Operation and Maintenance
ODMS Operational Data Management System (See PDMS)
OEM Original Equipment Manufacturer
OIT Operator Interface Terminal
OPL One Point Lesson
P&ID Process and Instrumentation Diagram
PC&A Process Control and Automation
PCD Process Control Description
PCS Process Control System
PDF Portable Document Format (.pdf file format)
PDMS Process Data Management System (replaces ODMS)
PID Proportional-Integral-Derivative (Used in control output algorithm)
PLC Programmable Logic Controller
RFI Request for Information
RTU Remote Terminal Unit
SFC Sequential Function Chart
SCADA Supervisory Control And Data Acquisition
SLC Allen-Bradley small PLC model
SMC System Management Console
SMP Standard Maintenance Procedure
SNMP Simple Network Management Protocol
SOP Standard Operating Procedure
SQL Structured Query Language
UDT User Defined Data Type
UPS Uninterruptible Power Supply

4
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Overview

USB Universal Serial Bus


VLAN Virtual Local Area Network
WAM Oracle’s Work and Asset Management Application Software
WAN Wide Area Network
WWTP Wastewater Treatment Plant

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.

5.0 Network Architecture


5.1 Server and Software Architecture
Figure 5-1 diagram illustrates the PCS Software features and installation locations.
PDMS

Replicated Historian

SQL Server

Historian

GR Node AOS #1 AOS #1 Historian Terminal Server #1 Terminal Server #2


(Redundant) (Redundant) (Redundant) (Redundant)

SQL Server DA Server (Pri) DA Server (Back) SQL Server Thin Manager Thin Manager

System Platform Eng 1 Eng 2 Eng 2 Eng 1 Historian InTouch InTouch


(Pri) (Back) Redundancy (Pri) (Back) Redundancy

InTouch Eng 3 Eng 4 Eng 4 Eng 3 Historian Client Historian Client

Eng 5 Eng 6 Eng 6 Eng 5

Ethernet PLC Connections

Figure 5-1 Typical HMI Architecture at Processing Sites

System features include:

• Single Galaxy repository server


• Redundant Application Object Servers (AOS) for each processing site
• Redundant data acquisition servers (DAS) for each processing site

5
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Network Architecture

• Redundant thin client servers for each processing site


• Historian store and forward (prevents data-loss by locally buffering data in the event the
historian connection is lost)
• Historian for each processing site
• Single process data management system (PDMS)

5.2 PCS Network Architecture


Figure 5-2 depicts the PCS network architecture from a Wonderware DAS to an I/O Device. For
simplicity, a single PLC is shown here to represent a typical installation; full network architecture
examples are provided in Appendix A. The Appendix A drawings have been revised to
show device level ring (DLR) network communications between the PLC rack and remote
I/O (RIO) racks.

Figure 5-2 Typical PCS Network Architecture

5.3 Virtual Local Area Networks


Each processing site contains two virtual local area networks (VLANs); the primary VLAN is
utilized for all PCS communications. A secondary VLAN is installed for network switch
management. IP address and VLAN assignment requests shall be submitted to the PC&A
manager.

6
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Applications

Table 5-1 - Existing VLAN

Westerly VLAN12
Easterly VLAN16
Southerly VLAN20
REF VLAN28

Table 5-2 Typical VLAN Subnet

VLAN Subnet
PCS 192.168.14.XX
Network Management 192.168.12.XX

5.4 Network Management


The District has deployed LANSweeper for network inventory management at each processing
facility. All new network devices must have simple network management protocol (SNMP)
information configured for integration with this software.

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.

When a Wonderware application is configured on the District control network on a District-


provided laptop, a license will automatically be assigned from the pool of available licenses.
Starting with Wonderware 2020 (AVEVA System Platform 2020), there has been a change in
how Wonderware allocates licenses. When the application is closed and the programmer
disconnects from the District network, that license is automatically released 20 minutes after
logoff.

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.

7.0 Wonderware Key Concepts


The Wonderware System Platform product contains key concepts that need to be understood in
order to plan, design, and implement an application. Some key concepts include DAS (supply
data to client nodes), alarm DB logger manager, application servers, Galaxy repository,
historian, information server, and HMI clients.

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.

8.0 Graphics Display Hierarchy


Graphics display hierarchy includes multiple levels. The graphics hierarchy shall be maintained
such that no more than two clicks are required to navigate to any process screen from any
location. The graphics provide progressive layers of system details ranging from plant and area
overviews to specific equipment details; each of these layers are described in subsequent
sections of this volume.

Figure 8-1 shows an overview of the graphic display hierarchy.

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

Figure 8-1 Graphics Display Hierarchy

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

Figure 8-2 Overview Graphic Screen Example

8.2 Graphic Screen (Process Unit)


This view displays the process unit screen. The plant/facility will be subdivided into various
process units and components of these process units will be displayed on the process unit
screen. Depending on the equipment in each process unit more than one graphic screen may
be required for a single process unit.

Figure 8-3 is an example of a process unit screen at the Southerly WWTP.

11
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Hierarchy

Figure 8-3 Process Unit Screen Example

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

8.3 Faceplate Display


Faceplate display provides an equipment control level to
enable management of all statuses, alarms and operating
modes for the concerned equipment. This view enables the
operator to take control action on the associated equipment.
From the graphic screen for a particular process unit the
operator can click on the equipment object to bring up its
associated window. Interactions with faceplate control
elements is restricted by security group as described in
Section 9 of this volume.

Faceplates are further described in Section 12 of this


volume.

9.0 Graphics Display Security Figure 8-4 Faceplate Example


Security settings let you control access to:

- User interfaces in the ArchestrA environment


- Object attributes and associated data
- Connection to the SQL Server database used for the Galaxy Repository.

The security schema managed in a Galaxy is a three-level configuration model to create and
maintain the following:

- Users associated with specific roles


- User roles associated with specific system administration, configuration and run-time
(operational) permissions, which map to security groups;
- Security groups associated with specific objects in the Galaxy. Every object in the
Galaxy belongs to only one security group. These security groups are mapped to
roles.

9.1 Platform/Application Security


The application security has been configured as follows:

• Authentication mode = OS group based (security model)


• Configurable intervals
o Security groups
 18_Opers
 2798_Opers
 Admin
 Managers
 Default
o Users and roles
 Administrator

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

9.2 Galaxy Security Role – Default


By default, all currently used objects are assigned to a security group called Default. A user who
is a member of a role assigned to Security Role “Default” has permission to:

• View only, no Wonderware System Platform or InTouch permissions


• Print displays
• Access level = 0
• General permissions = None
• Operational permissions = None

9.3 Galaxy Security Role – 18_Opers (Incinerator Group)


The 18_Opers role is comprised of the union members of the Incinerator operations group. A
user who is a member of a role assigned to Security Role “18_Opers” has permission to:

• Restrict Wonderware System Platform permissions


• Enable basic controls within InTouch (turn pumps on/off, open/close valves, change from
auto/man, etc.) and specific setpoints required for operations
• Enable only to control equipment within specified areas (details provided by District/
Wonderware System Platform)
• Access level = 500
• General permissions = None
• Operational permissions
o 18_Opers
 Enable acknowledge alarms
 Enable modify configure attributes
 Enable modify operate attributes
 Enable modify tune attributes

14
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Security

9.4 Galaxy Security Role – 2798_Opers (General WWTP


Operator Group)
The 2798_Opers role is comprised of the union members of the General WWTP operations
group. A user who is a member of a role assigned to Security Role “2798_Opers” has
permission to:

• Restrict Wonderware System Platform permissions


• Enable basic controls within InTouch (turn pumps on/off, open/close valves, change from
auto/man, etc.) and specific setpoints required for operations
• Enable only to control equipment within specified areas (details provided by
District/Wonderware System Platform)
• Access level = 500
• General permissions = None
• Operational permissions
o 2798_Opers
 Enable acknowledge alarms
 Enable modify configure attributes
 Enable modify operate attributes
 Enable modify tune attributes

9.5 Galaxy Security Role – Facility_Managers


The Facility_Managers role is comprised of Supervisors, Managers and Superintendents. A
user who is a member of a role assigned to Security Role “Facility_Managers” has permission
to:

• Restrict ArchestrA permissions


• Enable basic controls within InTouch (turn pumps on/off, open/close valves, change from
auto/man, etc..) as well as setpoints restricted to the operators
• Reset the runtime values and start counts for motorized equipment
• Access level = 1000
• General permissions = None
• Operational permissions
o 18_Opers
 Enable acknowledge alarms
 Enable modify configure attributes
 Enable modify operate attributes
 Enable modify tune attributes
o 2798_Opers
 Enable acknowledge alarms
 Enable modify configure attributes
 Enable modify operate attributes
 Enable modify tune attributes

15
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Security

9.6 Galaxy Security Role – HMI Programmers/Domain


Programmers/REF Programmers
The Programmers role is comprised of PC&A and Contractors. A user who is a member of a
role assigned to Security Role “Programmers” has permission to:

• All permissions of Facility_Manager plus restricted Wonderware System Platform


permissions.
• Within Wonderware System Platform, enable derive new instances, create/edit windows,
etc.
• Restrict edit/create templates
• Access level = 9000
• General permissions
o IDE Permissions
 Enable start the IDE
 Importing and exporting
• Enable utilize Galaxy load/Galaxy dump
 General configuration
• Enable modify deployed instances
• Enable ability to disable change comments
• Enable override checkout
• Enable upload from runtime
 System configuration
• Enable create/modify/delete system object Instances (platforms and engines)
• Enable create/modify/delete area objects
 Device integration objects
• Enable create/modify/delete device integration object instances
 Application configuration
• Enable create/modify/delete application object instances
 Deployment permissions
• Enable deploy/undeploy system objects
• Enable deploy/undeploy area objects
• Enable deploy/undeploy application objects
• Enable deploy/undeploy device integration objects
• Enable mark an object as undeployed
 Graphic management permissions
• Enable create/modify/delete view applications
• Enable deploy/undeploy view applications
o System management console (SMC) permissions
 Enable start the SMC
 Enable start/stop engine/platform
 Enable write to GObject attributes using object viewer
• Operational permissions = All

16
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Logic State Descriptors and Text

9.7 Galaxy Security Role –


Administrator/Administrators/Automation Admins
The Administrator role is comprised of specific PC&A personnel. A user who is a member of a
role assigned to Security Role “Administrator” has permission to:

• Default Wonderware user with full control of the Wonderware System Platform and
InTouch.
• Access level = 9999 (unchangeable)
• General permissions = All
• Operational permissions = All

9.8 Wonderware System Platform – Common Functions


(InTouch)
This section contains common functions that secure InTouch include Inactivity triggers and
Windows key blocks.

• 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

9.9 Wonderware System Platform – Electronic Records


• A2ALMDB database stores events and alarms with user information within SQL on the
historian
• Analog values are stored in the runtime database within SQL on the historian
• All event and alarm records are stamped with date and time in coordinated universal
time (UTC)
• Electronic signatures are based on a combination of an identification code (user name)
and password
• Preserving user name uniqueness can be maintained assuming users are disabled and
never deleted. The PC&A group manages this function with procedural controls

10.0 Graphics Logic State Descriptors and Text


Static text and static objects are objects that do not change in response to change in input or
output statuses. They retain their text color irrespective of their associated equipment run-time,
alarm or maintenance status. Static text identifies the graphic screen title and static objects. All
text must be in US English and all units must be in US Imperial system.

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.

Table 10-1 Static Text Formatting

Text Font Style Size Alignment Color


Graphic screen title Arial Bold 18 Centered Black
Equipment tag Arial Bold 14 Centered Black
Static text Arial Regular 14 Justified Black
Alarm summary Arial Regular 14 Right aligned Dynamic

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.

11.1 Tag Name Standard


11.1.1 Direct Reference Tags
All references to ControlLogix tags made within a project shall be made using direct (device)
reference.

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.

11.1.2 HMI Tags


HMI tags in general shall not be used to link application elements (tag displays, trends, data log
models, etc.) with ControlLogix controller tags. Instead, direct reference tags shall be used
wherever possible.

18
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphic Symbols and Object Library

11.1.3 Orphaned Tags


Whenever PLC hardware is removed or demolished remove all orphaned Wonderware
configuration and tags.

11.2 Tag Configuration Standard


Reference Process Control System Standards and Conventions Manual, Volume 2, Section
12.1 for tag naming requirements.

12.0 Graphic Symbols and Object Library


The ISA 101 HMI standard is an industry standard developed by the ISA 101 HMI committee
which establishes standards, recommended best practices and guidelines pertaining to HMI
interfaces in manufacturing applications. The ISA 101 HMI standard serves as a guideline to
help organizations design, build and operate effective HMI applications. The NEORSD Object
Library incorporates recommendations from ISA 101. All new objects and displays shall follow
the current ISA 101 recommendations at time of development to maintain system with latest
industry standards.

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

These preconfigured objects are animated to District color


standards:

• 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

Figure 12-2 Mouse-Over Example

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.

12.1.1 Base Template Library


The BTL is provided by Wonderware as a free utility that contains preconfigured application
server objects for development use. The objects provide common HMI functions that are built
using Wonderware best practices for template derivation, modeling, and scripting. The BTL
serves as the framework for NEORSD application development.

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:

• Automatic I/O Binding - By configuring attributes


with “---“, the BTL scripting will automatically link
the attribute to the device integration object or
SuiteLink. This aids with linking Wonderware
application data to tag information provided by
the PLC.
• Object & Model Meta Data Exposure - Helps
expose or pass information across the model
hierarchy so that individual components can
access related components in the galaxy. For
example, a generic trend object called from a
graphical faceplate has access to historical
values and scaling needed to draw the trend for
that specific faceplate instance.

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.

12.1.2 General Coding Practices


Accepted best coding practices should always be applied to any code development. The District
has the following general practices that should also be applied during development.

• 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

{'***************************************************** Revision History ********************************************************

'Module Name: Script Name

'Author: First Name & Last Name (Company)

'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

'Rev By Date Modification

'1.0 Russell Riccardi (RoviSys Company) dd-Mmm-YY Creation of Script

''**********************************************************************************************************************************}

Figure 12-4 Script Header Template

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.

13.0 Graphics Faceplates


Each process display graphic screen provides statuses, alarms
and operating modes for all equipment associated with that
graphic screen. From the process display graphic screen, the
operator shall be able to take control action for equipment
associated with the faceplate. Clicking on the equipment object
shall bring up a specific faceplate associated with that
equipment.

Faceplate display should allow the operator to monitor and


control the action of a pump, motor, valve or analog value for
operational, maintenance, engineering, alarming or trending
purposes.

When the equipment has been designated as out of service its


faceplate should highlight an out of service status. When the
equipment is locked and tagged out, the associated start/stop or
auto/manual buttons should be rendered unavailable (greyed Figure 13-1 Faceplate
Example
out) for the operator to avoid accidentally energizing the
associated circuit.

22
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Alarms

13.1 Naming Convention


The District’s defined naming conventions shall be followed for all program development
including Wonderware HMI screen names.

The filename format is as follows:

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

14.0 Graphics Display Alarms


14.1 Alarm Displays by Priority Level
The NEORSD Standard Object Library contains objects
with pre-defined alarm attributes and animations.
Currently, there is no differentiation within the process
displays for alarm levels.

14.2 Alarm and Event Messages


Alarm and event messages shall be configured utilizing
plain English to describe the alarm clearly to an operator.
Alarm message shall not contain the tag name in the
message. Alarm messages are limited to 50 characters to Figure 14-1 Alarm Priorities Colors and
fit within the configured alarm banners. Symbol Example

Example: “Polymer Pump 1 Overload” or “Effluent D.O. High High Level”

All alarm messages shall be submitted for District approval prior to implementation.

14.3 Alarm Acknowledgement, Suppression and Shelving


Alarm handling methods and user privileges are detailed in District Alarm Management Strategy
Volume 5, Section 10.

23
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Configuration

15.0 Alarm Configuration


15.1 Overview
Alarm configuration requirements are contained in District Alarm Management Strategy, Volume
5, Section 12. Any alarm modification, addition or deletion must follow alarm definition and
rationalization procedures discussed in the alarm management strategy prior to implementation.

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.

15.2 Nuisance Alarm Suppression Techniques


All nuisance alarm suppression shall be by approved methods documented in District Alarm
Management Strategy (Reference PCS Standards and Conventions Manual, Volume 5, Section
10.0) including, but not limited to, state-based or state dependent alarms, time delay, filtering,
and first-out logic.

15.3 Commissioning Requirements


Commissioning activities create abnormal alarm situations; this section contains requirements
for alarm and event system during commissioning activities.

15.3.1 Operational Readiness Review Meetings


Alarms and events risk review shall be reviewed at operational readiness meetings to determine
alarm owner (contractor or operations) based on risk to process and processing equipment.

15.3.2 Alarms in Active Commissioning State


Alarms and events which are not turned over to operations at operational readiness review are
required to be suppressed by means of PLC logic suppression outside of testing hours to avoid
presenting operators with nuisance and/or unknown alarms.

24
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Graphics

15.3.3 Alarm and Event Acceptance Matrices


The District utilizes the defined average alarm rate of less than six alarms per hour period as
defined in alarm management strategy as maximum allowable alarm rate for acceptance of
modifications to alarm system. After commissioning activities have been completed, system
shall run for 30 days in hands-off mode to document alarm rates for modified alarms.

16.0 Alarm Graphics


16.1 Colors
Alarms of different priorities are displayed on the alarm footer and alarm summary using
different colors and animations to aid in their identification. Color configuration for alarms is
shown in Table 16-1.

Table 16-1 Alarm Summary Display Colors

Unacknowledged Acknowledged Alarms Unack-Return Alarms


Alarms + Flash Unack Alarms
Alarm Alarm Text/ Back- Text/ Back- Text/ Back-
Priority Level Foreground ground Foreground ground Foreground ground
1 High White Red Red White White Gray
2-500 Med Black Yellow Yellow Black White Gray
501-750 Low White Blue Blue White White Gray
950-998 Nuisance White Green Green White White Gray
999 Comm White Green Green White White Gray
*Note: Priorities 751 to 949 are being reserved for potential future development

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.

16.2.1 Alarm Indications


• Active alarms that are unacknowledged will blink with the alarm priority color (Flash
Unack Alarms)
• Active alarms that are acknowledged will stop blinking when acknowledged
• Inactive alarms that are unacknowledged remain in the alarm summary queue until
cleared by acknowledgement

16.2.2 Alarm Footer


The footer displays all of the alarms with priorities 1-949. Alarms are sorted by the time of the
alarms. The column details of the footer are state, time, name, value, alarm comment, and
priority (through displayed alarm color). Figure 16-1 displays an example footer.

This graphic is also called:

25
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Graphics

• AlarmFooter_Easterly
• AlarmFooter_Southerly
• AlarmFooter_Westerly
• AlarmFooter_EMSC

Figure 16-1 Alarm Footer Example

16.2.3 Alarm Summary


The alarm summary allows the user to see current alarms as well as historical alarms and
events. The user may acknowledge an individual alarm, a group of alarms, or all alarms and
add an alarm comment. Filtering is also available to allow the user to sort by state or priority.
Figure 16-2 is a screenshot of the alarm summary with a description of each of the functions.
This graphic is called:

• AlarmSummary_Easterly
• AlarmSummary_Southerly
• AlarmSummary_Westerly
• AlarmSummary_EMSC

1 2 3 4 5

Figure 16-2 Alarm Summary – Facility Screen Example

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.

Table 16-2 Alarm Element Descriptions

Graphic Design Element


Number
Function Description
1 Type The type section allows the user to choose whether current or historical
alarms and events are displayed. When historical options are selected, a
time picker will appear to the user to choose the date range.
2 State The state section allows the user to choose whether acknowledged and/or
unacknowledged alarms are displayed.
3 Priority The priority section allows the user to choose whether critical, high priority,
low/nuisance, maintenance, or all alarms are displayed.
4 Apply button The apply button, when pressed, will apply the state and priority selections
to the alarm summary.
5 Comment The comment section allows the user to acknowledge a single alarm or all
alarms. The user can elect to leave a comment in the input box to clarify the
reasoning for the alarm and its acknowledgment. The user must be logged
in and have sufficient access level to acknowledge the alarm.

16.2.4 Alarm Summary_System


Figure 16-3 contains an example alarm summary graphic which displays all the current system
alarms in the system. This graphic is also called:

• Alarm Summary_Easterly_System
• Alarm Summary_Southerly_System
• Alarm Summary_Westerly_System
• Alarm Summary_EMSC_System

3 4
2

Figure 16-3 Alarm Summary - System Screen Example

Table 16-3 describes the functions with numerical index in Figure 16-3.

Table 16-3 Alarm Element Descriptions

Graphic Design Element


Number
Function Description
1 System alarm This graphic displays all of the system alarms, sorted by the time of the
query alarms. The column details of this section are state, timeLCT, name,
value, alarm comment, and priority (thru alarm color).
2 Type This graphic displays the type of the selected alarm from the distributed
alarm query.

27
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Banner (Alarm Screamer)

Graphic Design Element


Number
Function Description
3 ACK button This graphic button allows the user to acknowledge a select alarm..
4 ACK ALL This graphic button allows the user to acknowledge all unacknowledged
button alarms.

17.0 Alarm Banner (Alarm Screamer)


The Wonderware Alarm Screamer faceplate, shown in Figure 17-1, reopens/positions itself over
every screen in the plant to notify operators of the highest priority alarms that require immediate
action. The naming format is as follows:

• AlarmScreamer_plant, where plant is Easterly, Westerly, Southerly.

Figure 17-1 Alarm Screamer - System Screen Example

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

Table 17-1 Alarm Screamer Element Descriptions

Graphic Design Element


Number
Function Description
1 Screamer This graphic displays all of the screamer alarms, sorted by the time of
Alarm query the alarms. The column details of this section are state, timeLCT, name,
value, alarm comment, and priority (thru alarm color).

18.0 Alarm Engine and Historian Configuration


This section contains specific requirements for alarm and event, and historian software
configuration. These settings shall not be modified by anyone other than Administrator.

18.1 Engine For Alarm Log Service


18.1.1 Description
The District’s EngineForAlarmLogService activates and disables the alarm logging service on
each application object server (AOS) node and prevents both alarm loggers from running
simultaneously. This is necessary to make the alarm logging redundant and prevents historical
alarms from being lost.

18.1.2 Functional Details


• Activates the redundant alarm logging engine on the backup AOS platform when a
failover event occurs. This script starts the alarm logging engine because there is not
any support in Server 2008 for this to run as a service.
• Based on location, the engine name in the engine user-defined alarm (UDA) must be
updated.

18.1.3 General
Table 18-1 contains the required alarm logging parameter settings.

Table 18-1 Alarm Logging Service Element Descriptions

Design Element Value


Engine startup type Auto
Engine restart Checked
Scan period 1000 ms
Enable storage to historian Unchecked
Maximum time for scripts to execute 1000 ms
Maximum asynchronous thread count 5
Checkpoint period 0 ms
Checkpoint directory location C:\Checkpoint
Alarm throttle limit 2000 alarms/s
Statistics average period 10000 ms
Maximum queue size 16 MB
Engine failure timeout 10000 ms
Maximum number of consecutive data 0
notification failures allowed

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.

Table 18-2 Redundancy Element Descriptions

Design Element Value

Enable redundancy Unchecked

18.1.5 R/W Interrupts


Table 18-2 contains required read/write interrupt settings.

Table 18-3 R/W Interrupt Element Descriptions

Design Element Value

Number of read/write interrupts 5


Enable standard interrupts Unchecked

18.1.6 Attributes
Table 18-4 contains attribute settings for the alarm services.

Table 18-4 Attribute Element Descriptions

Attribute Data Type Description

Almdb_setservice Boolean Turns the alarm logging service on through the


setservice script
AlmDBLogRunning Boolean Checks to see on which node the alarm logger is
running
Engine String Provides engine name for setservice script. Based on
location, engine name must be changed

18.1.7 Scripts
Table 18-5 contains a listing of scripts and execution types.

Table 18-5 Script Element Descriptions

Script Execution Description


Type
ALMDB Execute Restarts the engine when the platform changes
onscan Execute Triggers the setservice script when the object is on
scan
Setservice Execute Starts and Stops the alarm DB logger depending on
which platform the object is hosted
Setservice Shutdown Kills the Logger Service when the object is shutdown

30
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Alarm Engine and Historian Configuration

18.1.8 Graphics - DBLoggerConnection


The database (DB) logger connection graphic displays a constant string of DB logger status
followed by a dynamic string value that says ‘Running’ in black when the DB logger is running
and has a connection with the PLC and ‘Stopped’ in black when it is not.

Figure 18-1 DB Logger Graphic

Table 18-6 DB Logger Element Description

Graphic Design Element


Number
Function Description
1 DB Logger This graphic string displays the status of the DB logger. The
Status string displays running and stopped to show when the DB
logger is logging data.

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.2 Functional Details


Creates alarms in the galaxy if there are issues with the historian that are not generated by
default within the galaxy. Examples include critical alarms (if more than x alarms generated),
DataAcqRate, SysWarning, and SysFatalErrors.

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

Table 18-7 Historian Alarm Descriptions

Attribute Data Description Alarm


Type Priority
SysCritErrCnt Integer Total critical errors since startup. If above the value 500
of three an alarm will occur.
SysDataAcqOverallIt Integer Items per second received by the historian. If the 500
emsPerSec value drops below nine an alarm will occur.
SysErrErrCnt Integer Total non-fatal errors since startup. If the value 500
goes above six an alarm will occur.
SysFatalErrCnt Integer Total fatal errors since startup. If the value goes 500
above one an alarm will occur.
SysWarnErrCnt Integer Total warnings since startup. If the value goes 750
above 26 an alarm will occur.

Instances

• Southerly_Historian
• Westerly_Historian
• Easterly_Historian
• EMSC_Historian

18.2.4 Historian tags


As a requirement of Wonderware configuration, it is the responsibility of the application
programmer to update all Tier 1 and Tier 2 Historian tags.

19.0 Ancillary and System Status Screens


19.1 Overview
Any PCS system modification project that includes addition of a PLC is required to provide
displays depicting PLC hardware health and status information. These screens are built using
standard PLC module diagnostic global objects distributed by the District to provide
maintenance personnel with real time module channel status and diagnostic information. These
screens are designed to provide view only information and are primarily intended for
maintenance and troubleshooting activities. Approved objects and their usage is covered in
Section 8 of the NEORSD Standard Object Library Programming Guideline document.

19.2 Screen Requirements and Architecture


The Developer shall create and/or modify the standard maintenance and troubleshooting
displays described in sections below:

19.2.1 Maintenance Overview


The maintenance overview display is a single screen that is intended to summarize the
architecture of the viewed PLC system. The display graphically shows the number of and type
of PLC racks, OITs, and network types (Ethernet, Modbus, etc.). Objects on the maintenance
graphic are static; they are not animated and do not provide status information.

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.

19.2.2 PLC Rack Displays


A separate maintenance display shall be created for every PLC rack contained within the
architecture. Each display shall display a single PLC rack detailing the chassis size, module
configuration, and current module health (OK, FAULT).

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.

19.2.3 Module Faceplate Displays


Specific module information is provided on faceplates incorporated into the standard diagnostic
symbols. Faceplates display module and loop information including channel state (on/off, analog
%), channel faults, device tag (from P&IDs), device description (from I/O list), device units
(analog inputs), and other relevant module configuration settings.

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.

Figure 19-1 Navigation Graphic

33
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Trends

20.0 Graphics Display Trends


20.1 Trend Overview
NEORSD Standard Object Library contains preconfigured AOIs to interface with the
Wonderware trend object. Developers shall utilize the base trend template contained in the
galaxy’s global objects for configuration of new saved trend displays.

20.2 Trend Groups


All analog signals must include appropriate trending. All analog I/O shall be configured utilizing
the analog object using district standard AOI. PCS modifications requiring removal of analog I/O
are required to review saved trending groups and remove the deleted tag (abandon in place is
not acceptable).

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

20.2.1 PID Control Loops


All configured PID loops shall have a saved trend group developed. Trend group shall include
process variable (PV), setpoint (SP), and control variable (CV). Cascaded loops and interrelated
signals for feed forward, trim and other modifications to the PID shall be included on the saved
trend. Figure 20-1 provides one example PID group.

34
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Graphics Display Trends

Figure 20-1 PID Trend Group

20.3 Trend Colors


The colors within the example trend in the base project shall be used for all trending within the
application. The color standards are listed below:

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

20.4 Refresh Rate


A refresh rate of two seconds shall be chosen for trending process data. The developer may
select a slower refresh rate based upon the process.

20.5 Trend History


The application shall provide operators the ability to toggle between real-time and historical
trends. Trend durations are limited by the historian server roll-up and processing speeds.
Trends requiring data spans beyond 60 days shall be reviewed and approved by the District
during pre-Programming Workshop.

20.6 Maximum Pens per Trend


Limit the number of pens per trend to eight or less.

20.7 Custom Trends


The application shall be configured to allow user groups at level of operator (18_Opers and
2798_Opers) and above the ability to generate ad-hoc trend displays and save for future use.
Ad-hoc trend displays shall allow operator to choose pens to display (up to eight), colors per
pen, time and range settings, and historical or real-time trend. All other settings shall be
inherited from the parent. Reference Section 9.0 for user security groups.

35
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Reporting

20.8 Logging Data


For the collection resolution of process data points, all time series data being historized has a
forced storage period of two hours. Time series data is also logged based on a delta change in
the value. This delta is determined by the DB_Precision_Group attribute found inside the AOI
object. The available values for this attribute allow the user to set the precision of the data
being logged at low, high, or custom.

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.

22.0 Operator Interface Terminal


22.1 Introduction
For the OIT, NEORSD has standardized on the 15 inch Allen-Bradley PanelView Plus 7
Performance model with touchscreen. This section contains programming standards and
conventions which are designed to promote consistency and familiarity in design and layout
across all OITs installed within the District.

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.

22.2 PanelView Plus Framework


22.2.1 Overview
The District maintains a base PanelView Plus project to provide integrators with a starting point
in creating new applications. The base project contains example displays that use the screen
size, font, display colors, etc., and other application attributes that adhere to the standard as
described in the sections below.

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.

22.2.2 Standardized Objects and Functions


The PanelView Plus global objects standard library contains object symbols that may be
dragged and dropped into PanelView Plus HMI graphics. These symbols are already configured
for animation, textual message displays, and faceplate links for operator interaction. It is the
application programmer’s responsibility for selecting the correct global object from the library
and configuring that particular instance for ControlLogix tag and description attributes.

22.3 Project Settings


22.3.1 PanelView Plus Application Name
The PanelView Plus application name shall incorporate the site, building, process, and
equipment information as defined below.

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)

22.3.2 Project General Settings


The project window size must correspond to the target PanelView Plus device.

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.

Table 22-1 Default Window Sizes

Device Size
7” Display models* 640x480

15” Display models 1024x768


*7” model allowed only with approved NEORSD deviation request

Custom window sizes for the application are not permitted.

22.3.3 Project Runtime Settings


The default project runtime settings within FactoryTalk Studio ME shall be used for project
development. Specifically, projects must follow the format below:

• Disable title bar (uncheck)


• Disable border (uncheck)
• Project window position of Top: 0, Left: 0
• Enable auto logout
o Inactivity period: 10 minutes
o Uncheck Return to Graphic on Logout

22.3.4 Internal Clock Synchronization


In order to synchronize time displays across control network interfaces, the PanelView Plus
internal clock shall be synchronized with the internal clock of the associated PLC.

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:

Table 22-2 Global Connection Synchronization

Connection Tag or Expression Description


Remote date and time ({[PLC]CLOCK[3]}==0) Sets clock on rising edge trigger at 12:00 am
Remote year {[PLC]CLOCK[0]} Year Get System Value (GSV)
Remote month {[PLC]CLOCK[1]} Month GSV
Remote day of month {[PLC]CLOCK[2]} Day GSV
Remote hour {[PLC]CLOCK[3]} Hour GSV
Remote minute {[PLC]CLOCK[4]} Minute GSV
Remote second {[PLC]CLOCK[5]} Second GSV

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.

22.3.5 Other Global Connections


No other global connections are required for standard PanelView Plus applications. District
approval is required prior to configuring additional global connections settings within the
application.

22.3.6 MER Files


Only the current machine edition runtime file (.mer) may be stored on the PanelView Plus. All
older versions of the application should be removed and archived in the District’s Rockwell
FactoryTalk AssetCentre software.

22.4 PanelView Plus Display Development


22.4.1 Display Type
“Replace type” displays shall be used for depicting process flow, measurements, and status.
“Replace type” displays consume the least amount of memory and provide a simplified
mechanism for closing the prior screen.

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.

“On-Top Cannot Be Replaced” display types shall not be used.

39
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal

22.4.2 Display Name


Refer to the diagram in Section 22.3.1 of this volume for additional clarity. Display names shall
take the following format:

[COLUMN#][ROW#] - [AREA/LOCATION DESC] - [DISPLAY DESC]

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.

22.4.3 Color Standards


Table 22-3 contains a general guideline on the use of coloring object’s and animation:

Table 22-3 Color Standards for Displays

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

22.4.3.1 PROCESS PIPING


Standard process piping colors are shown in Figure 22-1:

Figure 22-1 Standard Piping Colors

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:

Each column of buttons


represents a process area or OVERVIEW A1
D1
A2
D1
A3
D1
A4
D1
A5
D1
Log
in

equipment. The first row button


A1 A3 A4 Log
D2 D2 D2 out

A1 A3 A4
D3 D3 D3

navigates to the specific area. A3


D4

The subsequent row buttons


indicate what additional
screens exist within that
specific area. Only the first row
of buttons has navigation
functionality. The other screens AREA 1 AREA 2 AREA 5
are accessible from the bottom DISPLAY 1 DISPLAY 1 ... DISPLAY 1

button bar, only after navigating


to the overview screen (or
D1 D2 D3 D1 D1

similar), from the Main menu


screen.

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

application will contain a main


...

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

Figure 22-3 PanelView Plus Main Screen

22.4.5.2 DISPLAY AREAS


All displays within a configured area will contain a similar navigation bar placed at the bottom of
the screen (See example in Figure 22-4). The bar will contain buttons to navigate to all
configured screens within that area. In order to navigate to a different area, the user will have to
navigate back to the main screen.

Figure 22-4 PanelView Plus Standard Navigation

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

22.4.5.3 ALARM SUMMARY, HISTORY, AND STATUS


All screen displays must contain a link to the alarm summary screen. This makes the alarm
summary accessible from anywhere within the application.

Figure 22-5 PanelView Plus Alarm Summary Navigation

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.

Figure 22-6 PanelView Plus Alarm Summary

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.

22.4.6 System Testing, Debugging, and Commissioning Screens


PCS suppliers may include standards-free displays in their application to aid in system testing,
debugging, and commissioning (e.g., creation of PID information displays to aid in loop tuning).
These displays shall still follow the standard naming convention described in Section 13.1 of this
document. This contingency is for OIT displays only.

These displays should still follow the standard naming convention, using a [COLUMN#]
assignment of 30 and an [AREA DESC] description of “OEM”.

Examples:

• 301 – OEM – Setpoint limits


• 302 – OEM – Drive settings

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.

22.5 PanelView Plus Tag Reference and Usage


22.5.1 Direct Reference Tags
All references to ControlLogix tags made within a project shall be made using direct (device)
reference.

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.

22.5.2 OIT Tags


OIT tags in general should not be used to link application elements (tag displays, trends, data
log models, etc.) with ControlLogix controller tags. Instead, direct reference tags should be used
wherever possible.

22.6 PanelView Plus Security


PanelView applications submitted for approval shall have a single default user account set with
full privileges. Additional user accounts and passwords will be configured onsite, during the
commissioning of the system, from a District provided engineering laptop to deploy correct user

45
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal

accounts and associated District FactoryTalk Directory security settings. District


Commissioning Manager will provide coordination with PC&A for addition of user accounts.

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.

22.6.1 User Groups and Accounts


A standard set of user groups will be provided by the District for use within each PanelView Plus
application. One or more accounts under each group may be assigned to each PanelView Plus
application. The standard user groups are listed below:

• Default (view only)


• Operator
• Maintenance
• Supervisor
• Configure

22.6.2 General Account Privileges and Restrictions


This section outlines user groups, security codes, and runtime account privileges required in all
PanelView Plus applications. Each security role is granted those privileges listed in their
specific role in addition to all lower level roles.

22.6.2.1 DEFAULT (VIEW ONLY) – SECURITY CODE A


The default account is provided for leaving the PanelView Plus in a view only state.

• View all process monitoring screens


• Restrict entering values or changing setpoints
• Restrict ability to open control object faceplates
• Restrict ability to acknowledge alarms
• Restrict access to PanelView Plus terminal settings

22.6.2.2 OPERATOR – SECURITY CODE A, B


Operator accounts are provided for basic operator control and monitoring. Special exception for
operator setpoint manipulation may be granted on a case-by-case basis after review by District
operations.

• View all process monitoring screens


• Enable open and operate object faceplates for the purpose of device mode selection and
manual control
• Enable view and acknowledge configured alarms
• Restrict ability to enter values or change setpoints for process control
• Restrict ability to enter or change configuration type values on faceplate objects (e.g.,
alarm limits)
• Restrict access to PanelView Plus terminal settings

46
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal

22.6.2.3 MAINTENANCE – SECURITY CODE A, B, C


Maintenance accounts take all of the operator’s abilities and add access to maintenance
specific screens for extended diagnostic features.

• View all process monitoring screens


• Enable open and operate object faceplates for the purpose of device mode selection and
manual control
• Enable view and acknowledge configured alarms
• Enable access to maintenance specific screens for diagnostic information
• Enable enter values or change setpoints for process control
• Restrict access to enter or change configuration type values on faceplate objects (e.g.
alarm limits)
• Restrict access to PanelView Plus terminal settings

22.6.2.4 SUPERVISOR – SECURITY CODE A,B,C,D


Supervisor accounts have limited added privileges over operator accounts. Supervisors can
access and change select process control setpoint limits as documented in PCN.

• 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

22.6.2.5 CONFIGURE– SECURITY CODE A,B,C,D,E


Configure accounts have unrestricted access to the PanelView Plus runtime application.
Configure accounts should be held only by District engineers for runtime editing of template
block operation as well as configuring the PanelView Plus terminal settings.

• Enable view all configured screens


• Enable open and operate all provided objects on control faceplates
• Enable view and acknowledge configured alarms
• Enable enter values and change setpoints for all provided process control points
• Enable enter and change configuration type values on faceplate objects (e.g., alarm
limits)
• Enable access to PanelView Plus terminal settings

22.6.3 Configuring Security Access


The global object template library is designed to meet most application runtime security needs.
For example, during runtime, template objects with faceplates require operator or equivalent
privileges to access. Faceplate configuration type settings similarly require configuration level
access privileges.

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.

22.6.4 Account Login/Logout


All user accounts with the exception of view are password protected and require the user to
provide both a username and password when logging in.

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.6.5 Auto Logout


Each PanelView Plus application shall be configured for automatic logout after a period of
inactivity. This setting is configured in the project settings dialogue and is referenced in Section
22.3.3 of this volume.

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.

22.7.2 Trigger Tag


Developers shall use either a single ControlLogix DINT tag or single ControlLogix DINT array
tag (DINT[X]), depending on the size of the application, to serve as a Boolean array for alarm
trigger. Name the alarm trigger tag

PV_ALARM

22.7.3 ControlLogix Trigger Routine


PanelView Plus alarming shall be organized in the ControlLogix processor within one or more
dedicated routines. Ladder routines are required.

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

PanelView Plus to PLC acknowledgment handshaking is not required, but permitted.

22.7.4 Trigger Label


The label for each trigger tag shall carry over the name of the trigger tag name defined in
ControlLogix for consistency and simplicity.

22.7.5 Message Guidelines


Each alarm trigger shall generate a unique message that is concise yet descriptive. Process
area and equipment naming shall remain consistent across OIT, PLC and HMI platforms. For
PanelView Plus applications with similar alarm sets for more than one set of equipment or
process train, the alarm message shall be prefixed with the equipment or train number to be
followed by the alarm in the message.

Several alarm message examples are shown below for a raw water softener skid with three
units:

• Softener #1 Conductivity High


• Softener #2 Conductivity High
• Softener #2 Differential Pressure High
• Softener #3 Conductivity High High

Use of embedded variables in the alarm message shall not be used.

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.

22.7.6 Advanced Settings


Default values for the advanced alarm settings as defined within the base PanelView Plus
project shall be used.

The default advanced alarm settings values are shown in Figure 22-8.

Table 22-4 Advanced Alarm Settings

Display Alarm (PV default)


History 128
Hold time (ms) 250
Max update rate (seconds) 1
Optional connections (None)

22.7.7 Alarm Displays


The PanelView Plus default alarm display shall be used in all PanelView Plus applications. This
display, by default, will open a pop-up when a new alarm is generated and displays an alarm
banner object.

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.7.8 Alarm Filtering


Alarm filtering shall not be incorporated into any alarm object within the PanelView Plus
application. The alarm summary, alarm history, and alarm status displays by default must show
all configured alarms.

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.

22.8.2 Trend Display Naming


Trend screen naming shall follow the standard PanelView Plus display naming conventions
outlined in Section 22.4 of this volume. [COLUMN#] values of 11-19 of the standard PanelView
Plus application should be used for historical trend screens. “TREND” should be used for the
display name [AREA DESC]. This will create an easily recognizable and organized grouping of
displays.

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

22.8.3 Other Trends


Aside from trends configured in the trend area, trends may also be configured and placed on
process displays as required. These trends must use the built in machine edition (ME) studio
trend object and follow trend standard colors and attributes set forth within this document.

22.8.4 Trend Colors


The colors within the example trend in the base project shall be used for all trending within the
application. The color standards are shown in Figure 22-9.

Table 22-5 Standard Trend Colors

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.

22.8.5 Refresh Rate


The maximum refresh rate that may be chosen for a trend is two seconds. In general, a refresh
rate of two seconds shall be chosen for trending process data. The developer may select a
slower refresh rate based upon the process, the time span, etc.

22.8.6 Trend History


The application shall provide historical logging for all trended values for a period of at least 12
hours.

22.8.7 Maximum Pens per Trend


Limit the number of pens per trend to eight or less.

22.8.8 Other Trend Settings


Table 22-10 details general trend settings:

Table 22-6 Standard Trend Settings

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

22.9 Data Logging


22.9.1 Number of Models
Applications shall include a single data log file to collect all pertinent data. Only one data log can
run at any given time.

Use of data log models is required to provide trend history for all configured application trends.

22.9.2 Maximum Data Points


The maximum data points must be set to achieve a 12-hour history of logged data for all
configured trends.

22.9.3 Logging Path


The system default logging path shall be used for all data log models.

22.9.4 Log Triggers


Each log shall be set up to trigger periodically at an interval no faster than two seconds.

22.9.5 Tags In Model


All tags within the model shall be configured as direct reference tags. Tags within the same
model may be polled from more than one PLC. There are no limits to the number of tags within
each model.

22.10 PanelView Plus I/O Diagnostic Screens


22.10.1 Overview
All PanelView Plus applications are required to provide displays depicting PLC hardware health
and status information. These screens are built using standard PLC module diagnostic global
objects distributed by the District to provide maintenance personnel with real time module
channel status and diagnostic information. These screens are designed to provide view only
information and are primarily intended for maintenance and troubleshooting activities.

22.10.2 Screen Requirements and Architecture


The following paragraphs depict screen quantity and requirements:

52
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal

22.10.2.1 MAINTENANCE OVERVIEW


The maintenance overview display is a single screen that is intended to summarize the
architecture of the viewed PLC system. The display graphically shows the number of and type
of PLC racks, OITs, and network types (Ethernet, Modbus, etc.). Objects on the maintenance
overview graphic are static; they are not animated and do not provide status information.

The District standard DIAGNOSTIC LIBRARY file contain symbols specific for generating the
maintenance overview display.

22.10.2.2 PLC RACK DISPLAYS


A separate maintenance display shall be created for every PLC rack contained within the
architecture. Each display shall display a single PLC rack detailing the chassis size, module
configuration, and current module health (OK, FAULT).

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.

22.10.2.3 MODULE FACEPLATE DISPLAYS


Specific module information is provided on faceplates incorporated into the standard diagnostic
symbols. Faceplates display module and loop information including channel state (on/off, analog
%), channel faults, device tag (from P&IDs), device description (from I/O list), device units
(analog inputs), and other relevant module configuration settings.

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.

22.10.3 Area and Navigation


Areas 20-29 of the standard PanelView Plus application are reserved for maintenance and
diagnostic type displays. Typically, only one single area (20) is required for maintenance
screens. The total number of screens will, at a minimum, consist of:

• 1 for the maintenance overview


• 1 screen per PLC rack (processor and remote I/O racks)

The main maintenance screen (200 – MAINTENANCE OVERVIEW) should contain navigation
links to each PLC rack screen.

Use the following display names as applicable:

• 200 – MAINTENANCE OVERVIEW


• 201 – MAINTENANCE – RACK 0
• 202 – MAINTENANCE – RACK 1
• 203 – MAINTENANCE – RACK 2…

53
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Operator Interface Terminal

22.11 PanelView Plus Standard Control Templates


22.11.1 Global Object Templates
All PanelView Plus controls that provide read/write functionality to ControlLogix tags must make
use of the NEORSD Standard Objects Library. Each template object is preconfigured to match
on a one-to-one basis with ControlLogix AOI’s.

For a complete list of the objects and instructions on their proper use, refer to NEORSD
Standard Object Library Programming Guideline.

22.11.2 General Usage Requirements


All global template object expressions and animations are pre-linked to the required member of
the corresponding ControlLogix AOI tag. Programmers shall not to adjust or change field values
or animation settings with the template object itself.

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:

Table 22-7 Discrete Valve and Motor Objects

Parameter Field Description


#1 Tag address PLC tag (direct reference)
#2 Tag name Device tag for display on faceplate
#3 Device desc Device/tag description for display on faceplate
#4 Keypad Keypad assignment for display next to object
#4-#9 Intlk desc Interlock 1 – 5 descriptions for display on faceplate

Table 22-8 Analog Objects

Parameter Field Description


#1 Tag address PLC tag (direct reference)
#2 Tag name Device tag for display on faceplate
#3 Device desc Device/tag description for display on faceplate
#4 Eng units Units for display on faceplate
#5 Keypad Keypad assignment for display next to object

Table 22-9 Discrete Objects

Parameter Field Description


#1 Tag address PLC tag (direct reference)
#2 State 0 text Text displayed when discrete value is 0 (clear)
#3 State 1 text Text displayed when discrete value is 1 (active)
#4 Fault text Text displayed when fault active

Table 22-10 PID/PIDE Objects

Parameter Field Description


#1 Tag address PLC tag (direct reference)

54
Revision 4.2 – July 2021
NEORSD PCS Manual | Volume 3: Interface Development Standards
Reference Documents

Parameter Field Description


#2 Tag name Device tag for display on faceplate
#3 Device desc Device/tag description for display on faceplate
#4 Eng units Units for display on faceplate
#5 Keypad Keypad assignment for display next to object
Table 22-11 Diagnostic Module Objects

Parameter Field Description


#1 Tag address PLC tag (direct reference, references module tag)
#2 Channel tag Channel device tag for display on faceplate

22.11.3 Global Object Default Values


The PanelView Plus project shall retain the original settings for the global object default values
as provided in the base project. The required settings are as follows:

• LinkAnimation default: Link with expressions


• LinkConnections default: True
• LinkSize default: True

23.0 Reference Documents


Table 23-1 contains a complete listing including live links to all referenced District standards and
forms, and industry standards and best practices.

Table 23-1 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

This page intentionally left blank.


3900 Euclid Ave
Cleveland, OH 44115
216.881.6600

neorsd.org

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy