This manual links to Knowledgebase Technote, PlantPAx System Release

5.0 Configuration and Implementation Tools for object and visualization

parameters, download the spreadsheets now to ensure offline access.

Rockwell Automation Library

of Process Objects
System Release 5.0

Reference Manual Original Instructions

Rockwell Automation Library of Process Objects Publication Type

Important User Information

Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize
themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.

Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to
be carried out by suitably trained personnel in accordance with applicable code of practice.

If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use
or application of this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and
requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for
actual use based on the examples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software
described in this manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is
prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may
lead to personal injury or death, property damage, or economic loss.

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or
economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.

IMPORTANT Identifies information that is critical for successful application and understanding of the product.

Labels may also be on or inside the equipment to provide specific precautions.

SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may
be present.

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach
dangerous temperatures.

ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc
Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements
for safe work practices and for Personal Protective Equipment (PPE).

2 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Table of Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 1
Rockwell Automation Library of PlantPAx Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Process Objects Process Library 5.0 Add-On Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Other Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Basic Attributes and Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
State Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Status Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Threshold Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Deviation Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Command Source Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Basic Faceplate Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Operator (Home) Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Advanced Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Faults Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Trends Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Help Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Quick Display Interaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Install the Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Import Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Import Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Import HMI Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
FactoryTalk Linx Device Shortcuts Configuration . . . . . . . . . . . . . . . . . . 38
FactoryTalk View Language Configuration . . . . . . . . . . . . . . . . . . . . . . . . 39
Help Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Library Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
PlantPAx Process Library Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 2
Graphic Framework Overview Header Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Process Control Displays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
L1 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
L2 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
L3 Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
L1 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
L2 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
L3 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Alarm Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 3
Table of Contents

Off-Screen Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Alarm Indication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Alarm Grouping and Supporting Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Chapter 3
Configure the Graphic Recommended Application Naming Structure . . . . . . . . . . . . . . . . . . . . . 53
Framework Build Your PlantPAx HMI Application . . . . . . . . . . . . . . . . . . . . . . . . . 54
Global Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
APP - Administrative Objects (raP-5-SE) . . . . . . . . . . . . . . . . . . . . . . . 57
APP - Alarm Objects (raP-5-SE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
APP - Header Objects (raP-5-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Template Custom Objects (raP-5-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Template L1 Navigation (raP-5-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Template L2 L3 Navigation (raP-5-SE) . . . . . . . . . . . . . . . . . . . . . . . . . 63
Displays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Macros. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Template_ClientStartup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Client File Setup (.CLI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Chapter 4
Organization and Propagation Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Programming - Controller Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Programming - HMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Configuring a Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Constructing a Nodal Tree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configure the Tree Node at Which to Start this View . . . . . . . . . . . . 94
Configuring Propagation and Navigation . . . . . . . . . . . . . . . . . . . . . . 97
Configure Nodal HMI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Issue Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Adding ownership to devices if using the raP_Opr_EMGen . . . . . . . . 108

Chapter 5
n-Position Device Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
(raP_Dvc_nPos) Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Virtualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Advanced Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

4 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Table of Contents

Engineering Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

HMI Configuration Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Chapter 6
Mix-proof Valve Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
(raP_Dvc_VlvMP) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Virtualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Advanced Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Engineering Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
HMI Configuration Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Chapter 7
Discrete 2-, 3-, 4-state Device Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
(raP_Dvc_D4SD) Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Virtualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Advanced Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Engineering Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
HMI Configuration Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Chapter 8
Process Area Module Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
(raP_Opr_Area) Command Source Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 5

Table of Contents

Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Chapter 9
Process Unit (raP_Opr_Unit) Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Command Source Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Chapter 10
General Equipment Module Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
(raP_Opr_EMGen) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Command Source Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
State Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Program Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Chapter 11
General Equipment Phase Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
(raP_Opr_EPGen) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Command Source Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

6 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Table of Contents

Phase Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Program Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Manual Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Chapter 12
Parameter and Reports Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
(raP_Tec_ParRpt) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Modes of Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Parameter Program Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Reports Program Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Parameter Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Report Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Parameter Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Report Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Chapter 13
Graphic Symbols and Process Analog Input (PAI) Graphic Symbols . . . . . . . . . . . . . . . . . . . . . 197
Faceplates for PlantPAx Process Analog Input (PAI) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Instructions
Maintenance Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Engineering Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Smart Device Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Smart Device Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Smart Device Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Smart Device HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Smart Device Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Process Dual Sensor Analog Input (PAID) Graphic Symbols . . . . . . . . 210
Process Dual Sensor Analog Input (PAID) Faceplates . . . . . . . . . . . . . . 211
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 7
Table of Contents

HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Process Multi Sensor Analog Input (PAIM) Graphic Symbols . . . . . . . 214
Process Multi Sensor Analog Input (PAIM) Faceplates . . . . . . . . . . . . . 215
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Process Analog Output (PAO) Graphic Symbols . . . . . . . . . . . . . . . . . . . 219
Process Analog Output (PAO) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . 220
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Process Boolean Logic (PBL) Graphic Symbols . . . . . . . . . . . . . . . . . . . . 225
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Process Boolean Logic (PBL) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Logic Gate Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
View Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Process Command Source (PCMDSRC) . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Command Source Totem Pole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Operator Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
External Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Maintenance Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Advanced Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Process Deadband Controller (PDBC) Graphic Symbols. . . . . . . . . . . . 232
Process Deadband Controller (PDBC) Faceplates . . . . . . . . . . . . . . . . . . 233
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Process Discrete Input (PDI) Graphic Symbols . . . . . . . . . . . . . . . . . . . . 237
Process Discrete Input (PDI) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Process Discrete Output (PDO) Graphic Symbols. . . . . . . . . . . . . . . . . . 240
Process Discrete Output (PDO) Faceplates. . . . . . . . . . . . . . . . . . . . . . . . 241
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

8 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Table of Contents

Process Dosing (PDOSE) Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . 245

Process Dosing (PDOSE) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Process Analog Fanout (PFO) Graphic Symbols . . . . . . . . . . . . . . . . . . . 250
Process Analog Fanout (PFO) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . 251
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Process High or Low Selector (PHLS) Graphic Symbols . . . . . . . . . . . . 253
Process High or Low Selector (PHLS) Faceplates . . . . . . . . . . . . . . . . . . 254
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Process Interlock (PINTLK) Graphic Symbols . . . . . . . . . . . . . . . . . . . . . 256
Interlock States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Process Interlock (PINTLK) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Process Lead/Lag/Standby Motor Group (PLLS) Graphic Symbols. . . 260
Process Lead/Lag/Standby Motor Group (PLLS) Faceplates. . . . . . . . . 261
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Manual Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Process Motor (Power Discrete) (PMTR) Graphic Symbols . . . . . . . . . 266
Process Motor (Power Discrete) (PMTR) Faceplates . . . . . . . . . . . . . . . 268
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
PPID Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
PPID Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Ramp Wizard Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 9

Table of Contents

ProcessPermissive (PPERM) Graphic Symbols . . . . . . . . . . . . . . . . . . . . 288

Permissive States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Process Permissive (PPERM) Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . 289
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Process Pressure/Temperature Compensated Flow (PPTC) Graphic
Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Process Pressure/Temperature Compensated Flow (PPTC) Faceplates. .
292
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Process Restart Inhibit (PRI) Graphic Symbols . . . . . . . . . . . . . . . . . . . . 294
Process Restart Inhibit (PRI) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Process Run Time (PRT) Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . 295
Process Run Time (PRT) Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Process Tank Strapping Table (PTST) Graphic Symbols . . . . . . . . . . . . 296
Process Tank Strapping Table (PTST) Faceplates . . . . . . . . . . . . . . . . . . 296
Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
HMI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Appendix A
FactoryTalk View Customization Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Tool
Appendix B
Command Sources and Device Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Virtualization Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Appendix C
Tag Extended Properties and raP_Opr_Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Default Alarm Settings raP_Opr_Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
raP_Opr_EMGen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
raP_Opr_EPGen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
raP_Dvc_D4SD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
raP_Dvc_VlvMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
raP_Dvc_nPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
raP_Opr_ExtddAlm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
raP_Tec_ParRpt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
raP_Opr_Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
raP_Opr_Prompt_Core. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

10 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Table of Contents

raP_Dvc_LgxTaskMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
raP_Dvc_LgxChangeDet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
raP_Dvc_LgxRedun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
raP_Dvc_LgxModuleSts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
raP_Dvc_LgxCPU_5x80 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
raP_Opr_ArbitrationQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
raP_Opr_OrgScan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
raP_Opr_OrgView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 11

Table of Contents

Notes:

12 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Preface

The PlantPAx® system provides a modern approach to distributed control. The

system shares common technology (Integrated Architecture® system) with all
other automation disciplines in the plant. This approach creates a seamless
information flow across the plant for optimization opportunities and enables a
Connected Enterprise.

Our scalable platform provides you with the flexibility to implement a system
appropriate for your application. The following table shows the documents
that are available to help design and implement your system requirements.
Stage Publication Description
Selection Guide, publication PROCES-SG001 Helps you understand the elements of the PlantPAx system to make sure that you
Define and Procure buy the proper components.
Install Template User Manual, publication 9528-UM001 Provides direction on how to install and deploy PlantPAx virtual templates.
Develop Configuration and Implementation User Manual, publication Provides system guidelines and instructions to assist with the development of your
PROCES-UM100 PlantPAx system.

Rockwell Automation Library of Process Objects Reference Manual, Describes the Add-On Instructions, PlantPAx instructions, and associated faceplates that
publication, PROCES-RM200 are available to develop applications.

Software and Firmware When you update software or firmware revisions, we recommend that you verify the
impact on performance and memory utilization before implementing the upgrade on
Upgrades the production system. For FactoryTalk® View or ControlLogix® platforms, we
recommend that you review the release notes and verify the impact of the upgrade on
performance and memory utilization.

You can also verify the compatibility of the upgrade with the installed software and
operating systems in use on your PlantPAx system. See the
Product Compatibility and Download Center.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 13

Preface

Rockwell Automation System Support offers technical assistance that is tailored for control systems. Some of
the features include the following:
Services and Support
• Highly experienced team of engineers with training and
systems experience
• Process support at a systems-level that is provided by process engineers
• Use of online remote diagnostic tools
• Access to otherwise restricted TechConnectSM Knowledgebase content
• 24-hour, 7 days per week, 365 days per year of phone-support coverage upgrade
option

For more information, contact your local distributor or Rockwell Automation

representative or see http://www.rockwellautomation.com/support.

You can view or download publications at

http://www.rockwellautomation.com/literature. To order paper copies of technical
documentation, contact your local Allen-Bradley distributor or
Rockwell Automation sales representative.

14 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1

Rockwell Automation Library of Process Objects

The PlantPAx® library contains add-on instructions to enable consistent

deployment and faster product delivery.

The Device Library is a tested, documented, and life cycle managed object
library. The Device Library provides pre-configured status and diagnostic
faceplates and AOI sets for Rockwell Automation discrete, velocity, and motion
automation devices. The Device Objects may be used with Machine Builder,
Process, and Packaged Libraries or as standalone components. Device library
add-on instructions objects collect, process, and deliver data between
hardware devices and application logic.

When you deploy the process controller in PlantPAx 5.0, you gain access to
additional PlantPAx instructions. The PlantPAx instructions on the process
controller provide objects that are embedded in controller firmware.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 15

Chapter 1 Rockwell Automation Library of Process Objects

PlantPAx Instructions In PlantPAx 5.0, Rockwell Automation offers device control strategies
embedded into the process controller. The following table outlines the
PlantPAx instructions in relation to previous releases of PlantPAx Add-On
Instructions. For more detailed information, see the online help section of
Studio 5000 Logix Designer®.
Input Processing
Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
CM_AIN (GEMS)
MSAinSiS (RAMS) The Process Analog Input (PAI) instruction monitors an analog input and checks for alarm
Process Analog Input (PAI) P_AIChan (PO) conditions. Use the PAI instruction to process a signal from a channel of an analog input
P_AInAdv (PO) module. Use the PAI instruction with any analog (REAL) signal.
P_Ain (PO)
The Process Dual Sensor Analog Input (PAID) instruction monitors one analog Process
Variable (PV) by using two analog input signals, from sources such as dual sensors, dual
transmitters, and dual input channels. The PAID instruction monitors conditions of the
Process Dual Sensor Analog Input (PAID) P_AInDual (PO) channels and reports configured PV quality. The PAID instruction has functions for input
selection, averaging, and failure detection. Additional functions, such as for filtering and
alarming, are done by a downstream PAI block.
The Process Multi Sensor Analog Input (PAIM) instruction monitors one analog process
variable (PV) by using up to eight analog input signals from sources such as sensors,
Process Multi Sensor Analog Input (PAIM) P_AInMulti (PO) transmitters, and input channels. The PAIM instruction has functions for input selection,
averaging, and failure detection. Additional functions, such as filtering and alarming, are
done by a downstream PAI block.
CM_DIN (GEMS) The Process Discrete Input (PDI) instruction monitors a discrete (true or false) input, and
Process Discrete Input (PDI) MsDinSiS (RAMS) checks for alarm conditions. Use the PDI instruction to process a signal from a channel of
P_DIn (PO) a discrete input module. Use the PDI instruction with any discrete (BOOL) signal.
The Pressure/Temperature Compensated Flow (PPTC) instruction calculates a flow at
Process Pressure/Temperature Compensated Flow standard temperature and pressure, essentially a mass flow rate, given a volumetric flow
P_PTComp (PO)
(PPTC) rate or differential pressure measurement. This instruction requires measurements of
the actual temperature and pressure of the flowing gas.
P_StrapTbl (PO) The Process Tank Strapping Table (PTST) instruction calculates the volume of product in
Process Tank Strapping Table (PTST) I_Chrctrztn (GEMS) an upright cylindrical tank, given the level of the product and the tank calibration table.
The Process Analog HART (PAH) instruction is used to provide HART digital data for an
Process HART (PAH) P_AInHART intelligent analog device alongside the analog input (PAI) or analog output (PAO)
(+ PAI or PAO) P_AOutHART instruction for that device.

Device Control
Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
CM_AOUT (GEMS) The Process Analog Output (PAO) instruction drives an analog output and checks for
MSAoSoS (RAMS)
Process Analog Output (PAO) alarm conditions. Use the PAO instruction for a channel of an analog output module. Use
P_AOut (PO) the PAO instruction with any analog (REAL) signal.
P_ValveC (PO)
The Process Discrete Output (PDO) instruction drives a discrete (true / false) output,
CM_DOUT (GEMS) monitors discrete inputs serving as feedbacks from a device driven by the discrete
Process Discrete Output (PDO) P_DOut (PO) output, and checks for alarm conditions. Use the PDO instruction for a channel of a
discrete output module. Use the PDO instruction with any discrete (BOOL) signal.

16 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Device Control
Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
CM_M2S (GEMS) The Process Motor (PMTR) instruction monitors and controls a fixed single-speed, two-
MsMtrFrS (RAMS) speed, or reversing motor using a full-voltage contactor or intelligent motor controller
P_Motor2Spd (PO) (soft starter). The motor can be run or jogged, including jogging reverse or jogging fast,
Process Motor (Power Discrete) (PMTR) P_MotorHO (PO) as configured by the user. The interface to the hardware motor controller can be through
P_MotorRev (PO) a Device Object Interface or through individual pins. The object is a configurable, built-in
P_Motor (PO) combination of the existing PlantPAx P_Motor (single speed), P_Motor2Spd (two speed),
P_SMC50 (PO) P_MotorRev (reversing), and P_MotorHO (hand-operated or monitor-only) Add-on
P_SMCFlex (PO) instructions in the Rockwell Automation Library of Process Objects.
CM_V2S (GEMS)
CM_V3S (GEMS) The Process Valve (PVLV) instruction operates a two-position, single-solenoid operated
MsVlv2sS (RAMS) valve, a dual-solenoid operated valve, or a motor-operated valve in various modes,
Process Valve Library (PVLV) MsVlv3S (RAMS) monitoring for fault conditions. It also monitors hand-operated two-position valves. It is a
P_ValveHO (PO) built-in analogy of the existing PlantPAx P_ValveSO, P_ValveMO, and P_ValveHO add-on
P_ValveMO (PO) instructions in the Rockwell Automation Library of Process Objects.
P_ValveSO (PO)
CM_VFD (GEMS)
MsVsdFrs (RAMS) The Process Variable Speed Drive (PVSD) instruction monitors and controls a variable
P_PF52x (PO) speed motor using an AC (variable frequency) or DC drive. Use the instruction to run or jog
P_PF6000 (PO)
Process VSD (Power Velocity) (PVSD) the motor, forward or reverse. The drive interface can be through a Device Object
P_PF7000 (PO)
P_PF753 (PO) Interface or through individual pins. The object is a built-in version of the existing P_VSD
add-on instruction in the Rockwell Automation Library of Process Objects.
P_PF755 (PO)
P_VSD (PO)

Discrete Monitoring and Control

Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
The Process Boolean Logic with Snapshot (PBL) instruction executes up to eight gates of
configurable Boolean logic. Gate types available include AND, OR, XOR (Exclusive-OR),
Process Boolean Logic (PBL) P_Logic (PO) Set/Reset, Select, and Majority. Each gate provides up to four input conditions that are
individually invertible using a configuration setting.
P_Intlk (PO) The Process Interlocks (PINTLK) instruction collects, or sums up, the interlock conditions
P_IntlkAdv (PO) that stop or de-energize a running or energized piece of equipment. This instruction can
I_Multiplex_04 (GEMS) also help prevent equipment from starting or being energized. Interlocks are always
Process Interlock (PINTLK) I_Multiplex_08 (GEMS) evaluated to de-energize equipment. For permissive conditions that must be made to
I_Multiplex_16 (GEMS) start the equipment, but are ignored once the equipment is running, use the Process
I_Multiplex_32 (GEMS) Permissive (PPERM) instruction.
I_Protective (GEMS)
The Process Lead Lag Standby Motor Group (PLLS) instruction provides control of a
parallel group of motors, such as a set of pumps with a common intake source and
discharge destination. The number of motors to run depends on the demand on the
P_LLS (PO)
Process Lead/Lag/Standby Motor Group (PLLS) system. The group can be configured to consist of as few as two or as many as 30
MsGrpM8S (RAMS) motors. The minimum demand can be set as low as 0, so that all motors are stopped at
minimum demand. The maximum demand can be set as high as the number of pumps in
the group.
P_Perm (PO) The Process Permissives (PPERM) instruction collects, or sums up, the permissive
I_Multiplex_04 (GEMS) conditions that allow a piece of equipment to energize. In most cases, permissive
ProcessPermissive (PPERM) I_Multiplex_08 (GEMS) conditions must be true to energize equipment. Once the equipment is energized,
I_Multiplex_16 (GEMS) permissives are ignored.
I_Multiplex_32 (GEMS)

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 17

Chapter 1 Rockwell Automation Library of Process Objects

Discrete Monitoring and Control

Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
Use the Process Restart Inhibit instruction for Large Motor (PRI) instruction to prevent
large motors from starting repeatedly. The high starting current for a large motor causes
heating. Continual starts or start attempts in a short period overheat the motor windings
Process Restart Inhibit (PRI) P_ResInh (PO) and damage the motor.

The PRI instruction provides a rule-based state model for restarts. Do not use the
instruction to model or monitor heating and replace sensor-based motor monitoring
devices. Use the instruction to avoid over stressing a motor.
The Process Run Time and Start Counter (PRT) instruction records the total run time and
number of instances the motor or other equipment starts. The PRT is a software
Process Run Time (PRT) P_RunTime (PO) implementation of the mechanical hour meter that displays the total motor runtime.
Maintenance personnel use the run time and equipment start variables to create a
maintenance schedule for the applicable equipment.
The Process Valve Statistics Object (PVLVS) instruction monitors a two-state (open and
close) valve and records statistics for stroke times and stroke counts to aid in planning
Process Valve Stat (PVLVS) P_ValveStats (PO) maintenance or diagnosing valve and actuator problems. The PVLVS instruction is
designed to work with the PVLV (solenoid, motor, and hand operated) valve instruction.

Ownership
Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
The Process Command Source (PCMDSRC) instruction selects the command source for a
Process Command Source (PCMDSRC) P_CmdSrc (PO) device.

Procedural Control
Previous Process
PlantPAx Instruction Instruction Description
Library AOIs
The Process Dosing (PDOSE) instruction controls an ingredient addition that uses a flow
meter to measure the quantity of ingredient added. The flow meter can be an analog flow
CM_TOT (GEMS) meter (signal proportional to flow), a pulse generating flow meter (pulse count
CM_WS (GEMS) proportional to quantity delivered), or a digital flow meter providing flow rate or quantity
Process Dosing (PDOSE) MsTotSiS (RAMS) (totalized flow) information. The instruction also controls an ingredient addition that
P_DoseFM (PO) uses a weigh scale to measure the quantity of ingredient added. The weigh scale can be
P_DoseWS (PO) on the receiving vessel, indicating gain in weight, or on the sourcing vessel, indicating
loss in weight. The weigh scale can be connected using an analog input, device network,
or other connection.

18 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Regulatory Control
Previous Process Library
PlantPAx Instruction Instruction Description
AOIs
The Process Deadband Controller (PDBC) provides:

• A Raise output, which is activated when the PV is less than the entered Raise
threshold, and a Lower output, which is activated when the PV is greater than the
entered Lower threshold.
• Q and Q-Not outputs. Q is set when the PV falls below the Raise threshold and
cleared when the PV rises above the Lower threshold; Q-Not is the inverse of Q.
• High and Low Deviation alarms with configurable thresholds and deadbands.
These alarms can provide notification that the PV is approaching an out-of-control
Process Deadband Controller (PDBC) P_DBC condition.
• Alarms for High PV Rate of Change Increasing and High PV Rate of Change
Decreasing. These alarms can provide notification that the PV is changing faster
than expected.
• Operation in Manual and Automatic Loop Modes. In Automatic Loop Mode, the
outputs are triggered by the control algorithm to keep the PV within limits. In
Manual Loop Mode, the operator directly manipulates the Raise and Lower outputs
from the HMI.
• Operation in Operator, Program, Override, and Maintenance command sources.
The Analog Fanout (PFO) instruction sends one primary analog output signal to
Process Analog Fanout (PFO) P_Fanout (PO) multiple secondary users or devices. Each secondary output has configurable gain,
offset, and clamping limits.
The Process High or Low Selector (PHLS) instruction selects the highest or the lowest
Process High or Low Selector (PHLS) P_HiLoSel (PO) of up to six incoming controlled variables (CVs). The instruction sends the selected
CV as output and flags the unselected CVs to track the selected CV.
Use the Process Proportional + Integral + Derivative (PPID) instruction to manipulate
the Control Variable (CV) in regulatory control loops in response to Process Variable
CM_PIDE (GEMS) (PV) readings and Setpoint (SP, the target PV) settings.
CM_PID (GEMS)
Process Regulatory Control (PPID) MSPidBaS (RAMS) The CV is typically used as a cascade setpoint for a secondary, or inner, control loop
MsPidEns (RAMS) or is sent to an Analog Output channel on an IO card.
P_PIDE (PO)
The PPID instruction integrates functions of the existing PID, PIDE, and P_PIDE AOI
into a single built-in instruction and adds additional features.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 19

Chapter 1 Rockwell Automation Library of Process Objects

Process Library 5.0 Add-On PlantPAx 5.0 Add-On Instructions in relation to previous releases of PlantPAx
Add-On Instructions.
Instructions

Input Control
PlantPAx 5.0 AOIs Bundled with 5.0 Library Download Previous Process Library AOI(s) Description
Transfers data from one Library 4.10 HART module
Channel Data array member (for one input or output
raP_Tec_HARTChanData_to_PAH New Instruction channel) to one (Highly-Integrated HART)
PAX_HART_DEVICE:I:0 data structure for use by PAH
instruction.
raP_Tec_LgxEvent Captures any of 16 event bit rising edge transitions and records the
New Instruction lowest-order rising edge bit as the reason for the event.

Device Control
PlantPAx 5.0 AOIs Bundled with 5.0 Library Previous Process Library AOI(s) Description
Download
This instruction controls a circular or linear discrete device
with up to 30 positions. The instruction provides outputs to
select an individual position and outputs to move toward
raP_Dvc_nPos P_nPos (PO) increasing positions (‘clockwise’ for a circular device) or
decreasing positions (‘counterclockwise’ for a circular
device).
This instruction controls and monitors feedback from a
discrete 2-state, 3-state, or 4-state device s, monitoring for
fault conditions. These devices include multiple-speed
motors or multiple position valves.
raP_Dvc_D4SD P_D4SD (PO) Controls four discrete outputs and monitors four discrete
feedback inputs. Each output and input has configurable
states of each output in the various device states.
The instruction also monitors permissive and interlock
conditions; the latter returns the device to its default state.
The Mix-proof Valve (P_ValveMP) Add-On Instruction
controls one mix-proof valve in a variety of modes and
P_ValveMP (PO)
raP_Dvc_VlvMP states, and can check position feedback inputs to verify
CM_VMX (GEMS) that the valve reached the commanded position. An alarm
can be provided on failure to reach a target position.

20 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Controller Diagnostics
PlantPAx 5.0 AOIs Bundled with 5.0 Library Previous Process Library AOI(s) Description
Download
The Logix Change Detector (raP_Dvc_LgxChangeDet) Add-
On Instruction monitors another Logix controller on the
Logix Change Detector (raP_Dvc_LgxChangeDet) L_ChangeDet (PO) network and checks for changes that impact operation.
Changes that can be monitored include downloads, online
edits, I/O forcing , and controller mode changes.
The Logix Controller CPU Utilization (raP_Dvc_LgxCPU_5x80)
Add-On Instruction monitors a Logix controller, and
provides information on controller CPU utilization,
communication usage, memory usage, task scan times, and
other information. Data that is provided by the L_CPU
instruction is useful to diagnose communication or control
responsiveness issues and in tuning the performance of
Logix Controller CPU Utilization L_CPU_5x80 (PO) control tasks for optimum controller performance.The
(raP_Dvc_LgxCPU_5x80) (v33) raP_Dvc_LgxCPU_5x80 instruction can be loaded as part of
a control application and disabled (default) until needed.
The instruction can also be enabled at a slow update rate
for general controller monitoring. The update rate can be
increased, if necessary, as directed by a Rockwell
Automation Technical Support representative to help
diagnose controller performance issues. ControlLogix®
5580 Controllers.
The Logix Module Status (raP_Dvc_LgxModuleSts) Add-On
Instruction monitors the connection status of one module
Logix Module Status (raP_Dvc_LgxModuleSts) L_ModuleSts (PO) in the I/O configuration tree of the Logix controller. The
instruction provides an I/O fault signal if the connection is
not ‘running’.
The Logix Redundant Controller Monitor
(raP_Dvc_LgxRedun) Add-On Instruction monitors one
Logix Redundant Controller Monitor redundant pair of Logix controllers. The instruction checks
L_Redun (PO)
(raP_Dvc_LgxRedun) primary and secondary controller status that can affect the
ability of the system to switch to the back-up controller on
a failure of the primary.
The Logix Task Monitor (raP_Dvc_LgxTaskMon) Add-On
Instruction monitors one task running in a Logix controller
to provide task statistics, such as task scan time and
overlap count.
The instruction also provides the following :
• Task configuration settings, such as priority, rate, and
Logix Task Monitor (raP_Dvc_LgxTaskMon) L_TaskMon (PO) watchdogtimer setting
• Task ‘plan’ execution time
• Alarm if the planned execution time is exceeded

Maintenance commands are provided for clearing the

maximum execution time and the overlap count.

Equipment Control
PlantPAx 5.0 AOIs Bundled with 5.0 Library Previous Process Library AOI(s) Description
Download
The raP_Opr_Area (Area Object) object groups Units
together, and provides a
raP_Opr_Area AREA (GEMS) propagation mechanism for aggregating status from Unit
objects, and
broadcasting commands to Unit Modules.
The raP_Opr_EMGen (Generic Equipment Module) object
controls an
raP_Opr_EMGen EM_GEN (GEMS) Equipment Module in a variety of modes and monitors for
fault
conditions.
The raP_Opr_EPGen (Generic Equipment Phase Module)
object controls a
raP_Opr_EPGen EP_GEN (GEMS) Equipment Phase in a variety of modes and monitors for
fault
conditions.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 21

Chapter 1 Rockwell Automation Library of Process Objects

Equipment Control
PlantPAx 5.0 AOIs Bundled with 5.0 Library Previous Process Library AOI(s) Description
Download
The raP_Tec_ParRpt (Parameter \ Report)Add-On
Instruction is used to implement parameter and report
data items. The raP_Tec_ParRpt instruction may be used as
follows:
I_ParameterEnum (GEMS) • For a read only parameter /report
I_ParameterInteger (GEMS) • For a read/write parameter /report
raP_Tec_ParRpt I_ParameterReal (GEMS) • For a parameter /report of type Integer, Real, String or
I_ParameterString (GEMS) Enumeration
• Equipment Module (raP_Opr_EMGen) and Equipment
Phase (raP_Opr_EPGen) are designed to work with the
raP_Tec_ParRpt instruction, which may be used for
Parameter or Report data items
The UNIT (Unit Object) object controls a Unit in a variety of
raP_Opr_Unit UNIT (GEMS) command sources
and monitors for fault conditions.
The P_Prompt (Operator Prompt) Add-On Instruction is a
universal mechanism for operator interaction that can be
Prompt (GEMS)
raP_Opr_Prompt used within a control scheme. The instruction presents an
P_Prompt (PO) operator with configurable message or data fields and
accepts operator response data and confirmation.
Monitors one input condition and provides one configurable
Process Extended Alarms (raP_Opr_ExtddAlm) Extended Alarms (GEMS) Alarm. The Alarm is provided as a Logix Tag Based Alarm.
Use <InstanceTag>.@Alarms members for access.

Organization

Organization is a method by which parent / child relationships can be created

and modified among control objects. Organization provides a method to
propagate a selected subset of commands (related to command source, alarms,
etc.) from the parent down to its children or propagate the aggregate of a
selected subset of status (related to command source, alarms, etc.) from the
children up to the parent.

Previous Process Library

PlantPAx 5.0 AOIs Bundled with 5.0 Library Download Description
AOI(s)
Ownership, Command and
Ownership (raP_Opr_Owner) The Add-On Instruction Function to allow ownership of a Bus element.
Status Propagation (GEMS)
Ownership, Command and The Add-On Instruction Function to create a tree view of the nodal
Organizational View (raP_Opr_OrgView) Status Propagation (GEMS) organization in FactoryTalk® View.
Ownership, Command and The Add-On Instruction Function to scan and update all Bus elements and tree
Organizational Scan (raP_Opr_OrgScan) Status Propagation (GEMS) nodes.
Ownership, Command and The Arbitration Queue (raP_Opr_ArbitrationQ) Add-On Instruction Function to
Arbitration Queue (raP_Opr_ArbitrationQ) Status Propagation (GEMS) add a FIFO to each class of owner in the ownership funtion.

22 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Other Libraries
Item Description
Process Library Rockwell Automation Library of Process Objects provides sample projects, application templates, Endress + Hauser
library objects, Application Code Manager library objects, and tools and utilities.
Includes the following:
• Graphics for built-in instructions
• HMI images and Help files
• Logix diagnostic objects
• Process objects
• Control strategies
• Sequencer objects
• PlantPAx Configuration Tools for Tags, Alarms and Historian
• Color Change
• Historian -- Asset Framework template and objects
I/O Device Library Provides objects for Rockwell Automation 1756, 1769, 1734, 1794, 1738, 1732E, 1719, 5069, 5094 I/O modules.
Provides preconfigured status and diagnostic faceplates sets for Rockwell Automation digital and analog I/O devices.
You can use these objects with Machine Builder, Process, and Packaged Libraries, or as standalone components.
IO-Link Device Library Provides IO-Link master and sensor objects.
Provides preconfigured status and diagnostic faceplates.
Electrical Protection Device Library Provides a standard to represent protection devices within your electrical distribution system
Machine Builder Libraries Library objects for use with Application Code Manager.
• Independent Cart Technology Libraries, includes ICT Libraries for iTRAK® and MagneMotion®
• Studio 5000® Application Code Manager
• Power Device Library, including objects for E300, ArmorStart®, PowerFlex®, and Kinetix®
Network Device Library Provides objects for Stratix® switch and Device Level Ring network objects.
Power Device Libraries Provides objects for discrete and velocity power devices.

Libraries can be accessed from the

Product Compatibility and Download Center.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 23

Chapter 1 Rockwell Automation Library of Process Objects

Visualization Files Each Add-On Instruction has associated visualization files that provide a
common user interface. You must import these files in the following order:
• Images (.png files)
• Global Objects(.ggfx file type)
• HMI faceplates (.gfx file type)
• Tags (.csv file type)
• Macros (FactoryTalk View SE software only) (.mcr file type)
File Type FactoryTalk View SE Description
Abbreviations
All .png files in the images folder.
IMPORTANT: FactoryTalk View application renames PNG files when they Common icons that are used in the Global Objects and standard
Images (.png)
are imported with a .bmp file extension, but the files retain a .png format. displays for all Process Objects.
Examples:
Global objects (.ggfx) (raP-5-SE) precedes name of the Global Objects. (raP-5-SE) Common Objects
Examples:
Standard displays (.gfx) (raP-5_00-SE) precedes name of the display. (raP-5_00-SE) PAI-Faceplate
HMI tags are created in a FactoryTalk View SE application to support
FTViewSE_ProcessLibrary_Tags_5_0_xx.csv security and other features on Process Library faceplates. HMI tags
HMI tags (.csv) where xx = the service release number. can be imported via the
comma-separated values file (.csv file type).
Macros used for the general library:
• NavToDisplay
• ToggleWithRemark

Macro used for the PLLS object displays:

• NavToPLLS_Motor
In a FactoryTalk View SE application, a macro is a series of commands
Macros (.mcr file) Macros used for the Organization TreeView and navigation: that are stored in a text file.
• DefineShowHWTreeCmd.mcr
• DefineShowTreeCmd.mcr
• NavToBusDevice
• NavToBusDeviceWithSC
• NavToBusDisplay
• ShowTreeForObject

Images are external graphic files that can be used in displays. They must be
downloaded from PCDC to be used by FactoryTalk View software.

Global object files contain Graphic Symbols that are created once and
referenced multiple times on multiple displays in an application. When
changes are made to a global object, all instances in the application are
automatically updated.

Global objects serve two purposes:

• Toolbox files contain common elements that are used to build faceplate
displays.
• Graphic Symbols files contain device symbols that you can use to build
your application displays. Select the symbol to open the corresponding
faceplate display.

Standard display files, commonly called faceplates, provide a common user interface.

24 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Basic Attributes and Indicators

This section shows examples of visual indicators that are common for graphic
symbols in the Rockwell Automation Library of Process Objects. Visual
indicators are critical to the daily operation of a plant.

Common attributes of graphic symbols typically include:

• Status/quality/threshold indicator
• Maintenance bypass indicator
• Engineering units
• Label
• Command Source indicator (only for non-analog inputs)
• Alarm border that changes color and blinks on unacknowledged alarm
• Alarm indicator symbol that changes with the severity of an alarm

Item Description
1 1 Alarm Indicator
2 2 Alarm Border
3 7 Command source indicator (In the example the flag indicates not in normal
3 command source)
4
5
4 Label
8
5 Process Variable
6 Maintenance bypass indicator
7 Not Ready indicator
8 Engineering units

Each graphic object includes a touch field over it that opens the faceplate. In
addition, there is a tooltip on the graphic symbol that displays the configured
tag and description.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 25

Chapter 1 Rockwell Automation Library of Process Objects

State Indicators

The State Indicator text and the color change depending on the state of the
drive. The indicators and colors are common across all Add-On Instructions.
Color State
Dark Gray Stopped
Light Blue Starting
Light Blue Jogging
Light Blue Stopping
Light Blue Horn
White Running

Status Quality Indicators

One of these images appears on the graphic symbol when the described
condition is true.
Image Description Image Description

No symbol displayed I/O communication and quality good, configuration valid Accelerating

Invalid Configuration Decelerating

Data quality bad / failure Value is being initialized

Data Quality degraded: uncertain, test, virtual, substitution, Value has not changed (stuck)
or out of specification

Device not ready to operate Value is being replaced

The input or device has been disabled Input matches target

Alarm Inhibit (Suppressed or Bypassed) input does not match target

Device in loopback test Auto loop mode

At target speed Manual loop mode

Speed ref limited to the minimum / maximum Cascade loop mode

Value infinite or not a number Motor not controllable

26 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Image Description Image Description

Process Variable within setpoint deadband (no control

value is being held at last good value action occurs)

Input Controlled Variable that is clamped to minimum / Raise Process Variable output that is energized
maximum

Output Controlled Variable that is clamped to minimum / Lower Process Variable output that is energized
maximum

When the Invalid Configuration indicator appears, you can find what
configuration setting is invalid by following the indicators. Select the graphic
symbol to open the faceplate. The Invalid Configuration indicator appears next to
the appropriate tab at the top of the faceplate to guide you to the configuration
error. Once you navigate to the tab, the misconfiguration is flagged with this
indicator.

Threshold Indicators
These indicators show that the process variable has exceeded a threshold.
Image Description

High-high threshold exceeded

High threshold exceeded

Low threshold exceeded

Low-low threshold exceeded

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 27

Chapter 1 Rockwell Automation Library of Process Objects

Deviation Indicators

These indicators warn of exceeding the deviation limits.

Image Description

High-high deviation exceeded

High deviation exceeded

Low deviation exceeded

Low-low deviation exceeded

Command Source Indicators

The command source indicator displays by exception only. For example, if the
device is operating normally, there is not an indicator. If the device is out of
service (OoS), then the OoS indicator is displayed.

Command source indicators are not used for analog inputs.

Image Description
No symbol displayed Device is in normal command source operation

Device is out of service

Device is not in normal command source operation

Device is in program command source operation

Device is in program locked command source

Device is in maintenance command source operation

Device is in operator command source operation

Device is in external command source operation

28 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Image Description

Device is in operator locked command source operation

Device is in override command source operation

Device is in hand command source operation

Maintenance Bypass Indicator

The maintenance bypass indicator appears to the right of the label to indicate
that a maintenance bypass has been activated. The Maintenance bypass
indicator appears when the Substitute PV function is enabled. A Maintenance-
entered value supersedes the ‘live’ process variable.
Image Description

A maintenance bypass is active

No symbol displayed No maintenance bypass is active

When the Maintenance bypass indicator appears, you can find what condition
was bypassed by following the indicators. Select the graphic symbol to open the
faceplate. The Maintenance bypass indicator appears next to the appropriate tab
at the top of the faceplate to guide you to the bypass. Once you navigate to the
tab, the bypassed item is flagged with this indicator.

Basic Faceplate Attributes Faceplates consist of tabs, and each tab consists of one or more pages. The
Operator (Home) tab is displayed when the faceplate is initially opened. The
faceplate provides the means for operators, maintenance personnel,
engineers, and others to interact with an instruction instance, which includes
a view of its status and values. Faceplates also manipulate an instruction
through its commands and settings. Select the appropriate icon on the left of
the faceplate to access a specific tab. This section provides an overview of the
faceplate attributes that are common across the objects. More details are
supplied in the individual section for each object.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 29

Chapter 1 Rockwell Automation Library of Process Objects

Operator (Home) Tab

Item Action
1 7 1 Select to open the operator tab.
2 2 Select to open the maintenance tab.
3 Select to open the trends tab.
3 4 Select to open the diagnostics tab.
4 5 Select to open the alarm tab.
6 Select to open the help file.
5 7 Select to reset and acknowledge all alarms.
Select to enable navigation to an object with more information
(Cfg_HasMoreObj is set to true.)

You configure the tagname of the object you want to navigate

6 8 to in the extended tag property "Cfg_HasMoreObj.@Navigation".
It uses the <backing tag>.@Library and <backing
tag>.@Instruction extended tag properties to display the
object’s faceplate.
If the object is configured to have permissive and interlock
9 8 objects (for example, Cfg_HasPermObj (Fast or Slow) or
Cfg_HasIntlkObj is true), the permissive and interlock
indication become buttons. These buttons open the faceplates
9 of the source objects that are used as a permissive or
interlock. Often this object is a P_Perm or P_Intlk object. If the
object is not configured in this way, the permissive or interlock
symbols are indicators only.

Maintenance Tab

In the maintenance tab, there is a button for Advanced properties. There are
also page identifiers at the bottom if there are multiple configuration pages.
See the following diagram for common attributes of the maintenance tab.

Item Action
1 1 Select to open the Advanced Properties.
2 Page identifiers.

30 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Advanced Properties

The advanced maintenance, engineering, HMI configuration, Diagnostics,

and Faults tabs for the objects are available in the advanced properties
faceplate. The advanced maintenance and engineering tabs have object-
specific configurations that are detailed for each object.

The HMI configuration tab has settings that are common to the objects. See
the following diagram for common attributes of the HMI configuration tab.

1
Item Action
2
1 Select to open the HMI Configuration tab.
2 Select to open the engineering tab.
3 3 Select to open the Advanced Maintenance tab.
4
4 Device description that shows on the faceplate title bar.
5 Label to show on the graphic symbol.
5
6
6 Tag name that shows on the faceplate and Tooltip.
7 7 Area name for security.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 31

Chapter 1 Rockwell Automation Library of Process Objects

Diagnostics Tab

The Diagnostic tab provides indications that are helpful to diagnose or help
prevent device problems. These problems can include specific reasons a device
is 'Not Ready', device warnings and faults, warning and fault history, and
predictive/preventive maintenance data.

The Diagnostics tab displays possible reasons for the device not being ready.

Faults Tab

The faults tab contains specific reasons that the device is not ready.

32 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Trends Display

The Trends display shows trend charts of key device data over time. These
faceplate trends provide a quick view of current device performance to
supplement, but not replace, dedicated historical or live trend displays.

Item Action
1 Select to zoom in
2 Select to zoom out
3 Select to reset view

1
2
3

Alarms Tab

The Alarms tab displays each configured alarm. The icon on the tab for the
alarms page has an outline that changes color to show the current active alarm
status.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 33

Chapter 1 Rockwell Automation Library of Process Objects

Help Button

Press the help button on the faceplates to access help specific to that faceplate.
The help file is in .pdf format and opens in a separate window. See the
following example:

34 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Quick Display Interaction A Quick Display provides means for operators to perform simple interactions
with an instruction that is instance based on a task. From the Quick Display,
Select the Home button to navigate to the faceplate for full access for
operation, maintenance, and configuration. All other buttons function the
same as on the main faceplate. The following figures show examples of quick
displays.

Install the Library For the latest compatible software information and to download the Rockwell
Automation Library, see the Product Compatibility and Download Center.

Import Logic

An Add-On Instruction is defined once in each controller project, and can be

instantiated multiple times in your application code. To use pre-engineered
logic, import each Add-On Instruction into a controller project.
1. In the Studio 5000 Logix Designer application, open a new or
existing project.

IMPORTANT Add-On Instruction definitions can be imported, but not updated, online.
2. Select the Add-On Instructions folder in the Controller Organizer and
choose Import Add-On Instruction.

3. Select the Add-On Instruction and Select Import.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 35

Chapter 1 Rockwell Automation Library of Process Objects

Some Add-On Instructions are provided in RUNG import files.

If a RUNG import file is provided, import the rung into a
ladder diagram routine to get all required additional tags,
data types, and message configurations.

4. On the Import Configuration dialog box, Select OK to select the

defaults.

5. Once the import is complete, the Add-On Instructions are visible in the
Controller Organizer.

36 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Import Visualization Files

There are several components to import for the visualization files. You import
files from the downloaded Rockwell Automation library files via FactoryTalk
View SE.

Import files in this order:

1. Import HMI Images files.

Select all the images and Open.

2. Import Global Object files

Select the global object (.ggfx) files.

3. Import HMI Faceplates

Select the faceplate (.gfx) files.

4. Import Macros

Right-click Macro and select Add Component Into Application.

Select all the macros and Open.

Import HMI Tags

From the Tools pull-down menu, select Tag Import and Export Wizard. Use
the following table to complete the wizard.
On this Dialog Box Action
Select the operation you would like to perform Select ‘Import FactoryTalk View tag CSV files’
Choose the FactoryTalk view project you want to import Browse to the .sed project file that you want the HMI tags
into imported into
Choose the FactoryTalk View CSV files you want to import Select the .csv file that is contained within the downloaded Library
zipped file
Choose the import options you want Select ‘Skip existing (fastest)’

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 37

Chapter 1 Rockwell Automation Library of Process Objects

When you finish the wizard the FactoryTalk View - Database Import dialog box
appears with the information that the import is complete.

FactoryTalk Linx Device The Library of Process Objects 5.0 utilizes the feature Extended Tag Properties
inside Studio 5000 Logix Designer. Ensure when configuring FactoryTalk Linx
Shortcuts Configuration communication setup for device shortcuts the following boxes are checked:
• Upload all extended tag properties
• Display pass-through values for tag extended properties

Note: Configuring the shortcuts incorrectly will result in wireframes

if extended tag properties are left blank.

38 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

FactoryTalk View Language The Library of Process Objects 5.0 utilizes the feature Extended Tag Properties
inside Studio 5000 Logix Designer. This allows localization of strings in the
Configuration controller in the HMI Faceplates provided. When configuring languages
(FactoryTalk View Studio - View Site Edition > Tools > Language
Configuration) ensure the following checkbox is selected:
• Display undefined strings using the default language.

Help Files
The help displays for the Library of Process Objects have been converted to
PDF documents. The PDF documents can be displayed from the FactoryTalk
View displays by clicking the Help button. The help files are downloaded as
part of the Library of Process Objects and are contained in the Documents
folder.
1. Copy the Help files to a folder accessible by the FactoryTalk View
clients.
In this example we have copied the files to
C:\Users\Rockwell\Desktop\HMI Help Files.
2. Open your project in FactoryTalk View Studio.
3. Open the Tags setting in the Folder Tree.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 39

Chapter 1 Rockwell Automation Library of Process Objects

4. Select the RALibrary Folder and then Select RALibrary\HelpFilePath to

access the settings for the Help Files.

5. Enter the path to the Help Files into the Initial Data Source Field and
Select Accept.

Local Station:

40 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 1 Rockwell Automation Library of Process Objects

Distributed System Server:

6. Close the settings display.

7. Restart FactoryTalk View Studio for the settings to take effect.
8. The Help Files can now be accessed using the Help button on the HMI
Display.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 41

Chapter 1 Rockwell Automation Library of Process Objects

Library Versions Each library object has a revision x.yy.zz where: x is the Major Revision
number, yy is the Minor Revision number, and zz is the Maintenance Release.
Each release of the Process Library comes with release notes that describe the
changes that were made since the last release.

Component Example

The Add-On Instruction in Logix Designer

application has revision information
visible when the instruction is selected
in the Controller Organizer.

The faceplate in FactoryTalk View

software has revision information
visible when the pointer is paused just
inside the lower left corner of the
faceplate.

PlantPAx Process Library This tool is used to migrate from Process Library version 4.1 to version 5.0. The
PlantPAx Process Library Migration Tool provides the following:
Migration Tool
• Updates Logix controller ACD files containing Rockwell Automation
Process Library AOI tags to corresponding Process Controller
predefined process instruction tags and V5.0 AOI tags.
• Converts FactoryTalk View SE process graphics XML files containing
global object references from previous Process Library versions to V5.0
Process Library global objects.
• Migration of Process Library HMI libraries.
• Migration of GEMS Version 4.4 AOIs to corresponding Process
Controller predefined process instruction tags and V5 AOI tags.

The tool reduces engineering time and migration errors. Use the tool to keep
up with the latest Rockwell Automation software features and increase the life
cycle of the PlantPAx DCS.

42 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 2

Graphic Framework Overview

It is important to organize an HMI application in a hierarchical way, to

provide the operator and/or end user with a logical progression of complexity
from main area overview down to detailed device information. ANSI/ISA-
101.01-2015 outlines basic HMI design guidelines and recommends a
progressive disclosure methodology with up to four levels of displays. The
PlantPAx® Graphic Framework was created to assist the end user by providing
a basic structure that can be used to follow the ANSI/ISA-101.01-2015
recommendations.

For more information on HMI philosophy, style guide contents and the
various display types/levels, see Rockwell Automation Process HMI Style
Guide, PROCES-WP023-EN-P.

The PlantPAx Graphic Framework is made up of four main components,

Header, Process Control Displays, Navigation, and Alarm Indication. Note:
Template display files are a specific size and defined to open at a specific
location. This should not be changed and could result in the Graphic
Framework not functioning properly.

Header Display The Header is a perpetual graphic display that is positioned at the top of each
HMI client monitor to provide major navigation, annunciation, and status
information for the process and the control system.

The Header is made up of several modular objects that can be selectively used
to meet the needs of the end user. The following list indicates the available
components in the PlantPAx Graphic Framework that can be used to create the
Header display:
• Logo Object

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 43

Chapter 2 Graphic Framework Overview

• L1 Navigation Object
• Diagnostics Object
• Home Navigation Object
• Close Client Object
• Login / Logout Object
• Alarm Banner (Default sized Alarm Banner Object – 3 lines)
• Alarm Summary Navigation with Visual Alarm Indication Object
• Alarm Silence Object
• Date / Time Object
• Windows® Navigation Objects
• Help Object
• Language Switching Objects
• Report Navigation Object
• Trend Navigation Object
• Documentations Navigation Object
• L2 Navigation Bar (required)

A separate header must be used for each L1 area, reflecting information within
that operator's sphere of influence. The header will typically have a similar look
and feel for each L1 area with different configuration to provide information
only relevant to the operator of that L1 Area.

Process Control Displays Process control displays are the main displays in the system that the operator
will interact with. The PlantPAx Graphic Framework provides template
displays, or default displays, that can be used to build the main graphics. These
template displays can be duplicated for customization in each application. All
default displays are sized the same and include different navigation and
indication to allow operations to quickly assess the process status and take
required actions.

There are three process control displays available as templates:

Display Description
• This is an overview of the operator's sphere of influence (Overview Display)
• Full graphic displays with L2 Navigation Bar visible
L1 Default Display • The first display that is populated when the operator refreshes the FactoryTalk® View
Template SE client
• Intended to be a high-level process area display typically consisting of key performance
indications using trends and display objects (not just lists of numerical data)
• An operator’s main control display designed to support typical operation modes often
arranged like a process flow diagram (PFD).
• Control for main operation variables and annunciation to prompt operator to access
L2 Default Display associated L3 display when necessary
Template
• Full graphic display with L2 and L3 Navigation Bar present
• Typically, there are multiple L2 displays required to cover an operator’s sphere of
influence represented by the L1 display.
• A more detailed display designed for troubleshooting and abnormal scenarios. The L3
L3 Default Display display design presents data that best matches to current task at hand.
Template • Full graphic display with L2 and L3 Navigation Bar present. Simple L2 areas may not
require an L3 display and therefore L3 Navigation Bar may not be required.

Typically, there are multiple L3 displays required to cover the detail

represented by a single L2 display. L4 displays provide finer detail and are
opened as Faceplate or popup display from L2 and L3 displays. These would
include PlantPAx standard faceplates or custom popup displays.
44 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020
 Chapter 2 Graphic Framework Overview

L1 Display

L1 Process Control Display is used as an overview for a single operator's sphere

of influence. This is the first screen that the operator sees when the HMI client
starts up and contains a high-level overview of the operator's sphere of
influence as well as KPI's and indications. There will typically be one L1 Process
Control Display for each L1 Area in the project. The display is typically designed
to represent the various process units with key indications, trends, and rolled-
up alarm status to help drive the operator to the appropriate L2 displays to
address the abnormal condition.

L2 Display

L2 Process Control Displays are used as the operators' main control screens.
These displays provide access to the main operating parameters while
concurrently providing annunciation when abnormal conditions exist. If
required, the operator can access the associated and more detailed L3 displays
to address the situation. The L2 display will include the L3 Navigation bar at
the top with an indicator of the selected display. There will be one L2 Process
Control display for each L2 Navigation button utilized and will be displayed by
clicking on the given L2 Navigation button.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 45

Chapter 2 Graphic Framework Overview

L3 Display

L3 Process Control Displays are used to access in-depth equipment details and
diagnostics that may not be needed while the process is running normally.
These displays are often similar to the traditional P&ID style of displays
allowing the operator access to all control and monitoring information for that
specific area of the plant. The L3 display will include the L3 Navigation bar at
the top with an indicator of the selected display and indicator of associated L2
display.

Navigation The PlantPAx Graphic Framework provides an intuitive and 'easy to configure'
navigation strategy. Navigation among displays as part of the Graphic
Frameworks can be configured and accessed from:
• L1 Navigation
• L2 Navigation
• L3 Navigation
• Alarm Navigation
• Graphic Off-Screen Connectors

L1 Navigation
L1 Navigation allows operators to navigate to other areas of the facility. This
will move the operator to a different sphere of influence. The Display Map
Button is used to open a popup display - the Display Map. This is the L1
Navigation display. This display can be expanded to include as many L1 areas
as necessary for an application. Four buttons are provided by default.

46 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 2 Graphic Framework Overview

L2 Navigation

L2 Navigation is the first level of display access within a given L1 area. There is
just one L2 Navigation bar used for each L1 area. The L2 Navigation bar resides
within the header display and is always visible. The L2 Navigation Bar is made
up of 16 buttons and can navigate to up to 16 different displays.

When the operator clicks the desired L2 button, that L2 display will open. On
that L2 display, the L3 navigation bar will open. Each L2 button has alarm
indication and these are rolled up from the L3 alarms. The L2 Navigation
button text can be modified for each specific application.

L3 Navigation
L3 Navigation is the second level of display access within a given L1 area. There
are multiple L3 Navigation bars - one for each L2 button used. The L3
Navigation bar resides within the L2 and L3 Displays. Each L3 Navigation Bar
is made up of 16 buttons and can navigate to up to 16 different displays.
Included in the L3 Navigation bar is an indicator that shows which L2 and L3
area the operator is currently viewing.

When the operator clicks a desired L3 button, that L3 display will open. Each L3
button has alarm indication and these are rolled up into the L2 alarms. The L3
Navigation button text can be modified for each specific application.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 47

Chapter 2 Graphic Framework Overview

Alarm Navigation

Alarm information is accessed by pressing the Alarm Button on the header.

This will open the Alarm Summary display. From the Alarm Summary display,
other alarm information displays can be accessed, including the Alarm
History, Alarm Shelved, and Alarm Explorer (with proper runtime security).
There is a display associated with each of the four alarm buttons - see Global
Objects for more information on Alarm Global Objects. See Displays for more
information on template Alarm displays.

The Alarm Navigation has an indication below each button to show which
alarm display the operator is currently viewing.

Off-Screen Navigation
Graphic Off-Screen Connectors are used to supplement navigation for
Operators to follow the process progression (to the left or to the right of the
current display) on P&ID style screens. Various style of off-screen navigation
can be found in a Toolbox graphic.

48 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 2 Graphic Framework Overview

There are three different off-screen navigation functionalities available.

Functionality Description
Navigation to Same L1 area This is used if the off-screen navigation is within the same L1 area. The button
simply opens a new L2/L3 display within that L1 area.
This is used if the off-screen navigation is outside the current L1 area. The button
Navigation to Other L1 area will need to execute a macro that displays the destination L1 area header and the
desired L2/L3 display. An additional step of creating a macro specific to this display
navigation will need to be completed.
The static off-screen connector does not navigate to any display. It is used as an
No Navigation (static) indicator of a process inflow or outflow with no accompanying graphic - just a static
indication. Various styles are offered in the toolbox.

Alarm Indication Alarm indication is embedded throughout the PlantPAx Graphic Framework.
As mentioned in the L1/L2/L3 Navigation section, each navigation button has
alarm indication available, with alarms rolled-up from L3 to L1. The Alarm
button on the Header display also indicates to the operator if alarms are active
in that L1 area. The following displays give the operator information on
specific alarms and alarm configuration.
Display Description
There is one Alarm Banner for each L1 area. The Alarm Banner, which resides on the Header display, will show three alarms.

Alarm Banner

Each L1 area will have a corresponding alarm summary. The purpose of the alarm summary is to indicate alarms within the L1 area (by severity and
time) and provide the ability for the operator to interact with these alarms. Navigation to the alarm summary is accomplished by clicking on the Alarm
Alarm Summary Summary Navigation button from the associated Header. The alarm summary must be configured to subscribe to alarms specific to the L1 area. Filters
can be configured for each L2 alarm group for additional alarm functionality.
Alarm History display contains a configured Alarm and Event Log Viewer object that accesses the alarm and events historical data. Note: The alarm and
Alarm History event server must be configured to log the alarm data for this display to work properly. This display filters based on predefined filters.
Alarm Shelved display contains an Alarm and Event Status Explorer object preconfigured to access alarm and event databases within the application
Alarm Shelved with the status of “Shelved”. This display can be further filtered based on alarm names. The shelved alarm display will display the alarm grouping tree to
allow easy access to each alarm group.
Alarm Explorer display contains an Alarm and Event Status Explorer object preconfigured to access A&E databases within the HMI application. This
Alarm Explorer display can be further filtered based on alarm names. The alarm explorer will display the alarm grouping tree to allow easy access to each alarm group.
The button to access this display has security built in. Only users with ability to enable/disable alarms can access this display.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 49

Chapter 2 Graphic Framework Overview

Alarm Grouping and To create alarm groupings that align with the Navigation bars, additional
upfront effort must be made in each controller to support this function. This
Supporting Logic effort requires using the Logical organizer in the controller files to use the
same hierarchy as that in the graphical hierarchy. That is, if multiple
controllers are used within a single operator's sphere of influence, the same L1
- L2 - L3 architecture must be represented within each controller (the L1 / L2 /
L3 folders represent graphical displays in the HMI). Once the folders are
created, the Alarm builder tool allows you to merge the alarm groups
appropriately so that the process alarm indication displays are control
equipment agnostic. In addition, if a single controller contains logic used by
multiple operators, the folder structures of each area must be created in the
Logical organizer to represent of the multiple L1 hierarchies.

50 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 2 Graphic Framework Overview

The alarm grouping setup in the Logical Organizer should then be reflected on
the L2 / L3 navigation as shown below in a few examples, for button naming as
well as alarm breadcrumb (alarm groups):

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 51

Chapter 2 Graphic Framework Overview

Notes:

52 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3

Configure the Graphic Framework

The following table defines common terms used in the setup.

Term Description
The term “Template” within a filename indicates that the file should be duplicated when used in the
application. The duplicated file should be re-named to a title that is meaningful for the specific area
Template or sub-area of the facility of your application. The original template file is to be used as a starting
point for multiple files in the application and should not be modified.
When a file in the application contains the term "APP", the objects in these files can be used directly
App out of this file - the file name does not need to be duplicated or renamed.

The PlantPAx® Library download provides the following files to use as a

starting point to utilize the PlantPAx Graphic Framework. Templates are
provided both with and without the PlantPAx Process Object library faceplates
included.
• FTVSE_12_0_Template_{version}.APB
(i.e. FTVSE_12_Template_5_00_00.APB)
• FTVSE_12_0_TemplateWLibrary_{version}.APB
(i.e. FTVSE_12_TemplateWLibrary_5_00_00.APB)
• FTVSE_12_0_Template_{version}.zip
(i.e. FTVSE_12_Template_5_00_00.zip)

The PlantPAx Graphic Framework can be utilized in one of two ways:

• Restore the provided Local Station project templates (.APB) using the
FactoryTalk® View SE Application Manager.
• Create your own project and import the HMI server or individual files
as needed.

For a Distributed or Network Station application, we recommend the HMI

Server Import.

Recommended Application
Naming Structure Template Display Name Suggested Name Structure Example:
(raP-5-SE) Template 1Mon Display Map [App_Name]_DisplayMap ABC-Chem_DisplayMap
(raP-5-SE) Template Diagnostic-Summary [App_Name]_Diagnostic-Summary ABC-Chem_Diagnostic-Summary
(raP-5-SE) Template Language-Select [App_Name]_Language-Select ABC-Chem_Language-Select
(raP-5-SE) Template 1Mon Header [L1_Name]_Header Mixing_Header
(raP-5-SE) Template Display L1 [L1_Name] Mixing
(raP-5-SE) Template Display L2 [L1_Name]_[L2_Name] Mixing_IngredAdd
(raP-5-SE) Template Display L2 no L3 [L1_Name]_[L2_Name] Mixing_Agitate
(raP-5-SE) Template Display L3 [L1_Name]_[L2_Name]_[L3_Name] Mixing_IngredAdd_Weigh
(raP-5-SE) Template Alarm-Explorer [L1_Name]_Alarm-Explorer Mixing_Alarm-Explorer

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 53

Chapter 3 Configure the Graphic Framework

Template Display Name Suggested Name Structure Example:

(raP-5-SE) Template Alarm-History [L1_Name]_Alarm-History Mixing_Alarm-History
(raP-5-SE) Template Alarm-Shelved [L1_Name]_Alarm-Shelved Mixing_Alarm-Shelved
(raP-5-SE) Template Alarm-Summary [L1_Name]_Alarm-Summary Mixing_Alarm-Summary

Global Object Files Suggested Name Structure Example:

(raP-5-SE) APP - Administrative Objects N/A Use file as is
(raP-5-SE) APP - Alarm Objects N/A Use file as is
(raP-5-SE) APP - Header Objects N/A Use file as is
(raP-5-SE) Template Custom Objects [App_Name]_CustomObjects ABC-Chem_CustomObjects
(raP-5-SE) Template L1 Navigation [App_Name]_L1Navigation ABC-Chem_L1Navigation
(raP-5-SE) Template L2 L3 Navigation [L1_Name]_L2L3Navigation Mixing_L2L3Navigation

Macro File Suggested Name Structure Example:

Template_ClientStartup [L1_Name]_ClientStartup Mixing_ClientStartup
Template_Repaint [L1_Name]_Repaint Mixing_Repaint

Build Your PlantPAx HMI Application

1. Go to FactoryTalk View SE Application Manager > Local Station and
select Restore Archive.

2. Browse to the APB file.

3. Name the new application and select Restore.

You can now open Factory Talk View SE Local Station and build out the
application using the PlantPAx Graphic Framework.

The HMI Server backup can be used for Distributed or Network Station
applications. The following assumes that the server system is configured
correctly and to PlantPAx recommendations. The following also assumes that
the FactoryTalk Directory is setup and all applicable images are joined to the
directory.

IMPORTANT This should be used as a rough guide only. Reference PlantPAx and FactoryTalk View documentation for best practice and
proper system configuration.
1. Go to FactoryTalk View Studio and select either Distributed or Network
Station.

54 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

2. Create a new application.

3. Build out the Area folder structure. Place only one server in each area
folder

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 55

Chapter 3 Configure the Graphic Framework

4. Right click on the HMI area folder. Select Add New Server > HMI
Server. The Add HMI Server Wizard will open. Select Import a project
and click Next.
On this Page Action
Warning Popup Select OK
• Select FactoryTalk View Site Edition Project.
• Navigate to the provided HMI server backup and select the SED file for the project file.

Import Project

• Name the HMI server

• Select the computer that will host the new HMI server

New HMI Server

Properties

The HMI server will take a few minutes to import. Once the import is
complete, the application is ready to build out with the PlantPAx Graphic
Framework.

56 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Global Objects The following section outlines each of the global object files available in the
PlantPAx Graphic Framework and how each object should be used and
configured.

APP - Administrative Objects (raP-5-SE)

The following objects are used for administrative control.

Configuration
Object Graphic Description
Parameter Number Description Explanation

The purpose of the Close Client object No configuration required. This object can be placed on the Header or on a separate
Close Client is to shut down the client. administrator display.

APP - Alarm Objects (raP-5-SE)

The following objects are used for alarm navigation and annunciation.
Configuration
Object Graphic Description Parameter Description Explanation
Number
The purpose of the Alarm Summary Navigation Alarm Summary Enter full Alarm Summary display name
101
object is to visually alert operators of current active Display Name
alarms in their L1 process area and to provide
navigation to the Alarm Summary. This object will
Alarm navigate to a different Alarm Summary screen in
Summary each L1 area.
Navigation Alarm Group Enter the L1 area alarm group name (for
102
This button should already be populated on the Name (Level 1) indication)
template Header display. The global object
parameter values will need to be updated on the
Header display.
The purpose of the Alarm Silence Button object is to
silence any active audible alarms assigned to that L1 Enter the associated L1 Header display name
area for that specific client. Alarm and Event that contains the alarm banner.
Alarm Silence 101 Banner Display
Button This button should already be populated on the Name "Invoke
Header display. The global object parameter values #101.FactoryTalkAlarmandEventBanner.SilenceAll"
will need to be updated on the Header display.
Alarm Group L1 Group name in FTAE and/or FTLinx (required
The alarm annunciation objects are available for L1, 101 Name (Level 1) for L1, L2, and L3 annunciation objects)
L2, or L3 alarm groups. These annunciation objects Alarm SubGroup L2 Group name in FTAE and/or FTLinx (required
Alarm Group are built into template objects for L1, L2, and L3 102 Name (Level 2) for L2 and L3 annunciation objects)
Annunciation navigation objects, but can be added to additional
buttons if desired. There are also larger objects Alarm L3 Group name in FTAE and/or FTLinx (required
available for L1 Overview display. 103 SubSubGroup for L3 annunciation objects)
Name (Level 3)

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 57

Chapter 3 Configure the Graphic Framework

APP - Header Objects (raP-5-SE)

The following objects are recommended to be placed on the Header display

and provide information and specific navigation.
Configuration
Object Graphic Description Parameter Description Explanation
Number
The logo object is pre-built using the
PlantPAx logo. The logo object is populated in
the Header display by default but can be
removed to free up space on the Header.
PlantPAx Logo No configuration required.
If users prefer to add their own logo, See
Template Custom Objects (raP-5-SE) for
more information.

The Time-Date object indicates the current

Time Date time and date. This object is populated in the No configuration required.
Header display by default.

The System Status object is used for Enter the whole display name into the
navigation to the control system status 101 System Status parameter.
display (custom display created by the Display Name
customer). Display "#101"

There is an optional System Status

breadcrumb that can be added to the System
Status button (see Displaysfor Template
Toolbox display). ). There is also an L1 alarm
breadcrumb that could be used for this
button (see APP - Alarm Objects (raP-5-SE)
for Alarm Group annunciation).

The system status screen is a custom display

developed to show diagnostics and hardware
information.
System Status It is recommended that the PlantPAx The system status breadcrumb is configured as follows: Replace “[MyCLX]” with
Hardware Tree be placed on this display for the shortcut defined for your application. If you have multiple processors,
each controller. See PlantPAx manuals for duplicate the function for each processor and use a logical “or” to combine the
more information on the Hardware Tree and expressions. The system status breadcrumb should be placed on top of the
Tree View. System Status Button in the Header bar.
Alarm bread crumb objects - L1 for the
System Status header button and L2 for each
individual Hardware Tree button - are
provided in the alarm global object file that
fit on top of the buttons for System Status.
See APP - Alarm Objects (raP-5-SE) for alarm
group annunciation details. It is
recommended that an L1 alarm group be for
overall system diagnostics and that L2
subgroups be created for each controller and
hardware under that controller.

The Repaint Screen object is used to refresh

Level 1 Macro Name Enter the macro used to repaint the display
Repaint the display client. The button will call up a 101 (See Macros for more information.)
Screen macro that closes all displays and reopens - Repaint Macro "#101"
the header and the main overview display.

The purpose of the Home Navigation object is

to provide a link allowing an operator to go to No configuration required. See Macros
Home to verify that the “Client Startup” macro is
their "Home" area or sphere of influence.
Navigation setup properly.
Navigates to Client Home display (not the
current L1 home display).
The purpose of the L1 Navigation object is to Enter the whole display name for the Display
link to a popup display that provides access
Map display popup.
to other L1 Process Areas within the facility. Display Map Display
L1 Navigation This object configured the same for all L1 101 Name Display "#101" /cc
Headers (it will always call up the same See Displays for more details on configuring
popup, regardless which L1 area is being the display map popup.
displayed).

58 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Configuration
Object Graphic Description Parameter Description Explanation
Number

Enter the whole display name for the

The Administrator Button can be used to Administrator Administrator display
Administrator navigate to a custom administrator display. 101 Display Name
Display "#101"

The purpose of the Trend Navigation Button

object is to navigate to a display Enter the whole display name for the Trends
Trend prepopulated with navigation buttons to Trends Display display
101
Navigation various prebuilt trends or generic trend Name
display to allow building of ad hoc trend Display "#101"
displays.

Enter the whole display name for the

Diagnostic The Diagnostics Events Summary object is Diagnostic Display Diagnostic display
Events used as a navigation button to access the 101 Name
Summary ADDA event summary. Display "#101"

The purpose of the Language Switching

Button object is to provide ability for the user
to change the HMI text to use their preferred
(previously configured) language. The
selection is client based and each client can Enter the whole display name for the
Language choose a different language provided that Language Select Language Selection display
101
Switching the data sources are configured with the Display Name
selected language. The dynamic text is Display "#101" /RP
provided by the controller and the static text
is provided by the HMI Server (both sources
can provide information in multiple
languages concurrently).
Enter the whole display name for the help
Display: display.
Help Display Name
101
Display #101
The purpose of the Help Button object is to Help File
provide access to a User defined Help display Full file path
or PDF file.
There are two separate buttons available For example:
Help Button Enter the file path to the Help PDF. The file can
depending on if you want to use a Help
display (FTView-based) or PDF. These PDF: reside on the OWS that the client is run on or
C:\Users\public\do located on a shared file directory.
buttons can be added to the Header display 101 cuments\help.pdf
or any other display.
AppStart #101
or
\\PRC-
PASS\Shared\help.pdf
The purpose of the Windows Navigation
Button objects is to provide Windows like
navigation capability within the HMI. Note:
Windows For multi-monitor applications, the display
Navigation None. Buttons are ready to use and only need to be added to the Header display.
history is shared with all the configured
Button monitors. Therefore, this navigation should
be concerned as a common group monitor
history.

The Login / Logout object is used to allow This object is already populated on the default Header display.
logging in and out of various users and Note: For log out to the view only user to work correctly, the view only user must
Login / Logout includes an indication of the current user. be configured in security.
Logging out will log in as a View Only User. The log out button is setup for user “default” password “default”.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 59

Chapter 3 Configure the Graphic Framework

Template Custom Objects (raP-5-SE)

The following objects are customizable to customer's specific needs. Prior to

customizing, duplicate and rename the file to preserve the original template
file.
1. Go to file > Duplicate.

2. Name the new global object file.

Use a filename that represents the application/facility. Replace only the
'(raP-5-SE) Template' portion of the filename. This creates a file for your
specific application and preserves the original template file.

Object Graphic Description Configuration

The logo object is in the Custom Objects files can be replaced with the
customer's logo. The customer logo must first be imported into the
application Images folder. Once the image is imported, open the object
in Custom Objects file and replace with customer logo.

Once the image file is correct, copy the updated

Custom Company global object and paste it onto the header after
Logo deleting the default PlantPAx logo.

The purpose of the Report Navigation Button object is to navigate to a Copy and paste the button on the Header
Report Navigation display with pre-populated navigation buttons to access various prebuilt display (or any other display) in the desired
reports. location. Update the navigation as necessary.

60 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Template L1 Navigation (raP-5-SE)

This global object file is a template. The template file for L1 Navigation will only
need to be utilized once for each application. This file defines the navigation to
each L1 Area - one button per each L1 area. To utilize this file, use the following
steps:
1. Go to file > Duplicate.

2. Name the new global object file.

Use a filename that represents the application/facility. Replace only

the '(raP-5-SE) Template' portion of the filename. This creates a file
for your specific application and preserves the original template file.

3. Duplicate the buttons as required (one for each L1 area).

Four buttons are provided by default - not all buttons need to be used.

4. To update the text on the button, go to Object Explorer and select the
L1_ButtonTxt_# object and modify as required.

Repeat for each button.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 61

Chapter 3 Configure the Graphic Framework

5. To update the navigation for each button, go to the L1_Button_# object

> Action tab and replace the Release Action with the macro command
for that L1 area. See Macros for more information on configuration.
Repeat for each button used.

Repeat for each button used.

6. After you finish updating all the button text and actions, select the
updated buttons in the L1 Navigation global object file and copy them to
the application specific (raP-5-SE) Template 1Mon DisplayMap.
7. Go to the application specific display developed from the template file
(raP-5-SE) Template 1Mon DisplayMap, delete any existing L1 button
objects, and paste the new ones.
8. For all buttons, enter the L1 alarm group parameters in the global object
parameters. See In the wizard, set the following: for more information
on alarm grouping.

62 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Template L2 L3 Navigation (raP-5-SE)

This global object file is a template. Utilize the template file for L2 / L3
Navigation once for every L1 area. This file defines the navigation to each L2
and L3 display within a given L1 Area. To utilize this file, use the following
steps:
1. Go to file > Duplicate.

2. Name the new global object file. Use a filename that represents the
specific L1 area. Replace only the '(raP-5-SE) Template' portion of the
filename. This creates a file for your specific L1 area and preserves the
original template file.

There are three sets of buttons to update for each L1 Area:

• Alarm Navigation Bar
• L2 Navigation Bar
• L3 Navigation Bars

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 63

Chapter 3 Configure the Graphic Framework

Alarm Navigation Bar

Only one Alarm Navigation bar is needed for each L1 area. For the Alarm
Navigation, the button text does not need to be updated. Only the navigation
needs to be updated.
1. To update the navigation for each button, go to the alarm button >
Action tab and update the display names for each of the alarm screens.

2. This should match the Alarm Displays created for this L1 area (see
Displays for more information on the alarm template displays).

Note: If the alarm display names match the recommended naming

convention, you can do a “Tag Substitution” and simply replace “(raP-5-SE)
Template” on the whole Alarm Navigation bar instead of updating each button
individually.
3. Copy the button bar and paste the bar in each of the four alarm
displays:
• [L1Area] Alarm-Summary
• [L1Area] Alarm-History
• [L1Area] Alarm-Shelved
• [L1Area] Alarm-Explorer
4. To update the location for the alarm displays, go to the Alarm
Navigation bar and place all of the Alarm Navigation bars in this
location on each of the four alarm displays: Left - 2, Top - 10.

64 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

5. Update the global object parameter for the Alarm Button indication.

This shows the operator what alarm display is currently being viewed.
Update the global object parameter for each alarm display:
• Alarm Summary = 1
• Alarm History = 2
• Alarm Shelved = 3
• Alarm Explorer =4

L2 Navigation Bar

Only one L2 Navigation bar is needed for each L1 area. Update the text on the
buttons that are being used.
1. To update the text on the button, got to Object Explorer and select the
L2_ButtonTxt_# object.

Repeat for each button.

2. To update the navigation for each button, go to the L2_Button_# object

> Action tab and replace the Release Action to point to the correct L2
display.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 65

Chapter 3 Configure the Graphic Framework

Repeat for each button used.

3. After you finish updating all the button text and actions, select the
updated button bar and copy.
4. Go to the application specific display developed from the template file
(raP-5-SE) Template 1Mon DisplayMap, delete the existing L2
Navigation bar, and paste the new one.
5. Go to the L2 Navigation bar and place the bar in this location on the L1
Header display: Left - 0, Top - 61.

6. For all buttons (used or not used), Enter the L1 and L2 alarm group
parameter in the global object parameters. See In the wizard, set the
following: for more information.
66 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020
 Chapter 3 Configure the Graphic Framework

These fields MUST be filled in with text or errors will populate in

FactoryTalk Diagnostics. Fill in the appropriate alarm group name for
the buttons used. If button is not used, simply enter “NotUsed” as
shown below. This will act as a dummy alarm group.

7. To make a button that is not used invisible, go to the Header graphic

Object Explorer, select the button, and modify the Group Visible
parameter.

Repeat for each button that should be invisible.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 67

Chapter 3 Configure the Graphic Framework

L3 Navigation Bar

One L3 Navigation bar is needed for each L2 Navigation button that is used (or
up to 16 L3 Navigation bars per L2 Navigation bar). Update and configure each
of the L3 Navigation bars.
1. Go to the L3 Navigation bar in the global object file and copy and paste
as many L3 Navigation bars as needed.

The first L3 Navigation bar correlates to the first L2 Navigation button;

the copy correlates to the second L2 Navigation button and so on for
additional copies.

There can be as many as 16 L3 Navigation bars in the global object file

for the L1. This example shows four L3 Navigation bars (only four L2
buttons used in this example).

2. To update the text on the button, got to Object Explorer and select the
L3_ButtonTxt_# object.

68 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Repeat for each button.

Note: The object names in the L3 Navigation bars that are copied from
the first L3 Navigation Bar do not populate new button numbers in
order. Take care when configuring buttons that the correct one is
selected.
3. To update the navigation for each button, go to the L3_Button_# object
> Action tab and replace the Release Action to point to the correct L2
display.

Repeat for each button used.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 69

Chapter 3 Configure the Graphic Framework

Note: The object names in the L3 Navigation bars that are copied from
the first L3 Navigation Bar do not populate new button numbers in
order. Take care when configuring buttons that the correct one is
selected.
4. Select the updated button bar and copy.

The object names in the L3 Navigation bars that are copied from the
first L3 Navigation Bar do not populate new button numbers in order.
Take care when configuring buttons that you select the correct bar.
5. Go to the application specific display developed from the template file
(raP-5-SE) Template Display L2 for this L2 area in this L1 area, delete
the existing L3 navigation bar, and paste the new L3 navigation bar.

6. Place the button bar in this location on the Header display:

Left-0, Top-0.

You can update the location on the property panel for the L3 Navigation
bar while in the Header display.

70 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

7. For all buttons (used or not used), the L1, L2, and L3 alarm group
parameter will need to be entered in the global object parameters. See
In the wizard, set the following: for more information.

These fields MUST be filled in with text or errors will populate in

FactoryTalk Diagnostics. Fill in the appropriate alarm group name for
the buttons used. If button is not used, simply enter “NotUsed” as
shown in the following display. This will act a dummy alarm group.

8. Edit parameters 107 and 108 for button indication.

Parameter Desscription
Parameter #107 is used to position the indicator of the L2 Button selected. This
parameter will stay the same across all L2 and L3 displays for this L3 Navigation
107 bar. In the following example, the first L2 Button is being configured, so a “1” is
entered. The parameter is incremented up to 16, for each L2 button (each L3
Navigation Bar).
Parameter #108 is used to position the indicator of the L3 Button selected.
When 0 is entered into #108, no indicator will appear under the L3 navigation
108 bar. When 1-16 is entered in #108, the indicator will be visible under the
appropriate L3 navigation bar button.

Additional information on parameter #107 and #108:

• When 0 is entered, the indication is invisible (no indication). This is
used when an L2 display is used – the L3 display buttons are not pressed
yet.
• When 1 through 16 is entered, this will correlate with what button is
indicated (button 1 to 16 from left to right).

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 71

Chapter 3 Configure the Graphic Framework

• The indicator uses horizontal animation with the parameter to indicate

the button selected. Use run time of navigation bars to clarify the
indicator function.

9. If a button on the L3 Navigation bar is not used, the button can be made
invisible. While in the L2 graphic, select the populated L3 Navigation
bar. In the Object Explorer, select the button to be made invisible. In
the Property Panel, modify the “Group Visible” parameter from True to
False.

Repeat for each button that should be invisible.

10. While in the L2 graphic, select the L3 Navigation bar and copy.
a. In the L2 area, open all the L3 graphics associated with this L2 area,
delete the L3 Navigation bar in each of the L3 graphics and paste the
updated L3 Navigation bar.
b. Update the global object parameter #108 for each L3 graphic.

Repeat this section for each L3 Navigation bar in the global object file.

72 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

L2 Indication Only

On displays where the L3 navigation bar is not utilized, a single indicator for
the selected L2 screen will be used. This is placed by default on the display
“(raP-5-SE) Template Display L2 No L3”. No configuration is required in the
global object file. See Displays for configuration on the default display

Displays Each display is a template. The template display should be duplicated and the
prefix “(raP-5-SE) Template” or “(raC-5-SE) Template” replaced with
meaningful name for each L1 area in the application. This preserves the
original template to use as a starting point on additional screens. See
Recommended Application Naming Structure for more information on
naming structure.
Display Graphic Description

This template can be used if language switching is used in the

application. Only one per application is required. This should be
used in conjunction with the Header button for Language
Switching. The display is pre-populated with typical languages
(raC-5-SE) Template used but can be modified for application specific needs.
Language-Select
Link this display to the Language Switching Header button.
Languages that are not used for this application can be removed
if desired.

This template is used for navigation between different L1 areas.

Only one per application is required. This should be used in
conjunction with the Header button for Navigation.
(raP-5-SE) Template
1Mon DisplayMap Link this display to Navigation Header button. Updated the Display
title for the specific application. See Global Objects for more
information on configuring the buttons on this display.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 73

Chapter 3 Configure the Graphic Framework

Display Graphic Description

This template is used for Headers for each L1 area. This template should be used once for each L1 area. The buttons on the header can be modified
using objects provided in the global object files. The L2 Navigation bar resides on this screen and is always visible.

The alarm banner object will need to be configured for alarms in that L1 area. Open the Alarm and Event Banner Properties and select the Event
Subscriptions tab. Then select the “Browse” button under “Scopes” box. Select the L1 area group(s) that correlates with that Header. Note: If there
are alarms that are both controller based and server based, both subscriptions will need to be added. Every Alarm or Data server that has alarms
for this L1 area needs to be added to the scope of the alarm banner.

(raP-5-SE) Template
1Mon Header

The L2 Navigation bar will need to be configured properly - see Global Objects to configure the L2 Navigation.

(raP-5-SE) Template
Alarm-Explorer

This template is used for Alarm Explorer for each L1 area. This template should be used once for each L1 area.

The Alarm Navigation bar will need to be configured - see Global Objects for more information.

74 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Display Graphic Description

(raP-5-SE) Template
Alarm-History

This template is used for Alarm History for each L1 area. This template should be used once for each L1 area.

The Alarm Navigation bar will need to be configured - see Global Objects for more information. Filters can be added to the Alarm History object if
desired from the Alarm History properties.

(raP-5-SE) Template
Alarm-Shelved

This template is used for Shelved Alarms for each L1 area. This template should be used once for each L1 area.

The Alarm Navigation bar will need to be configured - see Global Objects for more information.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 75

Chapter 3 Configure the Graphic Framework

Display Graphic Description

(raP-5-SE) Template
Alarm-Summary
This template is used for Alarm Summary for each L1 area. This template should be used once for each L1 area.

Link this display to the Alarm Header button. The Alarm Navigation bar will need to be configured - see Global Objects for more information. Display
filters can be added if desired in the Alarm and Event Summary properties.
The alarm summary object will need to be configured for alarms in that L1 area. Open the Alarm and Event Summary Properties and select the Event
Subscriptions tab. Then select the “Browse” button under “Scopes” box. Select the L1 area group(s) that correlates with that Header. Note: If there
are alarms that are both controller based and server based, both subscriptions will need to be added.

76 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Display Graphic Description

(raP-5-SE) Template
Diagnostic-Summary

This template is used for Automatic Diagnostic Event Summary. This template can be used either one for the whole facility or one for each L1 area.
If a display is created for each L1 area, then the event subscription scope will need to adjusted for each L1 display. Otherwise, no configuration is
required.

Link this display to the Diagnostic Events Summary Button.

(raP-5-SE) Template
Display L1

This template is used for each L1 Display. There will be one L1 display for every L1 area. Typically, this display will have an overview of that L1 area
and is the first display that the operator will see when the client starts up. This display is flexible - alarm indicators can be added if desired.

Link this display to the appropriate macros for client startup and screen repaint - see Macros for information.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 77

Chapter 3 Configure the Graphic Framework

Display Graphic Description

(raP-5-SE) Template
Display L2

This template is used for L2 Displays that have L3 displays associated. There will be one L2 display for every L2 Navigation button that is utilized.
The template will automatically display the GFX file name in the lower right corner. Typically, this graphic will contain necessary controls and
indication for the operator to run the facility.

Link each L2 Display to the appropriate L2 Navigation Button - see Global Objects for details on navigation configuration.

(raP-5-SE) Template
Display L2 No L3

This template is used for simple L2 Displays that do not have L3 Displays associated (no L3 navigation bar). There will be one L2 display for every L2
Navigation button that is utilized. The template will automatically display the GFX file name in the lower right corner. Typically, this graphic will
contain necessary controls and indication for the operator to run the facility.

Link each L2 Display to the appropriate L2 Navigation Button - see Global Objects for details on navigation configuration.
The parameter for the global object for L2 button indication will need to be configured. There is one parameter (#107) and is setup the same as with
the L3 navigation bar. See Global Objects for details on this parameter.

78 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

Display Graphic Description

(raP-5-SE) Template
Display L3

This template is used for each L3 Display. There will be one L3 display for every L3 Navigation button that is utilized. The template will
automatically display the GFX file name in the lower right corner. Typically, this graphic will contain more detailed information on devices that are
on associated L2 display.

Link each L3 Display to the appropriate L3 Navigation Button - see Global Objects for details on navigation configuration.
This display is used as a toolbox of objects that can be copied and
places on other displays. This screen will not be used on any
active clients.
If the off-screen navigation objects are used, then the button
action and text will need to be updated.

• Same L1
1. Copy the objected onto the desired screen.
2. Update the text.
3. Update the button action – navigate direct to display.
(raP-5-SE) Template
Toolbox
• Other L1
1. Copy the objected onto the desired screen.
2. Update the text object.
3. Update the button action – use macro to display other L1
header and L3/L2 display.

If the system status breadcrumb is used, the animation will need

to be updated. Replace “/Area1/DATA::[MyCLX]” with the shortcut
defined for your application. If multiple processors are used,
duplicated the function for each processor and use a logical OR
statement to combine the expression.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 79

Chapter 3 Configure the Graphic Framework

Macros Macros are an important component in the graphic framework. There are
three macros that are provided as a template and their functions are very
similar.
• Template_ClientStartup
• Template_Repaint
• Template_OffScreen

Template_ClientStartup

The Client Startup macro should be linked to the Startup Macro selected in the
client file configuration. There should be one Client Startup macro for every L1
area.

The two “Define” functions shown above are used to setup up the Client
Startup Macro for use with the Hardware and Software Tree Views. For each
client used, the number at the end of these “Define” calls should increment by
one (i.e. if you have five clients in a system, each client would be assigned a
different number: 0, 1, 2, 3, 4, etc). The shortcut defined for each in the second
line above should be a valid shortcut that is used for to initialize on. The
shortcut should include the full area and short name.

80 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

The main purpose of this macro is to open the header and the L1 overview
display. The specific displays will need to be updated for each macro created to
point to the Header and screen for that L1 area.

The macro is also used to define the GoHome command. This command is
used for Home button on the Header. The definition of the GoHome will have
to be updated to point to the specific L1 area repaint macro.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 81

Chapter 3 Configure the Graphic Framework

Client File Setup (.CLI) Setup a basic client file to use with the PlantPAx Graphic Framework.
1. Go to FactoryTalk View SE Client Wizard and select Create a
FactoryTalk View SE Client configuration file.

2. In the wizard, set the following:

On this Page Action
File Name and Name the client file and select the store location. In most cases, the store location should be the OWS desktop.
Location
Select the appropriate application type. Connect to the correct application and select the initial language. Select the HMI server name within your
application. Select the Startup Macro created in Macros. Select Advanced.

Startup Components

Select "Maximize Window" - Note: It is assumed that all the monitors in the system will have a resolution of 1920x1080. The PlantPAx Graphic
Framework is designed to work with this resolution. Unselect “Allow Client to be resized at runtime”. Unselect “Show title bar” and unselect “Show
diagnostic list”. Save and select the “Security and debugging”.

Advanced Settings

82 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 3 Configure the Graphic Framework

On this Page Action

Depending on application requirements, select or unselect the “Enable auto logout”, “Open FactoryTalk View SE Client as view-only”, or “Disable
switch to other applications”. The Debugging feature is only used for troubleshooting. Select “Other Options” tab.

Security and
Debugging

Review the options and modify if required. Leave at default if there are not application specific requirements. Save and close or Select Run to run
the Client file.

Other Options

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 83

Chapter 3 Configure the Graphic Framework

Notes:

84 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4

Organization and Propagation

Organization Organization is a method by which parent / child relationships can be created

and modified among control objects. Organization provides a method to
propagate a selected subset of commands (related to command source, alarms,
etc.) from the parent down to its children or propagate the aggregate of a
selected subset of status (related to command source, alarms, etc.) from the
children up to the parent(s).

Organizational views can be many nodes deep and wide, and numerous
organizational views can reference the same devices to suit the needs of the
user. The structure and view of these organizational trees can be modified
online from the HMI. This provides the ability to coordinate commands of
related equipment and view their related status (equipment modules or phase
modules), or alternatively to monitor specific equipment or equipment types
as a maintenance function.

Functional Description Bus - An interface for use by Bus enabled PlantPAx® objects to convey specific
status and commands through a user defined organizational structure.

Bus Status Elements - The status elements included in the Bus contain specific
elements relative to alarms, Command Source and virtualization if the object
has those elements or capabilities. The status is indicative of the object and
propagated from its children.
Status Produced and Propagated Description
Alarm(s) Active At least one alarm is active for this object or its children
Alarm(s)/Object to be Reset At least one alarm is ready for reset for this object or its children
Ready for Reset At least one object or child is ready for reset
Alarm(s) Enabled At least one alarm is enabled for this object or its children
Alarm(s) Disabled At least one alarm is disabled for this object or its children

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 85

Chapter 4 Organization and Propagation

Status Produced and Propagated Description

Alarm(s) Unsuppressed At least one alarm is not suppressed for this object or its children
Alarm(s) Suppressed At least one alarm is suppressed for this object or its children
Alarm(s) Shelved At least one alarm is shelved for this object or its children
Object Not Ready At least one object or child is not ready
Maint Bypass Active At least one object or child has a Maint Bypass active
Object(s) in Physical At least one object or child is in Physical
Object(s) in Virtual At least one object or child is in Virtual
Ready for Oper Request At least one object or child is ready for an Oper request
Ready for Prog Request At least one object or child is ready for a Prog request
Ready for Ext Request At least one object or child is ready for an Ext request
Ready for Ext Release At least one object or child is ready for an Ext release request
Ready for Maint Request At least one object or child is ready for a Maint request
Ready for Maint Release At least one object or child is ready for a Maint release request
Object(s) in Hand At least one object or child has an active prompt
Object(s) Out of Service (OoS) At least one object or child is Out of Service
Object(s) in Oper or Prog Locked At least one object or child is Oper or Prog Locked
Object(s) has Prog, is not in Prog At least one object or child has Prog but is not in Prog
Prompt is active At least one object or child has an active prompt

Bus command Elements - The command elements included in the Bus contain
specific elements relative to alarms, Command Source and virtualization if the
object has those elements or capabilities. The command will be issued to the
object and propagated to its children.
Commands Issued and Propagated Description
Reset/Ack All Issue a Reset/Ack All to all objects
Reset Issue a Reset to all objects
Disable alarms Disable all alarms
Enable alarms Enable all alarms
Suppress alarms Suppress all alarms
Unsuppress alarms Unsuppress all suppressed alarms
Unshelve alarms Unshelve all shelved alarms
Request Virtual Request all to be in Virtual
Request Physical Request all to be in Physical
Request Oper Request all to be in Oper
Request Prog Request all to be in Prog
Request Ext Request all to be in Ext
Release Ext Release all from Ext
Request Maint Request all to be in Maint
Release Maint Release all from Maint

Node - An element which contains organizational information about a single

point in a user defined organizational structure such as parent/child
relationship and status/command propagation configuration.

Node Propagation Configuration - Each node can be individually configured

to propagate status to its parent and accept propagated commands from its
parent. By default all status is propagated to parents and no commands are
accepted from the parent.

86 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

Required Files
File Description
raP_Opr_OrgScan Function to scan and update all Bus elements and tree nodes
Function to create a file tree view of the nodal organization in
raP_Opr_OrgView FTView
raP_Opr_Owner Function to allow ownership of a Bus element
raP_UDT_Opr_Bus Individual Bus element
raP_UDT_Opr_Bus_Node Individual Node element
raP_UDT_Opr_Bus_View Individual FTView client data

Operations Programming - Controller Logic

1. Create a controller scoped array of type 'Bus'. The number of elements
in the array should be enough to hold all elements in the project that
will participate on the Bus.

2. Assign a unique Bus index to any project element in the controller that
you wish to have participate on the Bus.

Right click to monitor this Bus element and type a name. This is the
string that will appear in the HMI tree view. It also supplies a quick
check as to whether this Bus element has already been assigned to
something.

Assign any non-functional Bus elements to be used as organizational

nodes. Participation on the Bus is not limited to functional objects
(objects which have instruction instances.) These can be used as
'folders' in organizational trees to consolidate other functional and
non-functional Bus elements.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 87

Chapter 4 Organization and Propagation

3. Create a controller scoped array of type 'Node'. The number of elements

in the array should be enough to hold all of the nodes in all of the
organizational trees.

4. Create a controller scoped array of UDT type raP_Opr_OrgView. The

number of array elements should be greater than the number of
FTView clients which will have a view into the organizational tree.

5. Create one instance of the OrgScan AOI in a routine in the one second
'System' task.

6. Create one instance of the OrgView AOI to immediately execute after

the OrgScan AOI. One instance of the OrgView AOI will need to be
created for each HMI client which will have access to the organizational
tree view.

Programming - HMI
1. Select and copy the 'Display Tree View' button from the '(raP-5-SE)
Graphic Symbols - Cross Functional.ggfx' global object file. Paste this
button to the desired display.

2. Add the following lines to the client startup macro:

'Define SW_ShortcutRedefine DefineShowTreeCmd 0'

88 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

'SW_ShortcutRedefine [TOPIC]'

*Where '0' is the index of the OrgView array in the controller for this
client.

*And [TOPIC] is the linx shortcut to the controller.

Configuring a Node Constructing a Nodal Tree

1. Open the organizational tree display by clicking on the Global Object in
the display.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 89

Chapter 4 Organization and Propagation

2. Select Tree Edit mode (by selecting Edit On). This mode causes the HMI
to respond with tree edit displays.

3. Select the Node to edit. Click on the node in the tree to select it for edit.
The edit display will then appear.
4. Acquire the Edit Privilege. Click on the 'Enter Edit Mode' button. This
action causes this client to own the edit privilege. If no edit action is
taken in the time specified by the 'Organization Edit Timeout' then the
client will automatically release the edit privilege. This period can be
shortened or extended by entering a different value into the
'Organization edit timeout' in seconds.

90 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

5. Several options are now available to the user.

Option Description
Add Child Adds a child to the selected node. It will appear indented in the tree.
Delete Node Deletes the selected node. Is available only if the selected node has no children.
Select Bus Allows the assignment of any Bus element to this tree node.
Set Start Node Pressing this will make the currently selected node the top most node in the visible tree.
Reset Start Node Pressing this will reset the top most node to the 'root' of the organizational trees.

6. Add a child. This action adds a child node to the tree with no Bus
element assigned.

7. Close the edit display.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 91

Chapter 4 Organization and Propagation

8. Select the new node to edit.

9. Select 'Select Bus' to select the Bus element for this Node.

92 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

10. Select the Bus element for this Node. This action will assign the Bus
element selected to the node selected and close the Bus selection
display.

11. Repeat this process to create the desired organizational tree(s) from the
available Bus elements.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 93

Chapter 4 Organization and Propagation

Configure the Tree Node at Which to Start this View

1. Open the organizational tree display.

2. Select the tree edit mode (select Edit On).

94 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

3. Expand the tree to view and select the Node to edit.

4. Acquire the edit privilege and select Set Start Node. The tree view will
now have the selected node as its top most node.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 95

Chapter 4 Organization and Propagation

96 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

Configuring Propagation and Navigation

By default, all status items are propagated from child to parent. No commands
are propagated from parent to child. The user can optionally enable or disable
propagation of any status and command at any point in the organizational
trees.
1. Open the organizational tree display.

2. Select the Tree Edit Mode.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 97

Chapter 4 Organization and Propagation

3. Select the Node to edit.

4. On the Engineering tabs, select all commands that should be

propagated from the parent for this node. Selecting a command means
that if a command is given to the parent it will be received and
processed by this node as well.

98 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

5. From the HMI Configuration tab, select all the status’ that should be
propagated to the parent for this node. Selecting a status means that if
a status is asserted by this node or propagated from its children then it
will be pushed to the parent node.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 99

Chapter 4 Organization and Propagation

6. From page three of the HMI Configuration tab, specify what occurs
when the node in the tree is selected in non-edit mode. Specify what
action occurs when a user clicks on that node in the organizational tree.

Action Description
Nowhere No action occurs
Generic Bus Faceplate The Generic Bus Faceplate is displayed
Use when the node represents a device which has a faceplate that requires the
instance backing tag as display parameter.

To configure navigation path for a node go to Bus[x].@EngineeringUnit and

Device Faceplate populate the field with Tag. True for all instructions in the PlantPAx Pallet.

Example
Bus[2].@EngineeringUnit = XV101

100 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

Action Description
Use when the node represents a device which has a faceplate that requires the
instance backing tag and shortcut as display parameters. True for
raP_Opr_EMGen, raP_Opr_EPGen, raP_Dvc_LgxCPU_5x80 and raP_Opr_Unit
instructions.
Device Faceplate with Shortcut To configure navigation path for the node go to Bus[x].@EngineeringUnit and
populate the field with [TOPIC]Tag.

Example
Bus[2].@EngineeringUnit = [ControlStrategies]eTK101
Specify Display Other user specified display
This allows the engineer to disable the organizational tree edit capability for this
Allow tree node edits client.

Configure Nodal HMI

1. Open the organizational tree display and select the node to configure.

2. Select the maintenance tab.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 101

Chapter 4 Organization and Propagation

1. Select the Advanced Properties tab and set the commands that are
available from the Bus Faceplate.

2. Select the HMI configuration tab and select the status items which are
to be shown on the Bus faceplate.

102 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

3. On page three of the HMI Configuration tab, select the configuration of

operator confirmation of commands.

Issue Commands
When configured to be available, specific commands can be issued from any
node in an organizational tree via the Bus faceplate. Commands related to
alarms, command source, and virtualization are supported. The commands
available on the faceplate are determined by the configuration previously
entered.

When commands are issued from this faceplate, those commands are issued
to this object and all children of this object in the organizational tree that are
configured to accept commands from the parent.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 103

Chapter 4 Organization and Propagation

The Home tab shows the 'Program Request' and 'Operator Request' button
available.

On the Maintenance tab, the 'Virtual' and 'Physical' commands are available.

On the Alarm tab the alarm commands to 'Disable All', 'Enable All', 'Unshelve
All' and 'Acknowledge/Reset All' are available.

104 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

Status Indicators

When configured to be available, specific status’ can be viewed from any node
in an organizational tree via the Bus faceplate. Select status’ are represented by
breadcrumbs which appear in the organizational tree next to the nodes that
are affected. Status’ related to alarms, command source, and virtualization are
supported. The status’ available on the faceplate are determined by the
configuration previously entered.

When a condition occurs which produces a status point, those status’ may be
relative to this object or any of its children.
Status Symbol Description

This object or one of its children is not ready. This indication will appear over the 'NIP.'

This object or one of its children is not in Program.

This object or one of its children is alerting the operator (Attention.)

This object or one of its children is in Virtual. This indication will appear over the 'MP.'

This object or one of its children has an active Maintenance Bypass.

Example of the Not Ready symbol next to the Area node.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 105

Chapter 4 Organization and Propagation

Expanding the 'Area' node shows that a child of the 'Group 1' node is 'Not
Ready.'

Expanding the 'Group 1' node shows that 'Group Motor 1' and 'Group Motor 2'
are 'Not Ready.'

106 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 4 Organization and Propagation

The Bus faceplate can indicate detailed status of each status used or
propagated.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 107

Chapter 4 Organization and Propagation

Adding ownership to Add the ownership interface to any objects which will be used with an
raP_Opr_EMGen object to group into equipment in the organizational tree.
devices if using the Placing these modules as children of the raP_Opr_EMGen object will enable
raP_Opr_EMGen the ownership functionality without further programming.

Using the same Bus element as is used for the object tie the Bus parameter
'Bus[x].Own.Out_OwnerCmd' to the object input 'Object.Inp_OwnerCmd.'
Also connect the object output 'Object.Out_OwnerSts' to the Bus parameter
'Bus[x].Own.Inp_OwnerSts.

Note that the Bus element referenced for the ownership parameters is the
same as that of the object.

If the object in question does not have these parameters then it cannot
participate in formal ownership. But can and should still be used in the
equipment organizational tree as a child.

108 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5

n-Position Device (raP_Dvc_nPos)

The raP_Dvc_nPos (n-Position Device) Add-On Instruction controls a circular

or linear discrete device. The device can have between 2 and 30 positions. The
instruction provides outputs to select each individual position, and it provides
outputs to drive the device toward increasing positions (“clockwise” for a
circular device) or toward decreasing positions (“counterclockwise” for a
circular device).

For linear devices, the raP_Dvc_nPos instruction can be configured to return

to Position 1 on every move, approaching the target position from the ‘same
side’ on each move to improve position repeatability, or move directly to the
new position.

For circular devices, the raP_Dvc_nPos instruction can be configured to move

only “clockwise” to increasing positions, or to move in whichever direction
provides the shortest move. For example, with an 8-position device, a move
from position 1 to position 6 could be clockwise only (from position 1 through
positions 2, 3, 4, and 5 to position 6) or via the shortest path (from position 1
through positions 8 and 7 to position 6).

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

The raP_Dvc_nPos instruction also supports devices that have a lock or seal
which must be unsealed before moving the device and resealed after the
motion is complete. The instruction supports devices such as rotary tube
selector valves, which use indexing cylinders to accomplish motion from
position to position, with outputs to cylinders which engage, shift clockwise,
retract, and shift counterclockwise.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 109

Chapter 5 n-Position Device (raP_Dvc_nPos)

The diagram shows the functional characteristics of the raP_Dvc_nPos

Add-On Instruction.

Note: States 2 (Unlocking) and 5 (Locking) are skipped if the

device is configured to not have the lock/seal feature.

Functional Description The n-Position Device instruction provides the following capabilities:
• Controls and monitors a multi-position device (up to 30 positions), such as
rotary valves, and other devices with multiple fixed positions
• Monitors limit switches or other position feedback and displays actual device
position
• Checks for failure to reach the requested position within a configured time.
Provides Alarm on Position Failure
• Monitors Permissive conditions to allow moving to a new position

110 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

• Monitors Interlock conditions to de-energize the device, or to request the

device to return to Position 1. Provides an Interlock Trip Alarm if an interlock
condition causes the device to de-energize or return to Position 1
• Provides outputs to request each position, and provides outputs for increasing
and decreasing position
• Provides outputs to sequence indexing cylinders for devices that use pneumatic
or hydraulic devices to step through positions. The cylinders work in an
Extend, Shift, Retract, Shift sequence to engage the device, and step it to the
next position. The cylinder sequence reverses the Shift directions when driving
circular devices ‘counterclockwise’ (for devices that support bidirectional
operation)
• Optionally provides handling of a position lock or seal that must be driven to
an unlocked or unsealed state before moving the device, and returned to a
locked or sealed state after the move is completed
• Capability for maintenance personnel to take the device out of service.

IMPORTANT This capability is not a substitute for hard lockout/tagout (LOTO) procedures.

• If the optional lock or seal is used, provides position feedback for the lock or
seal to verify the locked or unlocked state at appropriate times. Provides Alarm
for Lock Failure
• Provides a virtual capability, responding as if a working device were present
while keeping outputs de-energized. The virtual capability can be used for
activities such as system testing, operator training, or as part of a full process
virtualization
• Monitors for I/O communication faults and provides an I/O
Fault Alarm
• Provides an ‘Available’ status for use by automation logic so the logic knows
when it has control of the device
• Provides maintenance capabilities, such as the ability to bypass any bypassable
interlocks or permissives or temporarily disable feedback checking

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Dvc_nPos_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 111

Chapter 5 n-Position Device (raP_Dvc_nPos)

Operations This section describes the primary operations for this Add-On Instruction.

Alarms
Alarms are implemented using Logix Tag Based Alarms.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer® online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

Virtualization
Virtualization in raP_Dvc_nPos disables the normal outputs and provides
feedback of a working device. This lets you operate the n_Postion Add-On
Instruction as if it were a working device, even if no device is physically
present.

Use Maintenance Commands or Program Commands to command the device

to Virtual (simulated) or Physical (controlling real device). The Virtual or
Loopback Test icon is displayed at the top left of the Operator faceplate.

You can also set the following parameters in virtual:

• Cfg_VirtualPosTime - time to reach target position in virtual (seconds)
• Cfg_VirtualLockTime - time to lock or unlock in virtual (seconds)
• Cfg_VirtualCylTime - time to simulate index cylinder feedback in virtual
(seconds)

When you have finished in virtual, use PCmd_Physical (from program logic) or
MCmd_Physical (from the HMI faceplate) to return to normal operation.

112 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

Execution

The following table explains the handling of instruction execution conditions.

Condition Description
EnableIn False (false rung) Processing for EnableIn False (false rung) is handled the same as if the device were taken
out of service by Command. The device outputs are de-energized and the device is shown
as Program Out of Service on the HMI. All alarms are cleared.
Powerup (prescan, first scan) On prescan, any commands that are received before first scan are discarded. The device is
de-energized. On first scan, the device is treated as if it were returning from Hand
command source: the instruction state is set based on the position feedback that is
received from the device. If the feedback is valid for one position, the device is set to that
position, and, if the device has the lock/seal capability enabled, the device is locked in that
position. If the device does not have position feedback or the position feedback is invalid,
the device is set to the ‘unknown/powerup’ state.
The command source is set to its default, either Operator or Program (unlocked).
Postscan No SFC Postscan logic is provided.

For more information, see the Logix 5000 Controllers Add-On Instructions
Programming Manual, publication 1756-PM010.

Programming Example This example uses the raP_Dvc_nPos instruction to control a rotating selector
valve with four fixed positions. Each position directs a sample air from one of
four sampling locations to an air quality monitor. The rotating selector valve
directs all non-selected streams to flow to a common outlet to vent. In this
example, the device handles transitions from one position to another. The
instruction does not have to enforce a progression of positions to get to the
desired state.

First, some simple selector logic is used to turn the individual sampler position
requests into a position selection number. The select blocks provide a value of
1, 2, 3, or 4 based on the requests, or 0 if no request is active.

The requested position is fed to the PSet_Pos program setting.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 113

Chapter 5 n-Position Device (raP_Dvc_nPos)

Next, the outputs of the instruction are connected to the selector valve. For this
example, the parameter Cfg_NumPos is set to 4, indicating this is a four-
position device. The parameter Cfg_HasPosFdbk and Cfg_UsePosFdbk are
both set to 1 to indicate that the selector valve provides position feedback, and
must be used. The input parameters for positions 1…4 (Inp_Pos01FdbkData,
Inp_Pos02FdbkData, Inp_Pos03FdbkData, and Inp_Pos04FdbkData) are
connected to the digital inputs representing the status of the selector valve.

Next, the instruction is configured to connect to the outputs of the instruction

to the selector valve. The parameter Cfg_OutPosLatch is set to 1 to latch the
output parameter until a new position is commanded. The output parameters
for positions 1…4 (Out_Pos01Data, Out_Pos02Data, Out_Pos03Data, and
Out_Pos04Data) are connected to the digital outputs that command the
selector valve to the desired position.

Once the I/O have been configured, the instruction can be configured to
recognize commands from the analyzer control sequence. In this example, the
Program setting for target position (PSet_Pos set to 1, 2, 3 or 4) is connected to
the commands from the analyzer control sequence to command the selector
valve to the desired position in the sequence. The Command Source is
configured to default to Program

The valve does not have a locking or sealing device, so Cfg_HasLock is set to 0.

In the controller Alarm Manager, the object's Alm_PosFail alarm has its "Use"
checkbox checked to enable the position fail alarm. The remaining alarms have
their “Use” checkbox unchecked, as these alarms are not used in this
application. The parameter Cfg_PosCheckTime is set to 30 seconds, to allow 30
seconds for the selector valve to achieve commanded position before a position
failure alarm is issued.

114 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

The status output parameters (Sts_Pos01, Sts_Pos02, Sts_Pos03, and

Sts_Pos04) can be connected to external tags to be used by the analyzer control
sequence, if desired.

Lastly, the following tag extended properties must be configured to drive the
text on the operations faceplate. See Logix 5000 Controllers I/O and Tag Data,
publication 1756-PM004 for more information on extended tags.

In this example, the selector valve P&ID tag is ZY1128. In this example, the
strings are set as follows:
Extended Property Value
Name ZY1128
Label (ZY1128.@Label) Air Sample Selector
Description (ZY1128.@Description) Air Quality Analyzer Sample Selector
Library (ZY1128.@Library) raP-5_00-SE
Area (ZY1128.@Area) Area01

The label for the position name is set from the extended properties of the
position. In this example, Position A would be set from the extended
properties of ZY1128.Sts_Pos1. Repeat for each individual position.
Extended Property Value
ZY1128.Sts_Pos1.@Label Position A
ZY1128.Sts_Pos2.@Label Position B
ZY1128.Sts_Pos3.@Label Position C
ZY1128.Sts_Pos4.@Label Position D

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 115

Chapter 5 n-Position Device (raP_Dvc_nPos)

116 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description

GO_PnPos_8SelValve

GO_PnPos_8SelValve1

GO_PnPos_6SelValve

GO_PnPos_6SelValve1 These Graphic Symbols are used for routing

one flow path to many vertically. These
elements show all 3, 4, 6, or 8 ports and unused
GO_PnPos_4SelValve ports are not hidden.

GO_PnPos_4SelValve1

GO_PnPos_3SelValve

GO_PnPos_3SelValve1

GO_PnPOS_8PosRotary

These Graphic Symbols are used for rotary

selection from one port to many ports. Only the
ports that are enabled are displayed. For
GO_PnPOS_6PosRotary example, if you configure the PnPos instruction
with five positions, ports 6, 7, and 8 are not
displayed.

GO_PnPOS_4PosRotary

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 117

Chapter 5 n-Position Device (raP_Dvc_nPos)

Graphic Symbol Name Graphic Symbol Description

GO_PnPOS_SlideGate
These Graphic Symbols show a linear multi-
position device. The symbol is animated to
show the position that is based on the number
of positions configured.
GO_PnPOS_SlideGate1

GO_PnPos
These Graphic Symbols are similar to those
elements shown on the first page of this table,
but ports that aren’t configured are not
displayed.
GO_PnPos1

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Operator

The Faceplate initially opens to the Operator (Home) tab. From here, an
operator can monitor the device status and manually operate the device when
it is in Operator command source.

Item Description
1 Current device position

118 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

Maintenance

Maintenance personnel use the information and controls on the Maintenance

tab to adjust device parameters, troubleshoot, temporarily work around device
problems, and disable the device for routine maintenance.

Advanced Maintenance Tab

The Advanced Properties Display opens to the advanced maintenance settings.

The Advanced Properties Display provides access to device configuration
parameters and ranges, and options for device and I/O setup. This tab is used
for initial system commissioning or later system changes.

Item Description
Enter a value (0…2,147,483) that indicates the maximum time that is allowed for
1 lock feedback before a fault.
1
Enter a value (0…2,147,483) that indicates the maximum time that is allowed for the
2 device to be in position before a fault.
2
Enter a value (0…2,147,483) that indicates the time delay before engaging a cylinder
3 move.
3
Enter a value (0…2,147,483) that indicates the delay time to verify that a device is in
4
4 a commanded position.
Enter a value (0…2,147,483) to indicate the number of retires for a device in Position
5 5 1 before a fault is set.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 119

Chapter 5 n-Position Device (raP_Dvc_nPos)

Item Description
This state is highlighted whenever the device is in the position that it was last
1 commanded.
This state is highlighted if the device feedback fails to confirm that the device is
1 4 2 unlocked, moved to position, or locked as requested within the configured failure
times.
This state is displayed only if the device is configured with a lock or seal that must
be unlocked or unsealed to move. This state is highlighted when the device has
3 reached its commanded position and has been commanded to lock, but locked
2 feedback has not been received yet.
This state is displayed only if the device is configured with a lock or seal that must
4 be unlocked or unsealed to move. This state is highlighted when the device has
been commanded to unlock, but unlocked feedback has not been received yet.
3 5 This state is highlighted when the device is being moved to its commanded
5 position, but that position feedback has not been received yet.

Engineering Tabs

Item Description
1 Select circular or linear for the device type
For Circular, select either clockwise only or clockwise or counterclockwise.
1 2 For Linear, select whether the device returns to Position 1 for every move or moves
directly to the target position.
3 Select to reset a fault on a new Operator command.
2 4 Select to reset a fault on a new External command.
5 Select to bypass permissives and interlocks in Override command source.

3
4

120 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

Item Description
1 Select to enable device feedback for all positions.
1 Select to enable a new position command to be received and processed while a
2 move is in progress.
2
3 Select to keep a position output On until the next move.
3 4 Select to enable indexing cylinders with position feedback.
4 Select if the device must be unlocked to move and locked when the move is
5 complete.
5 6 Select if the device has feedback for locked/unlocked positions.
6

Item Description
Select to enable whether an I/O Fault, Failure to Reach Position, or Lock Failure is
1 considered a shed condition.

1 The device always sheds on an Interlock Trip. This item cannot be unchecked. It is
displayed as a reminder that the Interlock Trip function always triggers a shed.

If a condition causes the device to shed, a reset is required to operate the device.
Select to determine whether the device holds the hold position or goes to position 1
2 upon a shed condition.
2

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 121

Chapter 5 n-Position Device (raP_Dvc_nPos)

Item Description
1 Select yes to enable virtual.
1 2 Enter the time (0…2,147,483) to reach a target position in virtual.
3 Enter the time (0…2,147,483) to lock/unlock with the device in virtual.
4 Enter the time (0…2,147,483) to simulate index cylinder feedback in virtual.
2
5 Select to sound an audible on a commanded stage from Position 1.
3 6 Select to sound an audible on a commanded stage from any State.
Enter the time (in seconds) that the audible sounds when there is a commanded
4 7 State change.

5
6

HMI Configuration Tabs

The HMI configuration tab provides access to displayed text, and faceplate-to-
faceplate navigation settings. View the description, label, tag, and security area
for the device. The HMI configuration tab has settings that are common to the
objects. See page 31 for descriptions of the common settings.

Item Description
Name is displayed for each device position that is based on the number of
1 positions.

122 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 5 n-Position Device (raP_Dvc_nPos)

Item Description
Name is displayed for each device position that is based on the number of
1
positions.

Item Description
1 Name is displayed for each device position that is based on the number of
positions.
Select to indicate that a permissive object is connected to the permissive inputs of
1 this object.
2 IMPORTANT: The name of the Permissives object in the controller must be the
name of the object with the suffix ‘_Perm’. For example, if your raP_Dvc_nPos object
has the name ’nPos123’, then its Permissives object must be named ‘nPos123_Perm’
Select to indicate that an interlock object is connected to the interlock inputs of
this object.
2
3 IMPORTANT: The name of the Interlock object in the controller must be the name of
3 the object with the suffix ‘_Intlk’. For example, if your raP_Dvc_nPos object has the
name ’nPos123’, then its Interlock object must be named ‘nPos123_Intlk’.
4 Select to enable navigation to an object with more information (Cfg_HasMoreObj is
set to true.)

4 You configure the tagname of the object you want to navigate to in the extended tag
property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library and
<backing tag>.@Instruction extended tag properties to display the objects
faceplate.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 123

Chapter 5 n-Position Device (raP_Dvc_nPos)

Item Description
1 Select to allow Operator to shelve alarm.
2 Select to allow Maintenance to disable alarm.
1 Select to configure operator command confirmation. This action would take place
3 after any operator command.
2

Diagnostics Tab
The Diagnostic tab provides indications that are helpful to diagnose or help
prevent device problems. The device problems can include specific reasons a
device is 'Not Ready', device warnings and faults, warning and fault history,
and predictive/preventive maintenance data.

Alarms Tab

The Alarms tab displays each configured alarm. The icon on the tab for the
alarms page changes color to show the current active alarm status. A blinking
alarm icon indicates that one or more alarms must be acknowledged or the
device must be reset.

124 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 6

Mix-proof Valve (raP_Dvc_VlvMP)

Overview The Mix-proof Valve (raP_Dvc_VlvMP) Add-On Instruction controls one mix-
proof valve in a variety of modes and states, and can check position feedback
inputs to verify that the valve reached the commanded position. An alarm can
be provided on failure to reach a target position. The graphic symbols and
faceplate shown below are examples of the graphical interface tools for this
Add-On Instruction.

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

Functional Description The raP_Dvc_VlvMP Add-On Instruction provides the following capabilities:
• Operates a mix-proof valve with the following positions:
- Closed
- Opened
- Lift upper seat (optional)*
- Lift lower seat (optional)*
- CIP/SIP leakage cavity (optional)
- CIP/SIP upper seat (optional)*
- CIP/SIP lower seat (optional)*

The asterisk (*) indicates that the position can pulse the seat being
cleaned or lifted opened and closed to provide enhanced cleaning. (As
the seat is popped open and closed, the flow velocity across the seat is
increased compared to the fully open seat position.) Pulse times are
configurable.
• Operated by using a state model that makes sure that valve seats are sequenced
properly to avoid cross-contamination
• Provides six outputs and six inputs. The outputs in each valve state (including
intermediate states) are configurable for on and off states. The inputs that
verify each valve state are configurable for their required on, required off, and
don't care states. Provides feedback checking to make sure that the valve reaches
each position, including intermediate positions before moving to the next
position. The time for which the feedback inputs must match the configured
pattern to confirm each position is configurable.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 125

Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

• Graphic symbols are provided for mix-proof valves in 2-D layouts and
3-D (isometric) layouts for ease in building valve array and routing manifold
displays
• Capability for maintenance personnel to take the device out of service.

IMPORTANT This capability is not a substitute for hard lockout/tagout (LOTO)

procedures.

• Provides inputs for Permissive conditions to enable moving the valve from the
closed state
• Provides inputs for Interlock conditions to drive the valve to the closed state
• Monitors for I/O communication faults and closes the valve and alarms on a
fault
• Provides an ‘available’ status for Program command source logic so automation
code can know whether the valve can be controlled
• Provides a valve virtual capability. When the mix-proof valve is being
simulated, outputs are left de-energized, and the instruction behaves as if a fully
functioning valve were providing feedback

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Dvc_VlvMP_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Operations This section describes the primary operations for this Add-On Instruction.

IMPORTANT See Appendix B for Command Sources and Virtual types.

Alarms
Alarms are implemented using Logix Tag Based Alarms. P_Alarm and P_Gate
are no longer used.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer® online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

126 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

Virtualization

Virtualization in raP_Dvc_VlvMP disables the normal outputs and provides

feedback of a working device. This lets you operate the n_Postion Add-On
Instruction as if it were a working device, even if no device is physically
present.

Use Maintenance Commands or Program Commands to command the device

to Virtual (simulated) or Physical (controlling real device). The Virtual or
Loopback Test icon is displayed at the top left of the Operator faceplate.

When you have finished in virtual, use PCmd_Physical (from program logic) or
MCmd_Physical (from the HMI faceplate) to return to normal operation.

Execution

The following table explains the handling of instruction execution conditions.

Condition Description
EnableIn False (false rung) Processing for EnableIn False (false rung) is handled the same as if the device were taken out
of service by Command. The device outputs are de-energized and the device is shown as
Program Out of Service on the HMI. All alarms are cleared.
Powerup (prescan, first scan) On prescan, any commands that are received before first scan are discarded. The device is de-
energized. On first scan, the device is treated as if it were returning from Hand command
source: the instruction state is set based on the position feedback that is received from the
device. If the feedback is valid for one position, the device is set to that position. If the device
does not have position feedback or the position feedback is invalid, the device is set to the
‘unknown/powerup’ state.
The command source is set to its default, either Operator or Program (unlocked).
Postscan No SFC Postscan logic is provided.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 127

Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

Programming Example This example uses the raP_Dvc_VlvMP instruction to implement a mix-proof
valve feeding bulk material (safflower oil) from a storage silo into a mixer.

For this example, the mix-proof valve connects to the control system by using
two inputs and three outputs. The manufacturer's data sheet for the valve
shows the following information.

In the closed position (all outputs off), flow is not directed anywhere and the
valve cavity is vented to waste recovery. In the open state, flow is directed from
the upper line to the lower line. In the Lower Lift position, flow is directed from
the lower line through the valve cavity to waste recovery. In the Upper Lift
position, flow is directed from the upper line through the valve cavity to waste
recovery.

128 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

The raP_Dvc_VlvMP instruction for this valve is configured as shown in the

following diagram.

The two limit switches from the field are connected into inputs
Inp_LowerSeatLSData and Inp_UpperSeatLSData. The three outputs to the
field are connected to Out_OpenData, Out_LiftLowerData and
Out_LiftUpperData.

Lastly, the following tag extended properties must be configured to drive the
text on the operations faceplate. See Logix 5000 Controllers I/O and Tag Data,
publication 1756-PM004 for more information on extended tags.

The descriptive strings and supported states are configured.

Extended Property Value
Name Safflower Oil T-47 to Mixer M-5
Label (ZY1128.@Label) Safflower T-47 / M-5
Description (ZY1128.@Description) XV-5047
Library (ZY1128.@Library) raP-5_00-SE
Cfg_HasLiftLower, Cfg_HasLiftUpper 1 (checked)
Cfg_HasSIPCavity, Cfg_HasSIPLower, Cfg_HasSIPUpper 0 (unchecked)

The state configuration can be accessed and modified. For this example, we
have to configure six states. There are three outputs only, so for each state, the
outputs for Close, Cavity In, and Cavity Out can be ignored. We’ll also ignore
feedback states for feedback that is not required. The example uses parameters
for all ignored values set to 0.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 129

Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

The table shows the configuration for each valve state. These configuration
items are Local Tags of the instruction.
State Configuration
0 - De-energized Cfg_OutStateTbl[0] = 2#0000_0000 (all outputs are 0)
Cfg_FdbkReqdTbl[0] = 2#0000_1100 (Lift Lower and Lift Upper are required)
Cfg_FdbkStateTbl[0] = 2#0000_0000 (Lift Lower and Lift Upper feedback state are 0)
1 - Close Cfg_OutStateTbl[1] = 2#0000_0001 (Close output is 1 and all others are 0, Close output
set for display purposes only)
Cfg_FdbkReqdTbl[1] = 2#0000_1100 (Lift Lower and Lift Upper are required)
Cfg_FdbkStateTbl[1] = 2#0000_0000 (Lift Lower and Lift Upper feedback state are 0)
3 - Open Cfg_OutStateTbl[3] = 2#0000_0010 (Open output is 1 and all others are 0)
Cfg_FdbkReqdTbl[3] = 2#0000_1100 (Lift Lower and Lift Upper are required)
Cfg_FdbkStateTbl[3] = 2#0000_1100 (Lift Lower and Lift Upper feedback state are 1)
2 - Close Cavity Out Cfg_OutStateTbl[3] = 2#0000_0010 (Open output is 1 and all others are 0)
Cfg_FdbkReqdTbl[3] = 2#0000_1100 (Lift Lower and Lift Upper are required)
Cfg_FdbkStateTbl[3] = 2#0000_1100 (Lift Lower and Lift Upper feedback state are 1)
4 - Lift Lower Seat Cfg_OutStateTbl[4] = 2#0000_0100 (Lift Lower output is 1 and all others are 0)
Cfg_FdbkReqdTbl[4] = 2#0000_1100 (Lift Lower and Lift Upper are required)
Cfg_FdbkStateTbl[4] = 2#0000_0100 (Lift Lower feedback state is 1 and Lift Upper
feedback state is 0)
5 - Lift Upper Seat Cfg_OutStateTbl[5] = 2#0000_1000 (Lift Upper output is 1 and all others are 0)
Cfg_FdbkReqdTbl[5] = 2#0000_1100 (Lift Lower and Lift Upper are required)
Cfg_FdbkStateTbl[5] = 2#0000_1000 (Lift Lower feedback state is 0 and Lift Upper
feedback state is 1)

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description

This Mix-proof Valve graphic object allows for

GO_PValveMP2D numerous orientations on displays

This 3-D orthogonal Mix-proof Valve graphic

GO_PValveMP_Orth object provides different valve angle positions
on displays.

This 3-D orthogonal Mix-proof Valve graphic

GO_PValveMP_Orth1 object provides different valve angle positions
on displays.

130 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Operator

The Faceplate initially opens to the Operator (Home) tab. From here, an
operator can monitor the device status and manually operate the device when
it is in Operator command source.

Item Description
1 Select to go to the CIP/SIP Valve Lower Seat state.
2 Select to go to the CIP/SIP Valve Upper Seat state.
3 Select to go to the CIP/SIP Valve Cavity state.
4 Select to go to the Lift Valve Lower Seat state.
5 Select to go to the Lift Valve Upper Seat state.
6 Select to open valve.
7 Select to close valve.
1

2 3 4 5 6 7

Maintenance
Maintenance personnel use the information and controls on the Maintenance
tab to adjust device parameters, troubleshoot, temporarily work around device
problems, and disable the device for routine maintenance.

Advanced Maintenance Tab

The Advanced Properties Display opens to the advanced maintenance settings.

The Advanced Properties Display provides access to device configuration

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 131

Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

parameters and ranges, and options for device and I/O setup. This tab is used
for initial system commissioning or later system changes.

Item Description
Enter a value (seconds) that gives the valve time to achieve state before triggering a
1 valve failure fault.
1
2 Enter a value (seconds) that the valve seat is held closed when pulsing for cleaning.
2 3 Enter a value (seconds) that the valve seat is held open when pulsing for cleaning.

Item Description
Select a state box to open the State Configuration display to access configuration
1 parameters for the valve state

2 3 4
Item Description
Enter a value (seconds) the feedback must match for the valve to achieve the selected
1 state.
2 Set State of each Output in the selected valve state.
3 Select to require a feedback signal for the selected valve state.
4 Sets the desired value of the feedback signals for the selected valve state.

132 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

Engineering Tabs

Item Description
1 Select to enable the lift lower seat state for the valve.
1 2 Select to enable pulsing in the lift lower state.
3 Select to enable the lift upper seat state for the valve.
2
4 Select to enable pulsing in the lift upper state.
3 5 Select to enable the clean lower seat state.
4 6 Select to enable pulsing in the clean lower seat state
7 Select to enable the clean upper seat state.
5 8 Select to enable pulsing in the clean upper seat state.
9 Select to enable the clean cavity state.
6

Item Description
1 Select to reset a fault on a new Operator command.
1 2 Select to reset a fault on a new External command.
2 3 Select to bypass permissives and interlocks in Override command source.
Select to close the valve when an I/O Fault occurs. A reset is required to clear this
3 latched shed condition.
4
Clear this checkbox to show only the I/O fault status/alarm and not trip the valve if an
4 I/O fault is detected.
5 Selcet to close the valve when a Position Fail occurs. A reset is required to clear this
latched shed condition.
6 5
Clear this checkbox to show only the Position Fail status/alarm and not trip the valve
7 if a Position Fail is detected
The device always sheds (closes) on an interlock trip. This item cannot be unchecked.
6 It is displayed as a reminder that the interlock trip function always triggers a shed.
7 Select yes to enable virtual.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 133

Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

HMI Configuration Tabs

The HMI configuration tab provides access to displayed text, and faceplate-to-
faceplate navigation settings. Configure the description, label, tag, and
security area for the device. The HMI configuration tab has settings that are
common to the objects. See page 25 for descriptions of the common settings.

Item Description
Select if a Permissive object is used with this valve. This check changes the Permissive
indicator to a clickable button to open the Permissive faceplate.
1 IMPORTANT: The name of the Permissive object in the controller must be the name of
the object with the suffix ‘_Perm’. For example, if your raP_Dvc_VlvMP object has the
name ’ValveMP123’, then its Permissive object must be named ‘ValveMP123_Perm’.
1 Select if an Interlock object is used with this valve. This check changes the Interlock
indicator to a clickable button to open the Interlock faceplate.
2
2 IMPORTANT: The name of the interlock object in the controller must be the name of the
3 object with the suffix ‘_Intlk’. For example, if your raP_Dvc_VlvMP object has the name
’ValveMP123’, then its interlock object must be named ‘ValveMP123_Intlk’.
4
Select if the Valve Stats instruction (for example, P_ValveStats) is used with this device.
This check adds a button to the faceplate that opens the Valve Stats faceplate.
3 IMPORTANT: The name of the Valve Statistics object in the controller must be the name
of the object with the suffix ‘_ValveStats’. For example, if your raP_Dvc_VlvMP object has
the name ’ValveMP123’, then its Interlock object must be named ‘ValveMP123_ValveStats’.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
4 You configure the tagname of the object you want to navigate to in the extended tag
property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library and
<backing tag>.@Instruction extended tag properties to display the objects faceplate.

Item Description
1 Select to allow Operator to shelve alarm.
2 Select to allow Maintenance to disable alarm.
1 Select to configure operator command confirmation. This action would take place
3
2
after any operator command.

134 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

Diagnostics Tab

The Diagnostic tab provides indications that are helpful to diagnose or help
prevent device problems. The device problems can include specific reasons a
device is 'Not Ready', device warnings and faults, warning and fault history,
and predictive/preventive maintenance data.

Alarms Tab
The Alarms tab displays each configured alarm. The icon on the tab for the
alarms page changes color to show the current active alarm status. A blinking
alarm icon indicates that one or more alarms must be acknowledged or the
device must be reset.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 135

Chapter 6 Mix-proof Valve (raP_Dvc_VlvMP)

Notes:

136 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7

Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

The raP_Dvc_D4SD (Discrete 2-, 3-, 4-state Device) Add-On Instruction

controls and monitors feedback from a discrete 2-state, 3-state, or 4-state
device in a variety of modes, monitoring for fault conditions. These devices
include multiple-speed motors or multiple-position valves. The graphic
symbols and faceplate shown below are examples of the graphical interface
tools that are used with this instruction.

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

Functional Description The Discrete 2-, 3-, or 4-state Device Add-On Instruction provides the following
capabilities:
• Provides configuration to have two, three, or four selectable states for the
device.
• Provides Operator and Program commands to select one of the two, three, or
four states of the device.
• Controls four discrete outputs, with configurable states of each output in the
various device states. Each output can be set, cleared, or left in last state in a
given device state.
• Monitors four discrete feedback inputs, with configurable states (including
‘must be on’, ‘must be off ’, and ‘don't care’) for each input in the various device
states for monitoring the actual position of the device.
• Provides configurable text labels for each of the states.
• When feedback inputs are used, detects failure to reach the target state, after a
configurable time, and alarms the failure. Optionally ‘sheds’ to the default state
(state 0) on a feedback failure.
• Monitors Permissive conditions that allow commanding the device to each
state.
• Monitors Interlock conditions that return the device to its default state (state
0).
• Provides virtualization of a normal working device, while holding the outputs
to the real device de-energized, for use in testing or operator training.
• Monitors I/O communication status, providing an alarm on an I/O fault.
Optionally ‘sheds’ to the default state on an I/O fault condition.
Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 137
Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

• Provides an ‘Available’ status when in Program command source and operating

normally for use by automation logic to determine if the logic can manipulate
the device.
• Operates from Hand, Maintenance, Override, External, Program, and
Operator command sources.

Required Files

Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Dvc_D4SD_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Operations This section describes the primary operations for this Add-On Instruction.

IMPORTANT See Appendix B for Command Sources and Virtual types.

Alarms

Alarms are implemented using Logix Tag Based Alarms. P_Alarm and P_Gate
are no longer used.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer® online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

Virtualization

Virtualization in raP_Dvc_D4SD disables the normal outputs and provides

feedback of a working device. This lets you operate the n_Postion Add-On
Instruction as if it were a working device, even if no device is physically
present.

Use Maintenance Commands or Program Commands to command the device

to Virtual (simulated) or Physical (controlling real device). The Virtual or
Loopback Test icon is displayed at the top left of the Operator faceplate.

138 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

You can also set the following parameter in virtual:

• Cfg_VirtualFdbkTime - time to reach target state in virtual (seconds)
When you have finished in virtual, use PCmd_Physical (from program
logic) or MCmd_Physical (from the HMI faceplate) to return to normal
operation.

Execution
The following table explains the handling of instruction execution conditions.

Condition Description
Processing for EnableIn False (false rung) is handled the same as if the device
were taken out of service by Command. The device outputs are de-energized
EnableIn False (false rung) and the device is shown as Program Out of Service on the HMI. All alarms are
cleared.
On Prescan, any commands that are received before First Scan are discarded.
The device is de-energized. On first scan, the device is treated as if it were
returning from Hand command source: the instruction state is set based on
Powerup (prescan, first scan) the position feedback that is received from the device.
The command source is set to its default, either Operator or Program
(unlocked).
Postscan No SFC Postscan logic is provided.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 139

Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Programming Example This example uses the raP_Dvc_D4SD Add-On Instruction to control a cooling
fan that has three fixed speeds (‘low’, ‘medium’, ‘high’) and an ‘off’ state. This is
considered a 4-state device. In this example, three digital outputs are used to
set the speed setting (when all three are off, the fan is commanded off) and
three digital inputs provide feedback of the actual fan state (when all three are
off, the fan is off).

In this example, the four cooling fan states are being mapped to the device as
follows:
• State 0 = Off
• State 1 = Low
• State 2 = Medium
• State 3 = High

Set the Cfg_NumStates parameter to 4 to indicate this is a four-state device.

The input parameters for states 1…3 (Inp_FdbkBData, Inp_FdbkCData, and
Inp_FdbkDData) are connected to the digital inputs, representing the status of
the fan. The output parameters for states 1…3 (Out_BData, Out_CData, and
Out_DData) are connected to the digital outputs that command the fan to the
desired state.

Based on the wiring of the I/O, we can now configure the raP_Dvc_D4SD
instruction how we want to process the outputs to get to the desired state. We
can do this via the following table.

140 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Output A Output B Output C Output D

State 0 1 0 0 0
State 1 0 1 0 0
State 2 0 0 1 0
State 3 0 0 0 1
1 = command output On, 0 = command output Off.

We are setting Output A so it can be used for display purposes even though
Output A is not used by the cooling fan device. The parameters
Cfg_bStXOutWrite determine which outputs get written for each state, and
the parameters Cfg_bStXOutState determine the states that get written.
These parameters are short integers where the bits .0 through .3 correspond to
outputs A through D respectively.

These parameters are displayed in binary format as indicated by the prefix 2#.
By using the previous table, we can set the settings as follows:

Cfg_bSt0OutWrite: 2#0000_1111
Cfg_bSt0OutState: 2#0000_0001
Cfg_bSt1OutWrite: 2#0000_1111
Cfg_bSt1OutState: 2#0000_0010
Cfg_bSt2OutWrite: 2#0000_1111
Cfg_bSt2OutState: 2#0000_0100
Cfg_bSt3OutWrite: 2#0000_1111
Cfg_bSt3OutState: 2#0000_1000
We can now repeat this same effort to configure how the raP_Dvc_D4SD
instruction determines actual state based on the field inputs via the following
table.
State Input A Input B Input C Input D
State 0 x 0 0 0
State 1 x 1 0 0
State 2 x 0 1 0
State 3 x 0 0 1
x = status not checked, 1 = status checked on, 0 = status checked off

The parameter Cfg_bStXFdbkCheck determines which feedback inputs to

check for each state. The parameter Cfg_bStXFdbkState determines how the
state is interpreted from the input values.

By using the previous table, we can set the settings as follows:

Cfg_bSt0FdbkCheck: 2#0000_1110
Cfg_bSt0FcbkState: 2#0000_0000
Cfg_bSt1FdbkCheck: 2#0000_1110
Cfg_bSt1FdbkState: 2#0000_0010
Cfg_bSt2FdbkCheck: 2#0000_1110
Cfg_bSt2FdbkState: 2#0000_0100

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 141

Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Cfg_bSt3FdbkCheck: 2#0000_1110
Cfg_bSt3FdbkState: 2#0000_1000
As this is a cooling fan, if there is a device mismatch or fault, we still want the
logic to command to the desired state. Therefore, Cfg_ShedOnFail and
Cfg_ShedOnDeviceFault are both set to 0.

Lastly, configure the following tag extended properties to drive the text on the
operations faceplate. See Logix 5000 Controllers I/O and Tag Data, publication
1756-PM004 for more information on extended tags.

In this example, the cooling fan P&ID tag is M401. In this example, they are set
as follows:
Extended Property Value
Name M401
Label (ZY1128.@Label) Line 4 Rectifier Fan
Description (ZY1128.@Description) Line 4 Rectifier Cooling Fan
Library (ZY1128.@Library) raP-5_00-SE
Sts_St0.@Label Stopped
Sts_St1.@Label Slow
Sts_St2.@Label Medium
Sts_St3.@Label Fast
M401.@Area Area01

142 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Graphic Symbols A Graphic Symbol (global object) is created once and can be referenced
multiple times on multiple displays in an application. When changes are made
to the original (base) object, the instantiated copies (reference objects) are
automatically updated. Use of graphic symbols, with tag structures in the
ControlLogix system, aid consistency and save engineering time.
Graphic Symbol Name Graphic Symbol Description
Three/Four-Way Valve.
The Three/Four-way Valve parameters define
the inlet and output ports of the valve:
• No. 110 - Top port open state
• No. 111 - Right port open state
• No. 112 - Bottom port open state
GO_PD4SD_4Way • No. 113 - Left port open state

• 0 = Inlet (always shown as open)

• 1 = Open when Val_Sts = 1 (state 0)
• 2 = Open when Val_Sts = 2 (state 1)
• 3 = Open when Val_Sts = 3 (state 2)
• 4 = Open when Val_Sts = 4 (state 3)

GO_PD4SD_3Way_SORt

GO_PD4SD_3Way_SOLt Two-Way Solenoid-operated Diverter Valve in

different positions: right, left, bottom, and top.
Parameters define the inlet and output ports of
the Two-way Solenoid-operated Diverter Valve.
GO_PD4SD_3Way_SOBtm

GO_PD4SD_3Way_SOTop

Two Way Diverter Valve in open top-left and

open top-right positions.
GO_PD4SD_Diverter The Two-way Diverter Valve parameters define
the state of the valve:
• State 0: Open top-left
• State 1: Open top-right
GO_PD4SD_Diverter1
• State 2: —
• State 3: —

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 143

Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Graphic Symbol Name Graphic Symbol Description

GO_PD4SD_3WayMO_Rt

GO_PD4SD_3WayMO_Lt Two-Way Motor-operated Diverter Valve in

different positions: right, left, bottom, and top.
Parameters define the inlet and output ports of
the Two-way Motor-operated Diverter Valve.
GO_PD4SD_3WayMO_Btm

GO_PD4SD_3WayMO_Top

GO_PD4SD_R

Motors in different positions: right, up, and

GO_PD4SD_U down.

GO_PD4SD_D

GO_PD4SD_Blower_R

GO_PD4SD_Blower_L
Blowers in different positions: right, left, up, and
down.
GO_PD4SD_Blower_U

GO_PD4SD_Blower_D

144 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Graphic Symbol Name Graphic Symbol Description

GO_PD4SD_Conveyor_R Conveyor

GO_PD4SD_Inline_U

GO_PD4SD_Inline_L

Inline Motors in different positions: up, left,

down, and right.

GO_PD4SD_Inline_D

GO_PD4SD_Inline_R

GO_PD4SD_Pump_R

GO_PD4SD_Pump_L Pumps in different positions: right, left, and up.

GO_PD4SD_Pump_U

GO_PD4SD_Agitator_D Agitator in down position.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 145

Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Graphic Symbol Name Graphic Symbol Description

GO_PD4SD_Mixer_U Mixer in up position.

GO_PD4SD_RPump_U Rotary Gear Pump in up position.

GO_PD4SD_Fan_D Fan in down position.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Operator Tab

The Faceplate initially opens to the Operator (Home) tab. From here, an
operator can monitor the device status and manually operate the device when
it is in Operator command source.

Item Description
1 1 Device state indicator
2 Move to state command buttons

146 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Maintenance Tab

Maintenance personnel use the information and controls on the Maintenance

tab to adjust device parameters, troubleshoot, temporarily work around device
problems, and disable the device for routine maintenance.

Advanced Maintenance Tab

The Advanced Properties Display opens to the advanced maintenance settings.

The Advanced Properties Display provides access to device configuration
parameters and ranges, and options for device and I/O setup. This tab is used
for initial system commissioning or later system changes.

Item Description
Enter a value (0…2,147,483.647) to indicate the time (seconds) to energize outputs
1 to the device to be sure that they are latched in.
(0 = output held continuously)
Enter a value (0…2,147,483.647) to indicate the time (seconds) to allow the device to
2 reach the commanded state before issuing a fault.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 147

Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Engineering Tabs

Item Description
1 Select the number of states.
1 Select a state to open the raP_Dvc_D4SD State Configuration display for that state.

2
3

4 This display directs how the raP_Dvc_D4SD instruction commands the device state via
outputs and determines the actual device state via feedback inputs. The first two
5 columns for output set parameters, Cfg_bSt[x]OutWrite, and Cfg_bSt[x]OutState,
determine how outputs are written to command to a state. The second two columns for
6 feedback set parameters, Cfg_bSt[x]FdbkCheck, and Cfg_bSt[x]FcbkState, determine
how the state is interpreted from the
input values.
3 Select to reset a fault upon a new operator command.
4 Select to reset a fault upon a new external command.
Select (= 1) to make Operator State 0 (OCmd_St0) available in any command source.
5 Clear this checkbox (= 0) to make Operator State 0 (OCmd_St0) available only in Operator
or Maintenance command source.
Select (= 1) to make External State 0 (XCmd_St0) available in any command source.
6 Clear this checkbox (= 0) to make External State 0 (XCmd_St0) available only in External
command source.

Item Description
1 Select to shed if a Device Fault is detected.
2 Select to shed if an I/O Fault is detected.
1 3 Select to shed if target state is not reached.
The device always sheds an Interlock Trip. This item cannot be unchecked. It is displayed
2 4 as a reminder that the Interlock Trip function always triggers a shed.
3 5 Select to determine whether you hold position or go to state 0 upon a shed condition.
4 Enter a value (seconds) to indicate the delay to echo back reaching the state when in
6 virtual.
5
7 Select yes to enable virtual.

148 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Item Description
1 Select to sound an audible on a commanded stage from State 0.
1
2 Select to sound an audible on a commanded stage from any State.
Enter the time (in seconds) that the audible sounds when there is a commanded State
2 3 change.

HMI Configuration Tabs

The HMI configuration tab provides access to displayed text, and faceplate-to-
faceplate navigation settings. Configure the description, label, tag, and
security area for the device. The HMI configuration tab has settings that are
common to the objects. See page 25 for descriptions of the common settings.

Item Description
1 Enter text to describe the state.
Check if the corresponding State object is used with this device. This check changes
the Permissive Indicator to a button that accesses the Permissive faceplate.
IMPORTANT: The name of the Permissives object in the controller must be the name of
2 the object with the suffix ‘_Perm#’, where ‘#’ is the permissive number (0…3) For
example, if your raP_Dvc_D4SD object has the name ’D4SD123’, then its Permissives
object must be named ‘D4SD123_Perm0’.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 149

Chapter 7 Discrete 2-, 3-, 4-state Device (raP_Dvc_D4SD)

Item Description
Select if an interlock object is connected to Inp_Intlk. This check changes the interlock
1 indicator on the Operator tab to a button that opens the interlocks faceplate.
1 IMPORTANT: The name of the Interlock object in the controller must be the name of the
object with the suffix ‘_Intlk’. For example, if your raP_Dvc_D4SD object has the
name’D4SD123’, then its Interlock object must be named ‘D4SD123_Intlk’.
2
2 Select to allow Operator to shelve alarm.
3 3 Select to allow Maintenance to disable alarm.
Select to configure operator command confirmation. This action would take place after
4 4 any operator command.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set to
true.)
5 You configure the tagname of the object you want to navigate to in the extended tag
property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library and
<backing tag>.@Instruction extended tag properties to display the objects faceplate.

Diagnostics Tab

The Diagnostic tab provides indications that are helpful to diagnose or help
prevent device problems. The device problems can include specific reasons a
device is 'Not Ready', device warnings and faults, warning and fault history,
and predictive/preventive maintenance data.

Alarms Tab
The Alarms tab displays each configured alarm. The icon on the tab for the
alarms page changes color to show the current active alarm status. A blinking
alarm icon indicates that one or more alarms must be acknowledged or the
device must be reset.

150 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 8

Process Area Module (raP_Opr_Area)

The raP_Opr_Area object groups Units together, and provides a propagation

mechanism for aggregating status from Unit objects, and broadcasting
commands to Unit objects.

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

The Area group is based in a controller.

The Area is responsible for managing the equipment that is associated to that
Area. These responsibilities include, but are not limited to, the following:
• Command Source management for a group of equipment.
• Alarm management for a group of equipment.
• Aggregate (propagation) status (for items such as: command source,
alarm, configuration errors, etc.) and provided “bread crumbs” for
navigation.
• Provide broadcast (propagation) command mechanism.
• Detects failure conditions, such as Emergency Stop and Software Stop.
• Provides mechanism for extended Alarms.
• Monitor various Area failure conditions, and produce alarms.
• Provide a propagation mechanism to allow the Area to receive status
from and send commands to a group of equipment.
• Provides the ability to produces a Software Stop condition based on any
of the following:
- Alarm from any lower level object
- Software Stop input
- Area Alarm

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 151

Chapter 8 Process Area Module (raP_Opr_Area)

Functional Description Command Source Management

Allows the user to interact with the system at various levels.

Use the PCMDSRC PlantPAx® instruction to manage the command source

(owner) of an instruction or control strategy. For more information, see Logix
5000 Advanced Process Control and Drives and Equipment Phase and
Sequence Instructions Reference Manual, 1756-RM006

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Opr_Area_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Operations Alarms

Alarms are implemented using Logix Tag Based Alarms.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer® online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

152 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 8 Process Area Module (raP_Opr_Area)

Execution

The handling of instruction execution conditions.

Condition Description
Handle processing for EnableIn False (False Rung) the same as if the
EnableIn False (False Rung) Area were Disabled by Command. The Area outputs are deenergized
and the Area is shown as Disabled on the HMI.
Handles processing of command source and alarms on Pre-scan and
Powerup (Pre-scan, First Scan) Powerup. On Powerup, the Area is treated as if it were Commanded
to reset all the program and operator commands
Postscan (SFC Transition) No SFC Postscan logic is provided.

Refer to Logix 5000 Controllers Add-On Instructions: Programming Manual,

1756-PM010 for more information.

Programming Example

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description
The raP_Opr_Area object groups Units together,
and provides a propagation
GO_PAREA mechanism for aggregating status from Unit
objects, and broadcasting
commands to Unit Objects.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 153

Chapter 8 Process Area Module (raP_Opr_Area)

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Operator Tab

1 Item Description
1 Displays the current state of the object
2 Acquire child command source
3 Release child command source
4 Display organizational tree view for this object
5 Display more information

2 3 4 5

Maintenance Tab

Item Description
1
1 Display Advanced Properties

154 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 8 Process Area Module (raP_Opr_Area)

Engineering Tab

Item Description
1 Select to include software stop from child
1 2 Select to include software stop input
2 3 Select to have the Command source follow the owner
4 Select to stop unit on extended alarms
3
5 Select yes to enable virtual mode
Use the radio buttons for the area owner commands to follow the overall command
6 source of the instruction, or to “keep” particular source (operator, program or
4
external).

HMI Configuration Tab

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Select to enable extended alarms
2 Select to allow Operator to shelve alarm
3 Select to allow Maintenance to disable alarm

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 155

Chapter 8 Process Area Module (raP_Opr_Area)

Item Description
1 Select an option for Operator Command Confirmation Requirements
1 Select to allow navigation to an object with more information.
You configure the tagname of the object you want to navigate to in the extended tag
2 property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library and
<backing tag>.@Instruction extended tag properties to display the objects
faceplate.

156 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 9

Process Unit (raP_Opr_Unit)

Overview The raP_Opr_Unit object groups Equipment together, and provides a

propagation mechanism for aggregating status from Equipment, and
broadcasting commands to Equipment. As an example each vessel, tank,
mixer, machine, etc… within the control system would be considered a Unit.
• Units are presumed to operate on only one batch at a time.
• Units operate relatively independently of one another.
• This term applies to both the physical equipment and the equipment
entity.
• Examples of major processing activities are; react, crystallize, and
make a solution.

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

The UNIT object controls a Unit in a variety of command sources and monitors
for fault conditions.

Use when:
• You want to consolidate status from groups of equipment. These
status’s include:
- Alarm Status
- Alarm Priority
- Command Source
- Configuration Errors
• You want to manage and to following functions for a group of
equipment, with a “master” or “global” set of commands:
- Command Source
- Alarm Acknowledge
- Alarm Reset
• You want to apply permissive conditions to a group of equipment.
• You want to shut down groups of equipment based on a single alarm
which occurs in any related equipment.
• You want to issue user defined commands to equipment.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 157

Chapter 9 Process Unit (raP_Opr_Unit)

Functional Description Command Source Management

Allows the user to interact with the system at various levels.

Use the PCMDSRC PlantPAx® instruction to manage the command source

(owner) of an instruction or control strategy. For more information, see Logix
5000 Advanced Process Control and Drives and Equipment Phase and
Sequence Instructions Reference Manual, 1756-RM006

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File The raP_Opr_Unit_5.00.00_AOI.L5X Add-On Instruction must

be imported into the controller project to be used in the controller
configuration. The service release number (boldfaced) can change as service
revisions are created.

Operations Alarms

Alarms are implemented using Logix Tag Based Alarms.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer® online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

158 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 9 Process Unit (raP_Opr_Unit)

Execution

The handling of instruction execution conditions.

Condition Description
Handle processing for EnableIn False (False Rung) the same as if the
EnableIn False (False Rung) Area were Disabled by Command. The Area outputs are deenergized
and the Area is shown as Disabled on the HMI.
Handles processing of modes and alarms on Pre-scan and Powerup.
Powerup (Pre-scan, First Scan) On Powerup, the Area is treated as if it were Commanded to reset all
the program and operator commands
Postscan (SFC Transition) No SFC Postscan logic is provided.

Refer to Logix 5000 Controllers Add-On Instructions: Programming Manual,

1756-PM010 for more information.

Programming Example

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description

The raP_Opr_Unit object groups Equipment

together, and provides a propagation
GO_PUNIT mechanism for aggregating status from
Equipment, and broadcasting commands to
Equipment.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 159

Chapter 9 Process Unit (raP_Opr_Unit)

Operator Tab

Item Description
1 1 Displays the current state of the object
2 Acquire child command source
3 Release child command source
4 Display tre view for this object

2 3 4

Maintenance Tab

Item Description
1
1 Display Advanced Properties
2 Select yes to enable bypass

160 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 9 Process Unit (raP_Opr_Unit)

Engineering Tab

Item Description
1 Select to include a software stop from child object
2 Select to include software stop input
1 3 Select to include material
4 Select to have the command source follow the owner.
2
5 Enter the material maximum and minimum quantities as well as the units.
3

Item Description
1 Enable User-Defined Group Commands.
1 2 Enable level command for Command 0
2 3 Enable level command for Command 1
4 Enable level command for Command 2
3
5 Enable level command for Command 3
4 6 Enable User-Defined Group States.
5 7 Select to stop unit on extended alarms
8 Select to enable virtual made
6

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 161

Chapter 9 Process Unit (raP_Opr_Unit)

Item Description
Use the radio buttons for the unit commands to follow the overall command source
1 of the instruction, or to “keep” particular source (operator, program or external).
Use the radio buttons for the unit owner commands to follow the overall command
2 source of the instruction, or to “keep” particular source (operator, program or
external).

HMI Configuration Tab

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the number of decimal places for the material
2 Select to enable navigation to the permissive object
3 Select to enable navigation to the interlock object
4 Select to enable extended alarms

162 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 9 Process Unit (raP_Opr_Unit)

Item Description
1 Select to allow Operator to shelve alarm
2 Select to allow Maintenance to disable alarm
1 3 Select an option for Operator Command Confirmation Requirements
2 Select to enable navigation to an object with more information.
You configure the tagname of the object you want to navigate to in the extended tag
3 4 property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library and
<backing tag>.@Instruction extended tag properties to display the objects
faceplate.

The Configuration – HMI Interface Tab has the following purpose:

• Displays configuration of Command Buttons and Target State text
(displayed on Operator Tab) for the Equipment Object.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 163

Chapter 9 Process Unit (raP_Opr_Unit)

Notes:

164 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 10

General Equipment Module (raP_Opr_EMGen)

Overview An equipment module is a functional group of equipment that can carry out a
finite number of specific minor processing activities. An equipment module is
typically centered around a piece of process equipment (a weigh tank, a
process heater, a scrubber, etc.). This term applies to both the physical
equipment and the equipment entity.

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

The raP_Opr_EMGen (Generic Equipment Module) object controls an

Equipment Module in a variety of command sources and monitors for fault
conditions.

Use when:
• You want to group equipment, and you want to apply a custom state
model
• You want to provide the following for a group of equipment
- Apply a mode model to the equipment group
- Definable Commands and states
- Apply interlocks and/or permissives to the group of equipment
- Parameter which define the behavior of the group of equipment
- Report / Resultant data from the group of equipment
- A faceplate which allows monitoring / control of the equipment
grouping
- Alarm if any device fails
- Monitor step (description), and allow forcing of steps in
maintenance command source
- Allow configurable alarms for certain process / equipment failure
conditions

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 165

Chapter 10 General Equipment Module (raP_Opr_EMGen)

Functional Description
Program
Dispatch raP_Opr_EMGen
Contains raP_Opr_EMGen instruction
and any external instructions required.
Command Source Commands

State and Sequence Commands

Parameter Data Entry
Alarm Commands

State & Sequence Status

Command Source & Alarm Status

Parameter & Report Data

Operator
Parameters
Command Source Commands

State and Sequence Commands Report Data

Parameter Data Entry
Alarm Commands

StateModel
Contains your state model (if state
model is implemented external to
raP_Opr_EMGen

STxx_<State> Routines
Contains your logic which sequences
and coordinates devices (implement
states as required)

166 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 10 General Equipment Module (raP_Opr_EMGen)

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Opr_EMGen_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Operations The primary operations of raP_Opr_EMGen (Generic Equipment Module) are

to:
• Provides user defined states, and commands
• Allow monitoring of sequence Step, and display sequence Status.
• Monitor permissive conditions to prevent Equipment Module
operation.
• Monitor interlock conditions to prevent Equipment Module operation
or create failure condition.
• Provide the ability to force steps (maintenance)
• Monitor various Equipment Module failure conditions, and produce
alarms.
• Operate in maintenance, program and operator command source.
• Provide an “available” status for use by automation logic, to indicate the
Equipment Module is available for operation.
• Provide a propagation mechanism to allow the Equipment Module to
publish status to and receive status from a group of equipment.
• Provides Interface to parameter display, data entry and configuration.
• Provides interface to resultant (report) data display and configuration.
• Allows configurable state effect of Alarm and Permissive

Command Source Operations

The raP_Opr_EMGen (Generic Equipment Module) uses the following

standard command source operations implemented using an embedded
PCMDSRC instruction.
Command Description
Source
Operator The operator starts and stops the Equipment Module using the HMI faceplate.
Logic outside the raP_Opr_EMGen starts and stops the Equipment Module using Program
Program Commands (PCmd_Start, PCmd_Stop).
Maintenance personnel have control of the Equipment Module using the HMI faceplate and it is
not available for normal operation by
Maintenance operators or program logic; by-passable interlocks, permissives and device alarms are bypassed,
and fail-to-start and fail-to-stop checking is not performed

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 167

Chapter 10 General Equipment Module (raP_Opr_EMGen)

State Model

The raP_Opr_EMGen (Generic Equipment Module) allows the creation of a

customized state model, for a particular instance.

Depending on your requirements, you may choose to modify the provided

raP_Opr_EMGen with the logic required to implement the desired state model
OR you may choose to implement the logic required for the state model
external to raP_Opr_EMGen.

The raP_Opr_EMGen (Generic Equipment Module) provides up to 32 state

commands (PCmd) and 32 state status’s (Sts), which may be used when
creating a custom state model.

Program Structure

The raP_Opr_EMGen (Generic Equipment Module) may be implemented

using a program as a container (recommended). The following table outlies
suggested program structure and routine naming:
Routine Description
Contains raP_Opr_EMGen instance, external function instances
Dispatch (Interlock, Permissive, Associated Device), and routine calls.
AlarmsSuppress Contains raP_Opr_EMGen alarm suppression logic.
Contains raP_Opr_EMGen interlock mapping from interlock
Interlocks conditions to _Intlk block.
Contains raP_Opr_EMGen parameter mapping to and from
Parameters Parameter blocks (I_Parameter(Enum,Integer,Real,Strin g) to
raP_Opr_EMGen instance.
Contains raP_Opr_EMGen permissive mapping from permissive
Permissives conditions to _Perm block.
Contains raP_Opr_EMGen report mapping to and from Parameter
Reports blocks (I_Parameter(Enum,Integer,Real,Strin g) to raP_Opr_EMGen
instance.
_StateModel Contains raP_Opr_EMGen state module program logic.
Contains raP_Opr_EMGen instances of external alarm instances and
ExtddAlarms trigger logic.
St<xx>_<StateDesc> Contains raP_Opr_EMGen state logic.

IMPORTANT The raP_Opr_EMGen (Generic Equipment Module) may be implemented without the
program structure defined above; this is provided as an example.

Alarms

Alarms are implemented using Logix Tag Based Alarms.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer® online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

168 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 10 General Equipment Module (raP_Opr_EMGen)

Execution

Condition Description
Handle processing for EnableIn False (False Rung) the same as if the Equipment
EnableIn False (False Rung) Module were Disabled by Command. The Equipment Module outputs are de-
energized and the Equipment Module is shown as Disabled on the HMI.
Handles processing of command sources and alarms on Pre-scan and Powerup.
Powerup (Pre-scan, First Scan) On Powerup, the Equipment Module is treated as if it were Commanded to Reset all
the Program and Operator command.
Postscan (SFC Transition) No SFC Postscan logic is provided.

Refer to Logix 5000 Controllers Add-On Instructions: Programming Manual,

1756-PM010 for more information.

ATTENTION: Disabling the raP_Opr_EMGen Add-On instruction causes Equipment

Module outputs to become de-energized.

Programming Example

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description

The raP_Opr_EMGen (Generic Equipment Module)

object controls an Equipment Module in a variety
GO_PEMGEN of command sources and monitors for fault
conditions.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 169

Chapter 10 General Equipment Module (raP_Opr_EMGen)

Operator Tab

2 3 4 5 6

Item Description
1 Command buttons with command text
2 Acquire child command source
3 Release child command source
4 Display tree view for this object
5 Show parameter display
6 Show report display

170 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 10 General Equipment Module (raP_Opr_EMGen)

Maintenance Tab
2 3

Item Description
1 Select yes to enable bypass
2 Display advanced properties
3 Navigation to detail display

Engineering Tab

1 2
Item Description
1 Select to allow Operator command execution with active alarm condition
2 Select to allow Operator command execution with loss of permissive

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 171

Chapter 10 General Equipment Module (raP_Opr_EMGen)

Item Description
1 Show parameter configuration display
2 Show report configuration display
3 Select conditions to stop equipment

2
3

1 2 3 4
Item Description
1 Control of this feature will be determined by the current command source
2 This feature will always be commanded by the Operator
3 This feature will always be commanded by the Program Logic
4 This feature will always be commanded by the External Source

172 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 10 General Equipment Module (raP_Opr_EMGen)

HMI Configuration Tab

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Define the Idle State for Status indication.
2 Define the Running State for Status indication.
3 Define the Complete State for Status indication.
4 Define the number of Parameters.
5 Select to enable parameter command buttons
1
6 Define the number of Reports.
2 7 Select to enable report command buttons
3

Item Description
1 Select to enable navigation to permissive object
1 2 Select to enable navigation to interlock object
2 3 Select to enable extended alarms
4 Select to allow Operator to shelve alarm
3
5 Select to allow Maintenance to disable alarm

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 173

Chapter 10 General Equipment Module (raP_Opr_EMGen)

Item Description
1 Select an option for Operator Command Confirmation Requirements
1 Select to enable navigation to an object with more information.
You configure the tagname of the object you want to navigate to in the extended tag
2 property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library and
<backing tag>.@Instruction extended tag properties to display the objects faceplate.
3 Select to allow navigation to detail display

Define the Command Button and Target Stages on pages four, five and
six.

174 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 11

General Equipment Phase (raP_Opr_EPGen)

Overview An equipment phase is a functional group of equipment that can carry out a
finite number of specific minor processing activities when directed by a
(recipe) phase.

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

The raP_Opr_EPGen (Generic Equipment Phase Module) object controls a

Equipment Phase in a variety of command sources and monitors for fault
conditions.

Use when:
• You want to group equipment, and you want to apply the ISA 88.01
state model using PhaseManager™
• You want to provide the following for a group of equipment
- Apply a mode model to the equipment group
- Apply interlocks and/or permissives to the group of equipment
- Parameters which define the behavior of the group of equipment
- Report / Resultant data from the group of equipment
- A faceplate which allows monitoring / control of the equipment
grouping
- Monitor step (description), and allow forcing of steps in
maintenance command source
- Allow alarms to be defined for certain process / equipment failure
conditions
- Alarming function, including alarms based on device failure.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 175

Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Functional Description
Phase Manager Program

Dispatch raP_Opr_EPGen
Contains raP_Opr_EPGen instruction
and any external instructions required. PHASE
Command Source Commands

State and Sequence Commands

Parameter Data Entry
Alarm Commands

State & Sequence Status

Command Source & Alarm Status

Parameter & Report Data

Operator
Parameters
Command Source Commands

State and Sequence Commands Report Data

Parameter Data Entry
Alarm Commands

PHASECommands
Contains commands from your logic to
raP_Opr_EPGen (as required)
Note: FactoryTalk® Batch issues
commands directly to raP_Opr_EPGen
via Phase Manager - no logic is
requried.

Parameters
Contains logic which maps parameters .REAL [X] .Value
to raP_Opr_EPGen to Phase Manager .Dscptn
.INTGR [X] .Value
tags (Input) .UOM
.Dscptn
.MIN
.STRING .Value .UOM
.MAX
.Dscptn .MIN
.DcmlPlcs
.MAX

Reports
Contains logic which maps report data .REAL [X] .Value
from raP_Opr_EPGen to Phase Manager
.Dscptn
tags (Output) .INTGR [X] .Value
.UOM
.Dscptn
.STRING .Value .DcmlPlcs
.UOM
.Dscptn

Phase State Routines

Contains your logic which sequences
and coordinates devices (implement
states as required)

176 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Opr_EPGen_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Operations The primary operations of the raP_Opr_EPGen (Generic Equipment Phase

Module) are to:
• Provides ISA 88 states, and associated commands
• Provides program structure as a container for coordination and
sequencing logic.
• Provides Parameter display, and data entry (operator command
source).
• Provides resultant (report) data display.
• Allow monitoring of process Step, and display Equipment Phase status.
• Monitor permissives, preventing Equipment Phase operation.
• Monitor interlock conditions to prevent Equipment Phase operation or
create failure condition.
• Provide a stepping mechanism, including the ability to force steps
(maintenance)
• Monitor various Equipment Phase failure conditions, and produce
alarms.
• Operate in maintenance, program and operator command sources.
• Provide an “available” status for use by automation logic, to indicate the
Equipment Phase is available for operation.
• Provide a propagation mechanism to allow the Equipment Phase to
publish status to and receive status from a group of equipment.

Command Source Operations

The raP_Opr_EPGen (Generic Equipment Phase Module) uses the following

standard command sources implemented using an embedded PCMDSRC
instruction.
Command Description
Source
Operator The operator starts and stops the Equipment Module using the HMI faceplate.
Logic outside the EM_GEN starts and stops the Equipment Module using Program Commands
Program (PCmd_Start, PCmd_Stop).
Maintenance personnel have control of the Equipment Module using the HMI faceplate and it is
not available for normal operation by
Maintenance operators or program logic; by-passable interlocks, permissives and device alarms are bypassed,
and fail-to-start and fail-to-stop checking is not performed

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 177

Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Phase Manager

The raP_Opr_EPGen (Generic Equipment Phase Module) is designed to

operate with PhaseManager.

PhaseManager provides the following:

• ISA 88 state model, which can be executed by FTBatch, Studio 5000
Logix Designer®, or program logic.
• Program Structure, which contains phase state routines
• Program scoped tags, which allow individual tags to be configured as
Input (parameters from FTBatch) or Output (resultant data, or report
data, to FTBatch) for a particular PhaseManager phase.
• Phase data structure, which allows interface to the PhaseManager
phase
• An instruction set for issuing commands, and controlling the execution
of the PhaseManager phase.

The raP_Opr_EPGen (Generic Equipment Phase Module) provides an

embedded reference to an associated PhaseManager Phase. The
raP_Opr_EPGen (Generic Equipment Phase Module):
• Provides an HMI interface (faceplate), which allows control and
monitoring of the PhaseManager phase.
• Provides a predefined HMI interface (faceplate), which allows input &
monitoring of parameters (linked to program tags) and monitoring of
resultant/report data (linked to program tags)
• Provides a normalized logic command interface, which utilizes the
PhaseManager instruction set.

Program Structure

The raP_Opr_EPGen (Generic Equipment Phase Module) utilizes the

PhaseManager program structure, as follows:
Routine Description
Contains raP_Opr_EPGen instance, external function instances (Interlock,
Permissive, Associated Device), and Phase State routinecalls.
Phase state routines are a component of a PhaseManager Phase.
• One or all of the available Phase state routines may be implemented.
Dispatch
• The logic within a particular Phase state routine is executed when the Phase is
in the corresponding state.
• Any implemented Phase state routine requies a Phase State Complete
instruction (which the state engine uses to determine the state is complete).
Generally used for shutting down equipment in an emergency situation. If you
have implemented Stopping, you would at a minimum duplicate the stopping logic
Aborting within Aborting. In some cases the sequence in an emergency situation (Aborting)
differs from the orderly shutdown of equipment (Stopping).
Used if equipment or a sub-set of equipment needs to be shut down when the
phase enters the hold state. It may also be advantageous to release owned
Holding equipment if maintaining ownership while held constrains production by
maintaining ownership of shared equipment.
Generally used to perform “clean-up” activities such as release owned equipment,
Resetting etc.
Generally implemented if Holding is implemented. Used to bring equipment from
the state it is in at the end of the Holding state back to the state it was in prior
Restarting Holding. Usually used in conjunction with PSet_HoldIndx and Val_LastRunningStep
to return execution to the proper sequence step.
Running Use to start-up equipment, and aquire ownership of equipment (if required).
Stopping Use if equipment needs to be shut down in a given sequence.

178 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Routine Description
AlarmsSuppress Contains EP_GEN alarm suppression logic.
Contains EP_GEN interlock mapping from interlock conditions to <EP_GEN>_Intlk
Interlocks block.
Contains EP_GEN parameter mapping to and from Parameter blocks
Parameter (I_Parameter(Enum,Integer,Real,String) to EP_GEN instance.
Contains EP_GEN permissive mapping from permissive conditions to
Permissives <EP_GEN>_Perm block.
<EP_GEN>_PhaseCommands Maps commands from EP_GEN to PhaseManager commands
PXRQ Routine container. Use the PRXQ instruction to initiate communication with
<EP_GEN>_PXRQ FTBatch software.
Contains EP_GEN report mapping to and from Parameter blocks
Reports (I_Parameter(Enum,Integer,Real,String) to EP_GEN instance.
ExtddAlarms Contains EP_GEN instances of external alarm instances and trigger logic.

IMPORTANT Routines listed in the table above, are located within the PhaseManager program.
This represents an example for implementing PhaseManager with the
raP_Opr_EPGen (Generic Equipment Phase Module).
PhaseManager may be implemented without the raP_Opr_EPGen (Generic
Equipment Phase Module), in which case the PhaseManager program may be
structured as desired. See the PhaseManager User Manual, Publication LOGIX-
UM001.

Alarms

Alarms are implemented using Logix Tag Based Alarms.

Access to alarms is via

<backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>.

For more information, see the Studio 5000 Logix Designer online help topic:
"Logix Designer > Alarms > Tag-based alarms > Access tag-based alarms in
logic" and related subtopics.

Execution

The following table explains the handling of instruction execution conditions.

Condition Description
Handle processing for EnableIn False (False Rung) the same as if the Equipment
EnableIn False (False Rung) Module were Disabled by Command. The Equipment Module outputs are de-
energized and the Equipment Module is shown as Disabled on the HMI.
Handles processing of command sources and alarms on Pre-scan and Powerup.
Powerup (Pre-scan, First Scan) On Powerup, the Equipment Module is treated as if it were Commanded to Reset all
the Program and Operator command.
Postscan (SFC Transition) No SFC Postscan logic is provided.

Refer to Logix 5000 Controllers Add-On Instructions: Programming Manual,

1756-PM010 for more information.

ATTENTION: Disabling the raP_Opr_EPGen Add-On instruction causes Equipment

Phase outputs to become de-energized.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 179

Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Programming Example

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description

The raP_Opr_EMGen (Generic Equipment

Module) object controls an Equipment Module in
GO_PEPGEN a variety of command sources and monitors for
fault conditions.

Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

180 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Operator Tab

1 2 3 4 5 6 7
Item Description
1 Acquire child command source
2 Release child command source
3 Show parameter display
4 Show report display
5 Stop phase
6 Abort phase
7 Reset phase
8 Hold phase
9 Restart phase
10 Start phase
11 Display Tree View for this object
12 Display an object with more information

8 9 10 11 12

Manual Control

1 2 3 4

Item Description
1 Start phase
2 Stop phase
3 Abort phase
4 Reset phase

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 181

Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Maintenance Tab

2 3

Item Description
1 Select Yes to enable bypass
2 Display Advanced Properties
3 Navigate to detail display

Engineering Tab

Item Description
1 Select to wait for report data collected before alarming.
1 2 Select to allow a pause phase
2 3 Select to mask hold state from phase
4 Select to issue hold upon alarm
3
5 Select to issue hold upon interlock trip
4 6 Select to issue hold upon software stop
5 7 Select to use default step numbers
8 Select to have the command source follow the owner
6
9 Show parameter configuration display
7 10 Show report configuration display
8

10

182 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Item Description
1 Select conditions to stop phase
1

1 2 3 4
Item Description
1 Control of this feature will be determined by the current command source
2 This feature will always be commanded by the Operator
3 This feature will always be commanded by the Program Logic
4 This feature will always be commanded by the External Source

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 183

Chapter 11 General Equipment Phase (raP_Opr_EPGen)

HMI Configuration Tab

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Define the number of Parameters.
2 Select to enable parameter command buttons
3 Define the number of Reports.
4 Select to enable report command buttons

2
3

Item Description
1 Select to enable navigation to permissive object
1 2 Select to enable navigation to interlock object
2 3 Select to enable extended alarms
4 Select to enable external sequencer
3
5 Select to allow Operator to shelve alarm
4
6 Select to allow Maintenance to disable alarm

5
6

184 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Item Description
1 Select an option for Operator Command Confirmation Requirements
1 Select to enable navigation to an object with more information.
You configure the tagname of the object you want to navigate to in the extended
2 tag property "Cfg_HasMoreObj.@Navigation". It uses the <backing tag>.@Library
and <backing tag>.@Instruction extended tag properties to display the objects
faceplate.
3 Select to allow navigation to detail display

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 185

Chapter 11 General Equipment Phase (raP_Opr_EPGen)

Notes:

186 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 12

Parameter and Reports (raP_Tec_ParRpt)

Overview The raP_Tec_ParRpt Add-On Instruction is used to implement parameter data

items. The raP_Tec_ParRpt instruction may be used as follows:
• For a read only parameter
• For a read/write parameter
• For a parameter of type Integer, Real, String or Enumeration
• Equipment Module (raP_Opr_EMGen) and Equipment Phase
(raP_Opr_EPGen) are designed to work with the raP_Tec_ParRpt
instruction

Knowledgebase Technote, PlantPAx System Release 5.0 Configuration and

Implementation Tools, contains the object and visualization parameters.
Download the spreadsheet from this public article.

You may be asked to log in to your Rockwell Automation web account or

create an account if you do not have one. You do not need a support
contract to access the article.

Use when:
• You need the ability to view or modify a parameter from either the HMI
or from logic
• You need to arbitrate parameter input based on mode
• You need the ability to limit the value of a parameter, from either the
HMI or logic
• You need the ability to capture an initial parameter value (based on a
trigger), and provide an indication if the parameter was adjusted from
the initial value
• You need to limit the adjustment of a parameter within a deadband
relative to an initial value
• You need to apply command confirmation (i.e. Electronic Signature) to
parameter entry from the HMI.
• Your parameter is read only or read/write
• Your need a Parameter (recipe) or Report (resultant) parameter
• Your parameter is of data type: Integer, Real, String, or is an
Enumeration

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 187

Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Functional Description
Inp_Capture
OR S
NR
f (t)
End of
Inp_Clear
scan R

Val_Initial(E,I,R,S)
Cfg_Default(E,I,R,S)

PSet(E,I,R,S)
$ Sts_Adjstd

AND
Wrk_Buffer

OR

 f (t) R
Inp_Restore

Once Wrk_PrevOSet
NR
and OSet are updated
S
Rdy_Adjust Val_Max(E,I,R)

Wrk_PrevOSet AND Cfg_Max(I,R)

Cfg_MaxAdjst(R)

OSet(E,I,R,S)

6
Cfg_LimAdjst(R)
Val_Max(E,I,R)

+
Wrk_Buffer A!B '
OR Sts_LimFault -
Cfg_MinAdjst(R)
AB

Val_Min(E,I,R) NOT Cfg_Min(R)

Val_Min(E,I,R)
Inp_Oper

AND
Rdy_Adjust Logic does not apply to String or
Cfg_RestrictOper OR AND Enumeration

NOT
Logic does not apply to String
Cfg_ReadWrite

188 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Required Files Add-On Instructions are reusable code objects that contain encapsulated logic
that can streamline implementing your system. This lets you create your own
instruction set for programming logic as a supplement to the instruction set
provided natively in the ControlLogix® firmware. An Add-On Instruction is
defined once in each controller project, and can be instantiated multiple times
in your application code as needed.

Controller File

The raP_Tec_ParRpt_5.00.00_AOI.L5X Add-On Instruction must be imported

into the controller project to be used in the controller configuration. The
service release number (boldfaced) can change as service revisions are created.

Operations The primary operations of the raP_Tec_ParRpt (Parameter Instruction) are:

• Captures the initial value of the parameter (snap shot) when the
Trigger goes TRUE. Maintains the initial value until the Clear input
goes TRUE.
• Permits or denies Operator adjustment of the parameter value. When
permitted, allows the adjustment of the parameter value within a
deadband of the initial parameter value based on configured limits.
• Compares the initial parameter value to the present parameter value
and produces an “Adjusted” status.
• Allows initial parameter values to be restored, when the Reset to Initial
input goes TRUE.
• Limits the value of the parameter based on configured Minimum and
Maximum limits, and produces a status when the parameter value is
beyond limits.
• Allows parameter to be configured as Read, or Read/Write
• Allows a default parameter value to be configured, restores defaults
when Clear input goes TRUE.
• Allows the configuration of a text description, and units of measure
(engineering units) for the parameter.
• When configured to allow Operator entry and Read/Write, and
“Operator” mode input is true; produces “Ready to Adjust” status, and
allows the parameter value to be entered from the HMI.
• Allows command confirmation to be applied to parameter entry from
the HMI: No Signature, Performer Signature only, or Performer and
Approvers Signatures.

Modes of Operation
The raP_Tec_ParRpt instruction does not have modes. However, the
raP_Tec_ParRpt provides an input to monitor for Operator mode, and uses
this to arbitrate request to modify the parameter value.

Alarms

The raP_Tec_ParRpt instruction does not generate any alarms.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 189

Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Execution

The following table explains the handling of instruction execution conditions.

Condition Description
Handle processing for EnableIn False (False Rung) the same as if the Equipment
EnableIn False (False Rung) Module were Disabled by Command. The Equipment Module outputs are de-
energized and the Equipment Module is shown as Disabled on the HMI.
Handles processing of modes and alarms on Pre-scan and Powerup. On Powerup,
Powerup (Pre-scan, First Scan) the Equipment Module is treated as if it were Commanded to Reset all the Program
and Operator command.
Postscan (SFC Transition) No SFC Postscan logic is provided.

Refer to Logix 5000 Controllers Add-On Instructions: Programming Manual,

1756-PM010 for more information.

ATTENTION: Disabling the raP_Tec_ParRpt Add-On instruction causes Equipment

Phase outputs to become de-energized.

Programming Example Parameter Program Example

190 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Reports Program Example

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 191

Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Faceplates Parameter Display

1 2 3 4

Item Description
1 Parameter descriptions
2 Value of Parameter
3 Snapshot value
4 Default value of Parameter

192 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Report Display
1 2 3 4

Item Description
1 Report descriptions
2 Value of Report
3 Snapshot value
4 Default value of Report

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 193

Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Parameter Configuration
1 2 3 4 5 6 7 8 9 10 11 12 13

Item Description
1 Parameter Description
2 Default value of Parameter
3 Allow limit adjust
4 Integer minimum adjust value of parameter.
5 Integer maximum adjust value of parameter.
6 Minimum value of Parameter
7 Maximum value of Parameter
8 Enter the decimal places to display.
9 Engineering Unit of Parameter.
10 Parameter value can be modified by the operator when enabled.
11 Parameter value can be modified when in Program Command.
12 Enable Confirmation / E-Signature of Parameter.
13 Assign User Roles Security Level of Parameter.

194 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Report Configuration
1 2 3 4 5 6 7 8 9 10 11 12 13

Item Description
1 Report Description
2 Default value of Report
3 Allow limit adjust
4 Integer minimum adjust value of parameter.
5 Integer maximum adjust value of parameter.
6 Minimum value of Report
7 Maximum value of Report
8 Enter the decimal places to display.
9 Engineering Unit of Report.
10 Report value can be modified by the operator when enabled.
11 Report value can be modified when in Program Command.
12 Enable Confirmation / E-Signature of Report.
13 Assign User Roles Security Level of Report.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 195

Chapter 12 Parameter and Reports (raP_Tec_ParRpt)

Notes:

196 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13

Graphic Symbols and Faceplates for PlantPAx

Instructions

In PlantPAx® 5.0, Rockwell Automation offers device control strategies

embedded into the process controller. These PlantPAx strategies use Graphic
Symbols and Faceplates for the HMI interface. The instructions in this chapter
are only available on the process controller.

A Graphic Symbol is a global object that is created once and can be referenced
multiple times on multiple displays in an application. When changes are made
to the original (base) object, the instantiated copies (reference objects) are
automatically updated. Use of global objects, with tag structures in the
ControlLogix® system, aid consistency and save engineering time.

All of the objects with "_L1" are for Level 1 or Level 2 displays. These objects do
not launch faceplates.

Process Analog Input (PAI)

Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PAI Standard analog-input graphic symbol

Analog input with a trend of the Process

GO_PAI_Trend Variable and limits (highhigh, high, low, and low-
low).

Process Variable indicated by a moving triangle.

GO_PAI_Indicator The graphic display includes limits that are
displayed with filled bars.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 197

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

This object is the same as GO_PAI_Indicator plus

GO_PAI_IndicatorWCapture
a light gray minimum/maximum capture area.

Analog Input with Trend of Process Variable and

GO_PAI_TrendWCapture limits (high-high, high, low, and low-low) plus a
light gray capture area.

This graphic symbol includes a trend with target

GO_PAI_Adv_Trend lines and is intended to be used for the
Advanced Analog Input Add-On Instruction.

A moving triangle indicates the process

variable. The graphic display includes limits
GO_PAI_AdvIndicator that are displayed with filled bars plus a cyan
target range (for deviations).

A moving triangle indicates the process

variable. The graphic display includes limits
GO_PAI_AdvIndicatorWCapture that are displayed with filled bars plus a cyan
target range (for deviations) and a light gray
minimum/maximum capture area.

Displays the process variable value with alarm

GO_PAI_L1_ indication.

198 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

GO_PAI_L1_PV Displays the process variable value.

GO_PAI_L1_PV1 Displays the process variable value.

Label only. This does not include the process

GO_PAI_L1_Label variable value.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_Indicator displayed with filled bar. Includes alarm
indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_HIndicator displayed with filled bar. Includes alarm
indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_IndicatorS displayed with filled bar. Includes alarm
indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_HIndicatorS displayed with filled bar. Includes alarm
indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_BarWAlm displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip. Includes alarm indication.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 199

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

Process variable indicated by a moving triangle.
The graphic display includes limits that are
GO_PAI_L1_HBarWAlm displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip. Includes alarm indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_BarWAlmS displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip. Includes alarm indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_HBarWAlmS displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip. Includes alarm indication.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_Bar displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_BarS displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip.

Process variable indicated by a moving triangle.

The graphic display includes limits that are
GO_PAI_L1_HBar displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip.
Process variable indicated by a moving triangle.
The graphic display includes limits that are
GO_PAI_L1_HBarS displayed with filled bar. The process variable
value or EU are not displayed, but can be found
in the tooltip.

200 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

Trend of process variable that includes limits

GO_PAI_Trend1 (high-high, high, low, and low-low) plus a light
gray capture area. Includes alarm indication.

Trend of historical process variable values.

GO_PAI_HistTrend Analog limits are not included.

Trend of historical process variable values.

GO_PAI_HistTrend1 Analog limits are not included.

Process Analog Input (PAI) There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Faceplates

Operator Tab

Item Description
Current Process Variable that is shown as an arrow on the graph and
1 numerically.
2 Clear capture minimum / maximum extents

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 201

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Maintenance Tabs

2 3 4
Item Description
1 Use Substitute PV: Select to input a substitute process variable.
2 Select to display smart device object.
3 Enter the threshold (trip point) for analog input alarms.
Enter the deadband (hysteresis) that applies to each alarm limit. Deadband
helps prevent a noisy signal from generating numerous spurious alarms.
4 Example: If the High alarm limit is 90.0 and the High alarm deadband is 5, once
the signal rises above 90.0 and generates a High alarm. The signal must fall
below 85.0 (90.0 minus 5.0) for the alarm to clear.

2 3
Item Description
1 Out of Range (Fail) low and high threshold values.
2 Process variable deviation low and high threshold values.
Deadband associated with each threshold. Enter the deadband (hysteresis) that
3 is applied to each limit.

3
Item Description
Process variable high rate of change threshold value. There is an alarm
1 associated with this configuration. The deadband can be configured in the
advanced maintenance settings.
Process variable clamping low and high threshold values. Any process variable
1 2 below the low value or above the high value will be held at the low or high value
respectively.
Deadband associated with each threshold. Enter the deadband (hysteresis) that
3
2 is applied to each limit.

202 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

2 3
Item Description
Process variable control condition high high, high, low, and low low threshold
1 values.
2 Process variable deviation low and high threshold values.
Deadband associated with each threshold. Enter the deadband (hysteresis) that
3 is applied to each limit.
1

Advanced Maintenance

Item Description
Enter the amount of time the input must stay within the range thresholds (with deadband)
1 1 to clear the Out of Range (fail) condition. The off-delay time is used to help prevent a
chattering fail detection on a noisy signal near a range threshold.
2 Enter the amount of time the input must stay beyond a range threshold to cause an Out of
2 Range (fail) condition. The on-delay time is used to avoid an unnecessary fail detection
3 when the input only momentarily exceeds the threshold.
Enter the amount of time the input must remain unchanged to trigger a stuck input
3 condition. A value of zero means the input must change every instruction scan to avoid a
stuck input condition. Enter a large value to disable stuck input detection.
Process variable clamping configuration. This includes the clamping low and high
4 threshold values and the clamping deadband.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 203

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Process variable high high, high, low, and low low threshold gate delay (seconds).
2 Process variable high and low deviation threshold gate delay (seconds).
3 Process variable high rate of change threshold gate delay (seconds).
4 Process variable out of range threshold gate delay (seconds).
1

3
4

Engineering Tabs

Item Description
Input (unscaled) minimum and maximum
These parameters must be set to the range of the signal that is connected to the
Inp_Process Variable Input. The raw minimum default is 0.0 and the raw maximum
1 default is 100.0.
1 6 Example: If your input card provides a signal from 4.0…20.0mA, set Cfg_InpRawMin to
4.0 and Cfg_InpRawMax to 20.0. The raw minimum/maximum and engineering units
2 7 minimum/maximum are used for scaling to engineering units.
2 Enter the Raw Input units to display on the HMI.
3
PV scaling type selection. Square root can be configured for differential pressure
3 applications.
Select to allow the Substitute Process Variable Maintenance function.
4 Clear this checkbox to disallow the Substitute Process Variable Maintenance function
(default).
4 5 Select to enable target entry, deviation calculations, display, and alarms.
5 EU minimum and maximum for scaling
These parameters must be set to match the Process Variable range of the input signal
that is connected to Inp_PV. The Process Variable engineering units minimum default
is 0.0 and the Process Variable engineering units maximum is 100.0.
6 Example: If your input card provides a signal from 4…20 mA that represents -
50…+250 °C, set Cfg_PVEUMIN to -50.0 and Cfg_PVEU maximum to 250.0.
The raw minimum/maximum and Process Variable engineering units minimum/
maximum are used for scaling to engineering units.
7 Enter engineering units for display on the HMI. Percent (%) is the default.

204 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Process variable substitution is allowed or not allowed. The substitute PV allows for an
1
1 entry of the PV from the HMI, which overrides the read PV.
2 Select to enable process variable target calculations, display, and alarms.
2 3 Select to enable Rate of Change target calculations, display, and alarms.
3 4 Process variable rate of change configuration.
Configure if the virtual and substitute process variables will track the active process
5
4 variable.

Item Description
1 Configure if object will fail on uncertain signal quality.
Enter the Process Variable filter time constant.
1 2 If the time constant is 0, the Process Variable is unfiltered.
3 Filter configuration: no filter, 1st order, 2nd order.
2 Process variable replacement value for when the action is "Replace". There are multiple
4 action configurations. For example, if the Channel Fault action is configured to
3 “Replace”, this replace value will be used in the event of a channel fault.
5 Enable or disable virtual mode.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 205

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

1
2
3
4
5
6
7
8
9

Item Description Item Description

Action: Action:
When the P_AInChan configuration is not valid: When the input is out of range:
Use the input to determine value Use the input to determine value
Hold value at its last good value Hold value at its last good value
Set value by using Cfg_PVReplaceVal Set value by using Cfg_PVReplaceVal
1 5
Quality: Quality:
When the P_ configuration is not valid: When the input is out of range:
Set Sts_PVGood Set Sts_PVGood
Set Sts_PVUncertain Set Sts_PVUncertain
Set Sts_PVBad Set Sts_PVBad
Action: Action:
When there is a channel fault: Use the input to determine value
Use the input to determine value Hold value at its last good value
Hold value at its last good value Set value by using Cfg_PVReplaceVal
Set value by using Cfg_PVReplaceVal
2 6 Quality:
Quality: When the input is out of spec:
When there is a channel fault: Set Sts_PVGood
Set Sts_PVGood Set Sts_PVUncertain
Set Sts_PVUncertain Set Sts_PVBad
Set Sts_PVBad
Action: Action:
When there is a module fault: When Inp_FuncCheck is set:
Use the input to determine value Use the input to determine value
Hold value at its last good value Hold value at its last good value
Set value by using Cfg_PVReplaceVal Set value by using Cfg_PVReplaceVal
3 7
Quality: Quality:
When there is a module fault: When Inp_FuncCheck is set:
Set Sts_PVGood Set Sts_PVGood
Set Sts_PVUncertain Set Sts_PVUncertain
Set Sts_PVBad Set Sts_PVBad
Action:
Action: When the input is stuck
When the input is not a number: (no change):
Use the input to determine value Use the input to determine value
Hold value at its last good value Hold value at its last good value
Set value by using Cfg_PVReplaceVal Set value by using Cfg_PVReplaceVal
4 8
Quality: Quality:
When the input is not a number: When the input is stuck
Set Sts_PVGood (no change):
Set Sts_PVUncertain Set Sts_PVGood
Set Sts_PVBad Set Sts_PVUncertain
Set Sts_PVBad

206 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description Item Description

Action:
When Inp_MaintReqd is set:
Use the input to determine value
Hold value at its last good value
Set value by using Cfg_PVReplaceVal
9 N/A N/A
Quality:
When Inp_MaintReqd is set:
Set Sts_PVGood
Set Sts_PVUncertain
Set Sts_PVBad

HMI Configuration

The HMI configuration tab has settings that are common to the
objects. See page 31 for descriptions of the common settings.

Item Description
1 Set the number of decimal places for the Process Variable.
2 Select to allow navigation to SMART device object.
1
3 Select to allow Operator to shelve alarm.
2 4 Select to allow Maintenance to disable alarm.

3
4

Item Description
Select to configure operator command confirmation. This action would take place
1 after an operator resets the captured minimum and maximum values.
1
2 Select to configure if a Historical data source will be used or not.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
3 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 207

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Smart Device Properties

Item Description
1 Show Process Variable for the HART PV.
2 Show Process Variable for the HART SV
1 3
3 Show Process Variable for the HART TV.
2 4 4 Show Process Variable for the HART QV.

Smart Device Maintenance

Item Description
1 Display the description for the device.
2 Display the tag name for the device.
1
3 Display digital HART value for loop current in milliamps.
2

208 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Smart Device Engineering

Item Description
Select to display the digital variables’ (PV, SV, TV, FV) status as received via HART. Clear
1 1 this checkbox to disable automatic updating of HART device information.
2 Select to use HART communication status to generate SrcQ, 0 - assume good.
2 Display analog input unscaled signal maximum, minimum, and units from HART module
3 (in module units).
Display analog input scaled signal maximum, minimum, and units from HART module
4 (in module units).
3 4

Smart Device HMI Configuration

The HMI configuration tab has settings that are common to the
objects. See page 31 for descriptions of the common settings.
Item Description
1 1 Select to display text received from HART device, 0 = use extended properties for text.
2 Display the text to display the units of measure for variable HART PV, SV, TV, and QV.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
3
2 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 209

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Smart Device Diagnostics

The Diagnostic tab provides indications that are helpful to diagnose or help
prevent device problems. These problems can include specific reasons a device
is 'Not Ready', device warnings and faults, warning and fault history, and
predictive/preventive maintenance data.

The Diagnostics tab displays possible reasons for the device not being ready.

Process Dual Sensor Analog

Input (PAID) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols
GO_PAID Standard analog-input graphic symbol

Process Variable indicated by a moving triangle.

GO_PAID_Indicator The graphic display includes limits that are
displayed with filled bars.

Analog input with a trend of the Process

GO_PAID_Trend Variable and limits (highhigh, high, low, and low-
low).

210 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Dual Sensor Analog There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Input (PAID) Faceplates

Operator

Item Description
1 Select Sensor A Input Process Variable.
2 Select the average of Sensor A and Sensor B input Process Variables.
4
3 Select Sensor B Input Process Variable.
4 Select the maximum of Sensor A and Sensor B Input Process Variable.
5 Select the minimum of Sensor A and Sensor B Input Process Variable.
5

1 2 3

Maintenance

1
Item Description
Process variable high/low signal difference threshold. Enter the threshold (trip
1 point) for analog input alarms.
Process variable deadband. Enter the deadband (hysteresis) that is applied to the
alarm limit. Deadband helps prevent a noisy signal from generating numerous
2 spurious alarms.
2 Example: If the High alarm limit is 90.0 and the High alarm deadband is 5, once
the signal rises above 90.0 and generates a High alarm. The signal must fall below
85.0 (90.0 minus 5.0) for the alarm to clear.
3
Process variable fail deadband. Enter the deadband (hysteresis) that is applied to
4 each alarm limit. Deadband helps prevent a noisy signal from generating
numerous spurious alarms.
3 Example: If the High alarm limit is 90.0 and the High alarm deadband is 5, once
the signal rises above 90.0 and generates a High alarm. The signal must fall below
85.0 (90.0 minus 5.0) for the alarm to clear.
4 Process variable fail threshold in raw units.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 211

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance

Item Description
Configure the signal difference gate delay (seconds), which is the time after the gate
1 input activates before the threshold detection is enabled
1

Engineering

Item Description
1 Minimum and maximum scale for the process variable on the trend.
1 PV Source and Quality Input A
Generate SrcQ: This instruction determines the Process Variable quality using
Inp_PVBad, Inp_PVUncertain, and the PV value (out of range, infinite or not a number)
2
2 Pass thru connected Channel’s SrcQ value: This instruction uses the Source and
Quality (SrcQ) value that is provided by an upstream object (such as P_AIChan) via
Inp_PVSrcQ to determine the PV source and quality.
PV Source and Quality Input B
3 Generate SrcQ: This instruction determines the Process Variable quality using
Inp_PVBad, Inp_PVUncertain, and the PV value (out of range, infinite or not a number)
3
Pass thru connected Channel’s SrcQ value: This instruction uses the Source and
Quality (SrcQ) value that is provided by an upstream object (such as P_AIChan) via
Inp_PVSrcQ to determine the PV source and quality.
4
Allows any combination of the operator, program, or external sources to select the
4 active process variable.

212 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
Enter the name for Input Tag A to show on the faceplate and Tooltip.
1 IMPORTANT: Hover the pointing device over the field to display a tool tip with the
configured Logix tag/path.
Enter the name for Input Tag B to show on the faceplate and Tooltip.
2 IMPORTANT: Hover the pointing device over the field to display a tool tip with the
configured Logix tag/path.
3 Set the number of decimal places for the Process Variable.
1
4 Select to allow Operator to shelve alarm.
2
5 Select to allow Maintenance to disable alarm.
3

4
5

Item Description
Select to configure operator command confirmation. This action would take place after
1
1 any operator command.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
2 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.
Select to enable navigation to an upstream analog input object.
3 The tagname to navigate to is shown in the box under the checkbox label.
2 Select to enable navigation to an upstream analog input object.
4 The tagname to navigate to is shown in the box under the checkbox label.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 213

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Multi Sensor

Analog Input (PAIM) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols
GO_PAIM Standard analog-input graphic symbol.

The object displays four inputs (A-D), with each

input a moving line on a horizontal axis. The
GO_PAIM_4V graphic display includes indicators for disabled
and rejected inputs.

The object displays six inputs (A-F), with each

input a moving line on a horizontal axis. The
GO_PAIM_6V graphic display includes indicators for disabled
and rejected inputs.

The object displays eight inputs (A-H), with each

input a moving line on a horizontal axis. The
GO_PAIM_8V graphic display includes indicators for disabled
and rejected inputs.

214 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

The object displays eight inputs (A-H), with

each input a moving line on a vertical axis. The
GO_PAIM_8H graphic display includes indicators for disabled
and rejected inputs.

Process Variable indicated by a moving triangle.

GO_PAIM_Indicator The graphic display includes limits that are
displayed with filled bars.

Analog input with a trend of the Process

GO_PAIM_Trend Variable and limits (highhigh, high, low, and low-
low).

Process Multi Sensor There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Analog Input (PAIM)
Faceplates
Operator

Item Description
1 Process Variable

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 215

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Maintenance

1 2

Item Description
1 Failure status high/low threshold.
2 Failure status high/low threshold.
Sensor Inputs. Select:
• ON if the corresponding input is to be used to calculate the final Process Variable
(average or median).
3 • OFF to exclude the corresponding input from the Process Variable calculation.
This configuration is typically used to exclude a particular input when it is taken out of
service for maintenance. If the P_AInMulti instruction has a Process Variable but is not
using it, the Maintenance Bypass Indicator is displayed.

Engineering

Item Description
1 Minimum and maximum scale for the process variable on the trend.
1 Select to set this parameter:
• ON, if the corresponding Process Variable Input is to be used to calculate final
Process Variable (average or median)
2 • OFF, to exclude the corresponding Process Variable Input from the Process Variable
2 calculation
TIP: This configuration determines whether a particular input is intended to be wired
and used. See the Maintenance tab for functions to take an input out of service for
maintenance temporarily.
3 Enter the number of selected inputs that must have a good source quality to result in
3 a good Process Variable.
4 Select to set this parameter to one of the following:
• ON, an input that is flagged as uncertain is rejected and not used to calculate the
5 final Process Variable.
4
• OFF, an input that is flagged as uncertain is not rejected and is still used to
calculate the final Process Variable. The flag causes the final Process Variable to
be flagged as uncertain (default).
Select:
• 'Outside of rejection region' to reject an input that is more than two standard
deviations from the mean.
5 • 'Outside of mean +/-' to reject an input that deviates from the mean by more than
the value entered. Value is in PV engineering units.
IMPORTANT: At least four inputs must be used for the 'Outside of rejection region'
selection to be meaningful.

216 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select:
1 • 'Average of good inputs' - the calculated final Process Variable is the average
(arithmetic mean) of the good (non-rejected) Process Variable inputs.
1 • 'Median of good inputs' - the calculated final Process Variable is the median (central
value) of the good (non-rejected) Process Variable inputs (default).
2 The average is the sum of values that are divided by the number of values.
The median is the value of the item in the middle. If there are an even number of items,
the median is the average of the two central values.
Select one of the options to determine the output calculation when there are only two
2 unrejected inputs.

Item Description
Select either generate or pass thru source quality for each channel. If the channel
1 1 is configured to pass thru, the PV source quality will not be impacted by that
channel source quality.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 217

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the unit measurements.
2 Enter the Input tag names.
3 Enter the number of decimal places for the Process Variable.

Item Description
1 Select to allow Operator to shelve alarm.
2 Select to allow Maintenance to disable alarm.
1 Select to configure operator command confirmation. This action would take place after
3 any operator command.
2
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
3 to true.)
4 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

218 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 1 Enter the object to navigate to for each input.

Process Analog Output

(PAO) Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PAO Standard analog-output graphic symbol.

Normal controlled valve symbol for horizontal

GO_PAO_ControlValve pipe.

Inverted controlled valve symbol for horizontal

GO_PAO_ControlValve1 pipe.

Controlled valve symbol for vertical pipe (pipe to

GO_PAO_ControlValve2 the left.)

Controlled valve symbol for vertical pipe (pipe to

GO_PAO_ControlValve3 the right).

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 219

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Analog Output There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PAO) Faceplates

Operator

Item Description
1 Analog Output State (At Target, Ramping Down, Ramping Up, Clamped at Min,
1 Clamped at Max, or Disabled).
2
3 2 Control Variable.
3 Control Variable target.
4 Enter to change the Controlled Variable output value.

Maintenance

Item Description
Select box to indicate there is a feedback reference. Uncheck if a reference does
1 not exist.
2 Select YES to bypass checking of bypassable interlocks and permissives.
Select Yes to bypass checking of bypassable interlocks and permissives. Select No
3
1 to enable checking of all interlocks and permissives.

2 3

220 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance

Item Description
Controlled Variable clamp limits. Enter the clamping limits for the Controlled
3 1 Variable in engineering units.
1 Clamp limits are enforced in Operator and Program command sources only.
Enter the maximum allowed value for the Rate of Change Limit in engineering units
2 per second.
A value of zero allows any rate of change to be input by the Program or Operator.
4 Enter the Operator command source Controlled Variable Target in engineering
units.
3 This entry is available in Operator command source and Maintenance command
5 source.
Select and the Controlled Variable holds at the last good value when an Interlock
trips or an I/O Fault occurs.
2 4 Clear this checkbox and the Controlled Variable goes to the Interlock Controlled
Variable value when an Interlock trips or an I/O Fault occurs.
Enter the interlock target Controlled Variable in engineering units.
5 This value is used for the Controlled Variable when interlocked or on an I/O Fault,
but only if Hold Last Good Value is not selected.

Item Description
Enter the overall period for the open and close cycles. The open and close cycles
1 consist of a pulsed output and an idle time. If the total cycle time is 10 seconds and the
1 maximum output time is 5 seconds, the cycle will be 5 seconds of pulsed output and 5
seconds of idle. The pulse cycles are only used if pulse outputs are enabled.
2
2 Enter the additional time to be added to the first pulse of an open or close action.
3 3 Maximum time the open or close pulse output will be enabled during each cycle.
4 Minimum time the open or close pulse output will be enabled during each cycle.
4
Enter value for time the output is bumped for open or closed bump command by the
5
5 operator. When enabled, this is a one-time bump of the requested output.
Enter value for the stuck alarm. When this time is reached without position change, the
6 6 status will change to stuck.
Enter value for the gate of the deviation alarm. If deviation is above the high limit or
7 7 below the low limit for this time, the deviation status will be raised.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 221

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

Item Description
Enter values for the maximum and minimum scaled (engineering units) scaling
1 ranges.
4 2 Enter the value for the initial CV used on power up.
1 5 Select what method will be used to determine the CV on power up. Position
3 feedback must be enabled to use the position feedback power up method.
4 Engineering Units label.
5 Enter values for the maximum and minimum output (Raw) scaling ranges.

Item Description
Select whether this method will be used for opened and closed status. This is a cross
1 check between the position and the opened/closed feedback.
1
2 Select whether the valve has closed feedback or not.
3 Select whether the valve has opened feedback or not.
2
Select whether the valve will fault when the opened and closed feedbacks are both ON or
3 4 when they are both off.
4 5 Select whether the valve has position feedback (%) or not.
6 Select whether the valve will have a pulsed output for opening and closing.

5
6

222 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
When selected, the operator settings track the program settings when the command
1 source is Program, and program settings track the operator settings when the
1 command source is Operator. Transition between command sources is bumpless.
2 When not selected, the operator settings and program settings retain their values
regardless of command source. When the command source is changed, the value of a
3 limit can change, such as from the Program-set value to the Operator-set value.
When selected, the Program and Operator Settings of the CV track the output CV when
4 2 the command source is Hand or Override.
3 Select while in Override command source to bypass Interlocks that can be bypassed.
Select to have the CV immediately go to its target value or configured Interlock CV
value when an Interlock trips or the instruction is placed in Maintenance or Override
5 4 command source.
Clear this checkbox to have the CV always use rate of change limiting (ramping) of the
CV output.
Select so that an I/O Fault triggers a shed of the output, to the configured shed set
6 value or to hold last good output. The shed condition is latched internal to the Add-On
Instruction. When the I/O Fault condition clears, a Reset command is required to return
7 to normal operation.
5 Clear this checkbox so that the I/O Fault condition does not affect operation (but can
still generate an alarm).

The configured shed action always takes place on an interlock trip. This selection
cannot be changed.
Select this option to set the analog output to the configured shed set value when a
6 condition configured as a shed trigger occurs.
Select this option to hold the analog output at its last good value when a condition
7 configured as a shed trigger occurs.

Item Description
1 Enter the rate (%/sec) at which the the valve moves during opening and closing.
2 Select yes to enable Virtual.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 223

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Set the number of decimal places for the Control Variable.
Select if an interlock object is connected to Inp_IntlkOK. The Interlock indicator
becomes a button that opens the P_Intlk faceplate.
2 IMPORTANT: The name of the Interlock object in the controller must be the name of
the object with the suffix ‘_Intlk_0. For example, if your P_AOut object has the name
‘AOut123’, then its Interlock object must be named ‘AOut123_Intlk_0’.
1 3 Select to enable navigation to a SMART device object.
2 4 Select to allow Operator to shelve the alarm.
5 Select to allow Maintenance to disable the alarm.
3

4
5

Item Description
Select to configure operator command confirmation. This action would take place
1
1 after any operator command.
2 Select to configure if a Historical data source will be used or not.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
3 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.
Select to enable navigation to the faceplate for the PlantPAx object that is providing
4
2 the CV for this object (PSet_CV).

224 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Boolean Logic

(PBL) Graphic Symbols Graphic Symbol Name Graphic Symbol Description

Standard PBL object. Displays boolean output

GO_PBL status and alarming. Opens faceplate.

Standard PBL object. Displays boolean output

GO_PBL1 status and alarming.

Process Boolean Logic There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PBL) Faceplates

Operator
1 2 3

Item Description
1 Input Name: Select to navigate to the Input object faceplate.
2 Gates: Select one of the gates to access the Gate Configuration display for that gate.
Select to take a snapshot of the current state.
3 IMPORTANT: When you take a snapshot, the View Snapshot tab is automatically displayed.
4 Boolean value that displays the final output of the PBL object.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 225

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Maintenance

Item Description
1 Enter a value for the off-delay time and the on-delay time.
2 Select to generate a time stamp whenever a snapshot triggers.
3 Select to allow a new snapshot to be triggered without a reset of the previous snapshot.
4 Select to trigger a snapshot when the designated condition is met.

Engineering

Item Description
1 Select to open the faceplate to select the output source.
2 Select to invert the selected output before it is passed to the output delay timers
1 3 Select to open the Gate Configuration faceplate.

2
3

226 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the text to display on the faceplate when output = 0
2 Enter the text to display on the faceplate when output = 1
3 Enter a description for each input.

1
2

Item Description
Select to configure operator command confirmation. This action would take place after
1 1 any operator command.
2 Select to enable nivigation to an object with more information.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 227

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Select to enable navigation to input object.
1

Logic Gate Configuration

3 4 5

Item Description
1 Displays the gate being configured.
2 Select to select which inputs of the gate are enabled (1…4).
3 Select the inputs for the gate.
4 Select to invert the source that enters the gate.
5 Select to select a gate type.

228 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

View Snapshot

The View Snapshot tab shows an image of the Operator faceplate when the
snapshot was taken. The background of the display turns from gray to white to
indicate capture. The View Snapshot has the same functionality as the
operator faceplate plus a Reset button.

Process Command Source The PCMDSRC (Command Source) Add-On Instruction is used to provide
selection of the command source (owner) of an instruction or control strategy. This
(PCMDSRC) instruction excludes Graphic Symbols.

The command source indicator displays by exception only. For example, if the device is
operating normally, there is not an indicator. If the device is out of service (OoS), then
the OoS indicator is displayed.

Command source indicators are not used for analog inputs.

Image Description

Device is out of service

Device is not in normal command source operation

Device is in program command source operation

Device is in maintenance command source operation

Device is in operator command source operation

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 229

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Image Description

Device is in override command source operation

Device is in local command source operation

Device is in external command source operation

Command Source Totem Pole

The Command Source Totem Pole shows the sources that have been requested.
These sources have a white background color. The leftmost source that is
highlighted is the active command source.

In the example that follows, the current command source is Operator Locked.
When Operator Locked is released, the default command source is Operator.
The small black triangle, in the upper left corner of the operator indicator
indicates the normal command source.

Operator Buttons

The Operator Lock buttons on device faceplates are used to lock and unlock
Operator command source. The buttons also show the current command
source status.
Image Description

Select to request Operator command source.

Select to lock in Operator command source. The program cannot take control.

Select to request Program command source.

230 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

External Control

There is a slider on the operator page that allows the operator to place the
device in External Control

Maintenance Buttons

The maintenance buttons on device faceplates are used to request and release
Maintenance command source.
Image Description

Select to acquire Maintenance command source.

Select to release Maintenance command source.

Select to display Advanced Properties command source.

Advanced Properties

Select the Advanced Properties button from the maintenance page to access
the engineering tabs. There are three engineering tabs. The first page is the
configuration for the Cfg_ProgDefault parameter for the object, which sets the
default command source when no command source is being requested.

From the other pages, you can configure the settings for additional command
sources.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 231

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Deadband
Controller (PDBC) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols
GO_PDBC Standard deadband controller graphic symbol.

232 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Deadband There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Controller (PDBC)
Faceplates
Operator
6 7 8

1
9
10

11
2
3 12
4
13
5

14 15 16 17

Item Description
1 PV EU maximum
2 Drive PV Lower Value
3 Current PV Value
4 Drive PV Higher Value
5 PV EU minimum
6 Drive PV Lower Limit
7 High Rate of Change Decreasing Limit
8 High Rate of Change Increasing Limit
9 Rate of Change Indicator
10 Current Rate of Change
11 Controlled Variable Indicator
12 Auto/Manual Mode Indicator
13 Drive PV buttons. From left to right: drive PV lower, don’t drive PV, drive PV higher
14 Current PV Value
15 Drive PV Higher Limit
16 Auto Mode Command Button
17 Manual Mode Command Button

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 233

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Maintenance

Item Description
Enter the value of the PV at which the output turns off and PV starts to
1 decrease.
1 7 Enter the value of the PV at which the output turns on and PV starts to
2
8 increase.
2
Enter the number that is used to establish the high deviation limit. When the
9 PV reaches this limit, a High Deviation alarm is generated.
3 3
10 EXAMPLE: In the examples, the Lower setpoint is 67 and the PV Hi Dev Status
4 is 5. We add 67 and 5 to get the high deviation limit of 72.
Enter the number that is used to establish the low deviation limit. When the
PV reaches this limit, a Low Deviation alarm is generated.
11 4
5 EXAMPLE: In the examples, the Raise setpoint is 30 and the PV Lo Dev Status
12 is -5. We add 30 and -5 to get the low deviation limit of 25.
6
Enter the number to set the high Rate of Change (decrease) limit (83 in the
5 example). When the Rate of Change reaches this level, a Hi Rate of Decrease
alarm is generated.
Enter the number to set the high Rate of Change (increase) limit (17 in the
6 example). When the Rate of Change reaches this level, a Hi Rate of Increase
alarm is generated.
Enter a number that is the size of the deadband for the Lower output (below
7 Lower limit)
Enter a number that is the size of the deadband for the Raise output (above
8 Raise limit)
Enter the number that PV must decrease to reset a High Deviation alarm.
EXAMPLE: The high deviation limit is 72 and the deadband is 1. The PV must
decrease 1 unit to 71 to reset the High Deviation alarm.
9 IMPORTANT: The deadband can be set so that the PV must decrease below
the Lower setpoint before the High Deviation alarm is reset. For example, the
deadband can be set to 10 so that the PV must decrease to 62 to reset the
alarm.
Enter the number that PV must increase to reset a Low Deviation alarm.
EXAMPLE: The low deviation limit is 30 and the deadband is 1. The PV must
increase 1 unit to 26 to reset the Low Deviation alarm.
10 IMPORTANT: The deadband can be set so that the PV must increase above
the Raise setpoint before the Low Deviation alarm is reset. For example, the
deadband can be set to 10 so that the PV must decrease to 35 to reset the
alarm.
Enter the number that the Rate of Change must decrease to reset a Hi Rate
11 of Decrease alarm.
Enter the number that the Rate of Change must increase to reset a Hi Rate of
12 Increase alarm.

234 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance

Item Description
1 Enter the Process Variable high deviation gate delay (seconds).
2 Enter the Process Variable low deviation gate delay (seconds).
1 3 Enter the Process Variable high rate of change increase gate delays (seconds).
2 4 Enter the Process Variable high rate of change decrease gate delays (seconds).

3
4

Engineering

Item Description
Select, the operator settings track the program settings when mode is Program, and
program settings track the operator settings when the mode is Operator. Transition
1 between modes is bumpless.
1
2 Clear the checkbox, this instruction does not modify the operator settings and program
settings. The operator settings and program settings retain their values regardless of
3 mode. When the mode is changed, the value of a limit can change, such as from the
4 Program-set value to the Operator-set value.
2 Enter the lower limit for the Loop PV Higher point.
3 Enter the upper limit for the loop PV Lower point.
Minimum and maximum values for PV input.
5 4 These values are reflected on the PV bar graph on the Operator tab and the graph on
the Trends tab.
5 Select the PV rate of change time base used.
Enter the number of units per x seconds, where x equals the number of seconds
6 selected for the PV rate of change time base.
6

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 235

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the text of the engineering units for the PV.
2 Enter the number of decimal places that are used for the PV.
3 Select to allow Operator to shelve alarm.
4 Select to allow Maintenance to disable alarm.

1
2

3
4

Item Description
Select to configure operator command confirmation. This action would take place after
1
1 any operator command.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
2 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

236 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Select to enable navigation to the PV object.
2 Select to enable navigation to the output object.
1

Process Discrete Input

(PDI) Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PDI Global object with label.

GO_PDI1 Global object without label.

GO_PDI_Circle Global object with only indicator.

GO_PDI_CircleWLabel Global object with indicator and label.

GO_PDI_L1_ Displays object status with label.

GO_PDI1_L1_ Displays object status without label.

GO_PDI_L1_Circle Displays object indicator.

GO_PDI_L1_CircleWLabel Displays object indicator with label.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 237

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Discrete Input There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PDI) Faceplates

Operator

Item Description
1 Current Process Variable
1 2 Target Process Variable

Maintenance

Item Description
1 Select to enable the use of the Substitute Process Variable.
2 Select to choose Process Variable to be used.

1 2

238 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance

Item Description
1 Minimum time the Process Variable must maintain the state, in seconds.

Engineering

Item Description
1 Select to enable the substitute Process Variable feature.
1 2 Select yes to enable Virtual.
2

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 239

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter text to display in PV 0 State.
2 Enter text to display in PV 1 State.
3 Select to display state text in normal state
4 Select to allow Operator to shelve the alarm.
5 Select to allow Maintenance to disable the alarm.
1
2
3

4
5

Item Description
Select to configure operator command confirmation. This action would take place
1 1 after any operator command.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is
set
2 to true.)
This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

Process Discrete Output

(PDO) Graphic Symbols Graphic Symbol Name Graphic Symbol Description

Digital (2-state) device Graphic Symbol for use

GO_PDO on overview and detail displays.

240 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Discrete Output There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PDO) Faceplates

Operator

Item Description
1 Feedback indicator
1 2 Discrete output indicator
2 3 Continuous Pulse Button
4 Single Pulse 'Off' Button
5 Output 'Off' Button
6 Output 'On' Button
7 Single Pulse 'On' Button

3 4 5 6 7

Maintenance

Item Description
1 Select if bypassable interlocks and permissives are bypassed.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 241

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance

Item Description
Enter the amount of time to allow for the device to get feedback for the Off setting
1 before setting a fault.
2 Enter the amount of time before the output deactivates.
4
1 3 Enter the amount of time to trigger a pulse when the device deactivates.
5 Enter the amount of time to allow for the device to get feedback for the On setting before
4
2 setting a fault.
6 5 Enter the amount of time before the output activates.
3
6 Enter the amount of time to trigger a pulse when the device deactivates.

Engineering

Item Description
1 Select to configure the instruction to use Off feedback signals from the device.
1 2 Select to configure the instruction to use On feedback signals from the device.
2 3 Select to Enable fault when both feedback inputs are either ON or OFF.
Select to reset a fault upon an operator command.
3 4 Clear this checkbox to reset faults by using only the reset code.
Select to reset a fault upon an external command.
5 Clear this checkbox to reset faults by using only the reset code.
4 6 Select to enable the pulsing functions.
5 Select if bypassable interlocks and permissives are bypassed in override command
7 source.
6
Select to make the Operator Off command available in any command source. Clear
8 this checkbox to make the Operator Off command available only in Operator or
7 Maintenance command source.
8 Select to make the External Off command available in any command source. Clear
9 this checkbox to make the External Off command available only in Operator or
9 Maintenance command source.

242 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Select to finish pulse when commanded ON or OFF.
1 Select to de-energize the output to the device and return the device to its fail position,
when an I/O Fault condition occurs.
Clear this checkbox to keep the output to the device in its current stat on an I/O Fault
2 condition.
2 IMPORTANT: If a condition is configured to shed the device to the Off state on a fault,
a reset is required to clear the shed fault. This reset commands the device to a state
3 other than Off.
4 Select to de-energize the output to the device, return it to its fail position, when a
Position Fail condition occurs.
5 Clear this checkbox to keep the output to the device in its current state (keep trying)
3 on a Position Fail condition.
IMPORTANT: If a condition is configured to shed the device to the Off state on a fault,
a reset is required to clear the shed fault. This reset commands the device to a state
other than Off.
6 The device outputs are always de-energized on an Interlock Trip. This item cannot be
4 unchecked. It is displayed as a reminder that the Interlock Trip function always de-
energizes the device.
5 Select the setting for when the audible output of the object is on.
6 Enter the amount of time the audible output will be held on when enabled.
7

Sets the time delay (in seconds) for the On or Off status to be echoed back when
5 Virtual is enabled or when On and Off feedbacks are not used.
6 Select yes to enable Virtual.

Item Description
Sets the time delay (in seconds) for the On or Off status to be echoed back when
1 Virtual is enabled or when On and Off feedbacks are not used.
1
2 Select yes to enable Virtual.
2

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 243

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter text to display when device is in Off (0) state.
2 Enter text to display when device is in On (1) state.
3 Enter text to display for the off command.
4 Enter text to display for the on command.
5 Enter text to display for the pulse off command.
1
2 6 Enter text to display for the pulse on command.
3 7 Select to enable navigation to the permissive object
4 8 Select to enable navigation to the interlock object
5
6
7
8

Item Description
1 Select to allow Operator to shelve the alarm.
2 Select to allow Maintenance to disable the alarm.
1 Select to configure operator command confirmation. This action would take place after
3 any operator command.
2
Select whether there is navigation to an additional object or not. If selected, enter the
4
3 object name in the value.

244 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Dosing (PDOSE)

Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PDOSE_FM Vertical Orientation Top

GO_PDOSE_FM1 Vertical Orientation Bottom

GO_PDOSE_FM2 Horizontal Orientation Right

GO_PDOSE_FM3 Horizontal Orientation Left

GO_PDOSE_WS Vertical orientation up.

GO_PDOSE_WS1 Horizontal orientation right.

GO_PDOSE_WS2 Horizontal orientation left.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 245

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Dosing (PDOSE) There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Faceplates

Operator

Item Description
1 1 Dosing Equipment Commanded State.
2 2 Delivery Progress Bar.
3 Configure the quantity to deliver.
4
4 Delivery progress.
3
Totalizer Control (from left to right)
• Select to clear the totalized quantity.
5 • Select to stop the Totalizer.
5
• Select to start the Totalizer.
• Select to check tolerances.
6 Select to stop the Totalizer flow.
7 Select to start the Totalizer flow.
8 Select to bump the Totalizer flow.
6 7 8

Maintenance

Item Description
Configure the quantity before the end of delivery, when a switch to a reduced
1 flow rate (dribble) for finer control of the final quantity is made.
1
Configure the quantity before reaching the Setpoint Quantity when a command
2 2 the delivery equipment to stop to allow equipment to react. The preact
quantity helps prevent overshooting the delivery Setpoint.
Enter the quantity by which delivery can exceed the setpoint. If the delivered
3 3 quantity is more than the setpoint plus this value, a tolerance check shows
over tolerance.
4
Enter the quantity by which delivery can fall short of the setpoint. If the
4 delivered quantity is less than the setpoint minus this value, a tolerance check
shows under tolerance.
Select whether there is equipment feedback or not. The equipment provides
5 run (dribble if used) and stop feedback.

246 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance

Item Description
Enter a value so that when the flow rate is less than this value, it is treated as zero. This
1 1 value helps prevent totalizing the transmitter error when flow is stopped.
2 Enter the percentage of delivery error.
When the delivery tolerance is checked, if no bump has occurred and if the delivery is in
3 2 tolerance, the error (difference between delivery setpoint and actual delivery) is
multiplied by this percentage and applied to the preact. The preact self tunes and learns
4 the correct value of the preact over time.
Configure the Time (in seconds) to Pulse the Clear Output to clear an external totalizer,
5 3 such as one in an intelligent flowmeter.
6 Enter the amount of time to command the controlled equipment to run flow when the
bump command button is pressed. If this value is set to zero, Bump is treated like a Jog:
4 flow starts when the button is pressed and stops when the button is released. If this value
7 is greater than zero, flow is bumped for the configured time.
8 Enter the amount of time in seconds after flow is stopped for the scale reading to settle
5 before a tolerance check can be commanded.
Enter the maximum allowed feedback time.
If equipment feedback is being used, the instruction allows this much time after
6 commanding the equipment for feedback to show the equipment in the commanded state
before raising a fault status.
7 Enter the flow high threshold. This is the limit for flow alarming.
8 Enter the flow low threshold. This is the limit for flow alarming.

Engineering

Item Description
Select to adjust the Preact automatically based on the actual versus setpoint Quantity
1 1 after each successful delivery.
Clear this checkbox to leave the Preact as entered.
2 Select to command the equipment to a slower Dribble rate as delivery nears completion
2 to improve the accuracy of Quantity delivered.
3
Select if the controlled equipment provides feedback of its running, dribbling, and
4 stopped status to this instruction. This instruction checks that the equipment is
performing the commanded function and provides a status (and optional alarm) if the
5 equipment fails to respond as commanded within a configurable time.
3 IMPORTANT: The feedback fault time is configured on the Advanced Maintenance tab.
Clear this checkbox if the controlled equipment does not provide feedback of its status.
6 The instruction assumes that the equipment is performing the commanded function and
no equipment failure-to-respond checks occur.
7
Select if you want the dosing instruction to attempt to stop the controlled equipment if
an equipment fault is reported (Inp_CtrldEqupFault) or detected (via feedbacks).
4 Clear this checkbox if you want the dosing instruction to keep performing its current
function, even if an equipment fault occurs.
5 Select to allow continuous rate monitoring.
6 Select to designate as a Transfer In instance.
7 Select to designate as a Transfer Out instance.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 247

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Enter the maximum allowed quantity to deliver. The quantity setpoint is clamped not to
1
exceed this value.
1
Enter the number of counts in Inp_QtyPV that equal one engineering unit of quantity
2
2 delivered. This value is used with pulse output flowmeters and a pulse input I/O card.
3 Enter the rate to quantity engineering units multiplier. This value is used if the input is
3 in one unit of measure, such as gallons per minute, and the total is in another that
requires conversion above and beyond time units, such as barrels.
4 Enter the quantity rollover. This value is used when a quantity or pulse count input rolls
4 over to zero at some value, such as 999,999 counts.
5
5 Enter the filter time constant for calculated rate.
6
6 Select the time base for rate.
Enter the number of units per x seconds, where x equals the number of seconds
7 selected for the time base for rate.

Item Description
Select to keep control of dosing Start and Stop commands with the Operator, Program,
1 External, or Follow the Source even if the instruction is in Program command source.
Select to keep control of the Setpoint quantity setting with the Operator, Program,
2 External, or Follow the Source even if the instruction is in Program command source.
Select to keep control of the Dribble and Preact quantity settings with the Operator,
3 Program, External, or Follow the Source even if the instruction is in Program command
1 source.
2 Select to keep control of the high and low Tolerance settings with the Operator,
4 Program, External, or Follow the Source even if the instruction is in Program command
3 source.

248 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Enter the normal running delivery rate that is used when the P_Dose instruction is in
1 virtual (Inp_Sim = 1).
1
Enter the dribble (slow) delivery rate that is used when the P_Dose instruction is in
2 2 virtual (Inp_Sim = 1).
3 Select yes to enable virtual.
3

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the units of measure descriptor for the Quantity delivered.
2 Enter the units of measure descriptor for the Rate of delivery.
Enter in the number of decimal places that are displayed for the Quantity Process
3 Variable
4 Enter in the number of decimal places that are displayed for the Rate Process Variable
1 5 Select to allow Operator to shelve the alarm.
2
6 Select to allow Maintenance to disable the alarm.
3
4

5
6

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 249

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select to configure operator command confirmation. This action would take place after
1
1 any operator command.
2 Select to configure if a Historical data source will be used or not.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
3 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

Item Description
1 Select to enable navigation to a Quantity PV object
2 Select to enable navigation to a Rate PV object
1

Process Analog Fanout

(PFO) Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PFO P_Fanout graphic symbol (horizontal layout).

GO_PFO1 P_Fanout graphic symbol (vertical layout).

250 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Analog Fanout There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PFO) Faceplates

Operator

The Faceplate initially opens to the Operator (Home) tab. From here, an
operator can monitor the device status and manually operate the device when
it is in Operator mode.

If outputs 6, 7, and 8 are used by the instruction (in other words, if

Cfg_HasCV6… Cfg_HasCV8 are 1), the Home tab has a second page that
displays the information.

Maintenance

1 2 3
Item Description
Enter a value that sets the ratio to calculate each individual output.
1 This value either sets the operator ratio (for example, OSet_CV1Ratio) or the
configuration ratio (for example, Cfg_CV1Ratio) depending on the ratio source selection.
Operator setting for the Input CV rate of change limit (increasing or decreasing).
2 If Cfg_MaxCVRoC = 0.0, then this parameter can be set to zero, which means the rate of
change is not limited.
Enter a value that sets the offset to calculate each individual output.
This value either sets the operator offset (for example, OSet_CV1Offset) or the
3 configuration offset (for example, Cfg_CV1Offset) depending on the ratio source
selection.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 251

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

1 2 3 4

Item Description
1 Select to enable use of the corresponding output.
2 Enter a value for the minimum value to be used to clamp CV (in engineering units).
3 Enter a value for the maximum value to be used to clamp CV (in engineering units).
Enter a rate the CV is to change to a calculated value after initialization to provide
4 bumpless transfer from initialization.

Item Description
1 Enter values to set the limits to use to clamp the CV.
2 Enter values to set the limits to display for the CV.
1 Select to use the CV1 initialization value (Inp_CV1InitVal) to set the initialization output
3 (Out_CV_InitVal) when initialization is requested.
Select to use a fixed value (Cfg_FixedInitVal) to set the initialization output
(Out_CV_InitVal) when initialization is requested.
2 4 Enter a value to set the initialization value (Out_CVInitVal) if initialization is requested
and a fixed value option is selected.
5 Select to pass through the bad value.
3 6 Select to hold last good value.
4

5
6

252 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the description of the output name.
2 Enter the units that are used with the CV.
3 Sets the CV engineering units to use for display.

2
1 3

Item Description
1 Enter the number of decimal places to be shown for CV.
1 Select to permit navigation to an input CV object faceplate for which you typed a tag
2 name.
Select to permit navigation to an output CV object faceplate for which you typed a tag
3 name.
2

Process High or Low

Selector (PHLS) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols
GO_PHLS Standard High or Low Selector graphic symbol.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 253

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process High or Low There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Selector (PHLS) Faceplates

Operator

The Operator tab shows the following information:

• Current operation (High or Low Select)
• Currently selected input (white highlight)
• Bar graph for clamp limits from minimum to maximum plus Output
CV indicator
• Input CV values and Output CV value

Maintenance

Item Description
Select to use a CV input.
1 1 Clear a checkbox not to use the input and put the instruction in Maintenance
Bypass.

254 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering
4

Item Description
1 Select 'Has Input' (CV1…CV6) where an input is connected.
Enter in the minimum and maximum to set the range for the selected input CV.
2 If the selected input CV is below the minimum, it is clamped to the minimum value.
1 If the selected input CV is above the maximum, it is clamped to the maximum value.
Select High Select to select the highest input CV value to pass to the output.
3 Select Low Select to select the lowest input CV value to pass to the output.
4 Select a 'Use Offset' (CV1…CV6) to include the Kp*E offset in initialization calculation.

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the engineering units for display on the HMI. Percent (%) is the default.
2 Enter in the number of decimal places that are displayed for the CV.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
3 This can be configured to navigate to an object backing tag or a UDT tag that has
1 Instruction and Library defined.
4 Select to enable navigation to an output object.
2
3

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 255

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Select an input (CV1…CV6) or the Output CV to allow navigation to a specified object.
2 Enter the tag name for the corresponding input (CV1…CV6) or Output CV.
1
2

Process Interlock (PINTLK)

Graphic Symbols
Graphic Symbol Name Graphic Symbol Description

GO_Interlock Standard Interlock Graphic Symbol.

GO_CfgHasType Used to configure the type of interlock.

GO_Interlock_MSet_Bypass Used to select maintenance bypass of the interlock.

GO_InterlockBank0 Used for navigation to a specific bank of interlocks.

Used to configure OK state, bypass, reset, and stop only

GO_InterlockCfg settings of interlocks.

GO_rb_Cfg_eTypeX Used to configure the types.

256 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Interlock States
Item Description

Not ready to run or energize. One or more interlock conditions are not OK.

Ready to run or energize. One or more conditions that can be bypassed are not OK, but these
conditions are bypassed. All conditions that cannot be bypassed are OK.

Ready to run or energize. All interlock conditions are OK.

Ready to run or energize, and all interlock conditions are OK, conditions that can be bypassed
are being bypassed and the equipment is not shut down.

The overall graphic symbol includes a touch field that opens the faceplate.
Hover the pointing device over the graphic symbol to display a tooltip that
describes the function of the symbol.

Process Interlock (PINTLK) There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Faceplates

Operator

The Faceplate initially opens to the Operator (Home) Tab. From here, an
operator can monitor the device status.

The Operator tab shows the following information:

• Interlock bypass status indicator (Enabled, Bypassed)
• Each configured interlock along with the current state of the interlock

If navigation is enabled, Select a condition to open the faceplate of the object

that is associated with the condition.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 257

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

The following figure shows the Operator tab in a non-bypassed condition with
no faults.

Maintenance

Item Description
Select an interlock condition that can be bypassed, one that has a
1 white checkbox, to enable bypass of that individual interlock.

258 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

2 3 4 5 6
Item Description
Enter the text description of each interlock condition used. Only the
1 interlocks with text entered appear on the Operator tab of the faceplate.
2 Selects the state of the corresponding interlock that is the OK to Run state.
3 Select to indicate that the corresponding interlock can be bypassed.
Select to indicate that the corresponding interlock is latched and must be
4 reset.
Select to configure the interlock for stop only. The object (motor) the
5 interlock object is associated will trip when if this specific interlock is not
OK, but it will not alarm.
1
Select to define the interlock type. The display opens to select an available
interlock type that was defined in the HMI Configuration.

HMI Configuration

Item Description
Select to enable the interlock type that can be defined in the Engineering
1 tab. There are eight types that are configurable. The first three letters
define the short name type followed by ‘:’ and then the full type description.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 259

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select to configure operator command confirmation. This action would
1
1 take place after any operator command.
Select to enable navigation to an object with more information
(Cfg_HasMoreObj is set to true.)
2 This can be configured to navigate to an object backing tag or a UDT tag
that has Instruction and Library defined.
3 Select to allow navigation to interlock input objects.

Process Lead/Lag/Standby
Motor Group (PLLS) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols
GO_PLLS_Motors A group of motors.

GO_PLLS_Blowers A group of blowers.

GO_PLLS_Pumps A group of pumps

260 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Lead/Lag/Standby There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Motor Group (PLLS)
Faceplates
Operator

Item Description
1 1 Motor state indicator.
2 Individual motor state indicators.
2 Enter a number between 0 and the maximum demand to indicate the number of
3 motors to run.
Select to rotate motor assignments. The lead motor is demoted to the end of the list.
4 Motors are started or stopped to satisfy Number of Motors to Run.
5 Select to start group.
Select to stop group.
3 6 IMPORTANT: Motors stop in reverse order of starting unless First Started is First
Stopped on the engineering tab is checked.

4 5 6

Manual Mode

1 2
Item Description
1 Displays the current preference for a motor.
Enter new preference value. The preference value determines the precedence
2 when starting motors.
3 Apply the values in the new column to the preference values.
4 Reset preferences to previous.

3 4

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 261

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Maintenance

Item Description
Select to place a motor in service (not in maintenance bypass).
1
1 Clear the checkbox to place a motor out of service (maintenance bypass)
Select Yes to bypass checking of bypassable interlocks and permissives. Select No
2 to enable checking of all interlocks and permissives.

Advanced Maintenance

Item Description
1 Enter the number of seconds after a start or stop that the next start is allowed.
1 2 Enter the number of seconds after a start or stop that the next stop is allowed.

262 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

Item Description
1 Enter the number of motors (2…30) in the group.
2 Enter the highest number of motors that can be running.
1 3 Enter the lowest number of motors that can be running.
2 4 Select to allow the Rotate command to rotate motor assignments.
3 5 Select to rotate the lead motor to the end of list upon stopping all motors.
6 Select so that the first motor that is started is the first motor that is stopped.
4 Select to allow the Operator Start or Stop command to reset any previous faults
7 (Interlock Trip), then start or stop the group.
5 Clear this checkbox to reset faults by using only the reset commands.
6 Select to allow the External Start or Stop command to reset any previous faults
8 (Interlock Trip), then start or stop the group.
7 Clear this checkbox to reset faults by using only the reset commands.
8 Select to bypass interlocks and permissives that are bypassable when in Override
9 command source.
9

Item Description
Select (= 1) so that the OCmd_Stop has priority and is accepted at any time. If the
Command Source is not Operator or Maintenance, the motor or drive requires a reset.
1 1 Clear this checkbox (= 0) so that the OCmd_Stop works only in Operator or Maintenance
2 command source.
Select (= 1) so that the XCmd_Stop has priority and is accepted at any time. If the
3 Command Source is not External, the motor or drive requires a reset.
2 Clear this checkbox (= 0) so that the XCmd_Stop only works when the command source
4 is External.
5 Select to have Program settings (such as Speed Reference) track Operator settings in
3 Operator command source, and have Operator settings track Program settings in
Program command source.
Select to have Program and Operator Speed Reference track the Override Speed
4 Reference in Override command source or the actual speed in Hand command source.
Enter the start priority within the list of the motors selected.
5 Motors start in order of priority (0...31) and the higher numbers start first.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 263

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
Select if a Permissive object is used with this motor. This check changes the
Permissive indicator to a clickable button to open the Permissive faceplate.
1 IMPORTANT: The name of the Permissive object in the controller must be the name of
the object with the suffix ‘_Perm’. For example, if your P_LLS object has the name
’LLS123’, then its Permissive object must be named ‘LLS123_Perm’.
Select if an Interlock object is used with this group. Checking this box changes the
1 Interlock indicator to a clickable button to open the Interlock faceplate.
2 IMPORTANT: The name of the Interlock object in the controller must be the object
2 name with the suffix ‘_Intlk’. For example, if your P_LLS object has the name’LLS123’,
then its Interlock object must be named ‘LLS123_Intlk’.
3 Select to allow Operator to shelve the alarm.
3
4 Select to allow Maintenance to disable the alarm.
4

Item Description
Select to configure operator command confirmation. This action would take place after
1
1 any operator command.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
2 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

264 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select to allow navigation to motor objects.
1
1 Additional pages are available if configured for more than 8 motors.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 265

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Motor (Power

Discrete) (PMTR) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols

GO_PMTR_R

Motors operate in different positions:

GO_PMTR_U right, up, and down.

GO_PMTR_D

GO_PMTR_Pump_R

Pumps operate in several positions: right,

GO_PMTR_Pump_L left, and up

GO_PMTR_Pump_U

GO_PMTR_Inline_U

GO_PMTR_Inline_L
Inline motors operate in several
positions: up, left, down, and right.
GO_PMTR_Inline_D

GO_PMTR_Inline_R

266 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

GO_PMTR_Blower_R

GO_PMTR_Blower_L
Blowers operate in different positions: right,
left, up, and down.
GO_PMTR_Blower_U

GO_PMTR_Blower_D

GO_PMTR_Conveyor_R Conveyor that is shown as a Graphic Symbol.

GO_PMTR_Agitator_D Agitator that is shown as a Graphic Symbol

GO_PMTR_Mixer_U Mixer that is shown as a Graphic Symbol.

Rotary gear pump that is shown as a Graphic

GO_PMTR_RPump_U Symbol.

GO_PMTR_Fan_D Fan that is shown as a Graphic Symbol.

GO_PMTR_L1_ Indicator with label.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 267

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

GO_PMTR_L1_Motor Motor indicator

GO_PMTR_L1_Pump Pump indicator

GO_PMTR_L1_Blower Blower indicator

Process Motor (Power There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Discrete) (PMTR)
Faceplates
Operator

Item Description
1 1 Motor state (stopping, stopped, starting, or running)
2 Select to jog Motor at speed 2.
3 Current command source (Program, Operator, Override, Maintenance, or Hand)
4 Select to start motor at speed 2.
5 Motor stop
6 Select to start motor slow (motor run for single speed motors)
7 Select to jog Motor

2 3 4 5 6 7

268 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Maintenance

2 3 4
Item Description
Select Yes to bypass checking of bypassable interlocks and permissives.
1 Select No to enable checking of all interlocks and permissives.
Select to open the runtime faceplate.
2 IMPORTANT: This option is only available if 'Enable navigation to run time object'
on the HMI Configuration tab is checked.
Select to open the Restart Inhibit faceplate.
3 IMPORTANT: This option is only available if 'Enable navigation to restart inhibit
object' on the HMI Configuration tab is checked.
Select to open the device object faceplate.
4 IMPORTANT: This option is only available if 'Enable navigation to device object' on
1 the HMI Configuration tab is checked.

Advanced Maintenance

Item Description
1 Enter the time for the reset output to be pulsed.
Enter the time to allow the run feedback to show that the motor has started before
1 2 raising a fail to start alarm.
2 Enter the time to allow the run feedback to show that the motor has stopped before
3 raising a Fail to Stop alarm.
3 4 Enter the time to allow the motor to jog.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 269

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

Item Description
1 Select the motor type.
1 Select if the motor provides run feedback to Inp_SlowRunFdbk and Inp_FastRunFdbk.
Clear this checkbox if there is no run feedback.
2 IMPORTANT: This check places the device in Maintenance Bypass unless 'Use Run
Feedback' on the Maintenance tab is checked.
3 Select to allow the motor to start at speed 1.
4 Select to allow the motor to start at speed 2.
2
5 Select to allow the motor to be jogged.
3 6 Select to allow the motor to jog at speed 2.
4 7 Select to allow the motor to be stopped.
5
6

Item Description
Select to allow the Operator commands for Start Slow, Start Fast, or Stop to reset any
previous faults (I/O fault, Fail to Start, Fail to Stop, Interlock Trip). Then start or stop
1 1 motor.
2 Clear this checkbox to reset faults only using the reset code.
Select to allow the External commands for Start Slow, Start Fast, or Stop to reset any
3 previous faults (I/O fault, Fail to Start, Fail to Stop, Interlock Trip). Then start or stop
2 motor.
4 Clear this checkbox to reset faults only using the reset code.
5 3 Select to bypass bypassable interlocks and permissives in Override command source.
Select to have the Operator Stop command available in any command source.
4 Clear this checkbox to have the Operator Stop command available only in the Operator
and Maintenance command sources.
Select to have the External Stop command available in any command source.
5 Clear this checkbox to have the External Stop command available only in the Operator
and Maintenance command sources.

270 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select to stop the motor if an I/O fault is detected.
1 Clear this checkbox to show only the I/O fault status/alarm and not stop the motor if an
I/O fault is detected.
1
Select to stop the motor if a fail to Start fault is detected.
2 2 Clear this checkbox to show only the Fail to Start status/alarm and not stop the motor if
a fail to Start fault is detected.
3
The motor always stops on an interlock trip. This item cannot be cleared. It is displayed
3
4 as a reminder that the Interlock Trip function always trips the motor.
4 Enter the amount of time to sound the audible alarm when the motor starts.
5 Enter the time delay between when the run output has turned off for one speed and
5 when it is turned on for the other speed.
6
Enter the time delay (in seconds) for the running or stopped status to be echoed back
6 when the virtual is enabled or when run feedback is not used.
7
7 Select yes to enable virtual.

Item Description
Select one of the four options to determine the source of each command (start and
1 jog). If any option but “Follow Source” is selected, then that source will be the only
source allowed for that command.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 271

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the text to display when the motor is running at speed 1.
2 Enter the text to display when the motor is running at speed 2.
3 Enter the text to display when the motor is starting at speed 1.
4 Enter the text to display when the motor is starting at speed 2.
5 Enter the text to display when the motor is jogging at speed 1.
1
6 Enter the text to display when the motor is jogging at speed 2.
2
3
4
5
6

Item Description
1 Select if Start Speed 1 is used with this motor.
1 2 Select if Start Speed 2 is used with this motor.
Select if an interlock object is used with this motor.
2 IMPORTANT: The name of the Interlock object in the controller must be the name of the
3 object with the suffix ‘_Intlk’. For example, if your P_Motor2Spd object has the name
3 ’Motor123’, then its Interlock object must be named ‘Motor123_Intlk’.
4 Select if a restart inhibit object is used with this motor.
IMPORTANT: The name of the Restart Inhibit object in the controller must be the name
5 4 of the object with the suffix ‘_ResInh’. For example, if your P_Motor2Spd object has the
name ’Motor123’, then its Restart Inhibit object must be named ‘Motor123_ResInh’.
6
Select if a run time object is used with this motor.
IMPORTANT: The name of the Run Time object in the controller must be the name of
5 the object with the suffix ‘_RunTime’. For example, if your P_Motor2Spd object has the
name ‘Motor123’, then its Run Time object must be named ‘Motor123_RunTime’.
7 6 Select to allow navigation to the device object.
8 7 Select to allow Operator to shelve the alarm.
8 Select to allow Maintenance to disable the alarm.

272 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select to configure operator command confirmation. This action would take place after
1
1 any operator command.
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
2 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.

PPID Graphic Symbols

Graphic Symbol Name Graphic Symbol Description

Graphic Symbol with PV and CV numeric

GO_PPID displays.

Graphic Symbol with PV, SP, and CV numeric

GO_PPID1 displays.

Graphic Symbol with SP and CV numeric

GO_PPID2 displays

Graphic Symbol with PV and CV numeric

displays and a trend display that plots SP, PV,
GO_PPID_Trend High, and Low Deviations. The trend is scaled to
PV EU Min and Max.

Graphic Symbol with PV, SP, and CV numeric

displays and a trend display that plots SP, PV,
GO_PPID_Trend1 High, and Low Deviations. The trend is scaled to
PV EU Min and Max.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 273

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

Graphic Symbol with PV and CV numeric

displays and a trend display that plots SP, PV,
GO_PPID_TrendWTarget High, and Low Deviations. The trend is scaled by
using the High and Low Deviations.

Graphic Symbol with PV, SP, and CV numeric

displays and a trend display that plots SP, PV,
GO_PPID_TrendWTarget1 High, and Low Deviations. The trend is scaled by
using the High and Low Deviations.

Bar graph with SP on the left and PV on the right

GO_PPID_Indicator that is scaled by PV EU minimum and maximum.

GO_PPID_Valve

GO_PPID_Valve1
Proportional Valve Graphic Symbol with PV and
CV numeric displays.

GO_PPID_Valve2

GO_PPID_Valve3

274 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

GO_PPID_Valve4

GO_PPID_Valve5
Proportional Valve Graphic Symbol with PV, CV,
and Setpoint numeric displays.

GO_PPID_Valve6

GO_PPID_Valve7

GO_PPID_Valve8

GO_PPID_Valve9
Proportional Valve Graphic Symbol with SP, CV,
and Setpoint numeric displays.

GO_PPID_Valve10

GO_PPID_Valve11

GO_PPID_Val_PV PV indicator with label.

GO_PPID_PV1 PV indicator with label.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 275

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

GO_PPID_PVSP Indicator with PV and SP.

GO_PPID_Label Label only

Bar indicator with PV and SP moving triangles.

GO_PPID_Indicator Includes displayed limits. Alarm indication.

Bar indicator with PV and SP moving triangles.

GO_PPID_Indicator1 Includes displayed limits. Alarm indication.

Bar indicator with PV and SP moving triangles.

GO_PPID_Indicator2 Includes displayed limits. Alarm indication and
PV value in tooltip.

Bar indicator with PV and SP moving triangles.

GO_PPID_Indicator3 Includes displayed limits. Alarm indication and
PV value in tooltip.

Bar indicator with PV and SP moving triangles.

GO_PPID_Indicator4 Includes displayed limits. PV value in tooltip.

276 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

Bar indicator with PV and SP moving triangles.

GO_PPID_Indicator5 Includes displayed limits. PV value in tooltip.

GO_PPID_Trend_L1 Trend with PV and SP values.

GO_PPID_Trend1_L1 Trend with PV and SP values.

GO_PPID_HistTrend1 Trend with PV and SP historical values.

GO_PPID_HistTrend2 Trend with PV and SP historical values.

GO_PPID_Sparkline PV indicated by Realtime Sparkline

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 277

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Graphic Symbol Name Graphic Symbol Description

GO_PPID_Sparkline1 PV indicated by Realtime Sparkline

GO_PPID_HistTrend3 PV indicated by Historical Sparkline

GO_PPID_HistTrend4 PV indicated by Historical Sparkline

PPID Faceplates There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.

Operator

4
Item Description
1 Current Process Variable (PV).
2 Bar graph for the current Process Variable.
3 Select to open the ramp wizard display.
4 Current Setpoint (SP).
1 8 5 Cascade loop mode.
6 Auto loop mode.
2 9 7 Manual loop mode
3 10
8 Current Control Variable (CV).
Enter a value for the loop setpoint.
11 9 IMPORTANT: This value can be entered only when the instruction command
source is Operator and the Loop mode is Automatic or Manual.
10 Bar graph for the current Control Variable.
11 Loop mode indicator.
5 6 7

278 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Ramp Wizard Display

Item Description
4 1 Enter new target setpoint.
1
2 Ramp Time
2 5 3 Stop setpoint ramping.
4 Calculated rate of change.
5 Start setpoint ramping.

Maintenance

2 3

Item Description
1 Threshold Name
2 Enter the threshold (trip point) for analog input alarms.
Enter the deadband (hysteresis) that applies to each alarm limit. Deadband helps
prevent a noisy signal from generating numerous spurious alarms.
3 Example: If the High alarm limit is 90.0 and the High alarm deadband is 5, once the
1 signal rises above 90.0 and generates a High alarm. The signal must fall below 85.0
(90.0 minus 5.0) for the alarm to clear.
Select Yes to bypass checking of bypassable interlocks and permissives. Select No
4 to enable checking of all interlocks and permissives.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 279

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Advanced Maintenance
3

Item Description
1 Enter the Operator ratio.
2 Enter the maximum and minimum limits for the ratio.
1 3 Enter the Operator Setpoint for the Operator Loop mode.

Item Description
1 Enter the minimum and maximum limits for the setpoint
2 Enter the interlock setpoint.
3 Enter the setpoint rate of increase.
1
4 Enter the setpoint rate of decrease.

3
4

280 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Enter the value for the zero-crossing deadband (in PV engineering units). When the
1 loop error is less than the zero-crossing deadband, the loop output does not
change.
Enter the maximum and minimum values of the PV range (span) (in PV engineering
2 units). The maximum value must be greater than the minimum.
1 3 3
2 Gains: Proportional

This value depends on the setting of Cfg_Depend.

If Cfg_Depend = 1 (dependent gains, the default), Enter the Controller Gain
4 (unitless). This gain is applied to the Proportional, Integral, and Derivative terms.
If Cfg_Depend = 0 (independent gains), Enter the Proportional Gain (unitless). This
4 gain is applied to the Proportional term only.
5 A value of zero in either case disables the Proportional term of the controller.
Negative values are not valid.
6
Gains: Integral

This value depends on the setting of Cfg_Depend.

If Cfg_Depend = 1 (dependent gains, the default), Enter the Integral Time Constant
5 (minutes pre-repeat).
If Cfg_Depend = 0 (independent gains), Enter the Integral Gain (1/minutes).
A value of zero in either case disables the Integral term of the controller. Negative
values are not valid.
Gains: Derivative

This value depends on the setting of Cfg_Depend.

If Cfg_Depend = 1 (dependent gains, the default), Enter the Derivative Time
6 Constant (minutes).
If Cfg_Depend = 0 (independent gains), Enter the Derivative Gain (minutes).
A value of zero in either case disables the Derivative term of the controller.
Negative values are not valid.

Item Description
1 Enter the operator CV (when the PID is in manual mode).
1 Enter the minimum and maximum CV engineering units. These are used for scaling
2 the output.
3 Enter the values for the maximum rate of change for increasing CV.
4 Enter the values for the maximum rate of change for decreasing CV.
Enter the maximum allowed value of the CV in percent. The CV output is clamped
not to exceed the entered value. This value must be less than or equal to 100.0 and
2 5 greater than the CV Low Limit.
5
Enter the minimum allowed value of the CV in percent. The CV output is clamped
not to go below the entered value. This value must be greater than or equal to 0.0
and less than the CV High Limit.
3
4

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 281

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Enter the value in percent to output as the CV when an Interlock input is not OK. The CV
1 is held at this
value until the interlock inputs are OK (subject to interlock bypassing).
1

Item Description
1 Enter the CV active threshold.
1 Process variable high high, high, low, and low low deviation threshold gate delay
2 (seconds).
2

282 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Tuning

2
Item Description
1 Trend display for Process Variable, Setpoint, and Controlled Variable.
2 Setpoint data entry.
3 Tuning constant entries.
4 Process variable data entry
5 Cascade loop mode.
6 Auto loop mode.
7 Manual loop mode.

3 4

Engineering

Item Description
1 Enter the interval (in seconds) to execute the PID algorithm.
1 Select for reverse-acting loop response (default). When the PV increases, the CV (output)
2 decreases.
3 Select for direct-acting loop response. When the PV increases, the CV (output) increases.
2 Select to use the Independent Gains form of the PID algorithm. Changes to the
4 proportional gain do not affect integral or derivative response.
3
Select to use the Dependent Gains form of the PID algorithm (default). Changes to
5 Cfg_PGain are applied as loop gain changes and affect proportional, integral, and
4 derivative responses.
5 Select to enable derivative smoothing. Derivative smoothing can help reduce output jitter
due to noise on the PV signal.
6 Clear this checkbox to disable derivative smoothing. When derivative smoothing is
6 disabled, it can result in quicker loop response at high derivative gain.
7 Select whether the error is squared on proportional action or not. Squaring the error
7 minimizes the effect of a small error on the output.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 283

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
If the PV derivative deadband is exceeded, PID will stop processing the error
1
calculation and the CV will freeze.
1 If the PV derivative deadband is exceeded, the integral portion of the error calculation
2
2 will be suspended. The error calculation will continue and the CV will be updated.
Enter the value for PV deviation when the CV is approaching SP. A lower deadband will
3 3 allow for less deviation in the PV. If the deviation deadband is reached, action will be
taken according to items #1 or #2.
4 Enter the value for PV deviation when the CV is leaving the SP. A lower deadband will
4 allow for less deviation in the PV. If the deviation deadband is reached, action will be
5 taken according to items #1 or #2.
Enter value for beta gain. This is the weight (multiplier) of the proportional gain. If beta
6 5 is set to 0.0, the proportional gain has value. If beta is set to 1.0, the proportional gain
has full effect. This is configurable from 0.0 to 1.5.
Enter value for gamma gain. This is the weight (multiplier) of the derivative gain. If
7 6 gamma is set to 0.0, the derivative gain has value. If beta is set to 1.0, the derivative
gain has full effect. This is configurable from 0.0 to 1.5.
8
Select whether the CV response to the proportional and derivative gains is bumpless or
7 not.
Select if the proportional and derivative is bumpless during a loop mode change. This
8 is only enabled when the integral gain is set to 0

Item Description
1 Select to enable Auto Loop mode.
1 2 Select to enable Manual Loop mode.
2 3 Select to enable Cascade Loop mode.
4 Select to enable ratio multiplier in Cascade mode.
3
5 Select to disable normal loop made selection
4 6 Select to choose manual as the normal loop mode
7 Select to choose auto as the normal loop mode
8 Select to choose cascade as the normal loop mode.
5
6
7
8

284 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Select to keep the Loop mode what it was at powerdown.
2 Select to set the Loop mode to Manual on powerup.
1
3 Select to set the Loop mode to Auto on powerup.
2
4 Select to set the loop mode to Cascade on powerup.
3 Enter a value to apply to the loop CV (in percent) on controller powerup. The CV is set to this
4 5 value on controller powerup in Run mode and on controller transition from Program mode
to Run mode.
Enter a value to apply to the loop setpoint (in PV engineering units) on controller powerup.
The setpoint is set to this value on controller powerup in Run mode and on controller
5 6 transition from Program mode
to Run mode.
6
7 Select to set the loop mode to the Normal loop mode on powerup.

7
8

Item Description
Select to set the Loop mode to Manual when the Use CVInit Value input is true. The loop is
1 left in manual with the CV at the initialization value when the initialization request clears.
1 Clear this checkbox to leave the loop in its current mode on an initialization request.
When the initialization request clears, the loop resumes controlling in its previous mode.
2
Select to have the current PV copied to the SP (track) whenever the loop is in Manual
2
3 mode.
Select to skip the setpoint rate of change limiting in Interlock Trip, Maintenance, or
4 3 Override.
5 4 Select to allow navigation to the setpoint Ramp Wizard Display from the Operator tab.
Enter a value for maximum deviation between SP and PV. If the deviation exceeds this
5
6 value, the SP ramp pauses until the PV returns to a value within the set deviation.
6 Select to disable CV clamping during Manual mode.
7
7 Select to disable CV rate of change during Manual mode.
8 Select to enable CV reset feedback tracking. This keeps the CV from ramping if the output
8 device or inner loop is significantly slower.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 285

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Enter gain for CV tracking.
1 Select so that when this parameter is:
• On, the operator settings track the program settings when command source is
2 Program, and program settings track the operator settings when the command source
2 is Operator. Transition between command sources is bumpless.
3 • Off, the operator settings and program settings retain their values regardless of
command source. When the command source is changed, the value of a limit can
change, such as from the Programset value to the Operator-set value.
4
Select so that Program and operator settings track when the command source is Hand or
3
5 Override.
4 Select to bypass Interlocks that can be bypassed while in Override command source.
5 Select the PV failure trigger.

Item Description
1 Possible Failures
1 2 For the given failure, do not change the CV operation, keep controlling.
3 For the given failure, hold the CV at the current value.
4 For the given failure, set the CV to the configured value.
2 5 For the given failure, do not change the SP operation.
3 6 For the given failure, hold the SP at the current value.
4
7 For the given failure, set the SP to the configured value.
8 For the given failure, have SP track the current PV value.
5
6 9 For the given failure, keep current loop mode.
7 10 For the given failure, set the loop mode to manual.
8 11 For the given failure, If loop made is cascade set to auto.

9
10
11

286 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
Select to keep control of loop mode commands with the Operator, Program, External, or
1 Follow the Source even if the instruction is in Program mode.
Select to keep control of the controlled variable quantity setting with the Operator,
2 Program, External, or Follow the Source even if the instruction is in Program mode.
Select to keep control of the setpoint settings with the Operator, Program, External, or
3 Follow the Source even if the instruction is in Program mode.
1 Select to keep control of the ratio settings with the Operator, Program, External, or Follow
4
2 the Source even if the instruction is in Program mode.

3
4

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Enter the PV engineering units for display on the HMI.
2 Enter the CV engineering units for display on the HMI. Percent (%) is the default
3 Enter in the number of decimal places that are displayed for the Process Variable
4 Enter in the number of decimal places that are displayed for the Control Variable
1 5 Enter the number of decimal places that are displayed for the ratio (cascade)
2 6 Select to enable navigation to the Interlock object.

3
4
5
6

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 287

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Item Description
1 Select to allow Operator to shelve alarm.
2 Select to allow Maintenance to disable alarm.
1 Select to configure operator command confirmation. This action would take place
3
2 after any operator command.
4 Select to configure if a Historical data source will be used or not.
3

Item Description
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
1 to true.)
1 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.
2 2 Select to enable navigation to the CV object.
3 Select to enable navigation to the PV object.
3 4 Select to enable navigation to Cascade SP object.

ProcessPermissive
(PPERM) Graphic Symbols Graphic Symbol Graphic Symbol Description
Name

GO_PPERM Standard Permissive Global Object.

288 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Permissive States
Image Description

Not ready to run or energize. One or more permissive conditions are not OK.

Ready to run or energize. One or more conditions that can be bypassed are not OK, but these
conditions are bypassed. All conditions that cannot be bypassed are OK.

Ready to run or energize. All permissive conditions are OK.

Ready to run or energize, and all permissive conditions are OK, conditions that can be
bypassed are being bypassed and the equipment is not shut down.

The overall graphic symbol includes a touch field over it that opens the
faceplate. Hover the pointing device over the graphic symbol to display a
tooltip that describes the function of the symbol.

Process Permissive There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PPERM) Faceplates

Operator

The Faceplate initially opens to the Operator (Home) tab. From here, an
operator can monitor the device status.
• The Operator tab shows the following information:
• Permissive bypass status indicator (Enabled, Bypassed)

Each configured permissive along with the current state of the permissive

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 289

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

If navigation is enabled, Select the condition to open the faceplate of the object
that is associated with the condition.

Maintenance

Item Description
Select an active permissive, one that has a white checkbox, to enable
1 bypass of that individual permissive.

290 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

1 2 3
Item Description
Enter the text description of each permissive condition used. Only the permissives with text
1 entered appear on the Operator tab of the faceplate.
2 Selects the state of the corresponding permissive that is the OK to Run state.
3 Select to indicate that the corresponding permissive can be bypassed.

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
Select to enable navigation to an object with more information (Cfg_HasMoreObj is set
to true.)
1 This can be configured to navigate to an object backing tag or a UDT tag that has
Instruction and Library defined.
2 Select to allow navigation to Permissive Input objects.
1

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 291

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Pressure/
Temperature Compensated Graphic Symbol Name Graphic Symbol Description
Flow (PPTC) Graphic
Standard pressure / temperature compensated
Symbols GO_PPTC flow graphic symbol

Process Pressure/ There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Temperature Compensated
Flow (PPTC) Faceplates
Operator

Item Description
1 1 The compensated flow (at standard temperature and pressure).
2 Actual (measured) uncompensated flow in volumetric units.
2 3 The actual (measured) pressure. Can be absolute or common units.
3 4 The actual (measured) temperature.

Advanced Maintenance

Item Description
1 Enter the flow value. Any flow below this value will be reported as 0.
1

292 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

Item Description
1 Enter the full-scale differential pressure reference.
1 2 Enter the flow at the reference differential pressure.
3 Enter the zero input-unit pressure. This is the pressure offset (usually 14.696 PSIA).
2
Enter the zero input-unit temperature. This is the temperature offset (usually 273.15 K
4
3 or 459.67 Rankine).
5 Enter the standard pressure value.
4 6 Enter the standard temperature value.
5 7 Select the flow calculation method.

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Displays units

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 293

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Process Restart Inhibit

(PRI) Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PRI Standard Restart Inhibit Graphic Symbol.

Process Restart Inhibit There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
(PRI) Faceplates

Operator

4 5 6 7

Item Description
1 Enter the time, in hours, for a stopped hot motor to cool.
2 Enter the time, in hours, during which three motor starts turn a cold motor to hot.
3 Enter the time, in hours, to wait after failing to start a cold motor the first time.
4 Enter the time, in hours, to wait after failing to start a cold motor two or more times.
5 Enter the time, in hours, to wait after failing to start a hot motor the first time.
6 Enter the time, in hours, to wait after failing to start a hot motor two or more times.
7 Enter the time, in hours, to wait after stopping a running hot motor.

294 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Process Run Time (PRT)

Graphic Symbols Graphic Symbol Name Graphic Symbol Description

GO_PRT Standard Run Time Graphic Symbol.

Process Run Time (PRT) There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Faceplates

Operator

Item Description
1 Select to clear maximum continuous running time for any given start.
2 Select to clear total running time.
1 3 Select to clear total number of motor starts or start attempts.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 295

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Process Tank Strapping

Table (PTST) Graphic Graphic Symbol Name Graphic Symbol Description
Symbols
GO_PTST Standard tank strapping table graphic symbol

Process Tank Strapping There are basic faceplate attributes that are common across all instructions.
See Basic Faceplate Attributes on page 29.
Table (PTST) Faceplates

Operator

Item Description
1 Displays gross tank volume.
1
2 Displays free water volume.
2 3 Displays raw (observed) volume.
4 Displays calculated tank temperature.
3 5 Displays correction for tank temperature
4 6 Displays floating roof adjustment volume

296 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

Engineering

Item Description
1 Enter temperature of tank calibration (typically 60 F or 15 C)
1 2 Enter degrees API for which the table includes floating roof data.
3 Enter the lowest level at which to add or subtract floating roof compensation.
2 Enter adjustment to table values for API <> CalAPI (volume/degress API, typically a
4 negative number).
3 5 Enter temperature weighting (0.0 for insulated tank). See API MPMS 2.2A Appendix D.
Enter table minor units in inches, cm, mm, per major unit (feet or meters). Enter 0.0 if
6
4 minor units are not used.
Enter tank shell linear coefficient of thermal expansion (1 per degree Fahrenheit or 1
7 per Celsius).
5

Item Description
1 Select to include the tank shell temperature correction.
1 2 Select to include the floating roof adjustment for calculating fluid level.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 297

Chapter 13 Graphic Symbols and Faceplates for PlantPAx Instructions

HMI Configuration

The HMI configuration tab has settings that are common to the objects. See
page 31 for descriptions of the common settings.

Item Description
1 Display units
2 Select to enable navigation to another object as a reference.

298 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix A

FactoryTalk View Customization Tool

Overview This customization tool lets you create a color palette to change the colors for global
objects and displays.

The Color Change tool uses three types of files:

• FactoryTalk® View Graphics .xml file: This file is exported from the
FactoryTalk View graphic (display or global object) in the View Studio
software program. Once changes are made, it is imported into the
View Studio software program to change the colors in the display or
global object.
• Color Association File: This .xml file matches a color instance in the
FactoryTalk View Graphics .xml file to the color palette entry. There is one
Color Association File (CAXML) for each FactoryTalk View Graphics .xml
file. The tool creates and maintains the CAXML file.
• Color Palette: This .xml file defines the colors for an application. The tool
creates and maintains the .xml file. There is one color palette file for all
FactoryTalk View Graphics .xml files that are being customized. If you want to
change the color, it is done in the color palette.

TIP We suggest that you make a copy of the color palette .xml file if you
plan to use the color tool.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 299

Appendix A FactoryTalk View Customization Tool

Install Tool File Obtain the Color Change tool as part of the Library of Process Objects download
from the Product Compatibility and Download Center at
http://www.rockwellautomation.com/rockwellautomation/support/
downloads.page.

Access the tool from the Process Library download. Choose RA>Process Library
vX.X>Tools & Utilities>FTView Customization Tool - Color Change Tool and
double-click FTViewCustomizationSetup.msi.

This file installs the program and adds a shortcut to the Start menu under ‘PlantPAx®.’

300 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix A FactoryTalk View Customization Tool

Use the Tool with Library The download includes .xml exports for all global objects and display files in the
library (for FactoryTalk View SE software). Make sure that you also download the
Objects CAXML and Process Library Standard Colors .xml files.

Follow these steps to change colors in the process library.

1. From the Process Library Customization Tool File menu, Select Open Graphic
XML File.

The Open Graphics XML Files dialog box appears.

Multiple global object and display files can be opened simultaneously from the
file open dialog box.
2. Select the Colors tab and choose Open Color Palette.

3. Select the colors that you want to change in the palette.

4. To select a new color, Select the Choose Color icon.

5. Repeat step 4 to change each color.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 301

Appendix A FactoryTalk View Customization Tool

6. To see where a color is used, right-click a color and choose

Search for Instances.

7. To save all graphic files (along with their association files) and the color palette

file, Select Save All .

8. Import the files into the FactoryTalk View software program.

There are bulk import files for the displays
(BatchImport_Displays_PlantPAx)Library.xml) and global objects
(BatchImport_Global_PlantPAx)Library.xml).

302 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix A FactoryTalk View Customization Tool

Modifying the Color Palette

The color palette appears in a tree format that shows a parent-child relationship
between colors. ‘Base Colors’ are shown with a color box next to them.
‘Reference Colors’ reference either a Base Color or another Reference Color.

By changing a Base Color, all Reference Colors under it change. For example, you can
create a generic Base Color, called ‘Energized’, and then reference it with the
Reference Color, called ‘Running’.

Do not delete Color palette entries unless they are known to be unused. To see if a
color palette entry is being used, right-click the color and choose ‘Find Color
Instances’.

Any color palette entry (Reference or Base Color) can be moved to reference another
color. This action is done by simply dragging the color to be moved and dropping it
on the new color to reference. When a color that has references is moved, all of its
references move as well.

To make a Reference Color a Base Color, right-click the Reference Color and select
‘Make Base Color’ from the context menu.

Color palette entries are stored with an integer code. That integer code is used in the
association file. Renaming a color palette entry does not break any existing
associations. Multiple color palette entries can have the same name, but this practice is
not recommended.

Follow these color palette considerations:

• Once a color palette entry is deleted and the palette is saved, the only way to
restore associations is to recreate them manually.
• Object names in FactoryTalk View software usually have a number on the end.
Names are considered to be similar if they are the same after the ending number
is removed.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 303

Appendix A FactoryTalk View Customization Tool

Use the Tool with Other The color palette must be applied to FactoryTalk View software files that are not part
of the Rockwell Automation® Library. Graphic elements in the file must be associated
FactoryTalk View Software to the color palette. You must create associations and save them in a color association
Files file. When opening an .xml graphics file, if the file already has an association file
(CAXML), it is automatically opened as well. If an association file does not exist, it is
created.

Follow these steps to create associations.

1. From the Process Library Customization Tool File menu, Select Open Graphic
XML File.
The Open Graphics XML Files dialog box appears.
2. Select an object from the tree on the left, and its colors appear in the center of
the screen.
3. To associate a color from the palette, select the palette color and drag it to the
text box next to the color display box.
Once all colors for an object are associated with the color palette, a check
appears next to the object in the tree.
Colors that are used for the object only are displayed. For example, if an object
is configured as ‘Transparent’, its background color does not show up in the
tool. Also, instances of global objects from display files do not appear in the
object tree. The tree can be configured to show instances of global objects.
These objects do not have any color instances because their parent global
objects control their colors.
4. Copy and paste functions have been included to allow quick creation of color
associations. To use these functions, right-click the graphic object in the tree on
the left and a menu appears.
• Copy Color Associations: Use this function to copy the color associations
for the object. If the object is a group, the color configuration for all group
members is copied.
• Paste Color Associations (this Object only): Use this function to paste
the previously copied color associations to the selected object. This option is
not available if the selected object is a group that has members with color
associations.
• Paste Color Associations (to all group members): Use this function to
paste the previously copied color associations to the new object and all of its
members. This option is available only if the source and destination objects
are groups with members that have similar names and object types.
• Copy and Paste Color Associations to Similar Objects with Names like
'Xxxx#': This option copies the selected object and searches objects with a
similar name and object type. Color associations are copied to all objects
with similar names and types in any of the currently open graphics files. If
the objects are groups, then the group members must have similar names
and object types. Be careful when you use this feature to help prevent
unwanted changes.

304 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix B

Command Sources and Device Virtualization

Command Sources The Command Source selection determines the source of Commands and
Settings for the object. For example, when the Command Source is Operator,
the object processes Commands and Settings from the Operator.

Highlighted indicators on the object faceplate display show which sources

have requested control. If more than one source is requesting control, multiple
indicators are highlighted. The sources are shown in priority order, and the
highlighted source furthest to the left has control. If that source relinquishes
control, the next source in priority order assumes control of the object.

A triangle in the upper left corner (as seen in the following screen capture on
the icon in the far right) indicates the “Normal” command source.

Command Source Description

Operator The Operator controls the object. Operator Commands, such as OCmd_Start and
OCmd_Stop, and Operator Settings, such as OSet_SP and OSet_CV, from the HMI are
accepted.
Program
Program logic controls the object. Program Commands, such as PCmd_Start and
PCmd_Stop, and Program Settings, such as PSet_SP and PSet_CV, are accepted.

An external system or other external devices control the object via logic. External
External Commands, such as XCmd_Start and XCmd_Stop, and External Settings, such as
XSet_SP, XSet_CV, from Logic are accepted. Examples of external devices and
systems that may control an object include a SCADA master system or local pilot
devices (push buttons, switches, pilot lights).
Override Priority logic controls the object and supersedes Operator, Program, and External
control. The Override Command Input (Inp_OvrdCmd) and other Override settings are
accepted. If so configured (for example, Cfg_OvrdPermIntlk=1), bypassable interlocks
and permissives are bypassed.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 305

Appendix B Command Sources and Device Virtualization

Command Source Description

Maintenance Maintenance controls the object and supersedes Operator, Program, External, and
Override control. Operator Commands and Settings from the HMI are accepted.
Bypassable interlocks and permissives are bypassed, and feedback timeout checks
are not processed.
The object may be placed Out of Service by Maintenance from the HMI (Maintenance
Out of Service Out of Service). The object may also be placed Out of Service by scanning the
instruction false (in a ladder diagram implementation) or by exposing and wiring the
EnableIn input pin and setting it false (in a Function Block Diagram implementation).
When the object is Out of Service, outputs are held de-energized / at zero, and alarms
are inhibited.
Hand Hardwired circuits or other logic outside the instruction controls the object, ignoring
outputs of the instruction. The instruction tracks the state of the object via inputs for
bumpless transfer back to another command source.

306 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix B Command Sources and Device Virtualization

Not all Command Sources are used in every object.

P_CmdSrc Operator Program External Override Maintenance Out of Service Hand
raP_Dvc_D4SD x x x x x x x
raP_Dvc_nPos x x x x x x x
raP_Dvc_VlvMP x x x x x x x
raP_Opr_Area x x x x x
raP_Opr_Unit x x x x x
raP_Opr_EMGen x x x x x
raP_Opr_EPGen x x x x x

Virtualization Virtualization is used with device objects to simulate operation of a device

instead of controlling the actual device. Virtualization is used for such
activities as system testing or operator training, where the process is shut
down or not connected to the controller.

When a device is set to Physical operation, the actual field device I/O are
monitored or controlled, and the field device operates normally, on-process.

When a device object is set to Virtual operation, the I/O for the field device are
ignored, and the device operates in one of these manners:
• For monitored devices, such as analog and discrete inputs, a virtual
process variable (PV) is provided, either by simulation logic or by entry
form the HMI faceplate.
• For controlled devices, such as valves, motors and drives, the outputs
are held de-energized (at zero) and the object responds in a "loopback"
manner, as if an actual device were connected. So a valve object, while
keeping outputs de-energized, reports valve status to the operator and
to program logic as if the valve were opening and closing normally.

To select Virtual or Physical operation, go to the Advanced faceplate for the

device and toggle the Virtual / Physical selector.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 307

Appendix B Command Sources and Device Virtualization

Notes:

308 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix C

Tag Extended Properties and Default Alarm

Settings

Tag extended properties must be configured to drive the text on the operations
faceplate. See Logix 5000 Controllers I/O and Tag Data, publication 1756-
PM004 for more information on extended tags.

You need to select the extended properties to populate for each tag and then
enter the values.

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 309

Appendix C Tag Extended Properties and Default Alarm Settings

raP_Opr_Area
Common
raP_Opr_Area.@Description "Area"
raP_Opr_Area.@Area "Area01"
raP_Opr_Area.@Instruction "raP_Opr_Area"
raP_Opr_Area.@Label "Area"
raP_Opr_Area.@Library "raP-5_00"
raP_Opr_Area.@URL ""
raP_Opr_Area.Cfg_HasMoreObj.@Navigation ""

General
raP_Opr_Area.Sts_ExtddAlms.@Label "Extended alarm"

Alarms Alarm Default Message Severity

raP_Opr_Area.Sts_EStopTrip.@Label “Emergency stop” "/*S:0 %.@Description*/: Emergency stop 750
raP_Opr_Area.Sts_SStopTrip.@Label “Software stop” "/*S:0 %.@Description*/: Software stop 750

raP_Opr_Unit
Common
raP_Opr_Unit.@Description "Unit"
raP_Opr_Unit.@Area "Area01"
raP_Opr_Unit.@Instruction "raP_Opr_Unit"
raP_Opr_Unit.@Label "Unit"
raP_Opr_Unit.@Library "raP-5_00"
raP_Opr_Unit.@URL ""
raP_Opr_Unit.Cfg_HasMoreObj.@Navigation ""

General
raP_Opr_Unit.Sts.0.@Description "State 0"
raP_Opr_Unit.Sts.1.@Description "State 1"
raP_Opr_Unit.Sts.2.@Description "State 2"
raP_Opr_Unit.Sts.3.@Description "State 3"
raP_Opr_Unit.Sts_ExtddAlms.@Label "Extended alarm"
"Group Command
raP_Opr_Unit.XCmd.0.@Description 0"
raP_Opr_Unit.XCmd.1.@Description ""
raP_Opr_Unit.XCmd.2.@Description ""
raP_Opr_Unit.XCmd.3.@Description ""
raP_Opr_Unit.Val_Actl.@EngineeringUnit "Kg"

Alarms Alarm Default Message Severity

raP_Opr_Unit.Sts_EStopTrip.@Label "Emergency stop” "/*S:0 %.@Description*/: Emergency stop 750
raP_Opr_Unit.Sts_GroupCmd1Fail.@Label "Group Command 1 Failed” "/*S:0 %.@Description*/: Group Command 1 Failed 500
raP_Opr_Unit.Sts_GroupCmd2Fail.@Label "Group Command 2 Failed” "/*S:0 %.@Description*/: Group Command 2 Failed 500
raP_Opr_Unit.Sts_GroupCmd3Fail.@Label "Group Command 3 Failed” "/*S:0 %.@Description*/: Group Command 3 Failed 500
raP_Opr_Unit.Sts_GroupCmd4Fail.@Label "Group Command 4 Failed” "/*S:0 %.@Description*/: Group Command 4 Failed 500
raP_Opr_Unit.Sts_IntlkTrip.@Label "Interlock trip” "/*S:0 %.@Description*/: Interlock trip 500
raP_Opr_Unit.Sts_SStopTrip.@Label "Software stop” "/*S:0 %.@Description*/: Software stop 750

310 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix C Tag Extended Properties and Default Alarm Settings

raP_Opr_EMGen
Common
raP_Opr_EMGen.@Description "Generic Equipment Module"
raP_Opr_EMGen.@Area "Area01"
raP_Opr_EMGen.@Instruction "raP_Opr_EMGen"
raP_Opr_EMGen.@Label "Equipment Module"
raP_Opr_EMGen.@Library "raP-5_00"
raP_Opr_EMGen.@URL ""
raP_Opr_EMGen.Cfg_HasMoreObj.@Navigation ""

General
raP_Opr_EMGen.Cfg_HasDetailDisplay.@Navigation ""
raP_Opr_EMGen.Sts.0.@Description "State 1"
raP_Opr_EMGen.Sts.1.@Description "State 2"
raP_Opr_EMGen.Sts.2.@Description "State 3"
raP_Opr_EMGen.Sts.3.@Description "State 4"
raP_Opr_EMGen.Sts.4.@Description "State 5"
raP_Opr_EMGen.Sts.5.@Description "State 6"
raP_Opr_EMGen.Sts.6.@Description "State 7"
raP_Opr_EMGen.Sts.7.@Description "State 8"
raP_Opr_EMGen.Sts.8.@Description "State 9"
raP_Opr_EMGen.Sts.9.@Description "State 10"
raP_Opr_EMGen.Sts.10.@Description "State 11"
raP_Opr_EMGen.Sts.11.@Description "State 12"
raP_Opr_EMGen.Sts.12.@Description "State 13"
raP_Opr_EMGen.Sts.13.@Description "State 14"
raP_Opr_EMGen.Sts.14.@Description "State 15"
raP_Opr_EMGen.Sts.15.@Description "State 16"
raP_Opr_EMGen.Sts.16.@Description "State 17"
raP_Opr_EMGen.Sts.17.@Description "State 18"
raP_Opr_EMGen.Sts.18.@Description "State 19"
raP_Opr_EMGen.Sts.19.@Description "State 20"
raP_Opr_EMGen.Sts.20.@Description "State 21"
raP_Opr_EMGen.Sts.21.@Description "State 22"
raP_Opr_EMGen.Sts.22.@Description "State 23"
raP_Opr_EMGen.Sts.23.@Description "State 24"
raP_Opr_EMGen.Sts.24.@Description "State 25"
raP_Opr_EMGen.Sts.25.@Description "State 26"
raP_Opr_EMGen.Sts.26.@Description "State 27"
raP_Opr_EMGen.Sts.27.@Description "State 28"
raP_Opr_EMGen.Sts.28.@Description "State 29"
raP_Opr_EMGen.Sts.29.@Description "State 30"
raP_Opr_EMGen.Sts.30.@Description "State 31"
raP_Opr_EMGen.Sts.31.@Description "State 32"
raP_Opr_EMGen.Sts_ExtddAlms.@Label "Extended alarm"
raP_Opr_EMGen.XCmd.0.@Description "Command 1"
raP_Opr_EMGen.XCmd.1.@Description ""
raP_Opr_EMGen.XCmd.2.@Description ""
raP_Opr_EMGen.XCmd.3.@Description ""
raP_Opr_EMGen.XCmd.4.@Description ""
raP_Opr_EMGen.XCmd.5.@Description ""
raP_Opr_EMGen.XCmd.6.@Description ""
raP_Opr_EMGen.XCmd.7.@Description ""

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 311

Appendix C Tag Extended Properties and Default Alarm Settings

General
raP_Opr_EMGen.XCmd.8.@Description ""
raP_Opr_EMGen.XCmd.9.@Description ""
raP_Opr_EMGen.XCmd.10.@Description ""
raP_Opr_EMGen.XCmd.11.@Description ""
raP_Opr_EMGen.XCmd.12.@Description ""
raP_Opr_EMGen.XCmd.13.@Description ""
raP_Opr_EMGen.XCmd.14.@Description ""
raP_Opr_EMGen.XCmd.15.@Description ""
raP_Opr_EMGen.XCmd.16.@Description ""
raP_Opr_EMGen.XCmd.17.@Description ""
raP_Opr_EMGen.XCmd.18.@Description ""
raP_Opr_EMGen.XCmd.19.@Description ""
raP_Opr_EMGen.XCmd.20.@Description ""
raP_Opr_EMGen.XCmd.21.@Description ""
raP_Opr_EMGen.XCmd.22.@Description ""
raP_Opr_EMGen.XCmd.23.@Description ""
raP_Opr_EMGen.XCmd.24.@Description ""
raP_Opr_EMGen.XCmd.25.@Description ""
raP_Opr_EMGen.XCmd.26.@Description ""
raP_Opr_EMGen.XCmd.27.@Description ""
raP_Opr_EMGen.XCmd.28.@Description ""
raP_Opr_EMGen.XCmd.29.@Description ""
raP_Opr_EMGen.XCmd.30.@Description ""
raP_Opr_EMGen.XCmd.31.@Description ""

Alarms Alarm Default Message Severity

raP_Opr_EMGen.Sts_DvcAlms.@Label "Device alarm” "/*S:0 %.@Description*/: Device alarm 500
raP_Opr_EMGen.Sts_IntlkTrip.@Label "Interlock trip” "/*S:0 %.@Description*/: Interlock trip 500
raP_Opr_EMGen.Sts_RptData.@Label "Report data not collected” "/*S:0 %.@Description*/: Report data 500

312 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix C Tag Extended Properties and Default Alarm Settings

raP_Opr_EPGen
Common
raP_Opr_EPGen.@Description "Generic Equipment Phase"
raP_Opr_EPGen.@Area "Area01"
raP_Opr_EPGen.@Instruction "raP_Opr_EPGen"
raP_Opr_EPGen.@Label "Equipment Phase"
raP_Opr_EPGen.@Library "raP-5_00"
raP_Opr_EPGen.@URL ""
raP_Opr_EPGen.Cfg_HasMoreObj.@Navigation ""

General
#2.Cfg_HasDetailDisplay.@Navigation ""
#2.Sts_ExtddAlms.@Label "Extended alarm"

Alarms Alarm Default Message Severity

raP_Opr_EPGen.Sts_DvcAlms.@Label "Device alarm” "/*S:0 %.@Description*/: Device alarm 500
raP_Opr_EPGen.Sts_IntlkTrip.@Label "Interlock trip” "/*S:0 %.@Description*/: Interlock trip 500
"Report data not
raP_Opr_EPGen.Sts_RptData.@Label collected” "/*S:0 %.@Description*/: Report data 500

raP_Dvc_D4SD
Common
raP_Dvc_D4SD.@Description "Discrete 2-, 3- or 4- State Device"
raP_Dvc_D4SD.@Area "Area01"
raP_Dvc_D4SD.@Instruction "raP_Dvc_D4SD"
raP_Dvc_D4SD.@Label "Discrete Device"
raP_Dvc_D4SD.@Library "raP-5_00"
raP_Dvc_D4SD.@URL ""
raP_Dvc_D4SD.Cfg_HasMoreObj.@Navigation ""

General
raP_Dvc_D4SD.Sts_St0.@Label "State 0"
raP_Dvc_D4SD.Sts_St1.@Label "State 1"
raP_Dvc_D4SD.Sts_St2.@Label "State 2"
raP_Dvc_D4SD.Sts_St3.@Label "State 3"

Alarms Alarm Default Message Severity

raP_Dvc_D4SD.Sts_Sts_EqpFault.@Label "Equipment fault” "/*S:0 %.@Description*/: Device-reported Equipment Fault 1000
raP_Dvc_D4SD.Sts_Sts_Fail.@Label "Position fail” "/*S:0 %.@Description*/: Fail to Achieve State 1000
raP_Dvc_D4SD.Sts_Sts_IntlkTrip.@Label "Interlock trip” "/*S:0 %.@Description*/: Interlock trip 500
raP_Dvc_D4SD.Sts_Sts_Sts_IOFault.@Label "IO fault” "/*S:0 %.@Description*/: I/O Fault 1000

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 313

Appendix C Tag Extended Properties and Default Alarm Settings

raP_Dvc_VlvMP
Common
raP_Dvc_VlvMP.@Description "Mix Proof Valve"
raP_Dvc_VlvMP.@Area "Area01"
raP_Dvc_VlvMP.@Instruction "raP_Dvc_VlvMP"
raP_Dvc_VlvMP.@Label "Valve Control"
raP_Dvc_VlvMP.@Library "raP-5_00"
raP_Dvc_VlvMP.@URL ""
raP_Dvc_VlvMP.Cfg_HasMoreObj.@ ""
Navigation

Alarms Alarm Default Message Severity

raP_Dvc_VlvMP.Sts_Sts_Fail.@Label "Position fail” "/*S:0 %.@Description*/: Fail to achieve position 1000
raP_Dvc_VlvMP.Sts_Sts_IOFault.@Label "IO fault” "/*S:0 %.@Description*/: I/O Fault 1000
raP_Dvc_VlvMP.Sts_Sts_IntlkTrip.@Label "Interlock trip” "/*S:0 %.@Description*/: Interlock trip 500

314 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix C Tag Extended Properties and Default Alarm Settings

raP_Dvc_nPos
Common
raP_Dvc_nPos.@Description "n-Position Device"
raP_Dvc_nPos.@Area "Area01"
raP_Dvc_nPos.@Instruction "raP_Dvc_nPos"
raP_Dvc_nPos.@Label "n-Position Device"
raP_Dvc_nPos.@Library "raP-5_00"
raP_Dvc_nPos.@URL ""
raP_Dvc_nPos.Cfg_HasMoreObj.@Navigation ""

General
raP_Dvc_nPos.Sts_Pos01.@Label "Postion 1"
raP_Dvc_nPos.Sts_Pos02.@Label "Postion 2"
raP_Dvc_nPos.Sts_Pos03.@Label "Postion 3"
raP_Dvc_nPos.Sts_Pos04.@Label "Postion 4"
raP_Dvc_nPos.Sts_Pos05.@Label "Postion 5"
raP_Dvc_nPos.Sts_Pos06.@Label "Postion 6"
raP_Dvc_nPos.Sts_Pos07.@Label "Postion 7"
raP_Dvc_nPos.Sts_Pos08.@Label "Postion 8"
raP_Dvc_nPos.Sts_Pos09.@Label "Postion 9"
raP_Dvc_nPos.Sts_Pos10.@Label "Postion 10"
raP_Dvc_nPos.Sts_Pos11.@Label "Postion 11"
raP_Dvc_nPos.Sts_Pos12.@Label "Postion 12"
raP_Dvc_nPos.Sts_Pos13.@Label "Postion 13"
raP_Dvc_nPos.Sts_Pos14.@Label "Postion 14"
raP_Dvc_nPos.Sts_Pos15.@Label "Postion 15"
raP_Dvc_nPos.Sts_Pos16.@Label "Postion 16"
raP_Dvc_nPos.Sts_Pos17.@Label "Postion 17"
raP_Dvc_nPos.Sts_Pos18.@Label "Postion 18"
raP_Dvc_nPos.Sts_Pos19.@Label "Postion 19"
raP_Dvc_nPos.Sts_Pos20.@Label "Postion 20"
raP_Dvc_nPos.Sts_Pos21.@Label "Postion 21"
raP_Dvc_nPos.Sts_Pos22.@Label "Postion 22"
raP_Dvc_nPos.Sts_Pos23.@Label "Postion 23"
raP_Dvc_nPos.Sts_Pos24.@Label "Postion 24"
raP_Dvc_nPos.Sts_Pos25.@Label "Postion 25"
raP_Dvc_nPos.Sts_Pos26.@Label "Postion 26"
raP_Dvc_nPos.Sts_Pos27.@Label "Postion 27"
raP_Dvc_nPos.Sts_Pos28.@Label "Postion 28"
raP_Dvc_nPos.Sts_Pos29.@Label "Postion 29"
raP_Dvc_nPos.Sts_Pos30.@Label "Postion 30"

Alarms Alarm Default Message Severity

raP_Dvc_nPos.Sts_Sts_IOFault.@Label "IO fault” "/*S:0 %.@Description*/: I/O Fault 1000
raP_Dvc_nPos.Sts_Sts_IntlkTrip.@Label "Interlock trip” "/*S:0 %.@Description*/: Interlock trip 500
raP_Dvc_nPos.Sts_Sts_LockFail.@Label "Lock / Unlock failure” "/*S:0 %.@Description*/: Device lock or seal failure 1000
raP_Dvc_nPos.Sts_Sts_PosFail.@Label "Position fail” "/*S:0 %.@Description*/: Device failed to reach commanded position 1000

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 315

Appendix C Tag Extended Properties and Default Alarm Settings

raP_Opr_ExtddAlm
Common
raP_Opr_ExtddAlm.@Description "Extended alarm"
raP_Opr_ExtddAlm.@Area "Area01"
raP_Opr_ExtddAlm.@Instruction "raP_Opr_ExtddAlm"
raP_Opr_ExtddAlm.@Label "Alarm"
raP_Opr_ExtddAlm.@Library "raP-5_00"
raP_Opr_ExtddAlm.@URL ""

raP_Tec_ParRpt
Common
raP_Tec_ParRpt_PAR_XX.@Description "Parameter"
raP_Tec_ParRpt_PAR_XX.@Area "Area01"
raP_Tec_ParRpt_PAR_XX.@Instruction "raP_Tec_ParRpt"
raP_Tec_ParRpt_PAR_XX.@Label "Parameter Label"
raP_Tec_ParRpt_PAR_XX.@Library "raP-5_00"
raP_Tec_ParRpt_PAR_XX.@URL ""
raP_Tec_ParRpt_PAR_XX.@EngineeringUnit "%"
raP_Tec_ParRpt_RPT_XX.@Description "Report"
raP_Tec_ParRpt_RPT_XX.@Area "Area01"
raP_Tec_ParRpt_RPT_XX.@Instruction "raP_Tec_ParRpt"
raP_Tec_ParRpt_RPT_XX.@Label Report Label"
raP_Tec_ParRpt_RPT_XX.@Library "raP-5_00"
raP_Tec_ParRpt_RPT_XX.@URL ""
raP_Tec_ParRpt_RPT_XX.@EngineeringUnit "%"

raP_Opr_Prompt
Common
raP_Opr_Prompt.@Description "Operator Prompt"
raP_Opr_Prompt.@Area "Area01"
raP_Opr_Prompt.@Instruction "raP_Opr_Prompt"
raP_Opr_Prompt.@Label "Prompt"
raP_Opr_Prompt.@Library "raP-5_00"
raP_Opr_Prompt.@URL ""
raP_Opr_Prompt.Cfg_HasMoreObj.@Navigation ""

316 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Appendix C Tag Extended Properties and Default Alarm Settings

raP_Opr_Prompt_Core
Common
raP_Opr_Prompt.@Description "Operator Prompt"
raP_Opr_Prompt.@Area "Area01"
raP_Opr_Prompt.@Instruction "raP_Opr_Prompt"
raP_Opr_Prompt.@Label "Prompt"
raP_Opr_Prompt.@Library "raP-5_00"
raP_Opr_Prompt.@URL ""
raP_Opr_Prompt.Cfg_HasMoreObj.@Navigation ""

raP_Dvc_LgxTaskMon
Common
raP_Dvc_LgxTaskMon.@Description "Logix Task Monitor"
raP_Dvc_LgxTaskMon.@Area "Area01"
raP_Dvc_LgxTaskMon.@Instruction "raP_Dvc_LgxTaskMon"
raP_Dvc_LgxTaskMon.@Label "Logix Task Monitor"
raP_Dvc_LgxTaskMon.@Library "raP-5_00"
raP_Dvc_LgxTaskMon.@URL ""

raP_Dvc_LgxChangeDet
Common
raP_Dvc_LgxChangeDet.@Description "Logix Change Detector"
raP_Dvc_LgxChangeDet.@Area "Area01"
"raP_Dvc_LgxChangeDet
raP_Dvc_LgxChangeDet.@Instruction "
raP_Dvc_LgxChangeDet.@Label "Controller Name"
raP_Dvc_LgxChangeDet.@Library "raP-5_00"
raP_Dvc_LgxChangeDet.@URL ""
raP_Dvc_LgxChangeDet.Cfg_HasMoreObj.@Navigation ""

raP_Dvc_LgxRedun
Common
"Logix Redundant
raP_Dvc_LgxRedun.@Description Controller Monitor"
raP_Dvc_LgxRedun.@Area "Area01"
raP_Dvc_LgxRedun.@Instruction "raP_Dvc_LgxRedun"
raP_Dvc_LgxRedun.@Label "Redundant Controller"
raP_Dvc_LgxRedun.@Library "raP-5_00"
raP_Dvc_LgxRedun.@URL ""

raP_Dvc_LgxModuleSts
Common
raP_Dvc_LgxModuleSts.@Description "Logix - Module Status"
raP_Dvc_LgxModuleSts.@Area "Area01"
raP_Dvc_LgxModuleSts.@Instruction "raP_Dvc_LgxModuleSts"

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 317

Appendix C Tag Extended Properties and Default Alarm Settings

Common
raP_Dvc_LgxModuleSts.@Label "Module Name"
raP_Dvc_LgxModuleSts.@Library "raP-5_00"
raP_Dvc_LgxModuleSts.@URL ""

raP_Dvc_LgxCPU_5x80
Common
raP_Dvc_LgxCPU_5x80.@Description "Processor utilization (5380/5580, v33 and later)"
raP_Dvc_LgxCPU_5x80.@Area "Area01"
raP_Dvc_LgxCPU_5x80.@Instruction "raP_Dvc_LgxCPU_5x80"
raP_Dvc_LgxCPU_5x80.@Label ""
raP_Dvc_LgxCPU_5x80.@Library "raP-5_00"
raP_Dvc_LgxCPU_5x80.@URL ""
raP_Dvc_LgxCPU_5x80.Cfg_HasMoreObj.@Navigation ""

raP_Opr_ArbitrationQ
Common
raP_Opr_ArbitrationQ.@Description ""
raP_Opr_ArbitrationQ.@Area "Area01"
raP_Opr_ArbitrationQ.@Instruction ""
raP_Opr_ArbitrationQ.@Label ""
raP_Opr_ArbitrationQ.@Library "raP-5_00"
raP_Opr_ArbitrationQ.@URL ""

raP_Opr_OrgScan
Common
raP_Opr_OrgScan.@Description ""
raP_Opr_OrgScan.@Area "Area01"
raP_Opr_OrgScan.@Instruction ""
raP_Opr_OrgScan.@Label ""
raP_Opr_OrgScan.@Library "raP-5_00"
raP_Opr_OrgScan.@URL ""

raP_Opr_OrgView
Common
raP_Opr_OrgView.@Description ""
raP_Opr_OrgView.@Area "Area01"
raP_Opr_OrgView.@Instruction ""
raP_Opr_OrgView.@Label ""
raP_Opr_OrgView.@Library "raP-5_00"
raP_Opr_OrgView.@URL ""

318 Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020

 Rockwell Automation Library of Process Objects Publication Type

Rockwell Automation Publication PROCES-RM200A-EN-P - October 2020 319

Rockwell Automation Support
Use these resources to access support information.

Technical Support Center Find help with how-to videos, FAQs, chat, user forums, and product notification updates. rok.auto/support
Knowledgebase Access Knowledgebase articles. rok.auto/knowledgebase
Local Technical Support Phone Numbers Locate the telephone number for your country. rok.auto/phonesupport
Literature Library Find installation instructions, manuals, brochures, and technical data publications. rok.auto/literature
Product Compatibility and Download Center Get help determining how products interact, check features and capabilities, and find rok.auto/pcdc
(PCDC) associated firmware.

Documentation Feedback
Your comments help us serve your documentation needs better. If you have any suggestions on how to improve our content, complete
the form at rok.auto/docfeedback.

Waste Electrical and Electronic Equipment (WEEE)

At the end of life, this equipment should be collected separately from any unsorted municipal waste.

Rockwell Automation maintains current product environmental information on its website at rok.auto/pec.

Allen-Bradley, ArmorStart, CompactLogix, ControlLogix, FactoryTalk, Integrated Architecture, iTRAK, Kinetix, MagneMotion, PlantPAx, PowerFlex, Stratix, Studio 5000, Studio 5000 Logix Designer,
TechConnect, Rockwell Automation, and Rockwell Software are trademarks of Rockwell Automation, Inc.
Microsoft and Windows are trademarks of Microsoft.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Rockwell Otomasyon Ticaret A.Ş. Kar Plaza İş Merkezi E Blok Kat:6 34752, İçerenkÖy, İstanbul, Tel: +90 (216) 5698400 EEE YÖnetmeliğine Uygundur

Publication PROCES-RM200A-EN-P - October 2020

Copyright © 2020 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.