Allen-Bradley PlantPAx Display and Library Reference Manual
Allen-Bradley PlantPAx Display and Library offers a comprehensive set of tools for building and deploying process control applications. It provides a library of objects and faceplates for creating HMIs, along with a framework for managing alarms, diagnostics, and navigation. The software is designed to work with Studio 5000 and FactoryTalk View SE, allowing you to create and manage your process control systems from a single platform.
PDF
Download
Document
Advertisement
Advertisement
PlantPAx Display and Library Guidelines Reference Manual Original Instructions PlantPAx Display and Library Guidelines Reference Manual 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. These 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). The following icon may appear in the text of this document. Identifies information that is useful and can help to make a process easier to do or easier to understand. 2 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Table of Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Rockwell Automation Library of Process Objects Graphic Framework Overview About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Download Firmware, AOP, EDS, and Other Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Summary of Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Rockwell Automation Services and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Process Library 5.20 Add-On Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Visualization Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 FactoryTalk View SE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Studio 5000 View Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Basic Attributes and Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 State Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Status Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Threshold Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Deviation Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Command Source Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Maintenance Bypass Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Basic Faceplate Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Operator (Home) Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Advanced Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Faults Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Trends Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Help Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Studio 5000 Logix Designer Project Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 FactoryTalk Linx Device Shortcuts Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Language Switching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Language Switching in a Controller Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Bulk Edit Translated Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Language Switching in a FactoryTalk View SE Project . . . . . . . . . . . . . . . . . . . . . . . . . 34 Language Switching in Studio 5000 View Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 FactoryTalk View SE Language Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Studio 5000 View Designer Language Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Help Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Library Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 PlantPAx Process Library Migration Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Header Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Process Control Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 L1 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 L2 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 L3 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 L1 Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 3 Table of Contents Configure the Graphic Framework Organization 4 L2 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 L3 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Alarm Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Diagnostic Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Off-Screen Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Multi-Monitor Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Alarm Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Alarm Grouping and Supporting Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Graphic Framework Builder Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 General Graphic Framework Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 PlantPAx Process Library Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Build Your PlantPAx HMI Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Recommended Application Naming Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Global Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 APP - Administrative Objects (raP-5_20-SE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 APP - Alarm Objects (raP-5_20-SE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 APP - Diagnostic Objects (raP-5_20-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 APP - Header Objects (raP-5_20-SE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Template Custom Objects (raP-5_20-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Template L1 Navigation (raP-5_20-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Template L2 L3 Navigation (raP-5_20-SE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Multi-Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 HMI Tags, Headers, and Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Create HMI Tags for Multi-Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Parameter Explanation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Template_ClientStartup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Template_Repaint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 SetRepaint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 NavToDisplay with Mixed Library / NavToFaceplate with Mixed Library . . . . . . . . . . 103 Client File Setup (.CLI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Create the Organization Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Example Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Define the Bus Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Configure the Area Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Configure the Unit Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Configure the Equipment Phase or Equipment Module Instances. . . . . . . . . . . . . . . 117 Configure the Device Instances to Use the Bus Elements . . . . . . . . . . . . . . . . . . . . . 118 Add Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Define the OrgView Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Example OrgView Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Create the Organizational Tree in the HMI Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Configure the Client Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Build the Node Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Set Start Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Node Array Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Table of Contents Ownership (raP_Opr_Owner) Arbitration (raP_Opr_ArbitrationQ) Organizational Scan (raP_Opr_OrgScan) Organizational View (raP_Opr_OrgView) Ownership. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Request Ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Arbitration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Programming Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Programming Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Programming Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 5 Table of Contents Process Area Module (raP_Opr_Area) Process Unit (raP_Opr_Unit) 6 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Programming Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Command Source Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Operator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Advanced Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Engineering Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Studio 5000 View Designer Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Command Source Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Program Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Local Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Operator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Advanced Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Engineering Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Studio 5000 View Designer Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Table of Contents Generic Equipment Module (raP_Opr_EMGen) Generic Equipment Phase (raP_Opr_EPGen) Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 State Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Program Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Local Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 Operator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Advanced Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Engineering Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Faults Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Studio 5000 View Designer Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Phase Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Program Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Local Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Operator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Manual Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Advanced Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Engineering Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 HMI Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 Faults Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Studio 5000 View Designer Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 7 Table of Contents Parameter and Reports (raP_Tec_ParRpt) Operator Prompt (raP_Opr_Prompt) Logix Diagnostic Objects 8 Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Parameter Program Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Reports Program Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Parameter Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Report Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Report Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Studio 5000 View Designer Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Parameter and Report Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Controller Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Command Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Operator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Engineering Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 HMI Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Studio 5000 View Designer Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Logix Change Detector (raP_Dvc_LgxChangeDet) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Graphic Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Table of Contents FactoryTalk View Customization Tool Command Sources and Device Virtualization Tag Extended Properties and Default Alarm Settings Logix Controller CPU Utilization (raP_Dvc_LgxCPU_5x80) . . . . . . . . . . . . . . . . . . . . . . . . . 223 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Graphic Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Logix Redundant Controller Monitor (raP_Dvc_LgxRedun). . . . . . . . . . . . . . . . . . . . . . . . . 233 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Graphic Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 Logix Module Status (raP_Dvc_LgxModuleSts) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Programming Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Graphic Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 Logix Task Monitor (raP_Dvc_LgxTaskMon) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 Graphic Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 FactoryTalk View SE Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Logix Event (raP_Tec_LgxEvent) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Programming Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Graphic Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Install Tool File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Use the Tool with Library Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Modifying the Color Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Use the Tool with Other FactoryTalk View Software Files . . . . . . . . . . . . . . . . . . . . . . . . . 260 Command Sources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Virtualization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 raP_Dvc_LgxChangeDet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 raP_Dvc_LgxCPU_5x80 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 9 Table of Contents HMI Navigation 5094-IF8IH to PAH Configuration Example 1756-IF8IH with raP_Tec_HARTChanData_to_PA H Add-On Instruction Configuration Example 10 raP_Dvc_LgxModuleSts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 raP_Dvc_LgxRedun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 raP_Dvc_LgxTaskMon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 raP_Opr_ArbitrationQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 raP_Opr_Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 raP_Opr_EMGen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 raP_Opr_EPGen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 raP_Opr_ExtddAlm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 raP_Opr_OrgScan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 raP_Opr_OrgView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 raP_Opr_Prompt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 raP_Opr_Prompt_Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 raP_Opr_Unit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 raP_Tec_ParRpt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 Tag Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271 Download and install the 5094 HART Analog Add-On Profile . . . . . . . . . . . . . . . . . . . . . . . 277 Add the 5094 Adapter Module to the Project I/O Configuration . . . . . . . . . . . . . . . . . . . . . 279 Add the 5094-IF8IH Module to the Project I/O Configuration . . . . . . . . . . . . . . . . . . . . . . . 280 Add the HART Device to the Project I/O Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 Configure the Analog Input Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 Add the PAH (Process Analog HART) and PAI (Process Analog Input) Instruction Instances to the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 Add the PAH Instruction Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 Connect PAX_HART_DEVICE:I:0 Member from Input Assembly to Ref_HARTData InOut Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 Add the PAI Instruction Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 Connect the PAH Instance to the PAI Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 Add the 1756-IF8IH Module to the Project I/O Configuration . . . . . . . . . . . . . . . . . . . . . . . 295 Configure the Channel for the HART Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 Import the raP_Tec_HARTChanData_to_PAH Add-On Instruction . . . . . . . . . . . . . . . . . . . 298 Import the I_1756IF8IH Rung into the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 Add the raP_Tec_HARTChanData_to_PAH Instance to the Project . . . . . . . . . . . . . . . . . . 303 Add the PAH and PAI Instances to the Project and Connect PAH and PAI Instances . . . . 307 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Preface About This Publication This publication Describes the PlantPAx® graphic framework, Add-On Instructions, and associated faceplates that are available to develop applications. Download Firmware, AOP, EDS, and Other Files Download firmware, associated files (such as AOP, EDS, and DTM), and access product release notes from the Product Compatibility and Download Center (PCDC) at rok.auto/pcdc. When you update software or firmware revisions, we recommend that you verify the impact on performance and memory utilization before implementing the upgrade on 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. Summary of Changes This publication contains the following new or updated information. This list includes substantive updates only and is not intended to reflect all changes. Topic PlantPAx Library Interactions updated to reflect 5.10.01 and later. Updated location of PCMDSRC instruction. It was moved into PROCES-RM215 Updated faceplates for DataLogPro Updated faceplate for Hold/Stop actions. Updated Library extended tags Updated Extended Tag Properties Added Graphic Framework Builder Tool Added new example that shows Ref_SM as an InOut parameter. Updated Faceplate for Variable State Machine Additional Resources Page 14 152, 160 Throughout 192 Throughout Appendix C 55 174 179 These documents contain additional information concerning related products from Rockwell Automation. You can view or download publications at rok.auto/literature. Resource Description Helps you understand the elements of the PlantPAx system to make sure that you buy the proper Selection Guide, publication PROCES-SG001 components. Provides direction on how to install and deploy PlantPAx virtual templates. Template User Manual, publication 9528-UM001 Provides system guidelines and instructions to assist with the development of your PlantPAx Configuration and Implementation User Manual, publication PROCES-UM100 system. Provides an overview of how to use the Rockwell Automation Sequencer Object. The manual Rockwell Automation Sequencer Object, Publication PROCES-RM202 includes a Sequencer programming demonstration, example, and configuration instructions. Describes the PlantPAx Process instructions, and associated faceplates that are available to PlantPAx Faceplates for Process Controller Instructions, publication develop applications. PROCES-RM203 This manual provides a programmer with details about the available Process instruction set for a PlantPAx Process Control Instructions, publication PROCES-RM215 Logix-based Process controller. Process Object parameters Spreadsheet, publication, PROCES-RD200 Describes the PlantPAx Process object parameters. Describes the visualization files that are required for the Library of Process Objects. PlantPAx Visualization Files, publication, PROCES-RD201 Describes how to configure and use EtherNet/IP™ devices to communicate on the EtherNet/IP EtherNet/IP Network Devices User Manual, publication ENET-UM006 network. Ethernet Reference Manual, publication ENET-RM002 Describes basic Ethernet concepts, infrastructure components, and infrastructure features. Provides guidance on how to conduct security assessments, implement Rockwell Automation System Security Design Guidelines Reference Manual, publication SECURE-RM001 products in a secure system, harden the control system, manage user access, and dispose of equipment. Assists original equipment manufacturers (OEMs) with construction of panels, to help ensure that UL Standards Listing for Industrial Control Products, publication CMPNTS-SR002 they conform to the requirements of Underwriters Laboratories. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 11 Preface Resource Description American Standards, Configurations, and Ratings: Introduction to Provides an overview of American motor circuit design based on methods that are outlined in the Motor Circuit Design, publication IC-AT001 NEC. Industrial Components Preventive Maintenance, Enclosures, and Contact Ratings Provides a quick reference tool for Allen-Bradley® industrial automation controls and assemblies. Specifications, publication IC-TD002 Designed to harmonize with NEMA Standards Publication No. ICS 1.1-1987 and provides general Safety Guidelines for the Application, Installation, and Maintenance of Solid-state guidelines for the application, installation, and maintenance of solid-state control in the form of Control, publication SGI-1.1 individual devices or packaged assemblies incorporating solid-state components. Industrial Automation Wiring and Grounding Guidelines, publication 1770-4.1 Provides general guidelines for installing a Rockwell Automation industrial system. Helps configure complete, valid catalog numbers and build complete quotes based on detailed ProposalWorks™ configuration software, rok.auto/systemtools product information. Provides coordinated high-fault branch circuit solutions for motor starters, soft starters, and Rockwell Automation Global SCCR tool, rok.auto/sccr component drives. Provides declarations of conformity, certificates, and other certification details. Product Certifications website, rok.auto/certifications 12 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects The Rockwell Automation® Library of Process Objects, also referred to in this document as the PlantPAx® library, contains all the tools required to enable consistent deployment and faster product delivery. The Library Includes the following: • Graphics for built-in instructions • HMI images and Help files • Logix diagnostic objects • Process objects • Premier Integration objects • Control strategies • Sequencer objects • PlantPAx Configuration Tools for Tags, Alarms, and Historian • Color Change tool • Historian -- Asset Framework template and objects The Library of Process objects is designed to work in conjunction with the following libraries: Item Description 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. Library of Electrical Protection Devices 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 Library Provides objects for discrete and velocity power devices. When you deploy the process controller in PlantPAx 5.0 and later, you gain access to additional PlantPAx instructions. The PlantPAx instructions on the process controller provide objects that are embedded in the controller firmware. For more information on faceplates for these instructions, see PlantPAx Faceplates for Process Controller Instructions, publication PROCES-RM203. See Logix 5000® Advanced Process Control and Drives Instructions, publication 1756-RM006 for more information on PlantPAx Instructions. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 13 Chapter 1 Rockwell Automation Library of Process Objects Rockwell Automation Services and Support System Support offers technical assistance that is tailored for control systems. Some of the features include the following: • 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 TechConnect 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 https://www.rockwellautomation.com. You can view or download publications at https://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-RM200G-EN-P - June 2024 Chapter 1 Process Library 5.20 Add-On Instructions Rockwell Automation Library of Process Objects In addition to the PlantPAx instructions listed previously, PlantPAx provides several Add-On Instructions. Libraries noted in the following table: GEMS - Global Engineering Modular Solutions RAMS - Rockwell Automation Mining Solutions PO - Process Objects Input Control PlantPAx 5.0 and later Add-On Instruction Bundled with 5.20 Library Download Previous Process Library Add-On Instruction raP_Tec_HARTChanData_to_PAH New Instruction raP_Tec_LgxEvent New Instruction Description Transfers data from one Library 4.10 HART module Channel Data array member (for one input or output channel) to one (Highly Integrated HART) PAX_HART_DEVICE:I:0 data structure for use by PAH instruction. Captures any of 16 event bit rising edge transitions and records the lowest-order rising edge bit as the reason for the event. Controller Diagnostics PlantPAx 5.0 and later Add-On Instruction Bundled with 5.20 Library Download Previous Process Library Add-On Instruction Logix Change Detector (raP_Dvc_LgxChangeDet) L_ChangeDet (PO) Logix Controller CPU Utilization (raP_Dvc_LgxCPU_5x80) L_CPU_5x80 (PO) Description The Logix Change Detector (raP_Dvc_LgxChangeDet) Add-On Instruction monitors another Logix controller on the 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 control tasks for optimum controller performance. The 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. This instruction supports ControlLogix 5580 and CompactLogix™ 5380 controllers, firmware release 33 and later. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 15 Chapter 1 Rockwell Automation Library of Process Objects Controller Diagnostics PlantPAx 5.0 and later Add-On Instruction Bundled with 5.20 Library Download Previous Process Library Add-On Instruction Logix Module Status (raP_Dvc_LgxModuleSts) L_ModuleSts (PO) Logix Redundant Controller Monitor (raP_Dvc_LgxRedun) L_Redun (PO) Logix Task Monitor (raP_Dvc_LgxTaskMon) L_TaskMon (PO) Description The Logix Module Status (raP_Dvc_LgxModuleSts) Add-On Instruction monitors the connection status of one module 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 redundant pair of Logix controllers. The instruction checks 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 watchdog timer 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 and later Add-On Instruction Bundled with 5.20 Library Download Previous Process Library Add-On Instruction raP_Opr_Area AREA (GEMS) raP_Opr_Unit UNIT (GEMS) raP_Opr_EMGen EM_GEN (GEMS) raP_Opr_EPGen EP_GEN (GEMS) raP_Tec_ParRpt I_ParameterEnum (GEMS) I_ParameterInteger (GEMS) I_ParameterReal (GEMS) I_ParameterString (GEMS) raP_Opr_Prompt Prompt (GEMS) P_Prompt (PO) Process Extended Alarms (raP_Opr_ExtddAlm) 16 Extended Alarms (GEMS) Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Description The raP_Opr_Area (Area Object) object groups Units together, and provides a propagation mechanism for aggregating status from Unit objects, and broadcasting commands to Unit Modules. The UNIT (Unit Object) object controls a Unit in various command sources and monitors for fault conditions. The raP_Opr_EMGen (Generic Equipment Module) object controls an Equipment Module in various modes and monitors for fault conditions. The raP_Opr_EPGen (Generic Equipment Phase Module) object controls an Equipment Phase in various modes and monitors for fault conditions. 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: • For a read-only parameter /report • For a read/write parameter /report • For a parameter /report 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, which may be used for Parameter or Report data items The P_Prompt (Operator Prompt) Add-On Instruction is a universal mechanism for operator interaction that can be used within a control scheme. The instruction presents an operator with configurable message or data fields and accepts operator response data and confirmation. Monitors one input condition and provides one configurable Alarm. The Alarm is provided as a Logix Tag Based Alarm. Use <InstanceTag>.@Alarms members for access. Chapter 1 Rockwell Automation Library of Process Objects Organization Organization is a method by which parent / child relationships can be created and modified among PlantPAx Instructions. Organization provides a method to propagate a selected subset of commands (related to command source, alarms, and so on) from the parent down to its children or propagate the aggregate of a selected subset of status (related to command source, alarms, and so on) from the children up to the parent. For more information See Organization on page 107. PlantPAx 5.0 and later Add-On Instruction Bundled with 5.20 Library Download Ownership (raP_Opr_Owner) Organizational View (raP_Opr_OrgView) Organizational Scan (raP_Opr_OrgScan) Arbitration Queue (raP_Opr_ArbitrationQ) Previous Process Library AddDescription On Instruction Ownership, Command, and Status The Add-On Instruction Function to allow ownership of a Bus element. Propagation (GEMS) Ownership, Command, and Status The Add-On Instruction Function to create a tree view of the nodal organization in Propagation (GEMS) FactoryTalk® View. Ownership, Command, and Status The Add-On Instruction Function to scan and update all Bus elements and tree Propagation (GEMS) nodes. Ownership, Command, and Status The Arbitration Queue (raP_Opr_ArbitrationQ) Add-On Instruction Function to add a Propagation (GEMS) FIFO to each class of owner in the ownership function. Libraries can be accessed from the Product Compatibility and Download Center. Visualization Files FactoryTalk View SE Each Add-On Instruction has associated FactoryTalk View SE 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) • Local Message files (.loc file type) File Type Abbreviations Images (.png) Global objects (.ggfx) Standard displays (.gfx) FactoryTalk View SE Description All .png files in the images folder. icons that are used in the Global Objects and standard displays IMPORTANT: FactoryTalk View application renames PNG files when they are Common for all Process Objects. imported with a .bmp file extension, but the files retain a .png format. Examples: (raP-5_20-SE) precedes name of the Global Objects. (raP-5_20-SE) Common Objects Examples: (raP-5_20-SE) precedes name of the display. (raP-5_20-SE) PAI-Faceplate Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 17 Chapter 1 Rockwell Automation Library of Process Objects File Type Abbreviations HMI tags (.csv) FactoryTalk View SE FTViewSE_ProcessLibrary_Tags_5_0_xx.csv where xx = the service release number. Description HMI tags are created in a FactoryTalk View SE application to support security and other features on Process Library faceplates. HMI tags can be imported via the comma-separated values file (.csv file type). Macros used for the general library: • NavToDisplay • ToggleWithRemark Macro that is used for the PLLS object displays: • NavToPLLS_Motor Macros (.mcr file) Local Message Files Macros that are used for the Organization TreeView and navigation: • DefineShowHWTreeCmd.mcr • DefineShowTreeCmd.mcr • NavToBusDevice • NavToBusDeviceWithSC • NavToBusDisplay • ShowTreeForObject • NavToDisplay with line of sight • NavToDisplay_with_4_x • NavToDisplayIndirect • NavToFaceplate_with_ETP • NavToVSM • SystemMaterialNames • SystemStepDescriptions • SystemSummary In a FactoryTalk View SE application, a macro is a series of commands that are stored in a text file. Local message files used by raP_Opr_EMGen, raP_Opr_EPGen, and raP_Opr_Unit. 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. Studio 5000 View Designer Each Add-On Instruction has associated Studio 5000 View Designer® visualization files that provide a common user interface. You must copy and paste these files from the provided template application into the user application: • Images (.svg files) • Add-on graphics • User-Defined Screens (Type: Pop-up) IMPORTANT Only copy and paste the User-Defined pop-up Screens and add-on graphics that are used in the final application. If there are unused add-on graphics in the project, the project has errors when verifying. Associated Images and add-on graphics automatically paste into your application if you copy and paste User-Defined pop-up Screens that use them. 18 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 File Type Abbreviations Images (.svg) Add-on graphics User-Defined Screens (Type: Pop-up) Studio 5000 View Designer All image files are in the template application. raP_5_GS or raP_5_Tb precedes the name of the add-on graphic files. Pop-up User-Defined Screens in folder "raP_5_10_Objects" folder Rockwell Automation Library of Process Objects Description Common icons that are used in the Global Objects and standard displays for all Process Objects. Reusable and repeatable graphic content to be used on UserDefined Screens. Add-on graphics are analogous to Global Objects used in FactoryTalk View SE. Pop-up displays for operator to view details about each object. The provided User-Defined Screen Popups are analogous to object faceplates in FactoryTalk View SE. Add-on graphics are created once and referenced multiple times on multiple displays in an application. When changes are made to the add-on graphic, all instances in the application are automatically updated. Add-on graphics serve two purposes: • Toolbox (raP_5_Tb) files contain common elements that are used to build faceplate displays. • Graphic Symbols (raP_5_GS) files contain device symbols that you can use to build your application displays. Select the symbol to open the corresponding faceplate display. Pop-up User-Defined Screens, commonly called faceplates, provide a common user interface. 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. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. 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 6 Item 1 2 1 2 3 7 4 5 8 3 4 5 6 7 8 Description Alarm Indicator Alarm Border Command source indicator (In the example the flag indicates not in normal command source) Label Process Variable Maintenance bypass indicator Not Ready indicator Engineering units Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 19 Chapter 1 Rockwell Automation Library of Process Objects Each graphic object includes a touch field over it that opens the faceplate. In addition, there is a tooltip (for FactoryTalk View SE only) on the graphic symbol that displays the configured tag and description. 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. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. Color Dark Gray State Stopped, De-energized, Closed Transitioning. examples: Starting, Jogging, Stopping, Opening, Closing, Moving Horn Running, Energized, Open Light Blue Light Blue White Status Quality Indicators One of these images appears on the graphic symbol when the described condition is true. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. 20 Image Description Image 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, or out of specification Value has not changed (stuck) 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 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Description Chapter 1 Image Description Rockwell Automation Library of Process Objects Image Description 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 value is being held at last good value Process Variable within setpoint deadband (no control action occurs) Input Controlled Variable that is clamped to minimum / maximum Raise Process Variable output that is energized Output Controlled Variable that is clamped to minimum / maximum Lower Process Variable output that is energized 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. IMPORTANT Advanced configuration options are not available on the Studio 5000 View Designer faceplates. Configuration modification must be completed in FactoryTalk View SE or directly in the Logix Designer application. Threshold Indicators These indicators show that the process variable has exceeded a threshold. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. Image Description High-high threshold exceeded High threshold exceeded Low threshold exceeded Low-low threshold exceeded Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 21 Chapter 1 Rockwell Automation Library of Process Objects Deviation Indicators These indicators warn of exceeding the deviation limits. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. 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. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. Command source indicators are not used for analog inputs. Image No symbol displayed Description 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 22 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Image Rockwell Automation Library of Process Objects 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 also appears when the Substitute PV function is enabled. A Maintenance-entered value supersedes the ‘live’ process variable. These indicators are applicable to both FactoryTalk View SE and Studio 5000 View Designer applications. 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. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 23 Chapter 1 Rockwell Automation Library of Process Objects 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. IMPORTANT The faceplates that are shown are FactoryTalk View SE faceplates. The Studio 5000 View Designer faceplates contain the same basic attributes except for the advanced configuration options. Operator (Home) Tab 7 1 2 3 4 5 6 9 24 8 Item 1 2 3 4 5 6 7 Action Select to open the operator tab. Select to open the maintenance tab. Select to open the trends tab. Select to open the diagnostics tab. Select to open the alarm tab. Select to open the help file. Select to reset and acknowledge all alarms. Select to enable navigation to an object with more information (Cfg_HasMoreObj is set to true.) 8 You configure the tag name of the object that 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 object’s faceplate. If the object is configured to have permissive and interlock 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 of the source objects that are used as a permissive or interlock. Often this is a PPERM or PINTLK instruction. If the object is not configured in this way, the permissive or interlock symbols are indicators only. 9 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects 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 1 2 1 Action Select to open the Advanced Properties. Page identifiers 2 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 25 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 2 3 4 5 6 7 Item 1 2 3 4 5 6 7 Action Select to open the HMI Configuration tab. Select to open the engineering tab. Select to open the Advanced Maintenance tab. Device description that shows on the faceplate title bar. Label to show on the graphic symbol. Tag name that shows on the faceplate and on the tooltip for graphic symbols. Area name for security. Hover the cursor over the tag name to see the actual network path and tag name that is associated with the object. 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. 26 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects Faults Tab The faults tab contains specific reasons that the device is not ready. 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 1 2 3 Action Select to zoom in Select to zoom out Select to reset view 1 2 3 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 27 Chapter 1 Rockwell Automation Library of Process Objects 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. 28 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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 button can be used to access help files provided with the library download in a .pdf format (See Help Files on page 39) or any specified URL configured in the object. IMPORTANT Help content is not available on the Studio 5000 View Designer faceplates. See the following example: Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 29 Chapter 1 Rockwell Automation Library of Process Objects To use a specific URL with the help button for an object, open the object's dialog box in Logix Designer. Select the "HMI" tab and input the URL under "Help button URL:" For a library object that is an AOI, find the object base tag in the controller tags. Select the tag and look at the properties panel. The extended tag property "URL" can be updated here. The URL can be any file path or web URL. If the Help button URL is left blank, the button will default to using the Help files provided with the library download. 30 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Studio 5000 Logix Designer Project Configuration Rockwell Automation Library of Process Objects The Library of Process Objects 5.0 and later uses the Extended Tag Properties feature inside Studio 5000 Logix Designer. When configuring your Studio 5000 Logix Designer project file, the following boxes must be checked (checked by default): • Download Project Documentation and Extended Properties • Download Custom Properties • Show Pass-Through Properties • Append To Base Tag Description Note: Configuring the properties (.@Library, .@Instruction, .@Area, and .@Labels) incorrectly will result in empty values that cause an error when calling up the relevant HMI faceplate. IMPORTANT The Pass-Through feature of Extended Tag Properties is not compatible with Studio 5000 View Designer. If using Studio 5000 View Designer faceplates, all extended tag properties MUST be entered directly or errors will be present. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 31 Chapter 1 Rockwell Automation Library of Process Objects FactoryTalk Linx Device Shortcuts Configuration The Library of Process Objects 5.0 utilizes the feature Extended Tag Properties inside Studio 5000 Logix Designer. When configuring FactoryTalk® Linx communication setup for device shortcuts, the following boxes must be checked: • Upload all extended tag properties • Display pass-through values for tag extended properties Note: Configuring the shortcuts incorrectly results in errors if extended tag properties are left blank. Language Switching Language Switching in a Controller Project In the Logix Designer application, to display project content in languages other than English, do the following: 1. Go to Tools > Documentation Languages and select a language in the Current dropdown menu. 2. Click OK 3. Open a Control Strategy and open the parameters for the main object. 32 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects This example shows the Tag properties for a PAO Control Strategy. 4. In the Description box, enter the description text. 5. With your cursor in the Description box, you can switch between French and English so that you can enter the text for each language. Bulk Edit Translated Content To edit multiple text strings (rather than opening the properties for each object in your program), use the PlantPAx Configuration Tool. 1. Open the PlantPAx Configuration Tool, and if necessary, add the controller for your project. 2. Select the controller and select Export Tag Meta Data to Logix Localization File. 3. Name the export file and select the files that you want to export. 4. Select Use language template values if tag properties not configured. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 33 Chapter 1 Rockwell Automation Library of Process Objects There are default values in the tag properties for tags in the Control Strategies. These are typical text strings to translate. 5. Select Export The exported data opens in an Excel® spreadsheet. Adjust the columns widths to see the data. There is one column for each language that you selected. Enter the translated content for each tag property and language. To import the translated content, open the controller project in the Logix Designer application and select Tools > Documentation Languages > Import and select the spreadsheet file with the translated strings. Language Switching in a FactoryTalk View SE Project In the library Tools & Utilities > Language Translations > HMI folder, there are already translated strings for the faceplates in the .txt files. The Excel file contains all languages. Import All Languages If you want to import all of the languages, you can use the Excel spreadsheet. 34 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects Open the spreadsheet and adjust the columns as needed. For example, with this project: Replace (do a Find and Replace All): /Server:Server with / Organization/HMI:Org_HMI_Server Save your changes. In FactoryTalk® View Studio, to import the updated translation, go to Tools > Languages. 1. Click Add to add languages. 2. Select each language and click Apply 3. Click Import - Select Import strings from an Excel spreadsheet into all application languages defined in the spreadsheet. - Click Next to select the updated file from the library. It takes a few minutes to import the translated text. Import a Single Language Before you can import these files into an HMI project, you must edit the path to the project. To work with a single language, open the file in a text editor. Edit the highlighted line to the correct path: /HMI project name/HMI folder:server name Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 35 Chapter 1 Rockwell Automation Library of Process Objects For example, with this project: Enter: /Organization/HMI:Org_HMI_Server Save your changes. In FactoryTalk View Studio, to import the updated translation, go to Tools > Languages. 1. Click Add to add a language. 2. Select the language and click Apply 3. Click Import - Keep the default selection of Import strings from Unicode text files into en-US. - Click Next to select the updated file from the library. It takes a few minutes to import the translated text. Language Switching in Studio 5000 View Designer In the library Tools & Utilities > Language Translations > HMI folder, there are already translated strings for the faceplates in the Excel file. The file contains all translated languages for View Designer. Import all Languages If you want to import all languages, you can use the Excel file as is. To import the language translation, in Studio 5000 View Designer: 1. Navigate to Tools > Import Languages. 2. Select Browse. 3. Navigate to the location of the Excel file is and click open. 36 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects 4. A list of the languages populates in the import dialog box. 5. Select Import, it takes a few minutes to import the translated text. Import a Single Language Before you can import into a View Designer project, you must edit the Excel file to only import the languages you want. 1. Create a copy of the provided Excel file. 2. Open the new Excel file. 3. Delete any columns in the Excel file of languages that you do not want to import. 4. Save the file and close. In Studio 5000 View Designer, to import the updated file with only the languages you want, go to Tools > Import Languages. 1. Select Browse 2. Navigate to the location of the newly created Excel file is and click open. 3. A list of the languages populates in the import dialog box. 4. Select Import, it takes a few minutes to import the translated text. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 37 Chapter 1 Rockwell Automation Library of Process Objects FactoryTalk View SE Language Configuration 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 controller in the HMI Faceplates provided. When configuring languages (FactoryTalk View Studio - View Site Edition > Tools > Language Configuration) confirm the following checkbox is selected: • Display undefined strings using the default language. Studio 5000 View Designer Language Configuration After importing the languages that will be used in the application, open the project properties (Project > Project Properties > Language Tab). Select the Default language that is used at startup of HMI device and for undefined translations: 38 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Help Files Rockwell Automation Library of Process Objects 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. 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. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 39 Chapter 1 Rockwell Automation Library of Process Objects Local Station: Distributed System Server: 6. Close the settings display. 7. Restart FactoryTalk View Studio for the settings to take effect. 40 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 1 Rockwell Automation Library of Process Objects 8. The Help Files can now be accessed using the Help button on the HMI Display. IMPORTANT Access to help is not available with Studio 5000 View Designer content. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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 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. The faceplate for Studio 5000 View Designer software has revision information visible by clicking the lower left corner of the faceplate. 42 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Example Chapter 1 PlantPAx Process Library Migration Tool Rockwell Automation Library of Process Objects This tool is used to migrate from previous Process Library versions to version 5.20. The PlantPAx Process Library Migration Tool provides the following: • Updates Logix controller ACD files containing Rockwell Automation Process Library Add-On Instruction tags to corresponding Process Controller predefined process instruction tags and version 5.20 Add-On Instruction tags. • Converts FactoryTalk View SE process graphics XML files containing global object references from previous Process Library versions to version 5.20 Process Library global objects. • Migration of Process Library HMI libraries. • Migration of GEMS Version 4.4 Add-On Instruction to corresponding Process Controller predefined process instruction tags and version 5.20 Add-On Instruction 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 lifecycle of the PlantPAx DCS. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 43 Chapter 1 Rockwell Automation Library of Process Objects Notes: 44 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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 composed of four main components, Header, Process Control Displays, Navigation, and Alarm Indication. IMPORTANT The Graphic Framework was developed at the specific resolution of 1920x1080. The 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 composed 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 • L1 Navigation Object • Diagnostics Object • Home Navigation Object • Close Client Object • Login / Logout Object • Alarm Banner (Default sized Alarm Banner Object – 3 lines) Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 45 Chapter 2 Graphic Framework Overview • • • • • • • • • • 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 a specific 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 interacts 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 L1 Default Display Template L2 Default Display Template L3 Default Display Template Description • This is an overview of a specific operator's sphere of influence (Overview Display) • Full graphic displays with L2 Navigation Bar visible • The first display that is populated when the operator refreshes the FactoryTalk® View 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 associated L3 display when necessary • Full graphic display with L2 and L3 Navigation Bar present • Typically, there are multiple L2 displays required to cover a specific operator’s sphere of influence, which is represented by the L1 display. • A more detailed display that is designed for troubleshooting abnormal scenarios. The L3 display design presents data that best matches to current task at hand. • 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. L4 displays provide finer detail and are opened as Faceplate or pop-up display from L2 and L3 displays. These would include PlantPAx standard faceplates or custom pop-up displays. 46 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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 abnormal conditions. 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 necessary, the operator can access the associated and more detailed L3 displays to address the situation. The L2 display includes the L3 Navigation bar at the top with an indicator of the selected L2 display. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 47 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 includes the L3 Navigation bar at the top with an indicator of the selected display and an indicator of its 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 • Diagnostic Navigation • Graphic Off-Screen Connectors L1 Navigation L1 Navigation allows operators to navigate to other areas of the facility. This moves the operator to another sphere of influence. The Display Map Button is used to open a pop-up 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. 48 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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 composed of 16 buttons and can navigate to up to 16 different displays. When the operator clicks the desired L2 button, that L2 display opens. On that L2 display, the associated L3 navigation bar opens. Each L2 button has alarm indications 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 composed 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 viewing. When the operator clicks a desired L3 button, that L3 display opens. Each L3 button has alarm indications and these are rolled up into the associated L2 alarms. The L3 Navigation button text can be modified for each specific application. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 49 Chapter 2 Graphic Framework Overview Alarm Navigation Alarm information is accessed by pressing the Alarm Button on the header. This opens 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 that is 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 viewing. Diagnostic Navigation Diagnostic information is accessed by pressing one of the Diagnostic related buttons on the header (for example the System Status button). This opens the related diagnostics display with associated diagnostic navigation bar. Other diagnostic information displays can be accessed, including the System Status and Automatic Diagnostic Event Viewer. There is a display that is associated with each diagnostic type and two buttons available to be customized for additional diagnostics. See Global Objects and Displays for more information on Diagnostic Objects. See Displays for more information on template Diagnostic displays. The Diagnostic Navigation display has an indication below each button to show which diagnostic display the operator is viewing. 50 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 2 Graphic Framework Overview 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 styles of off-screen navigation can be found in a Toolbox graphic. There are three different off-screen navigation functionalities available. Functionality Navigation to Same L1 area Navigation to Other L1 area No Navigation (static) Description 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 needs to execute several commands to open the destination L1 area header and the desired L2/L3 display. The static off-screen connector does not navigate to any display. It is used as an indicator of a process inflow or outflow with no accompanying graphic - just a static indication. Various styles are offered in the toolbox. Multi-Monitor Support The PlantPAx Graphic Framework provides the structure and configuration that is needed to use multi-monitor applications during runtime. Applications utilizing the framework can be run on single, dual, or quad monitor hardware. Each monitor will be formatted as described in the earlier section of this chapter - there will be one header and a process display. The user can configure the header of each monitor as described in the earlier Header Display section, with one Header Display dedicated to each monitor for each L1 area. Alternatively, the user can configure all headers to be the same. See Multi-Monitor for more information on configuring an application for multi-monitor. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 51 Chapter 2 Graphic Framework Overview Alarm Indication Display 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 rolledup 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. Description There is one Alarm Banner for each L1 area. The Alarm Banner, which resides on the Header display, will show up to three alarms. Alarm Banner Alarm Summary Alarm History Alarm Shelved Alarm Explorer Each L1 area has 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 the Alarm 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 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 that is preconfigured to access alarm and event databases within the application 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 display can be further filtered based on alarm names. The alarm explorer displays the alarm grouping tree to allow easy access to each alarm group. The button to access this display has security that is built in. Only users with ability to enable/disable alarms can access this display. Alarm Grouping and Supporting Logic To create alarm groupings that align with the Navigation bars, additional upfront effort must be made in each controller to support this function. This effort requires using the Logical organizer in the controller files to align to the same hierarchy as in the graphical hierarchy. Figure 1 - Pre-defined Graphical Layout The Logical Organizer folder structure must align with the predefined Graphical Hierarchy. That is, a folder in the Logical Organizer must be created for each process display that is used in the HMI. 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. IMPORTANT 52 If alarm grouping contains numbering, it is recommended to add a padded zero or else an unexpected alarm indication occurs. For example, if you have alarm groups D1_1, D1_10, and D1_11, the first alarm group should be modified to D1_01. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 2 Graphic Framework Overview Figure 2 - Logical Organizer Aligned with Graphical Layout Controller: DH_1_3 L1 L2 Controller: DH_4_6 L1 L3 L2 L3 L2 L3 Controller: DH_COM L1 L3 L2 L3 L2 L3 L3 L2 L3 L3 L3 L3 L3 L3 L2 L3 L2 L2 L2 L3 L3 L1 L3 L1 L3 L3 L2 L3 L1 L2 Once the folders are created, the PlantPAx Configuration Tool can be used 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 that is used by multiple operators, the folder structures of each area must be created in the Logical organizer to represent the multiple L1 hierarchies. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 53 Chapter 2 Graphic Framework Overview The following navigation bars must be configured to align with the information in Figure 1. Alarm groupings enable the appropriate alarm roll ups to the navigation buttons. L1 B_DIG L2 L3 Note: L3 for DIG2…DIG6 will align with the respective L2 Layer as shown in the DIG1 example. L3 L3 L3 The alarm grouping configuration in the Logical Organizer should then be reflected on the L2 / L3 navigation for button naming as well as alarm breadcrumb (alarm groups). 54 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework The following table defines common terms that are used in the configuration. Term Template App Description The term “Template” within a filename indicates that the file should be duplicated when used in the application. The duplicated file should be renamed to a title that is meaningful for the specific area or subsubarea 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 out of this file - the file name does not need to be duplicated or renamed. Graphic Framework Builder Tool The Graphic Framework Builder Tool can be used to quickly develop FactoryTalk View SE files to import into a base application. This tool can be used to automate most of the steps explained in this chapter. For more details on the Graphic Framework Tool and how to use it, See the Product Compatibility and Download Center and search “PlantPAx Tools”. General Graphic Framework Configuration 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_{version}_Template_{version}.APB (for example, FTVSE_13_0_Template_5_10_00.APB) • FTVSE_{version}_TemplateWLibrary_{version}.APB (for example, FTVSE_12_0_TemplateWLibrary_5_00_00.APB) • FTVSE_{version}_Template_{version}.zip (for example, FTVSE_12_0_Template_5_00_00.zip) • FTVSE_{version}_TemplateWLibrary_{version}.zip (for example, FTVSE_13_0_TemplateWLibrary_5_10_00.zip) The PlantPAx Graphic Framework can be used in one of two ways from the template files in the Process Library download: • Restore the provided Local Station project templates (.APB) using the FactoryTalk® View SE Application Manager. • Create your own project as a Distributed or Network Station application and import the HMI server or individual files as needed. If using FactoryTalk View SE version 13 and later, there is a third option to use the PlantPAx Graphic Framework. After creating an HMI server, right-click on the server and select “Add PlantPAx Library of Process Objects”. For this option, no download from PCDC is necessary as one specific version of Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 55 Chapter 3 Configure the Graphic Framework the Process Library is built into FactoryTalk View. This is not recommended for new implementations. PlantPAx Process Library Dependencies The Graphic Framework is dependent on the following files from the Library of Process Objects: • Display Files (.gfx) - (raP-5_20-SE) raP_Opr_OrgView-TreeView - (raP-5_20-SE) raP_Opr_OrgView-Select - (raP-5_20-SE) raP_Opr_OrgView-Config - (raP-5_20-SE) raC_UDT_Opr_Bus-Advanced - (raP-5_20-SE) raC_UDT_Opr_Bus-Faceplate • Global Object Files (.ggfx) - (raP-5_20-SE) Toolbox - Common Adv Objects - (raP-5_20-SE) Toolbox - Organization Objects - (raSDK-1-SE) Toolbox - Common Objects • Macros (.mcr) - DefineShowHWTreeCmd - DefineShowTreeCmd - ShowTreeForObject - ToggleWithRemark - NavToFaceplate - NavToDisplay Build Your PlantPAx HMI Application Local Station Applications 1. Go to FactoryTalk® View SE Application Manager > Local Station and select Restore Archive. 2. Browse to the APB file. 56 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework 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. Distributed or Network Station Applications 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 configured and all applicable servers are joined to the directory. IMPORTANT This should be used as a rough guide only. See PlantPAx Distributed Control System Configuration and Implementation User Manual, publication PROCES-UM100 and FactoryTalk View documentation for best practice and proper system configuration. 1. Go to FactoryTalk View Studio and select either Distributed or Network Station. 2. Create a new application. 3. Build out the Area folder structure. Place only one server in each area folder 4. Extract the graphic framework - either with or without the Process Library. (Found in the library download at \Process Library\Templates\FactoryTalk View SE). Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 57 Chapter 3 Configure the Graphic Framework 5. Right-click the HMI area folder. Select Add New Server > HMI Server. The Add HMI Server Wizard opens. Select Import a project and click Next. On this Page Warning pop-up Action Select OK • Select FactoryTalk View Site Edition Project. • Navigate to the HMI server backup that was extracted in step 4. Import Project • Name the HMI server • Select the computer that hosts the new HMI server New HMI Server Properties The HMI server takes a few minutes to import. Once the import is complete, the application is ready to build out with the PlantPAx Graphic Framework. 58 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Recommended Application Naming Structure Configure the Graphic Framework The following is a table of recommended naming structures for files that are provided in the Graphic Framework. The files with a suggested naming structure will need to be duplicated from the original file and renamed with the structure specific for your project. Template Display Name Suggested Name Structure (raP-5_20-SE) Template Display Map [App_Name]_DisplayMap (raP-5_20-SE) Template Diagnostic[App_Name]_Diagnostic-IOEvents IOEvents (raP-5_20-SE) Template Diagnostic[App_Name]_Diagnostic-Summary Summary (raP-5_20-SE) Template Language-Select [App_Name]_Language-Select (raP-5_20-SE) Common-Redirect-to-4_10 N/A (raP-5_20-SE) Common-Redirect-to-5_00 N/A (raP-5_20-SE) Template Reports [App_Name]_Reports (raP-5_20-SE) Template Trend_Full [App_Name]_Trend_Full (raP-5_20-SE) Template Trend_Popup [App_Name]_Trend_Popup (raP-5_20-SE) Template Admin[App_Name]_Admin-SysSecurity SysSecurity (raP-5_20-SE) Template Mon1 Header [L1_Name]_Mon1_Header (raP-5_20-SE) Template Mon2 Header [L1_Name]_Mon2_Header (raP-5_20-SE) Template Mon3 Header [L1_Name]_Mon3_Header (raP-5_20-SE) Template Mon4 Header [L1_Name]_Mon4_Header (raP-5_20-SE) Template Display L1 [L1_Name] (raP-5_20-SE) Template Display L2 [L1_Name]_[L2_Name] (raP-5_20-SE) Template Display L2 no L3 [L1_Name]_[L2_Name] (raP-5_20-SE) Template Display L3 [L1_Name]_[L2_Name]_[L3_Name] (raP-5_20-SE) Template Alarm-Explorer [L1_Name]_Alarm-Explorer (raP-5_20-SE) Template Alarm-History [L1_Name]_Alarm-History (raP-5_20-SE) Template Alarm-Shelved [L1_Name]_Alarm-Shelved (raP-5_20-SE) Template Alarm-Summary [L1_Name]_Alarm-Summary Global Object Files (raP-5_20-SE) APP - Administrative Objects (raP-5_20-SE) APP - Alarm Objects (raP-5_20-SE) APP - Diagnostic Objects (raP-5_20-SE) APP - Header Objects (raP-5_20-SE) Template Custom Objects (raP-5_20-SE) Template L1 Navigation (raP-5_20-SE) Template L2 L3 Navigation Macro File Template_ClientStartup_SingleMon Template_ClientStartup_DualMon Template_ClientStartup_QuadMon Template_Repaint_SingleMon Template_Repaint_DualMon Template_Repaint_QuadMon SetRepaint NavToDisplay with mixed library NavToFaceplate with mixed library Example: ABC-Chem_DisplayMap ABC-Chem_Diagnostic-IOEvents ABC-Chem_Diagnostic-Summary ABC-Chem_Language-Select Use file as is Use file as is ABC-Chem_Reports ABC-Chem_Trend_Full ABC-Chem_Trend_Popup ABC-Chem_Admin-SysSecurity Mixing_Mon1_Header Mixing_Mon2_Header Mixing_Mon3_Header Mixing_Mon4_Header Mixing Mixing_IngredAdd Mixing_Agitate Mixing_IngredAdd_Weigh Mixing_Alarm-Explorer Mixing_Alarm-History Mixing_Alarm-Shelved Mixing_Alarm-Summary Suggested Name Structure Example: N/A Use file as is N/A N/A N/A [App_Name]_CustomObjects [App_Name]_L1Navigation [L1_Name]_L2L3Navigation Use file as is Use file as is Use file as is ABC-Chem_CustomObjects ABC-Chem_L1Navigation Mixing_L2L3Navigation Suggested Name Structure Example: [L1_Name]_ClientStartup_SingleMon Mixing_ClientStartup_SingleMon [L1_Name]_ClientStartup_DualMon Mixing_ClientStartup_DualMon [L1_Name]_ClientStartup_QuadMon Mixing_ClientStartup_QuadMon [L1_Name]_Repaint_SingleMon Mixing_Repaint_SingleMon [L1_Name]_Repaint_DualMon Mixing_Repaint_DualMon [L1_Name]_Repaint_QuadMon Mixing_Repaint_QuadMon N/A Use file as is Optional macros - use only for applications with both Process Library 4.10 and Process Library 5.00 or later. See Macros section for detail. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 59 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. The purpose of this section is to provide the application developer details on each global object and how to configure them. Not all global objects are required to be used in the application. APP - Administrative Objects (raP-5_20-SE) The following objects are used for administrative control. Object Graphic Description The purpose of the Close Client object is to shut down the client. Close Client Parameter Number Configuration Description Explanation No configuration required. This object can be placed on the Header or on a separate administrator display. APP - Alarm Objects (raP-5_20-SE) The following objects are used for alarm navigation and annunciation. Configuration Object Alarm Summary Navigation Alarm Silence Button Alarm Group Annunciation 60 Graphic Description Parameter Number Description The purpose of the Alarm Summary Navigation object is to visually alert operators of current active alarms in their L1 process area and to provide navigation to the Alarm Summary. This object navigates to a different Alarm Summary screen in each L1 area. 101 Alarm Summary Display Name Enter full Alarm Summary display name 102 Alarm Group Name (Level 1) Enter the L1 area alarm group name (for indication) 101 Enter the associated L1 Header display name that Alarm and Event contains the alarm banner. Banner Display Name "Invoke This button should already be populated on the template Header display. The global object parameter values need to be updated on the Header display. The purpose of the Alarm Silence Button object is to silence any active audible alarms that are assigned to that L1 area for that specific client. This button should already be populated on the Header display. The global object parameter values need to be updated on the Header display. The alarm annunciation objects are available for L1, L2, or L3 alarm groups. These annunciation objects are built into template objects for L1, L2, and L3 navigation objects, but can be added to additional buttons if desired. There are also larger objects available for an L1 Overview display. Explanation #101.FactoryTalkAlarmandEventBanner.SilenceAll" 101 102 103 Alarm Group Name (Level 1) Alarm SubGroup Name (Level 2) Alarm SubSubGroup Name (Level 3) Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 L1 Group name in FTAE and/or FTLinx (required for L1, L2, and L3 annunciation objects) L2 Group name in FTAE and/or FTLinx (required for L2 and L3 annunciation objects) L3 Group name in FTAE and/or FTLinx (required for L3 annunciation objects) Chapter 3 Configure the Graphic Framework APP - Diagnostic Objects (raP-5_20-SE) The following objects are used for hardware and software diagnostics as well as L4 trend display access. Object Software Tree View Navigation Hardware Tree View Navigation Graphic Description The purpose of the Software Organization Tree View button is to view the entire organization tree view for each controller in one central location. Configuration Parameter Description Explanation Number SW Tree Enter a text string, not a tag. This 101 Identification displays on the button. 102 Enter the shortcut name where tree view is located. Include the area name Processor the parameter entry (for example, Shortcut Name in '[MyCLX]' or '/Area1/ SubArea1::[MyCLX]') The purpose of the Hardware Organization Tree View button is to view the hardware organization tree view for each controller. 101 HW Tree Identification This button is used in conjunction with organizational bus instructions raP_Opr_OrgView and raP_Opr_OrgView as well as raP_Dvc_LgxModuleSts. See [appropriate section name] for more information on configuration of the organizational bus. 102 This button is used in conjunction with organizational bus instructions raP_Opr_OrgView and raP_Opr_OrgView. See [appropriate section name] for more information on the configuration of the organizational bus. 101 102 Pop-up Display Trend Navigation The trend pop-up button is intended to be placed throughout L1, L2, or L3 process displays to display TrendPro templates that are specific to the user's process. 103 104 101 Tree View Alarm Annunciation The alarm annunciation object for the tree view is the same as for an L2 alarm annunciation object (see previous section). It is recommended to use in conjunction with the Hardware Tree View button to annunciate any hardware-related alarms. 102 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Enter a text string, not a tag. This displays on the button. Enter the shortcut name where tree view is located. Include the area name Processor the parameter entry (for example, Shortcut Name in '[MyCLX]' or '/Area1/ SubArea1::[MyCLX]') Full name of the pop-up trend name. should be (raP-5_20-SE) Trend pop-up This Trend_Popup or a display Display Name Template that is created from duplicating this display. Name of the TrendPro template that Trend should be invoked when the pop-up Template display opens. This can be left blank if (Optional) no TrendPro templates are created yet. The exact name of the HMI Server HMI server. The name Name next to this icon in your application: The exact name of the server that is hosting your HMI Server (usually the PASS). You can find this name by PASS Server examining the top of the application Name tree: Alarm Group Name (Level 1) L1 Group name in FTAE and/or FTLinx (for example, 'System') Alarm SubGroup Name (Level 2) L2 Group name in FTAE and/or FTLinx (for example, 'CLX1') 61 Chapter 3 Configure the Graphic Framework APP - Header Objects (raP-5_20-SE) The following objects are recommended to be placed on the Header display and provide information and specific navigation. Configuration Object PlantPAx Logo Graphic Description Parameter Number Description 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. Explanation No configuration required. If users prefer to add their own logo, See Template Custom Objects (raP-5_20-SE) for more information. Time Date The Time-Date object indicates the current time and date. This object is populated in the Header display by default. The System Status object is used for navigation to the control system status display. The system status screen is a custom display that is developed to show diagnostics and hardware information. See Displays for more information on the template display. Use (raP-5_20-SE) Template Diagnostic-Summary as a starting point. System Status No configuration required. 101 System Status Display Name Enter the whole display name into the parameter. Display "#101" There is an optional System Status breadcrumb that can be added to the System Status button (see Displays for Template Toolbox display). There is also an L1 alarm breadcrumb that could be used for this button (see APP - Alarm The system status breadcrumb is configured as follows: Replace "[MyCLX]" with the Objects (raP-5_20-SE) for Alarm Group shortcut defined for your application. If you have multiple processors, duplicate the annunciation). function for each processor and use a logical "or" to combine the expressions. The Alarm bread crumb objects - L1 for the System system status breadcrumb should be placed on top of the System Status Button in the Status header button and L2 for each individual Header bar. 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_20-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. Repaint Screen The Repaint Screen object is used to refresh the display client. The button uses defined symbol "Repaint" to build the proper repaint macro command for that L1 area and client. Home Navigation The purpose of the Home Navigation object is to provide a link allowing an operator to go to No configuration required. See Macros to verify that the "Client Startup" macro is their "Home" area or sphere of influence. configured properly. Navigates to Client Home displays (not the "GoHome" current L1 home displays). L1 Navigation The purpose of the L1 Navigation object is to link to a pop-up display that provides access to other L1 Process Areas within the facility. This object configured the same for all L1 Headers (it will always call up the same pop-up, regardless which L1 area is being displayed). Administrator The Administrator Button can be used to navigate to a custom administrator display or the provided Administrator System Security pop-up template display. 62 No configuration required. See Macros and Multi-Monitor to verify that the "Client Startup" macro is configured properly and repaint macros are created as required. "Repaint #2" 101 Display Map Display Name 101 Administrator Display Name Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Enter the whole display name for the Display Map display pop-up. Display "#101" /cc See Displays for more details on configuring the display map pop-up. Enter the whole display name for the Administrator display Display "#101" Chapter 3 Configure the Graphic Framework Configuration Object Generic Trend Navigation Full Display Trend Navigation Graphic Description The purpose of the Generic Trend Navigation Button object is to navigate to a display prepopulated with navigation buttons to various prebuilt trends or generic trend display to allow building of ad-hoc trend displays. The purpose of the Full Display Trend Navigation button object is to navigate to the display created from the template display (raP5_20-SE) Template Trend_Full. This display can use TrendPro templates and trend security. The user will typically use this style of display for system trend of that L1 area or for key performance indicators. Parameter Number 101 Description Explanation Trends Display Name Enter the whole display name for the Trends display Display "#101" 101 Trends Full Screen Display Name 102 Trend Template (Optional) 103 HMI Server name Full name of the full screen trend name. This should be (raP-5_20-SE) Template Trend_Full or a display that is created from duplicating this display. Name of the TrendPro template that should be invoked when the display opens. This can be left blank if no TrendPro templates are created yet. The exact name of the HMI server. The name next to this icon in your application: PASS Server name The exact name of the server that is hosting your HMI Server (usually the PASS). You can find this name by examining the top of the application tree: 104 Display "#101" /T #102, #103, #104, $Security\ConfigTrend$ Diagnostic Events Summary Language Switching Reports Navigation The Diagnostics Events Summary object is used as a navigation button to access the Automatic Diagnostic Event Summary object It is recommended to use this button to navigate the display created from "(raP-5_20-SE) Template Diagnostic-IOEvents". 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 choose a different language provided that the data sources are configured with the selected language. The dynamic text is provided by the controller and the static text is provided by the HMI Server (both sources can provide information in multiple languages concurrently). The purpose of the Reports Navigation button object is to access web-based SQL Server Reporting Services (SSRS) reports. Once these reports are configured, the user can access alarm and events reports and diagnostic reports. 101 Enter the whole display name for the Diagnostic Display Name Diagnostic display Display "#101" 101 Enter the whole display name for the Language Select Display Language Selection display Name Display "#101" /RP 101 102 103 Computer Name for the Enter the name of the server hosting the SSRS report reports, for example "PPLib-ASIS". Enter the port number that is used for Port Number accessing reports. Typically, by default this is 80 for HTTP. the whole display name use for reports. Reports Display Name Enter Reports display. Display "#103" /T"http://#101:#102/Reports" Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 63 Chapter 3 Configure the Graphic Framework Configuration Object Help Button Graphic Description The purpose of the Help Button object is to provide access to a User-defined Help display or PDF file. There are two separate buttons available depending on if you want to use a Help display (FTView-based) or PDF. These buttons can be added to the Header display or any other display. Parameter Number Description Display: 101 Help Display Name Explanation Enter the whole display name for the help display. Display #101 Help File Full file path For example: PDF: 101 Enter the file path to the Help PDF. The file can on the OWS that the client is run on or C:\Users\public\docum reside located on a shared file directory. ents\help.pdf AppStart #101 or \\PRCPASS\Shared\help.pdf Windows Navigation Button The purpose of the Windows Navigation Button objects is to provide Windows like navigation capability within the HMI. Note: For multimonitor applications, the display history is shared with all configured monitors. Therefore, this navigation should be concerned as a common group monitor history. Login / Logout The Login / Logout object is used to allow logging in and out of various users and includes an indication of the current user. Logging out will log in as a View Only User. None. Buttons are ready to use and only must be added to the Header display. This object is already populated on the default Header display. Note: For log out to the view only user to work correctly, the view only user must be configured in security and added to the view only user group. The log out button is configured for user "default" password "default". Template Custom Objects (raP-5_20-SE) The following objects are customizable to customer's specific needs. Before customizing, duplicate and rename the file to preserve the original template file. The following steps are not required if you are not using any of the custom global objects within the 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_20-SE) Template' portion of the filename. This creates a file for your specific application and preserves the original template file. 64 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Object Graphic Description 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. Configure the Graphic Framework Configuration Once the image file is correct, copy the updated global object and paste it onto the header after deleting the default PlantPAx logo. Custom Company Logo Custom Report Navigation The purpose of the Custom Report Navigation Button object is to navigate to Copy and paste the button on the Header display a display with pre-populated navigation buttons to access various prebuilt (or any other display) in the desired location. reports. Update the navigation as necessary. URL Reports Navigation The purpose of the URL Reports Navigation Button object is to pop open a web browser over the client to access the specified URL. This allows the user access to the default web browser. Copy and paste the button on the Header display in the desired location. Update the hyperlink, as necessary. Template L1 Navigation (raP-5_20-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. The following steps are required for all applications using the graphic framework, creating one new file for each application. 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_20-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). Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 65 Chapter 3 Configure the Graphic Framework 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. 5. The navigation for each button should be left as is. The symbol "Repaint" is used in conjunction with parameter #2 to call "SetRepaint" macro to the build the command for the proper macro to repaint all screens. See Macros for more information on configuration. See Multi-Monitor for more information on navigating between L1 areas with multi-monitor client workstations. 6. After you finish updating the button text, select the updated buttons in the L1 Navigation global object file and copy them to the application-specific display that is developed from the template file (raP-5_20-SE) Template Display Map. Delete any existing buttons and paste the new buttons. 7. For all buttons, enter the L1 alarm group parameters in the global object parameters. Also enter the name of the destination L1 area. This name should match the area name that is used for the repaint macros that are used in that L1 area. See Alarm Grouping and 66 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework Supporting Logic for more information on alarm grouping. See Macros for more information on configuration. Template L2 L3 Navigation (raP-5_20-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. The following steps are required for all applications using the graphic framework, created a new file for each L1 Area. For each L1 Area, perform 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_20-SE) Template' portion of the filename. This creates a file for your specific L1 area and preserves the original template file. There are four sets of buttons to update in the newly created global object file for each L1 Area: • Alarm Navigation Bar • Diagnostic Navigation Bar • L2 Navigation Bar • L3 Navigation Bars Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 67 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 must 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. This should match the Alarm Displays created for this L1 area (see Displays for more information on the alarm template displays). If the alarm display names match the recommended naming convention, you can do a “Tag Substitution” and simply replace “(raP-5_20-SE) Template” on the whole Alarm Navigation bar instead of updating each button individually. 2. 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 3. To update the location for the alarm navigation bar in the alarm displays, go to the Alarm Navigation bar and place the Alarm Navigation bars in this location on each of the four alarm displays: Left - 2, Top - 10. 4. Update the global object parameter for the Alarm Button indication. This shows the operator what alarm display is being viewed. Update the global object parameter for each alarm display: 68 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework - Alarm Summary = 1 - Alarm History = 2 - Alarm Shelved = 3 - Alarm Explorer =4 Diagnostic Navigation Bar Only one Diagnostic Navigation bar is needed for each L1 area. For the Diagnostic Navigation, the button text does not need to be updated. Only the navigation must be updated. 1. To update the navigation for each button, go to the diagnostic button > Action tab and update the display names for each of the diagnostic screens. Note: There are two user customizable buttons available on this navigation bar, to be used for additional diagnostic displays as needed. This should match the Diagnostic Displays created for this L1 area (see Displays for more information on the diagnostic template displays). If the diagnostic display names match the recommended naming convention, you can do a “Tag Substitution” and simply replace “(raP-5_20-SE) Template” on the whole Diagnostic Navigation bar instead of updating each button individually. 2. Copy the button bar and paste the bar in each of the two diagnostic displays, as well as any user custom diagnostic displays that have been created: - [L1Area] Diagnostic-Summary - [L1Area] Diagnostic-IOEvents Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 69 Chapter 3 Configure the Graphic Framework 3. To update the location for the diagnostic navigation bar in the diagnostic displays, go to the Diagnostic Navigation bar and place all Diagnostic Navigation bars in this location on each of the diagnostic displays: Left - 2, Top - 10. 4. Update the global object parameter for the Diagnostic Button indication. This shows the operator what diagnostic display is being viewed. Update the global object parameter for each diagnostic display: - Diagnostic Summary = 1 - IO Event Viewer = 2 - User custom = 3 - User custom =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. 70 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework 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. Repeat for each button used. 3. After you finish updating the button text and actions, select the updated button bar and copy. 4. Go to the application-specific display developed from the template files (raP-5_20-SE) Template Mon# Header, delete the existing L2 Navigation bar, and paste the new L2 Navigation bar. 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 Alarm Grouping and Supporting Logic for more information. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 71 Chapter 3 Configure the Graphic Framework These fields MUST be entered with text or errors populate in FactoryTalk® Diagnostics. Enter the appropriate alarm group name for the buttons used. If button is not used, simply enter “NotUsed” as shown below. This acts 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. 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. 72 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 1. Configure the Graphic Framework 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 copied L3 navigation bar 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 are used in this example). 2. To update the text on the button, got to Object Explorer and select the L3_ButtonTxt_# object. Repeat for each button. 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. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 73 Chapter 3 Configure the Graphic Framework Repeat for each button used. 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_20-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 L2 and L3 displays: Left-0, Top-0. 74 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework You can update the location on the property panel for the L3 Navigation bar while in the Header display. 7. For all buttons (used or not used), the L1, L2, and L3 alarm group parameter must be entered in the global object parameters. See Alarm Grouping and Supporting Logic for more information. These fields MUST be completed with text or errors populate in FactoryTalk Diagnostics. Enter the appropriate alarm group name for the buttons used. If a button is not used, simply enter “NotUsed” as shown in the following display. This acts as a dummy alarm group. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 75 Chapter 3 Configure the Graphic Framework 8. Edit parameters 107 and 108. Parameters #107 and #108 are used for active display indication. The indicators are horizontal dark gray lines that appear beneath the L2 and L3 navigation bars to indicate the active display. Parameter 107 108 Description Parameter #107 is a component of the L2/L3 display and is used to position the indicator for the active L2 display (It appears below the L2 Navigation bar). Valid values for #107 range from 0 to 16: L2 or L3 Display Active #107 = 0: no indication #107 = 1...16: locates the indicator in position 1 to 16 (left to right) to indicate the active L2 selection or the L2 associated with the active L3 display. Parameter #108 is a component of the L2/L3 display and is used to position the indicator for the active L3 display (it appears under the L3 Navigation bar). Valid values for #108 range from 0 to 16: L2 Display Active #108 = 0: no indicator appears as no L3 display is yet selected L3 Display Active #108 = 1...16: locates the indicator in position 1 to 16 (left to right) to indicate the active L3 selection. The indicator uses horizontal animation with the parameter to indicate the button selected. 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. 76 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework 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 L3 graphics that are 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. 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_20-SE) Template Display L2 No L3”. No configuration is required in the global object file. See Displays for configuration on the default display Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 77 Chapter 3 Configure the Graphic Framework Displays Each display is a template. The template display should be duplicated and the prefix “(raP-5_20SE) 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 Build Your PlantPAx HMI Application 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 used but can be modified for application-specific needs. (raP-5_20-SE) Template LanguageSelect 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 as a pop-up display for a summary of the current user's security access for A-P security, area security, and basic information such as user group and computer name. This should be used in conjunction with the Header button for Administrator. Link this display to the Administrator Header button. The sections on the display (Process Objects Authorized Functionality, HMI Security Codes (A-P), and User Groups) are configured with recommended PlantPAx configuration and should not need to be modified. The section for Area Based User Groups should be updated to reflect the areas used in the application: There is space at the bottom right of the pop-up display for users to add additional administrator level content. (raP-5_20-SE) Template AdminSysSecurity See (raP-5_20-SE) Template Admin-SysSecurity (Continued) (raP-5_20-SE) Template Admin-SysSecurity (Continued) 78 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Display (raP-5_20-SE) Template Display Map Graphic Configure the Graphic Framework Description 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 L1 Navigation. Link this display to L1 Navigation Header button. Update the Display title for the specific application. See Global Objects for more information on configuring the buttons on this display. These templates are used for Headers for each L1 area. Depending on the monitor configuration for the operator for the L1 area, one or more Header displays can be used for each L1 area. It is up to the user whether all Headers in a multi-monitor configuration use the same Header display or use a different header for each monitor. See Multi-Monitor for more information on configuring a multi-monitor system. The buttons on the header can be modified using objects that are provided in the global object files. The L2 Navigation bar resides on this screen and is always visible. (raP-5_20-SE) Template Mon1 Header The alarm banner object needs 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 groups that correlate with that Header. Note: If there are alarms that are both controller based and server based, both subscriptions 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_20-SE) Template Mon2 Header (raP-5_20-SE) Template Mon3 Header (raP-5_20-SE) Template Mon4 Header The L2 Navigation bar must be configured properly - See Global Objects to configure the L2 Navigation. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 79 Chapter 3 Configure the Graphic Framework Display Graphic Description (raP-5_20-SE) Template AlarmExplorer 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 must be configured - see Global Objects for more information. (raP-5_20-SE) Template AlarmHistory 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 needs 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. 80 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Display Graphic Configure the Graphic Framework Description (raP-5_20-SE) Template AlarmShelved 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 needs to be configured - see Global Objects for more information. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 81 Chapter 3 Configure the Graphic Framework Display (raP-5_20-SE) Template AlarmSummary Graphic Description 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 needs 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 needs 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 groups that correlate with that Header. Note: If there are alarms that are both controller based and server based, both subscriptions need to be added. 82 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Display Graphic Configure the Graphic Framework Description (raP-5_20-SE) Template DiagnosticSummary This template is used for access to hardware organizational tree view as well as additional custom diagnostic objects that a user may want to add. There is also an Automatic Diagnostic Event Summary object at the bottom of the display. 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 needs to be adjusted for each L1 display. Otherwise, no configuration is required. See Organization for configuration of the software and hardware organizational tree view objects. Link this display to the Diagnostic Events Summary Button or access via the Diagnostic Navigation bar. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 83 Chapter 3 Configure the Graphic Framework Display Graphic Description (raP-5_20-SE) Template DiagnosticIOEvents This template is used for full page 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 needs to be adjusted for each L1 display. Otherwise, no configuration is required. Link this display to the Diagnostic Events Summary Button or access via the Diagnostic Navigation bar. (raP-5_20-SE) Template Trend_Full This template is used for full screen display of the TrendPro object. It is recommended to use one per application and use various TrendPro templates to view different trend configurations. The desired initial TrendPro template view can be entered as a parameter into the Trend navigation button, but different TrendPro templates can be applied from the TrendPro toolbar. No direct configuration is required for this display. Link this display to the Trend header button - see Global Objects for details on navigation configuration. 84 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Display Graphic Configure the Graphic Framework Description (raP-5_20-SE) Template Trend_Popup This template is used for pop-up display of the TrendPro object. It is recommended to use one per application and use various TrendPro templates to view different trend configurations. The desired TrendPro template view can be entered as a parameter into the Trend pop-up navigation button. No direct configuration is required for this display. Link this display to the Trend pop-up button. The Trend pop-up button can be placed across L1, L2, or L3 process displays - see Global Objects for details on navigation configuration. (raP-5_20-SE) Template Reports This template is used to access SSRS reports via the SE Web Browser object. The template should be used once for each system. The SSRS reports must be installed and configured before using this display. Link this display to the Reports Header Button. See Global Objects for more information on configuring the buttons on this display. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 85 Chapter 3 Configure the Graphic Framework Display Graphic Description (raP-5_20-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 has 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. (raP-5_20-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 left corner. Typically, this graphic contains the 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. 86 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Display Graphic Configure the Graphic Framework Description (raP-5_20-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 left corner. Typically, this graphic contains the 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 needs to be configured. There is one parameter (#107) and is configured the same as with the L3 navigation bar. See Global Objects for details on this parameter. (raP-5_20-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 left corner. Typically, this graphic contains 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. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 87 Chapter 3 Configure the Graphic Framework Display Graphic Description 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 must be updated. • Same L1 1. Copy the object onto the desired screen. 2. Update the text. 3. Update the button action – navigate direct to display. (raP-5_20-SE) Template Toolbox • Other L1 1. Copy the objected onto the desired screen. 2. Update the text object. 3. Update the button action - use several commands to close current L1 view and opened desired L1 header and process display. These commands are developed to work with multi-monitor. See MultiMonitor for more information. If the system status breadcrumb is used, the animation needs 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. (raP-5_20-SE) Template DiagnosticSysSts Only available in FactoryTalk View v13 and later templates. This template is used to access the FactoryTalk System Status Portal via the SE Web Browser object. The template should be used once for each system. The FactoryTalk System Status Portal utility must be installed on system servers when installing FactoryTalk Services Platform. This display should be accessed via the Diagnostic Navigation bar. The parameter path must be updated to the IP address of the FactoryTalk Directory server. (raP-5_20-SE) Common-Redirect-to4_10 (raP-5_20-SE) Common-Redirect-to5_00 These two displays are optional and only needed in applications that are using both the Process Library 4.10 and Process Library 5.00 or later. The redirect displays are used with modified navigation macros - See Macros for more information. No configuration, modification, or renaming is needed to use these displays. They only need to be added into the application if the application is using both the Process Library 4.10 and Process Library 5.00 or later Multi-Monitor The Graphic Framework provides template options for single, dual, or quad monitor client workstations. There are several adjustments to button commands, startup macros, and displays as well as additional configuration that allows the multi-monitor functionality to operate smoothly. HMI Tags, Headers, and Macros There are HMI tags that must be created for multi-monitor to work correctly. Each tag is a string that stores the file name of the header displays used in each L1 area. All four tags should be 88 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework created for each L1 area, regardless of the number of monitors used by workstations in that area. For example, if there is an Area 1 with one quad-monitor workstation, Area 2 with one dual-monitor workstation, and an Area 3 with one single monitor workstation, the following tags, macros, and displays should be created. To begin, determine the area in the system that is using the maximum number of monitors. In our example, Area 1 is a quad monitor, so the maximum number of monitors would be four. Four header displays must be created for each area to ensure that the workstation in Area 1 operates correctly. Header displays can be identical or modified to show different information on each monitor. For each of the HMI tags, the value is each Header display file name. L1 Area Area 1 Area 2 Area 3 HMI Tag Name RALibrary\Area1_M1 RALibrary\Area1_M2 RALibrary\Area1_M3 RALibrary\Area1_M4 RALibrary\Area2_M1 RALibrary\Area2_M2 RALibrary\Area2_M3 RALibrary\Area2_M4 RALibrary\Area3_M1 RALibrary\Area3_M2 RALibrary\Area3_M3 RALibrary\Area3_M4 HMI Tag Value Area1_Mon1_Header Area1_Mon2_Header Area1_Mon3_Header Area1_Mon4_Header Area2_Mon1_Header Area2_Mon2_Header Area2_Mon3_Header Area2_Mon4_Header Area3_Mon1_Header Area3_Mon2_Header Area3_Mon3_Header Area3_Mon4_Header Macros Needed Displays Needed • Area1_Mon1_Header • Area1_ClientStatup • Area1_Mon2_Header • Area1_Repaint_QuadMon • Area1_Mon3_Header • Area2_Repaint_QuadMon • Area1_Mon4_Header • Area3_Repaint_QuadMon • Any required process, diagnostic, or alarm display • Area2_Mon1_Header • Area2_ClientStatup • Area2_Mon2_Header • Area2_Repaint_DualMon • Area2_Mon3_Header • Area1_Repaint_DualMon • Area2_Mon4_Header • Area3_Repaint_DualMon • Any required process, diagnostic, or alarm display • Area3_Mon1_Header • Area3_ClientStatup • Area3_Mon2_Header • Area3_Repaint_SingleMon • Area3_Mon3_Header • Area1_Repaint_SingleMon • Area3_Mon4_Header • Area2_Repaint_SingleMon • Any required process, diagnostic, or alarm display Area 1 Macro Files The following tables show the macros that are used for each Area. Screen displays are shown for Area 1 to provide clarity. The displays for Area 2 and Area 3 will follow the same format. Table 1 - Area_1ClientStartup Command Display Area1_Mon1_Header /TM1,Area1 /M1 Display Area1_L1 /TM1, RALibrary\Area1_M1 /M1 Display Area1_Mon2_Header /TM2,Area1 /M2 Display Area1_L1 /TM2,RALibrary\Area1_M2 /M2 Display Area1_Mon3_Header /TM3,Area1 /M3 Display Area1_L1 /TM3,RALibrary\Area1_M3 /M3 Display Area1_Mon4_Header /TM4,Area1 /M4 Display Area1_L1 /TM4,RALibrary\Area1_M4 /M4 Define GoHome Area1_Repaint_QuadMon Define Repaint SetRepaint QuadMon Description Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Display commands for monitor 3 (header and process display) with required tag parameters. Display commands for monitor 4 (header and process display) with required tag parameters. Define action of "GoHome" symbol used on Home Navigation Button Define action of "Repaint" symbol that is used on Repaint Button and L1 Navigation Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 89 Chapter 3 Configure the Graphic Framework Table 2 - Area1_Repaint_QuadMon Command Abort * /D Display Area1_Mon1_Header /TM1,Area1 /M1 Display Area1_L1 /TM1, RALibrary\Area1_M1 /M1 Display Area1_Mon2_Header /TM2,Area1 /M2 Display Area1_L1 /TM2,RALibrary\Area1_M2 /M2 Display Area1_Mon3_Header /TM3,Area1 /M3 Display Area1_L1 /TM3,RALibrary\Area1_M3 /M3 Display Area1_Mon4_Header /TM4,Area1 /M4 Display Area1_L1 /TM4,RALibrary\Area1_M4 /M4 90 Description Abort all current displays running on the Quad monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Display commands for monitor 3 (header and process display) with required tag parameters. Display commands for monitor 4 (header and process display) with required tag parameters. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework Table 3 - Area1_Repaint_DualMon Command Abort * /D Display Area1_Mon1_Header /TM1,Area1 /M1 Display Area1_L1 /TM1, RALibrary\Area1_M1 /M1 Display Area1_Mon2_Header /TM2,Area1 /M2 Display Area1_L1 /TM2,RALibrary\Area1_M2 /M2 Description Abort all current displays running on the dual monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Table 4 - Area1_Repaint_SingleMon Command Abort * /D Display Area1_Mon1_Header /TM1,Area1 /M1 Display Area1_L1 /TM1, RALibrary\Area1_M1 /M1 Description Abort all current displays running on the single monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 91 Chapter 3 Configure the Graphic Framework Area 2 Macro Files Table 5 - Area2_ClientStartup Command Display Area2_Mon1_Header /TM1,Area2 /M1 Display Area2_L1 /TM1,RALibrary\Area2_M1 /M1 Display Area22_Mon2_Header /TM2,Area2 /M2 Display Area2_L1 /TM2,RALibrary\Area2_M2 /M2 Define GoHome Area2_Repaint_DualMon Define Repaint SetRepaint DualMon Description Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Define action of "GoHome" symbol used on Home Navigation Button Define action of "Repaint" symbol used on Repaint Button and L1 Navigation Table 6 - Area2_Repaint_QuadMon Command Abort * /D Display Area2_Mon1_Header /TM1,Area2 /M1 Display Area2_L1 /TM1,RALibrary\Area2_M1 /M1 Display Area2_Mon2_Header /TM2,Area2 /M2 Display Area2_L1 /TM2,RALibrary\Area2_M2 /M2 Display Area2_Mon2_Header /TM3,Area2 /M3 Display Area2_L1 /TM3,RALibrary\Area2_M3 /M3 Display Area2_Mon2_Header /TM4,Area2 /M4 Display Area2_L1 /TM4,RALibrary\Area2_M4 /M4 Description Abort all current displays running on the quad monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Display commands for monitor 3 (header and process display) with required tag parameters. Display commands for monitor 4 (header and process display) with required tag parameters. Table 7 - Area2_Repaint_DualMon Command Abort * /D Display Area2_Mon1_Header /TM1,Area2 /M1 Display Area2_L1 /TM1,RALibrary\Area2_M1 /M1 Display Area2_Mon2_Header /TM2,Area2 /M2 Display Area2_L1 /TM2,RALibrary\Area2_M2 /M2 Description Abort all current displays running on the dual monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Table 8 - Area2_Repaint_SingleMon Command Abort * /D Display Area2_Mon1_Header /TM1,Area2 /M1 Display Area2_L1 /TM1,RALibrary\Area2_M1 /M1 Description Abort all current displays running on the single monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Area 3 Macro Files Table 9 - Area3_ClientStartup Command Display Area3_Mon1_Header /TM1,Area3 /M1 Display Area3_L1 /TM1,RALibrary\Area3_M1 /M1 Define GoHome Area3_Repaint_SingleMon Define Repaint SetRepaint SingleMon 92 Description Display commands for monitor 1 (header and process display) with required tag parameters. Define action of "GoHome" symbol used on Home Navigation Button Define action of "Repaint" symbol used on Repaint Button and L1 Navigation Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework Table 10 - Area3_Repaint_QuadMon Command Abort * /D Display Area3_Mon1_Header /TM1,Area3 /M1 Display Area3_L1 /TM1,RALibrary\Area3_M1 /M1 Display Area3_Mon2_Header /TM2,Area3 /M2 Display Area3_L1 /TM2,RALibrary\Area3_M2 /M2 Display Area3_Mon3_Header /TM3,Area3 /M3 Display Area3_L1 /TM3,RALibrary\Area3_M3 /M3 Display Area3_Mon4_Header /TM4,Area3 /M4 Display Area3_L1 /TM4,RALibrary\Area3_M4 /M4 Description Abort all current displays running on the quad monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Display commands for monitor 3 (header and process display) with required tag parameters. Display commands for monitor 4 (header and process display) with required tag parameters. Table 11 - Area3_Repaint_DualMon Command Abort * /D Display Area3_Mon1_Header /TM1,Area3 /M1 Display Area3_L1 /TM1,RALibrary\Area3_M1 /M1 Display Area3_Mon2_Header /TM2,Area3 /M2 Display Area3_L1 /TM2,RALibrary\Area3_M2 /M2 Description Abort all current displays running on the dual monitor client Display commands for monitor 1 (header and process display) with required tag parameters. Display commands for monitor 2 (header and process display) with required tag parameters. Table 12 - Area3_Repaint_SingleMon Command Abort * /D Display Area3_Mon1_Header /TM1,Area3 /M1 Display Area3_L1 /TM1,RALibrary\Area3_M1 /M1 Description Abort all current displays running on the dual monitor client Display commands for monitor 1 (header and process display) with required tag parameters. There is a naming convention that must be followed when creating each repaint macro. The file name must be in the following format, as shown in the macro file SetRepaint: Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 93 Chapter 3 Configure the Graphic Framework The %1 and %2 are defined in each client startup macro, as shown in the following examples. 94 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework Create HMI Tags for Multi-Monitor 1. Open Tags under HMI Tags in the application in FactoryTalk View Studio. 2. Open the folder “RALibrary”. There are four sample tags that are created in this folder. Duplicate each tag – groupings of four tags for each L1 area, one for each possible monitor. “Area1” should be replaced with the name of your L1 area. Update the description field and enter the header file display name (*.gfx) in the initial value field for each header in the appropriate tag. Repeat for each L1 area. Parameter Explanation Client Startup Macro Each monitor has two button command lines that are associated with the first time that the displays are opened on the given monitor of the client. It is important that these parameters are configured correctly in the client startup macro and when switching between L1 areas. The Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 95 Chapter 3 Configure the Graphic Framework following is an explanation of what the commands and parameters mean for each monitor, in this example for monitor 1. This needs to be duplicated for each monitor used in the client. Display Command Item Description and Configuration Parameter Tags - A built-in parameter that indicates the next items /T that are listed in the command will be Parameter Tags. No configuration required. Parameter #1 - Parameter is used to pass the monitor number to commands executed on the Header Display. The parameter must be M1 updated to M1, M2, M3, or M4 depending on which monitor the display opens on. Display (Header Display) Parameter #2 - Parameter is used to pass the current L1 area name to commands executed on the Header Display. The parameter must Area1 correspond to the area name for that L1 and match the area name that is used in the HMI Tags for multimonitor. Monitor Index - A built-in parameter in FactoryTalk View to command the display to open on a particular monitor. The parameter must be /M1 updated to /M1, /M2, /M3, or /M4 depending on which monitor it opens on. Parameter Tags - A built-in parameter that indicates the next items /T that are listed in the command will be Parameter Tags. No configuration required. Parameter #1 - Parameter is used to pass the monitor number to commands executed on the Process Display. The parameter must be M1 updated to M1, M2, M3, or M4 depending on which monitor the display will open on. Parameter #2 - Parameter is used to pass the HMI tag name for the Display (Process Display) current L1 area and current monitor. The value of the tag will be used identify what the Header display file name is for that monitor. The RALibrary\Area1_M1 to parameter must be updated to the specific L1 area and monitor for this client. See HMI Tags, Headers, and Macrosfor more details on how to configure the HMI tags for multi-monitor. Monitor Index - A built-in parameter in FactoryTalk View to command the display to open on a particular monitor. The parameter must be /M1 updated to /M1, /M2, /M3, or /M4 depending on which monitor it opens on. There are two defined symbols in the startup macro that are crucial for the client to operate as expected. As noted in FactoryTalk View Studio help documentation, the system command Define creates a symbol at run time on the FactoryTalk View SE Client. This command is only run on the FactoryTalk View SE Client. Symbol definitions are valid only during the current client session; they must be redefined each time that the client is restarted. Symbols are typically defined in a startup or login macro. 96 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Define command Define GoHome Configure the Graphic Framework Description and Configuration The "GoHome" symbol is used exclusively for the Home Button that is used on the header display. The "GoHome" symbol is defined when the client starts up and the definition is specific to that client. Regardless of which L1 area an operator might end up navigating to, when the Home Button is pressed, it executes the defined macro. The macro that is used for this symbol should be configured to open on the correct number of monitors for that client. The "GoHome" symbol should be used on every startup macro. Replace "Template_Repaint_QuadMon", "Template_Repaint_DualMon", or "Template_Repaint_SingleMon" with the Repaint macro to be used for this specific client. The "Repaint" symbol is used for both the Repaint Screen Button header display and L1 Navigation from the display map pop-up. The "Repaint" symbol is defined when the client starts up and the definition is specific to that client. When navigating to another L1 area or repainting the screen on any area, the symbol executes the pre-defined macro "SetRepaint", with two parameters passed to the macro. Define Repaint %1 Parameter - This is configured in the definition of in the startup client and should be either "QuadMon", "DualMon", or "SingleMon" depending on how many monitors that client has. User must update this in the startup client file. %2 Parameter - This is passed automatically when the button is pressed. No configuration is required as long as the display commands are configured as required in the startup macro. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 97 Chapter 3 Configure the Graphic Framework L2 Navigation Each button on the L2 Navigation bar needs the following button command constructed to pass the proper Parameter Tags to the process display. Command Item Description and Configuration Parameter Tags - A built-in parameter that indicates the next items /T that are listed in the command will be Parameter Tags. No configuration required. Parameter #1 - Parameter is used to pass the monitor number to commands executed on the L2 process display. The "#1" will use the #1 Parameter #1 pushed into the Header Display when it was initially opened. No configuration required; leave #1 as is. Display [L2 Process Display] Parameter #2 - Parameter is used to pass the HMI tag name for the current L1 area and current monitor. The value of the tag will be used to identify what the Header display file name is for that monitor. The RALibrary\#2_#1 "#1" and "#2" will use the Parameter #1 and Parameter #2 pushed into the Header Display when it was initially opened. No configuration required; leave #1 and #2 as is. See HMI Tag, Headers, and Macros for more details on how to configure the HMI tags for multi-monitor. L3 Navigation Each button on the L3 Navigation bar needs the following button command constructed to pass the proper Parameter Tags to the process display. This will also be used for any Off-Screen navigation buttons within the same L1 area. Command Item /T #1 Display [L3 Process Display] #2 98 Description and Configuration Parameter Tags - A built-in parameter that indicates the next items listed in the command will be Parameter Tags. No configuration required. Parameter #1 - Parameter is used to pass the monitor number to commands executed on the L3 process display. The "#1" will use the Parameter #1 pushed into the Process Display when it was initially opened. No configuration required; leave #1 as is. Parameter #2 - Parameter is used to pass the HMI tag name for the current L1 area and current monitor. The value of the tag will be used to identify what the Header display file name is for the monitor active for this display. The "#2" will use the Parameter #2 pushed into the Process Display when it was initially opened. No configuration required; leave #2 as is. See HMI Tags, Headers, and Macros for more details on how to configure the HMI tags for multi-monitor. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework Off-Screen Navigation Command Item Abort [Header Display] Abort $#2$ Abort [Process Display] Abort Me /T #1 Display [Header Display] Area2 /#1 /T #1 Display [Process Display] RALibrary\Area2_#1 /#1 Macros Description and Configuration This command aborts the header that is open above the process display. The "$#2$" inserts the value of the parameter "#2" that was passed into the display that the button is executing from. The value of "#2" is the HMI tag for the header display file name. This command aborts the process display that the button is executing from. Parameter Tags - A built-in parameter that indicates the next items listed in the command will be Parameter Tags. No configuration required. Parameter #1 - Parameter is used to pass the monitor number to commands executed on the Header Display. In this instance, we take the parameter that is passed from when the display was originally opened. No configuration required. Parameter #2 - Parameter is used to pass the destination L1 area name to commands executed on the destination Header Display of the other L1 area. The parameter must correspond to the area name for the destination L1 area and match the area name that is used in the HMI Tags for multimonitor. Monitor Index - A built-in parameter in FactoryTalk View to command the display to open on a particular monitor. In this instance, it takes the parameter that is passed from when the display was originally opened. No configuration required. Parameter Tags - A built-in parameter that indicates the next items that are listed in the command will be Parameter Tags. No configuration required. Parameter #1 - Parameter is used to pass the monitor number to commands executed on the Header Display. In this instance, we take the parameter that is passed from when the display was originally opened. No configuration required. Parameter #2 - Parameter is used to pass the HMI tag name for the destination L1 area and current monitor. The value of the tag will be used to identify what the Header display file name is for that monitor in the other L1 area. The parameter must be updated to the specific L1 area, but the "#1" should be left as is. See HMI Tags, Headers, and Macros for more details on how to configure the HMI tags for multi-monitor. Monitor Index - A built-in parameter in FactoryTalk View to command the display to open on a particular monitor. In this instance, it takes the parameter that is passed from when the display was originally opened. No configuration required. Macros are an important component in the graphic framework. There are several macros that are provided as a template. • Template_ClientStartup_SingleMon Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 99 Chapter 3 Configure the Graphic Framework • • • • • • Template_ClientStartup_DualMon Template_ClientStartup_QuadMon Template_Repaint_SingleMon Template_Repaint_DualMon Template_Repaint_QuadMon SetRepaint The following are optional macros used for applications using both Process Library 4.10 and Process Library 5.00 or later. • NavToFaceplate with mixed library • NavToDisplay with mixed library Template_ClientStartup Number of Monitors Commands 1 2 100 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Number of Monitors Configure the Graphic Framework Commands 4 The Client Startup macro should be linked to the Startup Macro selected in the client file configuration. There should be at least one Client Startup macro for every L1 area. The two "Define" functions that are shown in the preceding screen capture are used to configure 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 (for example, if you have five clients in a system, each client would be assigned a different number: 0, 1, 2, 3, 4, etc). The shortcut that is defined for each in the second line should be a valid shortcut that is used for to initialize on. The shortcut should include the full area and short name. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 101 Chapter 3 Configure the Graphic Framework The main purpose of this macro is to open the header and the L1 overview display for each monitor. The specific displays need to be updated for each macro that is created to point to the Header and screen for that L1 area. The macro is also used to define the GoHome and Repaint symbol commands. GoHome is used for Home button on the Header. The definition of the GoHome has to be updated to point to the specific L1 area and client repaint macro. The Repaint symbol is used for Repaint Screens button as well as the L1 Navigation. The number of monitors that are used by the client should be updated here (QuadMon, DualMon, or SingleMon) Template_Repaint The repaint macro is identical to the client startup macro, except the symbol definitions are not executed. At least one repaint macro should be created for every L1 area. If there is more than one client per L1 area with differing number of monitors, one repaint macro per each client, with specified monitor quantity, should be created for each L1 area. The repaint macro is used by the Repaint symbol, which executes the macro SetRepaint. The repaint macro should be created regardless of if the Repaint button is used, because it will be used by the Home button and for navigation between L1 areas. The following example shows a system with four display monitors. SetRepaint The SetRepaint macro is used to build the correct repaint macro to use based on the area parameter and quantity of monitors that are configured in the startup client macro. No configuration of this macro is required. It must exist in the macro list for navigation to work properly. 102 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 Configure the Graphic Framework NavToDisplay with Mixed Library / NavToFaceplate with Mixed Library The two macros “NavToDisplay with mixed library” and “NavToFaceplate with mixed library” are only necessary for applications that are using both the Process Library 4.10 and Process Library 5.00 or later. There is added logic in these two macros to ensure that navigation is possible between 4.10 object faceplates and 5.00 object faceplates and vice versa. The macros work with two redirect displays - “(raP-5_20-SE) Common-Redirect-to-4_10” and “(raP-5_20-SE) CommonRedirect-to-5_00”. The macros are used in place of the NavToDisplay and NavToFaceplate. To use: 1. Rename the existing NavToDisplay and NavToFaceplate to a temporary name such as NavToDisplay_Original and NavToFaceplate_Original. This is in case the macros are needed for review in the future, they will already be available. 2. Rename “NavToDisplay with mixed library” and “NavToFaceplate with mixed library” to NavToDisplay and NavToFaceplate respectively. The macros are ready use. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 103 Chapter 3 Configure the Graphic Framework Client File Setup (.CLI) Configure 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 Location Name the client file and select the store location. In most cases, the store location should be the OWS desktop. 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 104 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 3 On this Page Configure the Graphic Framework Action Select "Maximize Window" - Note: It is assumed that all monitors in the system 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 the configuration. Advanced Settings If more than one monitor is being used for the station that will run this client, check the box for "Multi-monitor". Additional options appear. Specify the monitor size as 1920x1080 and pick the desired monitor layout. In the following example, dual monitors side by side are being used. No additional configuration is required for each monitor - the startup macro that is selected on the Startup Components tab configures the screens when the client starts. Save and select the "Security and debugging". Advanced Settings Multi-Monitor Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 105 Chapter 3 On this Page Configure the Graphic Framework 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 necessary. Leave at default if there are not application-specific requirements. Save and close or Select Run to run the Client file. Other Options 106 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization Overview Organization is a method by which parent / child relationships can be created and modified among PlantPAx® Instructions. Organization provides a method to propagate a selected subset of commands (related to command source, alarms, and so forth) from the parent down to its children or propagate the aggregate of a selected subset of status (related to command source, alarms, and so forth) from the children up to one or more parents. 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. There are three basic capabilities: Function Organization Ownership Arbitration • • • • • Description Create parent/child relationships among objects to provide a method to propagate commands from the parent to its children and propagate status from the children to the parent. Uses the Organization backbone to allow a parent to take ownership of its children by placing them into Program state and accept the Owner's ID Provides ability to manage and prioritize ownership of shared equipment Provides the ability to command devices as an Equipment Group No additional Logix-based code required to group equipment Consolidates information (alarms, device modes) Queues ownership requests and lets users set arbitration rules Applying standard solutions not only for direct device control, but also for device management enables a common look and feel throughout the complete application Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 107 Chapter 4 108 Organization Commands Issued and Propagated Reset/Ack All Reset Disable alarms Enable alarms Suppress alarms Unsuppress alarms Unshelve alarms Request Virtual Request Physical Request Oper Request Prog Request Ext Release Ext Request Maint Release Maint Description Issue a Reset/Ack All to all objects Issue a Reset to all objects Disable all alarms Enable all alarms Suppress all alarms Unsuppress all suppressed alarms Unshelve all shelved alarms Request all to be in Virtual Request all to be in Physical Request all to be in Operator Request all to be in Program Request all to be in External Release all from External Request all to be in Maintenance Release all from Maintenance Status Produced and Propagated Alarms Active Alarms/Object to be Reset Ready for Reset Alarms Enabled Alarms Disabled Alarms Unsuppressed Alarms Suppressed Alarms Shelved Object Not Ready Description At least one alarm is active for this object or its children At least one alarm is ready for reset for this object or its children At least one object or child is ready for reset At least one alarm is enabled for this object or its children At least one alarm is disabled for this object or its children At least one alarm is not suppressed for this object or its children At least one alarm is suppressed for this object or its children At least one alarm is shelved for this object or its children At least one object or child is not ready Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Status Produced and Propagated Maint Bypass Active Objects in Physical Objects in Virtual Ready for Oper Request Ready for Prog Request Ready for Ext Request Ready for Ext Release Ready for Maint Request Ready for Maint Release Objects in Hand Objects Out of Service (OoS) Objects in Oper or Prog Locked Objects has Prog, is not in Prog Prompt is active Workflow Organization Description At least one object or child has a Maint Bypass active At least one object or child is in Physical At least one object or child is in Virtual At least one object or child is ready for an Oper request At least one object or child is ready for a Prog request At least one object or child is ready for an Ext request At least one object or child is ready for an Ext release request At least one object or child is ready for a Maint request At least one object or child is ready for a Maint release request At least one object or child has an active prompt At least one object or child is Out of Service At least one object or child is Oper or Prog Locked At least one object or child has Prog but is not in Prog At least one object or child has an active prompt Before you begin, confirm you have the following: • Controller project and HMI project communicating to controller • System hierarchy for equipment grouping • Graphic framework installed • Configured HMI shortcuts • Displays created This chapter shows how to manually configure organization. Application Code Manager and the PlantPAx Configuration Tool provide simplified workflows that are more efficient to initially configure organization. However, the manual process can be useful for minor edits. 1. In a process controller project, create the organization logic (create Bus and Node arrays) 2. Define the Bus elements 3. Implement the OrgView elements that store data for each HMI client 4. Create the Organizational Tree (define nodes and configure propagation and displays) Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 109 Chapter 4 Organization The Tank Farm Area has: • Unit TK100 has children FV101, FV102, FV301, PMP101, and AGT101 • Unit TK200 has children FV201, FV202, FV301, PMP201, and AGT201 Create the Organization Logic Before you begin, import the process library Add-On Instructions into your controller project. All logic must be in one controller. The following Add-On Instructions are required: • raP_Opr_OrgScan Organizational Scan • raP_Opr_OrgView Organizational View In a process controller project, create the organization program 1. Add a new program in the appropriate Task and name it Organization. The default task is the System task. 110 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization 2. Add a new routine to the Organization program and name it MainRoutine 3. Open the MainRoutine in the Ladder Diagram editor and add an raP_Opr_OrgScan Add-On Instruction to manage the propagation of commands/status and Ownership within the Organization Tree. In the next steps, you create two array tags for these parameters that are used in this Add-On Instruction: • Bus array with an element for each device in your system hierarchy. Make the array larger than the number of devices so you have room for future additions. • BusNode array with an element for each device and its relationship to other devices. Make the node array twice as large as the Bus array so that you can account for devices that have relationships with multiple other devices, and you have room for future additions a. Right-click the raP_Opr_OrgScan ? and create a new, controller-scoped tag OrgScan of data type raP_Opr_OrgScan. b. Right-click the BusNode ? and create a new, controller-scoped array tag Node of type raP_UDT_Opr_Bus_Node. The array tag must be named Node. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 111 Chapter 4 Organization For this example, edit the array to have 100 elements. You can have more nodes than bus elements to define multiple parent/child relationships. c. Right-click the Bus ? and create a new, controller-scoped array tag Bus of type raP_UDT_Opr_Bus. The array tag must be named Bus. Edit the array elements to have 50. Create more elements than your original list of bus elements to leave space to add future elements. Can have as many as 500 Bus elements per controller (increase to 1500 for 5.00.04 or later) 4. Add a rung with an instance of the raP_Opr_OrgView Add-On Instruction for each HMI client that will be in the organizational tree. This example assumes five HMI clients, so there are five individual rungs. a. Right-click the raP_Opr_OrgView ? and create a new tag OrgView of data type raP_Opr_OrgView. Edit the Data Type and enter the array dimensions so that you have an element for each 112 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization HMI client. In this example there are five HMI clients so edit the array to have five elements (one element for each of the five HMI clients in this example). b. Enter the BusNode, Bus, and Orgscan tags you created for the OrgScan instruction. Select one OrgView[x] element for each rung/instance to correspond with each HMI client. Example Logic The final logic for this example, looks like the following: Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 113 Chapter 4 Organization Define the Bus Elements Organization requires a mechanism to collect entities into a structure. Each entity that is grouped into an organization must be assigned a unique identifier. The Bus array provides this mechanism, in addition to providing an interface to exchange commands and status. A single Bus element is assigned to each control element. Generic Bus elements can be added as logical containers as necessary to group control elements and other Generic Bus elements. Example Bus Elements You need a bus element for every possible owner (parent) and child. For this example, create these elements. 114 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization The elements can be in any order and you can use any names that are appropriate for your application. Bus Element Bus[0] Bus[1] Bus[2] Bus[3] Bus[4] Bus[5] Bus[6] Bus[7] Bus[8] Bus[9] Bus[10] Bus[11] Bus[12] Bus[13] Bus[14] Bus[15] Bus[16] Bus[17] Bus[18] Bus[19] Bus[20]…Bus[50] IMPORTANT Name Description Reserved Area_Tank_Farm TK100 TK200 FV101 FV102 FV201 FV202 FV301 AGT101 AGT201 PMP101 PMP201 TK100_Fill_EP TK100_Drain_EP TK100_Agt_EP TK200_Fill_EP TK200_Drain_EP TK200_Agt_EP Empty; for future additions Process area Unit TK100 Unit TK200 Valve FV101 owned by TK100 Valve FV102 owned by TK100 Valve FV201 owned by TK200 Valve FV202 owned by TK200 Valve FV301 shared by TK100 and TK200 Agitator AGT101 Agitator AGT201 Pump PMP101 Pump PMP201 Fill Equipment Phase for TK100 Drain Equipment Phase for TK100 Agitate Equipment Phase for TK100 Fill Equipment Phase for TK200 Drain Equipment Phase for TK200 Agitate Equipment Phase for TK200 Release 5.00.00 of the PlantPAx library, supports as many as 500 bus elements. With release 5.00.04 and later, you can have as many 1500 bus elements. Each bus element has multiple members. To see the members, on the OrgScan or OrgView instruction, right-click Bus and select MonitorBus. Expand each element to configure the device. 1. Enter the name of each element in the Value Field for each Bus[x].Name. The organizational tree uses this value for the device name. 2. Add Extended Properties > Engineering Unit to the element and specify the shortcut for the Data value. The shortcut ties the element to the display faceplate. The shortcut must be defined in the HMI project. • • In this example: DATA is the name of the data server Org_Example is the name of the shortcut in the HMI project Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 115 Chapter 4 Organization • TK100_EM is the name of the element Configure the Area Instance Import the PlantPAx area control strategy: CS_raP_Opr_Area. This defines the Area. In this example, the main routine identifies Bus[2] element for the area. On the Import Configuration dialog, find and replace all instances of 'raP_Opr_Area' in Tags and Descriptions with 'Area.' Configure the Unit Instances Import the PlantPAx unit control strategy: CS_raP_Opr_Unit. This defines a Unit. In this example, the main routine defines Bus[3] (Unit_TK100) and Bus[4] (Unit_TK200) elements for a Unit. On the Import Configuration dialog, find and replace all instances of 'raP_Opr_Unit' in Tags and Descriptions with 'Unit_TK100' for the first instance and ‘Unit_TK200’ for the second instance. 116 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization Create instances for the TK100 and TK200 Units. Configure the Equipment Phase or Equipment Module Instances Import the appropriate PlantPAx control strategy: • CS_raP_Opr_EM_Gen (Equipment Module) • CS_raP_Opr_EP_Gen (Equipment Phase) This example uses Equipment Phases. Edit the Bus element appropriately: • Bus[14] for Unit TK100_Fill_EP • Bus[15] for Unit TK100_Drain_EP • Bus[16] for Unit TK100_AGT_EP • Bus[17] for Unit TK200_Fill_EP • Bus[18] for Unit TK200_Drain_EP • Bus[19] for Unit TK200_AGT_EP Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 117 Chapter 4 Organization On the Import Configuration dialog, find and replace all instances of 'raP_Opr_EP_Gen' in Tags and Descriptions with the appropriate phase name. Configure the Device Instances to Use the Bus Elements Use the PlantPAx control strategies to create the logic for your application. Import the appropriate control strategy for each device. Assign the bus element of each device to the process instruction. 118 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization The Bus Object must match the device element in the Bus array. Each device that you want to add to the node tree must have an associated process instruction. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 119 Chapter 4 Organization Add Devices Bus elements can be in any order and you can use any names that are appropriate for your application. To add additional devices to the Bus, reference and use a Bus array element that is not being used by another object, excluding 0. In this example, add level indicators to both tanks. Bus Element Bus[20] Bus[21] Bus[22]…Bus[50] Name LVL101 LVL201 Empty; for future additions Description Level for TK100 Level for TK200 Bus[20]…Bus[50] Define the OrgView Elements Each control entity and container has been assigned a unique identifier (Bus element), and each tree and its entities are capable of being updated dynamically using the OrgScan instruction (Node element). To facilitate the creation of the HMI client access, you must also define an OrgView array, which will store the data for each client. This is an array of type raP_UDT_Opr_OrgView. There should be one OrgView instruction that is configured for each HMI Client. OrgView provides a window to allow online manipulation of each organizational tree. The Organization View object allows online changes to the Organization Tree (Nodes) while providing a view to the various organizational trees. 120 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization Example OrgView Elements For each OrgView element, enable the Area, Instruction, and Library Extended Properties. These properties tie the display back to the organization structure. Then in the Data, enter this information: • Area = Area01 • Instruction = raP_Opr_OrgView • Library = raP-5_10 • URL = n/a IMPORTANT The Area and Library names must match the settings in the HMI page of the device properties. See the following example: These settings are the default names when you import a process control strategy. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 121 Chapter 4 Organization Create the Organizational Tree in the HMI Client Make sure that you have the application configured with the appropriate user groups. This example uses the default Area01_Basic and Area01_Advanced user groups with a user Engineer_A. Configure the Client Display 1. Build the client display with the elements you defined in the Bus. This example uses these graphic symbols in the display: Graphic Symbol Description (raP-5_20-SE) Graphic Symbols - raP_Opr_Area.gffx Area You must have one Area symbol (raP-5_20-SE) Graphic Symbols - raP_Opr_Unit.gffx Unit (raP-5_20-SE) Graphic Symbols - PVLV.ggfx Valve (one solenoid symbol for each valve) (raP-5_20-SE) Graphic Symbols - PMTR.ggfx Agitator (one agitator symbol for each agitator) 122 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Graphic Symbol Organization Description (raP-5_20-SE) Graphic Symbols - PMTR.ggfx Pump (one blower symbol for each pump) Display Tree View button (raP-5_20-SE) Graphic Symbols - Cross Functional.gffx 2. Select and copy the 'Display Tree View' button from the '(raP-5_20-SE) Graphic Symbols Cross Functional.ggfx' global object file. Paste this button to the desired display. 3. Add the following lines to the client startup macro Line Define SW_ShortcutRedefine DefineShowTreeCmd X DefineShowTreeCmdForClx /SERVER::[TOPIC] Description X = Client number (OrgView element) 0 in this example for client 0 SERVER = data server name TOPIC = shortcut name (path to controller) DATA:[Org_Example] in this example See Client Startup Macro on page 95 to complete this configuration. 4. Generate the client display Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 123 Chapter 4 Organization Build the Node Tree The node tree is where you define system hierarchy and relationships among objects. Build the complete node tree once. For each client you can specify a start node within the node tree. These examples show how to manually perform the processes, you can also use ACM and the PlantPAx Configuration Tool. 1. Sign in to the client display and click the Display Tree View button The initial Tree View shows only the <root> 2. Enable Edit mode In Edit Mode, you can define the Bus that is associated with each Node, define parents or children, and define propagation configuration. 3. Select <root> to display the edit options. 124 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization 4. Select the edit button. 5. Select the Add Child button to add a node. This adds a ? to the display tree. 6. Select the ? to edit the node. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 125 Chapter 4 Organization 7. Select the edit button and click the Select Bus button to assign a bus element to the new node element. 8. Select the bus element 9. Define how to propagate commands (gear button) 126 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization 10. Define how to propagate status (HMI button) 11. Define navigation (HMI button, page 3) IMPORTANT The navigation uses the Extended Tag Property @EngineeringUnit for the Bus Array instance (for example, Bus[37].@EngineeringUnit) because the @Navigation Extended Tag Property is not available in the user-defined data type (UDT) bus array. Option nowhere - node not navigable Description Engineering Unit Extended Tag Property There is no configured navigation for the node not used For use when the node does not have an associated display or faceplate. The generic faceplate can be configured to show any of the not used standard bus commands or status information. Show a standard library faceplate (or other Device Faceplate faceplate that uses the same navigation method) Device Tag. For example, "[MyPath]MyMotor" use with faceplates that require the path as Device Faceplate with For the third display parameter (These include Device Tag. For example, "[MyPath]MyEM" Shortcut Sequencer, Area, Unit, EM, and EP) A custom display. Display parameters are: #1 - read/write tag (constant 2) Specific Display FactoryTalk View display name #2 - Bus instance tag from the bus array #3 - Area security tag from OrgView Generic Bus Faceplate Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 127 Chapter 4 Organization The complete organization tree for this example: The organization tree updates the Node array in the controller.’ Node Element Node[0] Node[1] Node[2] Node[3] Node[4] Organization Tree Element <root> Area1 Tank_Farm TK100_EM TK200_EM Set Start Node You build the complete node tree once. Once you have a complete node tree, you can select which node to start for each client. For example you can have one client view only the TK100 portion and another client view only the TK200 portion. 1. Select the start node. 2. Click the pencil button and click the Set Start Node button to define the start node. 128 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization For example, this view shows unit TK100 as the start node. The other nodes are not viewable by this client. Node Array Guidelines Each entry that you make in the Node Tree becomes an element in the Node array. • Do not change the node array manually within the Logix Designer application. If you create your organization via Application Code Manager or the PlantPAx Configuration Tool, the Node array will be correctly configured. 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 statuses may be relative to this object or any of its children. Status Symbol Description This object or one of its children is not ready. Object 'not usable' by parent. Either the object is owned by another parent, or the object's command source helps prevent program control. This object or one of its children is alerting the operator (Attention.) This object or one of its children is in Virtual. This object or one of its children has an active Maintenance Bypass. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 129 Chapter 4 Organization Example of the Not Ready symbol next to the Area node. Ownership Ownership uses the organization that you configured in the Node Tree to let a parent take ownership of its children to place them in states and receive their status. An Area, Unit, Equipment Module, or Equipment Phase can act as an owner (parent). The implementation of Area, Unit, Equipment Module, and Equipment Phase is specific to each application. The tank farm example shows an instance of each type. Parent Area Unit Equipment Module Equipment Phase Guidelines An Area is the top-level ownership object. An Area groups Units together so that it can manage: • Command Source for a group of equipment • Alarms for a group of equipment If you must sequence equipment (rather than group equipment), use either an Equipment Module or Equipment Phase A Unit groups equipment. Units operate relatively independent of one another. A Unit manages: • Command Source for a group of equipment • Alarms for a group of equipment If you must sequence equipment (rather than group equipment), use either an Equipment Module or Equipment Phase An Equipment Module groups and sequences equipment. Use an Equipment Module when you want to apply a custom state model to the equipment. An Equipment Phase groups and sequences equipment. Use an Equipment Phase when you apply the ISA 88.01 state model using PhaseManager™. For more information see PhaseManager Software User Manual, LOGIX-UM001. 130 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 Organization The Ownership function performs no action on final control device, but instead provides a method to identify and prioritize owners so that other logic can use the 'Owned & Organized' status as permission to an Equipment Module or Equipment Phase to execute (Go / NoGo Flag). Although many objects (including PAI and PAO) can be included in the organizational tree, only objects with Command Source can be owned (Objects are in Program CmdSrc state when owned by a Bus element). Request Ownership The parent control point can be in Operator, Program, External, or Maintenance command state. All Ownership requests and statuses propagate through the Bus. Once owned, the owner issues a request to place its children in Program state. Ownership is established when a parent requests Ownership, all of its children grant this request, and all of its children are placed into program command source state (Children that belong to this parent are ready to accept parental requests). The parent can request ownership programmatically or via the faceplate for the associated parent Add-On Instruction. Parent Object Area Unit Equipment Module Equipment Phase Associated Add-On Instruction raP_Opr_Area raP_Opr_Unit raP_Opr_EMGen raP_Opr_EPGen For example, a Unit parent can request ownership programmatically via the PCmd parameters. To request Ownership you must set PCmd_OwnerAcq. Set PCmd_OwnerRel to release Ownership: A Unit parent can request ownership via the Operator tab on the faceplate: Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 131 Chapter 4 Organization Item 1 2 3 4 5 1 2 3 4 Description Displays the current state of the object Acquire child command source Release child command source Navigates to the tree view for this object Navigates to the Bus faceplate 5 For object and visualization parameters, see Object and Visualization Parameters, PROCES-RD201. Arbitration The optional Arbitration function manages optional queues for shared devices when using the Owner function. It takes an ownership acquisition request, which is pending and, places it on the appropriate class queue. Any pending ownership request is presented to the ownership function as a request in the order in which it resides on the queue. Once the current Owner releases its request, the next in the queue can take ownership. The Arbitration queue: • enables user-defined arbitration rules to be applied to shared resources within a class. • handles and maintains multiple simultaneous requests for ownership. • manages a FIFO of the IDs of Ownership requests within a single command source class. (Operator, Program, External, Maintenance) In the following example: • TK100 and TK200 both have FV301 in their organization tree. 132 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 4 • Organization Program an object for FV301 (Bus[9]) IMPORTANT For ownership commands and statuses to propagate, you must map the parameter pins as indicated in the example. The parameter pins that are connected must align with the bus object index. • There is an optional queue for each class request (Operator/Program/External/ Maintenance). Currently, only Program is used, the rest are reserved for future functionality. You can program logic to manipulate or reorder the entries on the individual queues. This queue shows ownership requests from Bus[3] (TK200) and Bus[2] (TK100). IMPORTANT The user should not directly add or delete items on the individual queues. These functions are handled by the ownership functionality. For object and visualization parameters, see Object and Visualization Parameters, PROCES-RD201. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 133 Chapter 4 Organization Notes: 134 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 5 Ownership (raP_Opr_Owner) The raP_Opr_Owner (Ownership) Add-On Instruction extends the functionality of the PCMDSRC (Command Source) instruction to allow for ownership requests and owner ID book-keeping functionality. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines Use this instruction when it is desirable to maintain ownership IDs and manage ownership arbitration between the ownership classes (Opr, Prog, Ext, and Maint). The raP_Opr_Owner functionality is included in the Bus Organizational UDT (raP_UDT_Opr_Bus). It is not necessary to create a separate raP_Opr_Owner instance to obtain ownership functionality between parent child relationships that are configured in organizational trees that are processed by a raP_Opr_OrgScan instruction. Functional Description The raP_Opr_Owner Add-On Instruction is used to accept and process ownership requests by ID utilizing a PCMDSRC (Command Source) instruction for class arbitration rules. The basic class arbitration rules are implemented by the PCMDSRC instruction, which ownership requests are allowed, which ownership requests 'win' when multiple ownership requests are made by different classes of owners, and so on. The raP_Opr_Owner instruction uses positive value DINTs as ownership IDs. This instruction yields status as to the current owner IDs maintained if any. The ultimate 'winning' owner class and ID are also produced as status. The state of 'Organization' is also indicated through status. This status indicates if the device/object is in the correct PCMDSRC state for its ultimate owner and the status of any children if present and aggregated (that is, through the BUS organization). In this way you can determine if this device/ object is in the proper condition for operation. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 135 Chapter 5 Ownership (raP_Opr_Owner) 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 Files The raP_Opr_Owner_5.20.00_AOI.L5X Add-On Instruction definition file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files The raP_Opr_Owner Instruction uses no visualization files or components. Operations Command Sources The raP_Opr_Owner instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Opr_Owner Instruction uses no alarms. Virtualization The raP_Opr_Owner Instruction has no Virtualization capability. Execution The following table explains the handling of instruction execution conditions. Condition Description EnableIn False (false rung) The raP_Opr_Owner instruction clears all owner status and ID fields, and releases any ownership that is currently applied when scanned false or with the EnableIn=0. Powerup (prescan, first scan) The raP_Opr_Owner instruction clears all owner status and ID fields on PreScan/first scan. Postscan No SFC Postscan logic is provided. For more information, see the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010. 136 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 5 Programming Examples Ownership (raP_Opr_Owner) The raP_ Opr_Owner instruction must be coupled with a PCMDSRC instruction or a device/object that contains a PCMDSRC instruction. There are input and output parameters to accomplish the interface: The 'Owner.Out_OwnerCmd' output parameter sends any pending ownership requests to the PCMDSRC owner interface parameter of the PCMDSRC (Inp_OwnerCmd). The 'Owner.Inp_OwnerSts' input parameter receives existence, configuration, and current state information from the associated PCMDSRC (Out_OwnerSts). When using a Process Object 5.00.xx and later device/object these parameters are supplied on the object to interface the ownership instruction with the object's internal PCMDSRC: When using a Process Object 5.00.xx and later device/object as a participant on the Bus, the Bus referenced ownership interface parameters are used as input and output to the device/object: Graphic Symbols There are no graphic symbols or HMI graphic support for the raP_Opr_Owner instruction. Faceplates There is no faceplate for the raP_Opr_Owner instruction. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 137 Chapter 5 Ownership (raP_Opr_Owner) Notes: 138 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 6 Arbitration (raP_Opr_ArbitrationQ) The raP_Opr_ArbitrationQ (Arbitration) Add-On Instruction extends the functionality of the raP_Opr_Owner (Ownership) instruction to allow for the queuing of ownership requests within an ownership class. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines Use this instruction if you want to extend the functionality of the raP_Opr_Owner to include multiple ownership requests within the same ownership class. One raP_Opr_ArbitrationQ instruction can be associated to a single raP_Opr_Owner to perform optional queuing of any of the four ownership classes (Oper, Prog, Ext, Maint). Functional Description The raP_Opr_ArbitrationQ Add-On Instruction is used to manage arrays of owner IDs for each class of ownership. Ownership requests made of the associated raP_Opr_Owner are intercepted by the raP_Opr_ArbitrationQ instruction and placed into a queue (DINT array) in the order in which they are received. By default, the earliest entry is used by the raP_Opr_Owner for ownership evaluation. As ownership requests and releases are made of the raP_Opr_Owner, the raP_Opr_ArbitrationQ instruction manages the addition and deletion of these requests and releases in the respective queues. Use of the raP_Opr_ArbitrationQ instruction is optional. It extends the functionality of the raP_Opr_Owner instruction. Use the raP_Opr_ArbitrationQ instruction when there are multiple entities that could simultaneously request owner ship of this entity AND you wish to maintain their order of request or manipulate the requests for prioritization. Items in the queues can be reordered by user programming to accommodate prioritization schemes. IMPORTANT You should never add or delete IDs on the queue by user programming. Addition and deletion of IDs is done by the instruction itself based on the ownership requests made by the associated raP_Opr_Owner instruction. The following image shows how a raP_Opr_ArbitrationQ instruction configured with the raP_Opr_Owner instruction 'My_Owner' as its associated owner instruction. Further, it is configured Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 139 Chapter 6 Arbitration (raP_Opr_ArbitrationQ) to have queues for Oper, Prog, and Maint owner classes. It does not use a queue for the External owner class: 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 Files The raP_Opr_ArbitrationQ_5.20.00_AOI.L5X Add-On Instruction definition file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files The raP_Opr_ArbitrationQ Instruction uses no visualization files or components. Operations Command Sources The raP_Opr_ArbitrationQ instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Opr_ArbitrationQ Instruction uses no alarms. Virtualization The raP_Opr_Owner Instruction has no Virtualization capability. 140 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 6 Arbitration (raP_Opr_ArbitrationQ) Execution The following table explains the handling of instruction execution conditions. Condition Description EnableIn False (false rung) The raP_Opr_Arbitration instruction clears all queues and counters when scanned false or with the EnableIn=0. Powerup (prescan, first scan) The raP_Opr_Arbitration instruction clears all queues and counters on PreScan/first scan. Postscan No SFC Postscan logic is provided. For more information, see the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010. Programming Examples The example in the Function Description section shows the basic use of the raP_Opr_ArbitrationQ Add-On Instruction for extending an ownership instruction. Typically, the raP_Opr_ArbitrationQ instruction is used in association with a Bus-resident entity. The following shows an arbitration instruction that is associated with a Bus referenced entity. The owner field is the '.Own' subelement of the Bus structure: A Bus enabled PlantPAx® device/object has its own Bus element. When extending the ownership functionality with the arbitration instruction, use the same Bus element reference that is used for that device/object: Graphic Symbols There are no graphic symbols or HMI graphic support for the raP_Opr_ArbitrationQ instruction. Faceplates There is no faceplate for the raP_Opr_ArbitrationQ instruction. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 141 Chapter 6 Arbitration (raP_Opr_ArbitrationQ) Notes: 142 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 7 Organizational Scan (raP_Opr_OrgScan) The raP_Opr_OrgScan (Organizational Scan) Add-On Instruction processes user-defined organizational trees to propagate status information from child nodes to parent nodes, and to propagate commands from parent nodes to child nodes. Further ownership requests and status can be propagated between parent and child nodes. The functionality to edit any organizational trees is built into this Add-On Instruction and edit requests are executed synchronously with the organizational scan. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines Use this instruction if you want to build parent child relationships between controller-resident entities and propagate status, command, and ownership functionality between them. Functional Description The raP_Opr_OrgScan Add-On Instruction is used to propagate the information between elements of organizational trees and allow ownership relationships between those elements. It also maintains the organizational tree editing functions and the edit token ownership. A single raP_Opr_OrgScan instruction is to be used to scan all organizational trees in a controller. As such, a single instance of the Add-On Instruction is to be scanned unconditionally in a slow, lowpriority task. 'Node' is an array that is composed of elements of type 'raP_UDT_Opr_Bus_Node.' This array must be of sufficient length to accommodate the maximum possible number of organizational tree nodes. Typical systems can have 100...1000 nodes depending upon the complexity of the organizational trees. Significant scans can occur when Node arrays with greater than 500 elements are used. 'Bus' is an array that is composed of elements 'raP_UDT_Opr_Bus.' This array must be of sufficient length to accommodate the maximum possible number of devices/objects that you wish to place on the Bus. IMPORTANT The name of the Node array must be 'Node' and the name of the Bus array must be 'Bus' for raP_Opr_OrgView operation. Edit functionality and Edit Token management is also maintained in the raP_Opr_OrgScan instruction. All editing of the nodal organizational trees occurs through this instruction instance. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 143 Chapter 7 Organizational Scan (raP_Opr_OrgScan) 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 Files The raP_Opr_OrgScan_5.20.00_AOI.L5X Add-On Instruction definition file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files The raP_Opr_OrgScan Instruction uses no visualization files or components. Operations Command Sources The raP_Opr_OrgScan instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. A raP_Opr_Owner and PCMDSRC instances are present in the Add-On Instruction to facilitate edit token ownership by an HMI client through a raP_Opr_OrgView instance. Alarms The raP_Opr_OrgScan Instruction uses no alarms. Virtualization The raP_Opr_OrgScan Instruction has no Virtualization capability. Execution The following table explains the handling of instruction execution conditions. Condition Description EnableIn False (false rung) No EnableIn False logic is provided. The raP_Opr_OrgScan instruction must always be scanned true. In relay ladder logic, the raP_Opr_OrgScan instruction must be by itself on an unconditional rung. Powerup (prescan, first scan) All status and internal limits are cleared on prescan/first scan and array bounds and existing node configuration are checked. Postscan No SFC Postscan logic is provided. For more information, see the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010. Programming Examples 144 The example in the Function Description section shows the basic use of the raP_Opr_OrgScan AddOn Instruction. The raP_Opr_OrgScan can be executed from any controller language. But must be executed unconditionally. The scan update of all nodes in a system may require long scan times, therefore it is recommended to be executed from a slow, low-priority task. Further, the associated timeouts (Program, and so on) should be lengthened accordingly. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 7 Organizational Scan (raP_Opr_OrgScan) Graphic Symbols There are no graphic symbols or HMI graphic support for the raP_Opr_OrgScan instruction. Faceplates There is no faceplate for the raP_Opr_OrgScan instruction. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 145 Chapter 7 Organizational Scan (raP_Opr_OrgScan) Notes: 146 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 8 Organizational View (raP_Opr_OrgView) The raP_Opr_OrgView (Organizational View) Add-On Instruction continuously scans the organizational trees and queues the information into a standard hierarchical tree view for presentation on a single HMI (FactoryTalk® View SE) client. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines Use this instruction if you want to display organizational tree information on an HMI client. Another instance of the raP_Opr_OrgView instruction must be instantiated and scanned within the user project for each intended HMI client. Functional Description The raP_Opr_OrgView Add-On Instruction is used to read and format organizational tree information into a standard tree view on the HMI. The Add-On Instruction automatically adjusts the tree view based on user edits of the organizational tree. It is intended to have one raP_Opr_OrgView instruction instance for each HMI client viewing the organizational trees in a controller. This is so each HMI client can have a tree view that is unaffected by the actions of another client (expand, collapse, edit, and so on). Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 147 Chapter 8 Organizational View (raP_Opr_OrgView) Here there are three raP_Opr_OrgView instances that are associated with the primary raP_Opr_OrgScan instance to update three individual HMI clients. IMPORTANT Required Files An array of raP_Opr_OrgView backing tags must be created at the controller scope of name 'OrgView.' Each element of the array is used as the backing tag for each instance servicing a single HMI client. See Organizational Scan (raP_Opr_OrgScan) on page 143 for other naming requirements. 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 Files The raP_Opr_View_5.20.00_AOI.L5X Add-On Instruction definition file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files See Visualization Files on page 17 for general information on visualization files. Operations Command Sources The raP_Opr_OrgView instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Opr_OrgView Instruction uses no alarms. Virtualization The raP_Opr_OrgView Instruction has no Virtualization capability. Execution The following table explains the handling of instruction execution conditions. Condition Description EnableIn False (false rung) No EnableIn False logic is provided. The raP_Opr_OrgView instruction must always be scanned true. In relay ladder logic, the raP_Opr_OrgView instruction must be by itself on an unconditional rung. Powerup (prescan, first scan) All status, internal HMI buffers, and internal limits are cleared on prescan/first scan and array bounds and existing node configuration are checked. Postscan No SFC Postscan logic is provided. For more information, see the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010. 148 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 8 Programming Examples Organizational View (raP_Opr_OrgView) The example in the Function Description section shows the basic use of the raP_Opr_OrgView AddOn Instruction for three HMI clients to monitor of the organizational tree. The raP_Opr_OrgView instances are to be executed immediately after the raP_Opr_OrgScan instance execution. And are to be scanned unconditionally (always enabled). 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 Faceplates Graphic Symbol Description GO_nav_ShowTree Show the object tree view for the current client GO_nav_NavShowTreeView Show the object tree view for the current client GO_nav_ShowHWTree1 Show the hardware tree view for the current client GO_nav_NavShowHWTreeView Show the hardware tree view for the current client There are basic faceplate attributes that are common across all instructions. See Basic Faceplate Attributes on page 24. Faceplates for this instruction are shown in Chapter 4 Organization. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 149 Chapter 8 Organizational View (raP_Opr_OrgView) Notes: 150 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 9 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. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines 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, and so forth) 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 produce 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-RM200G-EN-P - June 2024 151 Chapter 9 Process Area Module (raP_Opr_Area) Functional Description Command Source Management Allows you 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 PlantPAx Process Control Instructions, publication PROCES-RM215. 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 Files The raP_Opr_Area_5.20.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. Visualization Files See Visualization Files on page 17 for general information on visualization files. Operations Command Sources The raP_Opr_Area instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Opr_Area Instruction uses the following alarms, which are implemented by using Tag Based Alarms. 152 Alarm Alarm Name E-Stop trip Alm_EStopTrip S-Stop trip Alm_SStopTrip Description Raised when an emergency stop condition triggers a change in state of the Area. Raised when a software stop condition triggers a change in state of the Area. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 9 Process Area Module (raP_Opr_Area) Virtualization The raP_Opr_Area Instruction has no Virtualization capability. Execution The handling of instruction execution conditions. Condition EnableIn False (False Rung) Powerup (Pre-scan, First Scan) Postscan (SFC Transition) Description Handle processing for EnableIn False (False Rung) the same as if the Area were Disabled by Command. The Area outputs are de-energized and the Area is shown as Disabled on the HMI. Handles processing of command source and alarms on Pre-scan and Powerup. On Powerup, the Area is treated as if it were Commanded to reset all program and operator commands No SFC Postscan logic is provided. See Logix 5000 Controllers Add-On Instructions: Programming Manual, 1756-PM010 for more information. Programming Example The example in the Functional Description section shows the basic use of the raP_Opr_Area Add-On Instruction. Typically, the raP_Opr_Area instruction is used in association with a Bus-resident entity. The following example shows an area instruction that is associated with a Bus referenced entity. The area is also connected to 2 inputs, emergency stop, and software stop that can trigger two alarms. The area object typically is used in an S88 application but can be applied to suit numerous hierarchy layouts. Graphic Symbols Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol Description 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. GO_PAREA Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 153 Chapter 9 Process Area Module (raP_Opr_Area) FactoryTalk View SE Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab Item 1 2 3 4 5 1 2 3 4 Description Displays the current state of the object Acquire child command source Release child command source Display organizational tree view for this object Display more information 5 Maintenance Tab 1 154 Item 1 Description Display Advanced Properties Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 9 Process Area Module (raP_Opr_Area) Advanced Maintenance Tab The timer creates a delay for the Tree View to indicate that Children are ‘not good’ upon ownership acquisition. This is done to avoid nuisance indications on the Tree View while waiting for children to be acquired. The default of five seconds is sufficient delay for most applications. You may wish to raise that value if child acquisition takes longer than this. This can occur if the organization has many nested organizational levels or nested elements have relatively long scan intervals. This value is limited less than 3600 seconds. Engineering Tab 1 2 3 4 5 Item 1 2 3 4 5 6 7 8 Description Select to include software stop from child Select to include software stop input Select to have the Command source follow the owner Select to cascade ownership to children (children will be owned when this object is owned) Select to stop unit on extended alarms Select to stop unit when Child is in Alarm or Unacknowledged Alarm Select to stop unit when Child cannot be put into Program or is owned by another owner. Select yes to enable virtual mode 6 7 8 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 155 Chapter 9 Process Area Module (raP_Opr_Area) Item 1 Description Use the radio buttons for the area owner commands to follow the overall command source of the instruction, or to “keep” particular source (operator, program, or external). 1 HMI Configuration Tab Item 1 2 3 Description Select to allow Operator to shelve alarm Select to allow Maintenance to disable alarm Select to enable extended alarms 1 2 3 156 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 9 Item 1 1 2 Process Area Module (raP_Opr_Area) Description Select an option for Operator Command Confirmation Requirements Select to allow navigation to an object with more information. You configure the tag name of the object that 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. 2 Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk® View SE faceplates. See FactoryTalk View SE Faceplates on page 154. Operator Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 157 Chapter 9 Process Area Module (raP_Opr_Area) Notes: 158 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 10 Process Unit (raP_Opr_Unit) 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. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines The raP_Opr_Unit (Process Unit) object controls a Unit in various command sources and monitors for fault conditions. Use when: • You want to consolidate status from groups of equipment. These statuses include: - Alarm Status - Alarm Priority - Command Source - Configuration Errors • You want to manage and to following functions for a group of equipment, with a “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 that occurs in any related equipment. • You want to issue user-defined commands to equipment. The raP_Opr_Unit object also: • Provides an interface to parameter display, data entry and configuration. • Provides an interface to resultant (report) data display and configuration. • Provides interface to Prompt Response and configuration Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 159 Chapter 10 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 PlantPAx Process Control Instructions, publication PROCES-RM215. 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 Files Controller File The raP_Opr_Unit_5.20.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. Visualization Files See Visualization Files on page 17 for general information on visualization files. Operations Command Sources The raP_Opr_Area instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Program Structure The raP_Opr_Unit Instruction may be implemented using a program as a container (recommended). The following table outlines suggested program structure and routine naming: Routine Object Name AlarmsSuppress Interlocks 160 Description Contains raP_Opr_Unit instance, external function instances (Interlock, Permissive, Extended Alarms), and routine calls. Contains raP_Opr_Unit alarm suppression logic. Contains raP_Opr_Unit interlock mapping from interlock conditions to _Intlk block. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 10 Routine Parameters Permissives Group Command Permissives Reports ExtddAlarms IMPORTANT Process Unit (raP_Opr_Unit) Description Contains raP_Opr_Unit parameter mapping to and from Parameter blocks (_ParRpt (Enum, Integer, Real, String)) to raP_Opr_Unit instance. Contains raP_Opr_Unit permissive mapping from permissive conditions to _Perm block. Contains raP_Opr_Unit group commands (1-4) permissive mapping from permissive conditions to _Perm block. Contains raP_Opr_Unit report mapping to and from Parameter blocks (_ParRpt (Enum, Integer, Real, String)) to raP_Opr_Unit instance. Contains raP_Opr_Unit instances of external alarm instances and trigger logic. The raP_Opr_Unit Instruction may be implemented without the program structure that is defined in the previous table; this is provided as an example. Alarms The raP_Opr_Unit Instruction uses the following alarms, which are implemented by using Tag Based Alarms. Alarm Alarm Name E-Stop trip Alm_EStopTrip Group Command 1 Fail Alm_GroupCmd1Fail Group Command 2 Fail Alm_GroupCmd2Fail Group Command 3 Fail Alm_GroupCmd3Fail Group Command 4 Fail Alm_GroupCmd4Fail Interlock trip Alm_IntlkTrip S-Stop trip Alm_SStopTrip Description Raised when an emergency stop condition triggers a change in state of the Unit. Raised when the defined Group Command 1 fails to execute on the Unit. Raised when the defined Group Command 2 fails to execute on the Unit. Raised when the defined Group Command 3 fails to execute on the Unit. Raised when the defined Group Command 3 fails to execute on the Unit. Raised when an interlock condition triggers a change in state of the Unit. Raised when a software stop condition triggers a change in state of the Unit. Virtualization The raP_Opr_Unit Instruction has no Virtualization capability. Execution The handling of instruction execution conditions. Condition EnableIn False (False Rung) Powerup (Pre-scan, First Scan) Postscan (SFC Transition) Description Handle processing for EnableIn False (False Rung) the same as if the Area were Disabled by Command. The Area outputs are de-energized and the Area is shown as Disabled on the HMI. Handles processing of modes and alarms on Pre-scan and Powerup. On Powerup, the Area is treated as if it were Commanded to reset all program and operator commands No SFC Postscan logic is provided. See Logix 5000 Controllers Add-On Instructions: Programming Manual, 1756-PM010 for more information. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 161 Chapter 10 Process Unit (raP_Opr_Unit) Local Message The object raP_Opr_Unit utilizes local message display elements to display Step Names, Material Names, and Summary information. A default local message file is provided for each information type. This default local message file populates the local message display elements from tags in the controller. For Step Names and Material names, these are the same controller tags used in previous versions of the library. The difference is that 512 messages are available, rather than the 99 messages in the previous version. To upgrade from previous versions, developers need to add the local message file to the project and set the @Navigation property of the specified tag to the Local Message file name (see table below). Information Material Name Step Description Summary Information Default Local Message File File Name Reference Default Controller Data SystemMaterialNames Sts_eMtrl.@Navigation System.Enum.Materials[x].@Description SystemStepDescriptions Sts_eStep.@Navigation System.Enum.Step_Desc[x].@Description SystemSummary Sts_eSummary.@Navigation System.Enum.Summary_Desc[1].@Description Users may add customized local messages for individual objects by creating a new local message file and populating the file with the customized strings or tag references. Then set the @Navigation property of the specified tag to the name of the new custom file. Programming Example 162 The example in the Functional Description section shows the basic use of the raP_Opr_Unit Add-On Instruction. Typically, the raP_Opr_Unit instruction is used in association with a Bus-resident entity. The following example shows a unit instruction that is associated with a Bus referenced entity. The unit is also connected to 2 inputs, Emergency stop, and software stop that can trigger 2 alarms. Units also allow for connections to permissives and interlocks. The unit object typically is used in an S88 application but can be applied to suit numerous hierarchy layouts. The unit allows for optional connections to parameters, reports, and FTBatch interface objects. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 10 Process Unit (raP_Opr_Unit) Graphic Symbols Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol Description The raP_Opr_Unit object groups Equipment together, and provides a propagation mechanism for aggregating status from Equipment, and broadcasting commands to Equipment. GO_PUNIT FactoryTalk View SE Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab 8 Item 1 2 3 4 5 6 7 8 1 2 3 4 5 6 Description Displays the current state of the object Acquire child command source Release child command source Display tree view for this object Display the Bus faceplate for this object Show parameter display Show report display Command user-defined function (1, 2, 3, or 4) 7 Maintenance Tab Item 1 2 1 Description Display Advanced Properties Select yes to enable bypass 1 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 163 Chapter 10 Process Unit (raP_Opr_Unit) Advanced Maintenance Tab The timer creates a delay for the Tree View to indicate that Children are ‘not good’ upon ownership acquisition. This is done to avoid nuisance indications on the Tree View while waiting for children to be acquired. The default of five seconds is sufficient delay for most applications. You may wish to raise that value if child acquisition takes longer than this. This can occur if the organization has many nested organizational levels or nested elements have relatively long scan intervals. This value is limited less than 3600 seconds. Engineering Tab 1 2 3 Item 1 2 3 4 5 6 Description Select to include a software stop from child object Select to include software stop input Select to include material Select to have the command source follow the owner. Select to cascade ownership to children (children will be owned when this object is owned) Enter the material maximum and minimum quantities as well as the units. 4 5 6 164 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 10 Item 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 Process Unit (raP_Opr_Unit) Description Select to enable an operator prompt Select to open the Prompt configuration Enable User-Defined Group Commands Enable level command for Command 0 Enable level command for Command 1 Enable level command for Command 2 Enable level command for Command 3 Enable external ready mapping to group commands Enable User-Defined Group States 7 8 9 1 2 3 4 5 Item 1 2 3 4 5 6 7 8 Description Define the number of Parameters Select to enable parameter command buttons Define the number of Reports Select to enable report command buttons Select to show parameter configuration display (left) or report configuration display (right) Select to stop unit on extended alarms Shed Unit actions on active child alarm, or unacknowledged child alarm Shed Unit actions on child not usable, cannot be owned or in a state that makes it unusable. 6 7 8 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 165 Chapter 10 Process Unit (raP_Opr_Unit) Item 1 2 3 1 2 3 4 5 Description Use the radio buttons for the unit commands to follow the overall command source 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 source of the instruction, or to “keep” particular source (operator, program, or external). Use the radio buttons for the unit parameter commands to follow the overall command source of the instruction, or to “keep” particular source (operator, program, or external). Use the radio buttons for the unit report commands to follow the overall command source of the instruction, or to “keep” particular source (operator, program, or external). Select to enable virtual mode 4 5 HMI Configuration Tab 1 2 Item 1 2 3 4 5 6 7 Description Enter the number of decimal places for the material Select to enable navigation to the permissive object Select to enable navigation to the Command 1 permissive object Select to enable navigation to the Command 2 permissive object Select to enable navigation to the Command 3 permissive object Select to enable navigation to the Command 4 permissive object Select to enable navigation to the interlock object 3 4 5 6 7 166 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 10 Item 1 2 3 4 1 2 3 4 5 Process Unit (raP_Opr_Unit) Description Select to enable navigation to an object with more information. You configure the tag name of the object that 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. Select to allow Operator to shelve alarm Select to allow Maintenance to disable the alarm Select to enable extended alarms Select an option for Operator Command Confirmation Requirements 5 The Configuration – HMI 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-RM200G-EN-P - June 2024 167 Chapter 10 Process Unit (raP_Opr_Unit) Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 163. Operator Maintenance 168 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) An equipment module is a functional group of equipment that can conduct 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, and so forth). This term applies to both the physical equipment and the equipment entity. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines The raP_Opr_EMGen (Generic Equipment Module) object controls an Equipment Module in various 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 that define the behavior of the group of equipment - Report / Resultant data from the group of equipment - A faceplate that 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-RM200G-EN-P - June 2024 169 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) Functional Description Program raP_Opr_EMGen Dispatch 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 Operator Parameter & Report Data Parameters Command Source Commands State and Sequence Commands 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 that sequences and coordinates devices (implement states as required) 170 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Report Data Chapter 11 Required Files Generic Equipment Module (raP_Opr_EMGen) 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.20.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. Visualization Files See Visualization Files on page 17 for general information on visualization files. 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 help prevent Equipment Module operation. • Monitor interlock conditions to help 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 that 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 an interface to parameter display, data entry, and configuration. • Provides an interface to resultant (report) data display and configuration. • Allows configurable state effect of Alarm and Permissive • Provides interface to Prompt Response and configuration Command Sources The raP_Opr_EMGen (Generic Equipment Module) uses the standard command source operations that are implemented using an embedded PCMDSRC instruction. See PlantPAx Process Control Instructions, publication PROCES-RM215 for more information. State Model The raP_Opr_EMGen (Generic Equipment Module) Add-On Instruction allows the creation of a customized state model, for a particular instance. Depending on your requirements, you may choose to write your own State module logic and make the appropriate connections to the raP_Opr_EMGen, or you may choose to use one of the provided raP_Opr_VSM (Variable State Module) configurations (S88, NUMUA, PackML, Equipment, and Generic), or create your own using this provided Add-On Instruction. You can then make the appropriate connections to the raP_Opr_EMGen. Each instance of the raP_Opr_EMGen needs an instance of the raP_Opr_VSM Instruction. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 171 Chapter 11 Generic Equipment Module (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 outlines suggested program structure and routine naming: Routine Dispatch AlarmsSuppress Interlocks Parameters Permissives Reports _StateModel ExtddAlarms St<xx>_<StateDesc> IMPORTANT Description Contains raP_Opr_EMGen instance, external function instances (Interlock, Permissive, Associated Device), and routine calls. Contains raP_Opr_EMGen alarm suppression logic. Contains raP_Opr_EMGen interlock mapping from interlock conditions to _Intlk block. Contains raP_Opr_EMGen parameter mapping to and from Parameter blocks (_ParRpt (Enum, Integer, Real, String)) to raP_Opr_EMGen instance. Contains raP_Opr_EMGen permissive mapping from permissive conditions to _Perm block. Contains raP_Opr_EMGen report mapping to and from Parameter blocks (_ParRpt (Enum, Integer, Real, String)) to raP_Opr_EMGen instance. Contains raP_Opr_EMGen state module program logic. Contains raP_Opr_EMGen instances of external alarm instances and trigger logic. Contains raP_Opr_EMGen state logic. The raP_Opr_EMGen (Generic Equipment Module) may be implemented without the program structure that is defined in the preceding table; this is provided as an example. Alarms The raP_Opr_EMGen Instruction uses the following alarms, which are implemented by using Tag Based Alarms. Alarm Alarm Name Device alarms Alm_DvcAlms Interlock trip Alm_IntlkTrip Report data Alm_RptData Description Raised when a device within the Equipment Module has an alarm. Raised when an interlock condition triggers a change in state of the Equipment Module. Raised when new report data are available. Virtualization The raP_Opr_EMGen Instruction has no Virtualization capability. 172 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 11 Generic 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. On Powerup (Pre-scan, First Scan) Powerup, the Equipment Module is treated as if it were Commanded to Reset all Program and Operator commands. Postscan (SFC Transition) No SFC Postscan logic is provided. See 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. Local Message The object raP_Opr_EMGen utilizes local message display elements to display Step Names, Material Names, and Summary information. A default local message file is provided for each information type. This default local message file populates the local message display elements from tags in the controller. For Step Names and Material names, these are the same controller tags that are used in previous versions of the library. The difference is that 512 messages are available, rather than the 99 messages in the previous version. To upgrade from previous versions, developers must add the local message file to the project and set the @Navigation property of the specified tag to the Local Message file name (see the following table). Information Material Name Step Description Summary Information Default Local Message File File Name Reference Default Controller Data SystemMaterialNames Sts_eMtrl.@Navigation System.Enum.Materials[x].@Description SystemStepDescriptions Sts_eStep.@Navigation System.Enum.Step_Desc[x].@Description SystemSummary Sts_eSummary.@Navigation System.Enum.Summary_Desc[1].@Description Users may add customized local messages for individual objects by creating a new local message file and populating the file with the customized strings or tag references. Then set the @Navigation property of the specified tag to the name of the new custom file. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 173 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) Programming Example The example in the Functional Description section shows the basic use of the raP_Opr_EMGen AddOn Instruction. Typically, the raP_Opr_EMGen instruction is used in association with a Bus-resident entity. The following shows a generic equipment module instruction that is associated with a Bus referenced entity. The generic equipment module also allows for connections to permissives, interlocks, and a System tag. The generic equipment module typically is used in an S88 application but can be applied to suit numerous hierarchy layouts. The generic equipment module allows for optional connections to parameter and report interface objects. Graphic Symbols Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol The raP_Opr_EMGen (Generic Equipment Module) object controls an Equipment Module in a variety of command sources and monitors for fault conditions. GO_PEMGEN 174 Description Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 11 FactoryTalk View SE Faceplates Generic Equipment Module (raP_Opr_EMGen) There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab 1 2 Item 1 2 3 4 5 6 7 3 4 5 6 7 Description Command buttons with command text Acquire child command source Release child command source Display tree view for this object Display the Bus faceplate for this object Show parameter display Show report display Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 175 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) Maintenance Tab 2 3 4 1 Item 1 2 3 4 Description Select yes to enable bypass Display advanced properties Navigation to detail display The state force button is a Maintenance source command that is used to set the Sts_StateCompleteRqst bit. For an EM instance with the VSM enabled, this will set the Inp_StateComplete parameter and transition the current state to complete. For an instance without the VSM the user will need to connect the Sts_StateCompleteRqst to the required location in their SM logic. Advanced Maintenance Tab The timer creates a delay for the Tree View to indicate that Children are ‘not good’ upon ownership acquisition. This is done to avoid nuisance indications on the Tree View while waiting for children to be acquired. The default of five seconds is sufficient delay for most applications. You may wish to raise that value if child acquisition takes longer than this. This can occur if the organization has 176 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) many nested organizational levels or nested elements have relatively long scan intervals. This value is limited less than 3600 seconds. Engineering Tab 1 2 3 4 5 6 Item 1 2 3 4 5 6 7 Description Wait for report data to be collected. Command source follows parent object. Enable legacy ownership, use PCmd_Owner. Select to cascade ownership to children (children will be owned when this object is owned) Select to enable the Operator prompt. Select to navigate to the Variable State Machine (VSM) faceplate to configure the object's state machine controls. Select to navigate to the Prompt faceplate to configure this object’s prompts. 7 1 2 3 4 5 6 7 Item 1 2 3 4 5 6 7 8 9 10 Description Define the Idle State for Status indication. Define the Running State for Status indication. Define the Complete State for Status indication. Define the Restart State for Status indication. Define the number of Parameters. Select to enable parameter command buttons Define the number of Reports. Select to enable report command buttons Show parameter configuration display Show report configuration display 8 9 10 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 177 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) 1 2 Item 1 2 Description Select to allow Operator command execution with active alarm condition Select to allow Operator command execution with loss of permissive Item 1 Select conditions to stop equipment Description 1 178 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 11 Item 1 1 1 2 3 4 Item 1 2 3 4 Generic Equipment Module (raP_Opr_EMGen) Description Stop equipment module on interlock trip. Bit based condition applies to only its state, Bit 0 will only affect operation of state 0, bit 31 effects state 31. Description Control of this feature is determined by the current command source This feature will always be commanded by the Operator This feature will always be commanded by the Program Logic This feature will always be commanded by the External Source Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 179 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) HMI Configuration Tab Item 1 2 3 4 5 Description Select to enable navigation to permissive object Select to enable navigation to interlock object Select to allow Operator to shelve alarm Select to allow Maintenance to disable alarm Select to enable extended alarms Item 1 Description Select an option for Operator Command Confirmation Requirements Select to enable navigation to an object with more information. You configure the tag name of the object that 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. Select to allow navigation to detail display Select to allow navigation to a device alarm object. Select to allow navigation to the variable state machine configuration. 1 2 3 4 5 1 2 3 4 5 2 3 4 5 180 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) Define the Command Button and Target Stages on pages three, four, and five.. Faults Tab The Faults tab shows information on the status of the objects. You the Parameter and Report configuration buttons to determine which object has the fault. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 181 Chapter 11 Generic Equipment Module (raP_Opr_EMGen) Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 175. Operator Maintenance 182 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) An equipment phase is a functional group of equipment that can conduct a finite number of specific minor processing activities when directed by a (recipe) phase. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines The raP_Opr_EPGen (Generic Equipment Phase Module) object controls an Equipment Phase in various 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 that define the behavior of the group of equipment - Report / Resultant data from the group of equipment - A faceplate that 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-RM200G-EN-P - June 2024 183 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Functional Description Phase Manager Program raP_Opr_EPGen Dispatch 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 required. Parameters Contains logic that maps parameters to raP_Opr_EPGen to Phase Manager tags (Input) .REAL [X] .Value .Dscptn .UOM .MIN .MAX .INTGR [X] .STRING .Value .Dscptn .UOM .MIN .MAX .DcmlPlcs .Value .Dscptn Reports Contains logic that maps report data from raP_Opr_EPGen to Phase Manager tags (Output) .REAL [X] .INTGR [X] .STRING .Value .Dscptn Phase State Routines Contains your logic that sequences and coordinates devices (implement states as required) 184 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 .Value .Dscptn .UOM .Value .Dscptn .UOM .DcmlPlcs Chapter 12 Required Files Generic Equipment Phase (raP_Opr_EPGen) 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.20.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. Visualization Files See Visualization Files on page 17 for general information on visualization files. 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, helping prevent Equipment Phase operation. • Monitor interlock conditions to help 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 that 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. • Provides an interface to parameter display, data entry, and configuration. • Provides an interface to resultant (report) data display and configuration. • Provides interface to Prompt Response and configuration Command Sources The raP_Opr_EPGen (Generic Equipment Phase Module) uses the standard command sources that are implemented using an embedded PCMDSRC instruction. See PlantPAx Process Control Instructions, publication PROCES-RM215 for more information. 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. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 185 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) • • • • 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 a human machine interface (faceplate), which allows control and monitoring of the PhaseManager phase. • Provides a predefined human machine interface (faceplate), which allows input and 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 Dispatch Aborting Holding Resetting Restarting Running Stopping AlarmsSuppress Interlocks Parameter Permissives <EP_GEN>_PhaseCommands <EP_GEN>_PXRQ Reports ExtddAlarms 186 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 available Phase state routines may be implemented. • The logic within a particular Phase state routine is executed when the Phase is in the corresponding state. • Any implemented Phase state routine requires a Phase State Complete instruction (which the state engine uses to determine the state is complete). Used for shutting down equipment in an emergency situation. If you have implemented Stopping, you would at a minimum duplicate the stopping logic 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 subset of equipment must be shut down when the phase enters the hold state. It may also be advantageous to release owned equipment if maintaining ownership while held constrains production by maintaining ownership of shared equipment. Used to perform “clean-up” activities such as release owned equipment, etc. Implemented if Holding is implemented. Used to bring equipment from the state that it is in at the end of the Holding state back to the state that it was in prior Holding. Used in conjunction with PSet_HoldIndx and Val_LastRunningStep to return execution to the proper sequence step. Use to start up equipment, and acquire ownership of equipment (if necessary). Use if equipment must be shut down in a given sequence. Contains EP_GEN alarm suppression logic. Contains EP_GEN interlock mapping from interlock conditions to <EP_GEN>_Intlk block. Contains EP_GEN parameter mapping to and from Parameter blocks (_ParRpt (Enum, Integer, Real, String)) to EP_GEN instance. Contains EP_GEN permissive mapping from permissive conditions to <EP_GEN>_Perm block. Maps commands from EP_GEN to PhaseManager commands PXRQ Routine container. Use the PRXQ instruction to initiate communication with FTBatch software. Contains EP_GEN report mapping to and from Parameter blocks (_ParRpt (Enum, Integer, Real, String)) to EP_GEN instance. Contains EP_GEN instances of external alarm instances and trigger logic. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 12 IMPORTANT Generic Equipment Phase (raP_Opr_EPGen) 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 LOGIXUM001. Alarms The raP_Opr_EPGen Instruction uses the following alarms, which are implemented by using Tag Based Alarms. Alarm Alarm Name Device alarms Alm_DvcAlms Interlock trip Alm_IntlkTrip Report data Alm_RptData Description Raised when a device within the Equipment Phase has an alarm. Raised when an interlock condition triggers a change in state of the Equipment Phase. Raised when new report data are available. Virtualization The raP_Opr_EPGen Instruction has no Virtualization capability. 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. On Powerup (Pre-scan, First Scan) Powerup, the Equipment Module is treated as if it were Commanded to Reset all Program and Operator command. Postscan (SFC Transition) No SFC Postscan logic is provided. See 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. Local Message The object raP_Opr_EPGen utilizes local message display elements to display Step Names, Material Names, and Summary information. A default local message file is provided for each information type. This default local message file populates the local message display elements from tags in the controller. For Step Names and Material names, these are the same controller tags that are used in previous versions of the library. The difference is that 512 messages are available, rather than the 99 messages in the previous version. To upgrade from previous versions, developers must add the local message file to the project and set the @Navigation property of the specified tag to the Local Message file name (see table below). Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 187 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Information Material Name Step Description Summary Information Default Local Message File File Name Reference Default Controller Data SystemMaterialNames Sts_eMtrl.@Navigation System.Enum.Materials[x].@Description SystemStepDescriptions Sts_eStep.@Navigation System.Enum.Step_Desc[x].@Description SystemSummary Sts_eSummary.@Navigation System.Enum.Summary_Desc[1].@Description Users may add customized local messages for individual objects by creating a new local message file and populating the file with the customized strings or tag references. Then set the @Navigation property of the specified tag to the name of the new custom file. Programming Example Graphic Symbols Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol The raP_Opr_EMGen (Generic Equipment Module) object controls an Equipment Module in various command sources and monitors for fault conditions. GO_PEPGEN 188 Description Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 12 FactoryTalk View SE Faceplates Generic Equipment Phase (raP_Opr_EPGen) There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24 Operator Tab 1 2 3 4 5 6 Item 1 2 3 4 5 6 7 9 Description Acquire child command source Release child command source Display Bus faceplate for this object Show parameter display Show report display Show State Detail display Respond to Prompt request Phase Commands (from left to right): Hold phase, Restart phase, Start phase, Stop phase, Abort phase, Reset phase Display more information Item 1 2 3 4 5 6 Pause phase Auto pause the phase Start phase Stop phase Abort phase Reset phase 8 7 8 9 Manual Control 1 3 2 4 5 Description 6 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 189 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Maintenance Tab 2 3 Item 1 2 3 4 4 Description Select Yes to enable bypass Display Advanced Properties Navigate to detail display The state force button is a Maintenance source command that is used to set the Sts_StateCompleteRqst bit. For an instance without the VSM the user will need to connect the Sts_StateCompleteRqst to the required location in their SM logic. 1 Advanced Maintenance The timer creates a delay for the Tree View to indicate that Children are ‘not good’ upon ownership acquisition. This is done to avoid nuisance indications on the Tree View while waiting for children to be acquired. The default of five seconds is sufficient delay for most applications. You may wish to raise that value if child acquisition takes longer than this. This can occur if the organization has many nested organizational levels or nested elements have relatively long scan intervals. This value is limited less than 3600 seconds. 190 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Engineering Tab 1 2 3 4 5 Item 1 2 3 4 5 6 7 Description Select to wait for report data that is collected before alarming. Select to allow a pause phase Select to mask hold state from phase Select to use default step numbers Select to have the command source follow the owner Select to cascade ownership to children (children will be owned when this object is owned) This phase has an external sequence that is associated to it. (FTBatch) 6 7 5 Item 1 2 3 4 5 6 7 8 6 9 1 2 3 4 Description Map alarm code form the equipment phase to the phase with the PFL instruction. Use legacy object ownership. Use PCmd_Owner to set Val_Owner. Select to enable an operator prompt Select to open the Prompt configuration Define the number of Parameters. Select to enable parameter command buttons Define the number of Reports. Select to enable report command buttons Select to show parameter configuration display (left) or report configuration display (right) 7 8 9 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 191 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Item 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 Description Select conditions to Hold or Stop phase On alarm active Device alarms condition, external devices connected via Inp_DvcAlms Extended alarms active, connected via Inp_ExtddAlmsAlm Report data alarm, report data not received from external system in set time. Interlock not ok Child alarm active or UnAckd via OOAP Child cannot be owned or is in a state that makes it unusable via OOAP Software stop active 8 9 1 192 2 3 4 Item 1 2 3 4 Description Control of this feature is determined by the current command source This feature will always be commanded by the Operator This feature will always be commanded by the Program Logic This feature will always be commanded by the External Source Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) HMI Configuration Tab Item 1 2 3 4 5 Description Select to enable navigation to permissive object Select to enable navigation to interlock object Select to allow Operator to shelve alarm Select to allow Maintenance to disable alarm Select to enable extended alarms 1 2 3 4 5 Item 1 1 2 3 4 Description Select an option for Operator Command Confirmation Requirements. Select to enable navigation to an object with more information. You configure the tag name of the object that 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. Select to allow navigation to detail display. Select to allow navigation to a device alarm object. 2 3 4 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 193 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Faults Tab The Faults tab shows information on the status of the objects. You the Parameter and Report configuration buttons to determine which object has the fault. Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 189. Operator 194 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Manual Maintenance Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 195 Chapter 12 Generic Equipment Phase (raP_Opr_EPGen) Notes: 196 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) 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 For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Guidelines Use when: • You need the ability to view or modify a parameter from either the HMI or from logic • You must 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 must limit the adjustment of a parameter within a deadband relative to an initial value • You must apply command confirmation (that is, 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-RM200G-EN-P - June 2024 197 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) Functional Description 198 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 13 Required Files Parameter and Reports (raP_Tec_ParRpt) 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.20.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. Visualization Files See Visualization Files on page 17 for general information on visualization files. 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. Command Sources The raP_Tec_ParRpt instruction does not have command sources. 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. Virtualization The raP_Tec_ParRpt Instruction has no Virtualization capability. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 199 Chapter 13 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, the Powerup (Pre-scan, First Scan) Equipment Module is treated as if it were Commanded to Reset all Program and Operator command. Postscan (SFC Transition) No SFC Postscan logic is provided. See 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 The example in the Function Description section shows the basic use of the raP_Opr_ParRpt AddOn Instruction. Typically, the raP_Opr_ParRpt instruction is not used on its own. The instruction is used with the Unit, EMGen, or the EPGen instructions, the instruction is used for both the Parameters and Reports. Multiples of each can be created as long as it follows the naming convention and has a unique number that is associated with it. The raP_Opr_ParRpt instruction allows for four different options, Enumeration, String, Integer, or Real, only one of these types can be used per instance. When used with the EPGen, the PSet parameter tag is associated to the FTBatch parameter or report. Parameter Program Example 200 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) Reports Program Example Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 201 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) FactoryTalk View SE Faceplates Parameter Display Item 1 1 2 2 3 4 5 6 Description Select to navigate between current values, snapshot values, and default values. List of each parameter value and description. Navigation between up to 480 parameters (only visible if more than 16 parameter values used). Capture Snapshot. Press to capture current values into snapshot values. Restore Snapshot. Press to restore snapshot values into current values. Reset to defaults. Press to reset current values to default values. 3 4 5 6 The following page shows the information captured by the snapshot. 202 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) The following page shows the default information. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 203 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) Report Display Item 1 1 2 2 3 4 5 6 Description Select to navigate between current values, snapshot values, and default values. List of each report value and description. Navigation between up to 480 reports (only visible if more than 16 report values used). See Parameter Display on page 202. Capture Snapshot. Press to capture current values into snapshot values Restore Snapshot. Press to restore snapshot values into current values Reset to defaults. Press to reset current values to default values 3 4 5 6 The following page shows the information captured by the snapshot. 204 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) The following page shows the default information. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 205 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) Parameter Configuration 1 2 Item 1 2 3 4 5 6 7 8 9 10 11 12 13 206 3 4 5 6 7 8 9 Description Parameter Description Default value of Parameter Allow limit adjust Integer minimum adjust value of parameter. Integer maximum adjust value of parameter. Minimum value of Parameter Maximum value of Parameter Enter the decimal places to display. Engineering unit of Parameter. Parameter value can be modified by the operator when enabled. Parameter value can be modified when in Program Command. Enable Confirmation / E-Signature of Parameter. Assign User Roles Security Level of Parameter. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 10 11 12 13 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) Report Configuration 1 2 Item 1 2 3 4 5 6 7 8 9 10 11 12 13 3 4 5 6 7 8 9 10 11 12 13 Description Report Description Default value of Report Allow limit adjust Integer minimum adjust value of parameter. Integer maximum adjust value of parameter. Minimum value of Report Maximum value of Report Enter the decimal places to display. Engineering unit of Report. Report value can be modified by the operator when enabled. Report value can be modified when in Program Command. Enable Confirmation / E-Signature of Report. Assign User Roles Security Level of Report. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 207 Chapter 13 Parameter and Reports (raP_Tec_ParRpt) Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 202. Parameter and Report Display 208 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 14 Operator Prompt (raP_Opr_Prompt) The raP_Opr_Prompt (Operator Prompt) Add-On Instruction is a universal mechanism for operator interaction that can be used within a control scheme. The instruction presents an operator with configurable message or data fields and accepts operator response data and confirmation. The Sequencer Add-on Instruction instruction also uses the prompt instruction. For more information on the Sequencer instruction, see Rockwell Automation Sequencer Object, Publication PROCES-RM202. Guidelines Use a prompt to request input from an operator. The input can be any of the following: • Acknowledging the prompt • Viewing and confirming data • Making a selection • Entering numeric data • Entering text data Do not use a prompt in place of an alarm or an alert: • An alarm, per ANSI/ISA-18.2-2016, is used to notify an operator of an abnormal situation that requires a response • An alert is used to notify an operator of an abnormal situation that does not require a timely response A prompt requires a response, but does not advise of an abnormal situation. Operator Response Not Required Operator Response Required Functional Description Normal Operation Abnormal Situation Normal values and status Alert Prompt (raP_Opr_Prompt) Alarm The RespData tag at the bottom of the raP_Opr_Prompt function block lets you define where to store operator responses. This tag stores any operator response as a string in the application. This tag needs to be unique to every instance of the raP_Opr_Prompt instruction. The optional BusObj tag allows the prompt to participate on the organizational bus. The entry should be a unique bus element in the bus array. With this field populated, an 'operator attention' indicator is propagated up through any organizational tree in which this bus element is assigned. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 209 Chapter 14 Operator Prompt (raP_Opr_Prompt) 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 Files The raP_Opr_Prompt_5.20.00_AOI.L5X Add-On Instruction must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files See Visualization Files on page 17 for general information on visualization files. Operations Command Sources The raP_Opr_Prompt Add-On Instruction does not use command sources. Alarms The raP_Opr_Prompt Instruction uses the following alarm, which is implemented by using Tag Based Alarms. Alarm Alert timeout Alarm Name Alm_AlertTimeOut Description Raised when no response to a posted prompt has been entered within the configured time. Virtualization The raP_Opr_Prompt Instruction has no Virtualization capability. Graphic Symbols Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol GO_Prompt 210 Description Standard Prompt graphic symbol Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 14 FactoryTalk View SE Faceplates Operator Prompt (raP_Opr_Prompt) There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab Item 1 Description Navigate to the Prompt Response display 1 Engineering Tab 1 2 Item 1 2 3 Description Configure the maximum time without a user response before an exception occurs Allow prompt selection and configuration from this display Navigates to the prompt selection and configuration display 3 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 211 Chapter 14 Operator Prompt (raP_Opr_Prompt) HMI Tab Item 1 2 3 Description Hides the operator attention symbol on the Prompt Response button when there is an active prompt Select to allow Operator to shelve alarm Select to allow Maintenance to disable alarm 1 2 3 Item 1 1 2 Description Select an option for Operator Command Confirmation Requirements Select to enable navigation to an object with more information. You configure the tag name of the object that 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. 2 Selection The Prompt Selection display provides access to the configuration dialog box for a given prompt configuration in the prompts array by clicking the corresponding browse button. 1 2 212 Item 1 2 Description Select the radio button to select a prompt. Select to open the configuration faceplate. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 14 Operator Prompt (raP_Opr_Prompt) Configuration The Prompt Configuration dialog box has four sections to configure a prompt. The sections are Display Values, Input Values, Selection Options, and Response Prompts. Each of the four sections has the ability to add up to eight individually labeled items. Display Values 2 3 4 5 6 7 1 Item 1 2 3 4 5 6 7 Description Select to enable a numeric display field. Enter a label. Enter an engineering unit. Enter the decimal places to display. Select to either display a value from the prompt 'AOI Input' or the value that you enter in the box that appears. Select to scale the value by the entered value and the Inp_ScalePct. Select to require the operator to verify the displayed value. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 213 Chapter 14 Operator Prompt (raP_Opr_Prompt) Input Values 2 3 4 5 6 7 1 Item 1 2 3 4 5 6 7 8 Description Select to enable a numeric input Enter a label for the input value. Enter an engineering unit. Enter the decimal places to display. Enter a minimum value for the entry Enter a maximum value for the entry. Select to require an operator to enter a value. If an input is not required, click Minimum or Maximum to be used for the entry. Selection Options 2 3 Item 1 2 3 Description Select to enable a label text box. Enter a label for the selection option. Select to designate a selection as the default. 1 214 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 14 Operator Prompt (raP_Opr_Prompt) Response Prompts 2 3 Item 1 2 3 Description Select to enable a response prompt. Enter a label for the response prompt. Select to require an input. 1 Response This faceplate lets the operator review and record data based on the prompt. All values are configured on the prompt configuration faceplate. The operator selects the checkbox to continue. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 215 Chapter 14 Operator Prompt (raP_Opr_Prompt) Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Description Symbol GO_nav_PromptResponse – Standalone prompt button that assumes the raP_Opr_Prompt instruction is present, and the button is always visible. The Prompt instruction controls the enabled state and alert indicator visibility of the button. GO_nav_PromptResponseTxt – Prompt display indicator for use on faceplates and displays for objects that possibly do not have a prompt instruction. Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 211. Operator 216 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Logix Change Detector (raP_Dvc_LgxChangeDet) The raP_Dvc_LgxChangeDet (Logix Change Detector) Add-On Instruction monitors another Logix controller on the network and checks for changes that impact operation. Changes that can be monitored include downloads, online edits, I/O forcing, and controller mode changes. No visualization elements are supplied with the raP_Dvc_LgxChangeDet instruction. Guidelines Use this instruction if you want to monitor a Logix controller for changes, to be sure that the correct application is being run for regulatory, quality, or security reasons. Do not use this instruction in these situations: • You have only one Logix controller. The raP_Dvc_LgxChangeDet instruction is intended to be run in a controller other than the one being monitored. Although the raP_Dvc_LgxChangeDet instruction can be configured to monitor the controller in which it is running, because it runs in controller logic, it cannot detect when the controller in which it is running is placed in Program mode. • You have software, such as FactoryTalk® AssetCentre that monitors controllers on a secured network. This software provides much more extensive change tracking and auditing than the raP_Dvc_LgxChangeDet Add-On Instruction. Functional Description The raP_Dvc_LgxChangeDet instruction includes a source protected Add-On Instruction for use with Studio 5000 Logix Designer software, version 33 or later, and Logix controllers. This instruction is intended to be used in one Logix controller to monitor another controller for changes. Although this instruction must be executed in a Logix controller with firmware revision 33 or later, it can monitor controllers running firmware revision 12 or later. The raP_Dvc_LgxChangeDet instruction monitors a Logix controller for the following types of changes: • New entries being made in the change log, such as the following: - Modify, insert, or delete logic in Run or Program mode - Accept, assemble, or cancel edits - Enable, disable, or remove forces - Reconfigure a module - Change an output list Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 217 Chapter 15 Logix Diagnostic Objects • • • • • - Send the ‘Set Attribute’ MSG or ‘SSV’ to a controller object class or instance - Send the ‘Set Attribute List’ MSG to a controller object class or instance - Send the ‘Set Attribute All’ MSG to a controller object class or instance - Apply attributes to a controller object class or instance - Create, delete, or reset a controller object instance Download of a different application Partially import into an application Download of an application without logic changes (but saved configuration data that has changed) Download of an application that contains offline edits Restore an application from an external drive source, such as a Secure Digital (SD) card This instruction also reports the following: • Controller/application ‘check’ value for change detection • Date and time on the controller clock (YYYY-MM-DD hh:mm:ss) • Day of the week based on the controller date • Controller keyswitch position and mode • Major and minor fault indications The raP_Dvc_LgxChangeDet instruction is provided as a rung import for installation. Importing this rung into your ladder diagram routine: • Imports the Add-On Instruction definition • Create an instruction instance. • Creates and completes all required tags and data structures for the instruction. IMPORTANT Once the rung is imported, and before downloading and running the application, set the path in each of the referenced Message structures to point to the Logix controller to be monitored. The interval at which this instruction checks for changes and updates its status is configurable, from 1…60 seconds. 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 Files The raP_Dvc_LgxChangeDet_5.20.00_RUNG.L5X rung import file must be imported into the controller project for the controller that is performing the monitoring. It is not necessary to add any logic to the controller being monitored. The service release number (boldfaced) can change as service revisions are created. Visualization Files There are no visualization files because the raP_Dvc_LgxChangeDet object does not use Graphic Symbols or Faceplates. 218 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects Operations Command Sources The raP_Dvc_LgxChangeDet instruction has no commands or outputs that are intended to control equipment and therefore does not have any command sources. Alarms The raP_Dvc_LgxChangeDet Instruction uses the following alarm, which is implemented by using Tag Based Alarms. Alarm Alarm Name Change detected Alm_ChangeDetected Description Raised when a change in controller operation such as a download or online edit has been detected. Virtualization The raP_Dvc_LgxChangeDet Add-On Instruction does not have a Virtualization capability. Execution The following table explains the handling of instruction execution conditions. Condition EnableIn False (false rung) Powerup (prescan, first scan) Postscan (SFC transition) Description No EnableIn False logic is provided. The raP_Dvc_LgxChangeDet instruction must always be scanned true. In relay ladder logic, the raP_Dvc_LgxChangeDet instruction must be by itself on an unconditional rung. If the Rung Import provided with the Rockwell Automation® Library is used to install this instruction, the proper rung is created for you. On Prescan, any commands that are received before First Scan are discarded. The update timer and internal polling status are reset. On first scan, the Change Detected internal status latch is cleared. No SFC Postscan logic is provided. See to the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756PM010, for more information. Programming Example The raP_Dvc_LgxChangeDet instruction is provided fully configured as a rung import; so little programming is required for the instruction to be used. This programming example shows how the rung import is used to instantiate the raP_Dvc_LgxChangeDet instruction. Since the raP_Dvc_LgxChangeDet instruction is a rung import, it must be created in a Ladder Diagram routine. By default, raP_Dvc_LgxChangeDet checks controllers for changes only every 5 seconds, so the ladder routine does not need to run in a fast periodic task. The following steps describe how you instantiate raP_Dvc_LgxChangeDet in your routine. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 219 Chapter 15 Logix Diagnostic Objects 1. In your ladder routine, right-click where to insert the rungs and select Import Rungs. The Import Rungs dialog box appears. 2. Select the raP_Dvc_LgxChangeDet rung import file that is named in Required Files on page 218. 3. Select Open. 220 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects The Import Configuration dialog box appears. 4. Rename the tags being imported to incorporate the name of the controller being monitored. One controller can monitor several others. Adding the controller name to the tag makes it easier to track the individual instances when monitoring multiple controllers. 5. Select OK. 6. To point to the controller being monitored for changes, change the path in each of the MSG control tags. If you create a link to the controller in the I/O tree configuration, enter the name that is assigned to that controller. 7. Complete the following steps for each of the three MSG control tags. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 221 Chapter 15 Logix Diagnostic Objects a. Select the ellipsis next to the MSG control tag. The Message Configuration dialog box appears. b. Select the Communication tab and change the path to the controller link created in the I/ O tree. c. Select OK. 8. Place the controller in RUN mode. Status bits on the raP_Dvc_LgxChangeDet instruction indicate changes that are made to the monitored controller. Set Cmd_AckAll to 1 to clear the latched-in detections. Graphic Symbols There are no visualization files associated with this object. Faceplates There are no visualization files associated with this object. 222 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Controller CPU Utilization (raP_Dvc_LgxCPU_5x80) Logix Diagnostic Objects The raP_Dvc_LgxCPU_5x80 (Logix Controller CPU Utilization) Add-On Instruction monitors a Logix controller, and provides information on controller CPU utilization, communication usage, and other information. Data that is provided by the raP_Dvc_LgxCPU_5x80 instruction is useful to diagnose communication or control responsiveness issues and in tuning the performance of control tasks for optimum controller performance. The 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. The global object and faceplate in the following image are examples of the HMI that is provided with this library object. Guidelines Use this instruction in these situations: • Monitor general controller resource utilization: - Processor utilization - Communication capacity - Networking performance and connection usage • Gather data to help resolve a specific issue under the direction of a Rockwell Automation Technical Support representative • Tune the periods or priorities of multiple tasks in a controller to optimize control and observe how changes in task configuration affect CPU and other resource usage in the controller • For use with CompactLogix 5380 Controllers and ControlLogix 5580 Controllers. Firmware / software must be version 33 and later. Do not use this instruction at a high update rate on a continuing basis. The raP_Dvc_LgxCPU_5x80 instruction increases the communication load on the controller when it is polling for performance data. At high update rates, the resource load that the raP_Dvc_LgxCPU_5x80 instruction polling generates can affect control performance, especially if you already have a fully loaded controller. Functional Description The raP_Dvc_LgxCPU_5x80 instruction collects and summarizes various data from the Logix controller that is being monitored. This information includes the following: • Processor Identity information: - Catalog number and description - Major and minor firmware revision numbers • Communication Responsiveness information: - CPU% used for responding to communication requests - Optimized Packets that are used for responding to communication requests IMPORTANT • • The raP_Dvc_LgxCPU_5x80 instruction does not support SoftLogix™ 5800 or RSLogix™ Emulate 5000 controllers. CPU utilization (%): - Continuous task (or unused CPU, if no continuous task) - Periodic and Event tasks - Responding to communication requests (such as from HMI) - System (I/O scan, timer updates, everything else) Communication connection usage: Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 223 Chapter 15 Logix Diagnostic Objects • • - Total connections available - Connections that are used for each of several classes of communication - Unconnected buffers and cached messages I/O Forcing status Controller minor faults The items that are listed previously are displayed on several faceplate tabs, with summary information on the main (home) tab. IMPORTANT We recommend that you access the raP_Dvc_LgxCPU_5x80 faceplate when you contact Rockwell Automation Technical Support. The information on the Operator (home) tab is often requested when you call. You also need your Studio 5000 Logix Designer software serial number or other license or support contract information. The Maintenance tab has a space for you to record this information for reference. 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 Files For use with Logix 5x80 controllers, one instance of raP_Dvc_LgxCPU_5x80_5.20.00_RUNG.L5X must be imported into the controller. It is recommended to only use the rung import when configuring the AOI in a project. The service release number (boldfaced) can change as service revisions are created. Visualization Files See Visualization Files on page 17 for general information on visualization files. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Operations Command Sources The raP_Dvc_LgxCPU_5x80 instruction is not intended to control equipment and therefore does not have any command sources. However, there are two program commands and two maintenance commands available to enable and disable collection of data (PCmd_Enable, PCmd_Disable, MCmd_Enable, MCmd_Disable). The maintenance commands are only available via the HMI faceplate. Alarms The raP_Dvc_LgxCPU_5x80 Add-On Instruction does not provide any alarms. If an alarm is required, define the output status to be alarmed as a Logix Tag Based Alarm. 224 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects Virtualization The raP_Dvc_LgxCPU_5x80 Add-On Instruction does not have a Virtualization capability. Execution The following table explains the handling of instruction execution conditions. Condition EnableIn False (false rung) Powerup (prescan, first scan) Postscan (SFC transition) Description The raP_Dvc_LgxCPU_5x80 instruction has no EnableInFalse logic and does nothing on a false rung. Data that are associated with the instruction are left in their last state. Logic is sure that the window time is sent to the controller when it transitions to Run mode. Previously active polling (before power down or transition to Program mode) is canceled. High-water data that is stored in the instruction (not built in to the controller status registers) are cleared. No SFC Postscan logic is provided. See to the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756PM010, for more information. Programming Example The raP_Dvc_LgxCPU_5x80 instruction is provided fully configured as a rung import; therefore, little programming is required for the instruction to be used. This programming example shows how the rung import is used to instantiate the raP_Dvc_LgxCPU_5x80 instruction. Because raP_Dvc_LgxCPU_5x80 is a rung import, it must be created in a ladder diagram routine. The following steps describe how to instantiate raP_Dvc_LgxCPU_5x80 in your routine. 1. In your ladder routine, right-click where to insert the rungs and select Import Rungs. The Import Rungs dialog box appears. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 225 Chapter 15 Logix Diagnostic Objects 2. Select the appropriate raP_Dvc_LgxCPU_5x80 rung import file that is named in Required Files on page 224. 3. Select Open. The Import Configuration dialog box appears. IMPORTANT Do not change tag names in the Import Configuration. There must be one instance only of the raP_Dvc_LgxCPU_5x80 instruction in any controller project. 4. To create the instance of raP_Dvc_LgxCPU_5x80, select OK. 226 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects 5. Set the controller slot number in the Source of the MOV. Set this value before putting the controller into Run mode. If the value is changed, it requires a transition from Program to Run on the controller for the new value to take effect. 6. Select the Finalize All Edits in Program icon. 7. To finalize all edits, Select Yes. 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 GO_LgxCPU FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol Description This global object is used to view controller CPU utilization for Logix 5x80 controllers at firmware version 33 or later. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 227 Chapter 15 Logix Diagnostic Objects FactoryTalk View SE Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. 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. 6 Item 1 2 3 4 5 6 7 7 8 8 9 10 9 1 2 3 4 5 228 10 Description I/O communication status Current controller mode Device shortcut Processor name defined in RSLogix 5000 Current date and time Current firmware revision Path from the HMI server to the device Serial number or support agreement. This number is used when contacting Rockwell Automation technical support. Controller OK indicator I/O forcing status indicator Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects Communication Tab The pages in the Communication tab display the following information: • Nested bar graph and numeric displays that show the approximate percent CPU available for responding to communication requests from the HMI (outer bar). The outer bar graph changes color from green to yellow when CPU availability for communication is low. • The approximate percent CPU that is actually being used for responding to communication requests (inner bar). The inner bar graph changes color from blue to red when nearly all CPU availability for communication is being used. • The count of RSLinx® optimized packets that are currently used. • The high-water value of optimized packets that are used. • The largest optimized packet instance number that is used in the controller. • Diagnostic counters for the FactoryTalk® Linx software driver that is being used by the HMI to communicate with the controller. • The number of connections that are being used, the highest number that is used, and the total available connections for several types of data transfers. • Data also includes statistics for message instructions that are using unconnected buffers and message cache entries. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 229 Chapter 15 Logix Diagnostic Objects Faults Tab The Faults tab contains the list of minor faults and the fault count. There is an indicator to display the status of each fault. A blue indicator box shows that the fault is active. Performance Tab The Performance tab shows the approximate CPU percentage that is used by each of the major activities for the controller. If there is a continuous task running in the controller, the top segment of the bar graph shows the CPU used by the continuous task. If there is no continuous task, the top segment shows the percentage CPU free (unused). The CPU percentages do not necessarily add up to 100% because of the variability between execution cycles of the listed tasks and rounding errors. The raP_Dvc_LgxCPU_5x80 instruction is used with a multi-core controller. The bar graph on the left represents the CPU percentage that is used of the control core (Core 0). Maintenance Tab The Maintenance tab shows the following information: • An indicator to show whether data collection (polling) is enabled or disabled • An indicator to show when the instruction is waiting before the next data collection (poll) and when a poll is in progress • An indicator to show when a poll is busy or the result of the last poll • (Data Received or Error) • Configuration values, some of which cannot be changed from the faceplate 230 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Item 1 1 2 2 Item 1 1 2 2 Logix Diagnostic Objects Description Enter a serial number for your Studio 5000 Logix Designer software, the contract number for your TechConnectSM, or other technical support contract information. This information is then available for ready reference if you call Rockwell Automation Technical Support. Enable / Disable Data Collection IMPORTANT: The raP_Dvc_LgxCPU_5x80 instruction accomplishes its data collection by using MSG instructions to the controller (MSG to self), which uses some controller communication resources. You can leave data collection disabled until it is needed. Some faceplate data is monitored without using the polling messages and is still displayed. When disabled, only data collection via MSG instructions is disabled. Other data can still be updated and displayed on the faceplate. Data not updated when collection is disabled is not displayed. Description Area name for security Enter the interval that is used to collect and update data that is displayed on the other faceplate tabs. IMPORTANT: If you set this parameter too low, it can result in a flood of messages to the controller and possibly affect control performance. Do not use a value less than 5 seconds unless instructed to do so by a Rockwell Automation Technical Support specialist. Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 228 for descriptions of the features. Operator Tab Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 231 Chapter 15 Logix Diagnostic Objects Faults Tab Performance Tab Maintenance Tab 232 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Redundant Controller Monitor (raP_Dvc_LgxRedun) Logix Diagnostic Objects The raP_Dvc_LgxRedun (Logix Redundant Controller Monitor) Add-On Instruction monitors one redundant pair of Logix controllers. The instruction checks 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. Guidelines Use this instruction in these situations: • You are using Logix controllers in a redundant configuration. • You want to monitor the status of the redundant controller pair. • You want to display this status to operators, maintenance personnel, or engineers. Do not use this instruction in these situations: • You are using single Logix controllers, not in a redundant configuration. The raP_Dvc_LgxRedun instruction is designed around the ControlLogix® Enhanced Redundancy System architecture, by using information from the 1756-RM2 Redundancy Modules. The raP_Dvc_LgxRedun Add-On Instruction does not verify in a non-redundant system because the data items it monitors do not exist in a non-redundant configuration. • Your controllers are in an accessible location and the indicators on the controllers, network modules, and redundancy modules provide sufficient information about redundancy status. For more information, see the ControlLogix Enhanced Redundancy System User Manual, publication 1756-UM535. Functional Description The raP_Dvc_LgxRedun instruction is provided as a rung import for installation. Importing this rung into your ladder diagram routine: • imports the Add-On Instruction definition • creates an instruction instance • creates and completes all required tags and data structures for the instruction Once the rung is imported, and before you download and run the application, set the path in each Message tag that references the input/output parameters of the instruction to point to slot that contains the 1756-RM2 module in the local chassis ('1, <slot>'). 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 Files The raP_Dvc_LgxRedun_5.20.00_RUNG.L5X rung import file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 233 Chapter 15 Logix Diagnostic Objects Visualization Files See Visualization Files on page 17 for general information on visualization files. For the object and visualization parameters, see PlantPAx Process Objects, publication PROCES-RD200, and PlantPAx Visualization Files, publication PROCES-RD201. Operations The raP_Dvc_LgxRedun instruction monitors a redundant pair of Logix controllers and provides the following information and capabilities: • Determines and displays whether the current primary controller is in Chassis ‘A’ or Chassis ‘B’ (as defined by user configuration) • Displays the Chassis A and Chassis B Redundancy Module (1756-RM2) status • Displays the Controller A and Controller B redundancy status • Displays the Controller A and Controller B keyswitch positions • Displays the overall compatibility between modules in Chassis A and modules in Chassis B • Displays the synchronization progress in percent complete • Displays the amount of data that is transferred from the Primary redundancy module to the Secondary in the most recent transfer, and the most sent in any transfer (high-water mark) This instruction also supports the following commands, if enabled in the configuration: • Initiate a switchover from Primary to Secondary • Initiate a resynchronization of the system (if it does not take place automatically) Command Sources The raP_Dvc_LgxRedun instruction has no commands or outputs that are intended to control equipment and so does not have any command sources. Alarms The raP_Dvc_LgxRedun Instruction uses the following alarm, which is implemented by using Tag Based Alarms. Alarm Alarm Name Secondary not ready Alm_SecNotRdy Description Raised when the secondary controller in a redundant pair is not ready to take over control on loss of the primary. Virtualization The raP_Dvc_LgxRedun Add-On Instruction does not have a Virtualization capability. 234 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects Execution The following table explains the handling of instruction execution conditions. Condition EnableIn False (false rung) Powerup (prescan, first scan) Postscan (SFC transition) Description No EnableIn False logic is provided. The raP_Dvc_LgxRedun instruction must always be scanned true. In relay ladder logic, the raP_Dvc_LgxRedun instruction must be by itself on an unconditional rung. If the Rung Import provided with the Rockwell Automation is used to install this instruction, the proper rung is created for you. On Pre-scan, any commands that are received before first scan are discarded. No SFC Postscan logic is provided. See to the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756PM010, for more information. Programming Example The raP_Dvc_LgxRedun instruction is provided fully configured as a rung import, so little programming is required for the instruction to be used. This programming example shows how the rung import is used to instantiate the raP_Dvc_LgxRedun instruction. As raP_Dvc_LgxRedun is a rung import, it must be created in a Ladder Diagram routine. The following steps describe how you instantiate raP_Dvc_LgxRedun in your routine. 1. In your ladder routine, right-click where to insert the rungs and select Import Rungs. The Import Rungs dialog box appears. 2. Select the appropriate raP_Dvc_LgxRedun rung import file that is named in Required Files on page 233. 3. Select Open. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 235 Chapter 15 Logix Diagnostic Objects The Import Configuration dialog box appears. 4. To create the instance of raP_Dvc_LgxRedun, select OK. 5. Complete the following steps for each of the two MSG controls to set the path to point to the 1756-RM2 module in the local chassis. a. Select the ellipsis next to the MSG control tag. The Message Configuration dialog box appears. 236 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects b. To set the second number in the path to the slot number of the 1756-RM2 module, Select the Communication tab. c. Select OK. 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 GO_LgxRedun FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol Description This global object is used for redundancy modules. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 237 Chapter 15 Logix Diagnostic Objects FactoryTalk View SE Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab The Operator tab provides status information on the primary and secondary controllers. 1 2 5 6 3 7 4 8 Item 1 2 3 4 5 6 7 8 Description Compatibility status Chassis A (upper chassis) status Chassis A (upper chassis) controller mode Transfer size and status Chassis B (lower chassis) status Chassis B (lower chassis) controller status Synchronization status Switchover status Engineering Tab The Engineering tab provides access to device configuration parameters and ranges, options for device and I/O setup, security area, displayed text, and faceplate-to-faceplate navigation settings, for initial system commissioning or later system changes. On the Engineering tab, you can identify and configure each chassis and configure display, switchover, and synchronization options. 1 2 3 Item 1 2 4 3 5 4 5 238 Description Select to enable the Operator command to initiate synchronization of the primary controller to the secondary controller. Select to enable the External command to initiate synchronization of the primary controller to the secondary controller. Select to enable the Maintenance command to switch to the secondary controller. Select to enable the External command to switch to the secondary controller. Select to designate chassis A and chassis B on the HMI. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects HMI Configuration Tab Item 1 2 Description Enter a name for the location of Chassis A location. Enter a name for the location of Chassis B location. Item 1 2 3 Description Select to allow Operator to shelve the alarm. Select to allow Maintenance to disable the alarm. Select the type of confirmation required for Operator commands. 1 2 1 2 3 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 239 Chapter 15 Logix Diagnostic Objects Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 238 for descriptions of the features. Operator Tab Diagnostics Tab 240 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Module Status (raP_Dvc_LgxModuleSts) Logix Diagnostic Objects The raP_Dvc_LgxModuleSts (Logix Module Status) Add-On Instruction monitors the connection status of one module or device in the I/O configuration tree of the Logix controller, and monitors it for any I/O channel faults on the module. The instruction provides an “I/O fault” status to dependent equipment, and provides a “Module Fault” status and alarm if the connection to the module is lost. It also provides an “Any Channel Fault” status and alarm if any I/O channel on the module reports a fault. Guidelines Use this instruction if you want to monitor the I/O connection status of a given module or device. This instruction is for use in CompactLogix 5380 and ControlLogix 5580 controllers using software / firmware version 33 or later. Functional Description The raP_Dvc_LgxModuleSts Add-On Instruction is used to check the I/O connection status for the given module or device. The instruction provides an I/O Fault status output, which is 1 when the connection is lost, and 0 when the connection to the I/O module is OK and running normally. This status available for use by other Add-On Instructions that use inputs or outputs of the given I/O module or device. The following images show how the I/O Fault status output is connected to instructions that use the module being monitored. Here is the code showing the raP_Dvc_LgxModuleSts instruction getting the connection status for the module in Local chassis, Slot 2: That status is passed along to the Analog Input instruction, which uses an input on that module: Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 241 Chapter 15 Logix Diagnostic Objects The raP_Dvc_LgxModuleSts instruction can be used to provide the connection status for any connected device (anything with a Requested Packet Interval) in the I/O Configuration tree in Studio 5000 Logix Designer® application. These devices include I/O modules, network communication modules, motor drives, overload relays, flowmeters, analyzers, weigh scales and other devices on EtherNet/IP™ or another I/O network, or in the chassis containing the controller. IMPORTANT Entry of a name for an I/O module or other device in the I/O Configuration is optional. However, in order for the raP_Dvc_LgxModuleSts instruction to refer to the module or device, you MUST give the module or device a name. 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 Files The raP_Dvc_LgxModuleSts_5.20.00_AOI.L5X Add-On Instruction definition file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files See Visualization Files on page 17 for general information on visualization files. Operations Command Sources The raP_Dvc_LgxModuleSts instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Dvc_LgxModuleSts Instruction uses the following alarms, which are implemented using Tag Based Alarms: Alarm Alarm Name Module Fault Alm_ModuleFault Any Channel Faulted Alm_AnyChanFault Description Raised when the I/O connection to the module or device is not in the Running state. Raised when any I/O channel on the module is reporting a fault. Virtualization Virtualization allows the raP_Dvc_LgxModuleSts instruction to report a virtual connection status for use in test, demonstration, or training systems. The raP_Dvc_LgxModuleSts Add-On Instruction can be selected to virtual or physical (normal) operation. When physical operation is selected, the actual module connection status is monitored, and an I/O Fault status and Module Fault alarm is reported if the connection is not running. When virtual operation is selected, the actual module 242 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects connection status is ignored; the Set_VirtualConnectedSts input parameter determines the reported connection status. Set_VirtualConnectedSts value Description 1 Connected, the connection status is reported as OK Faulted, the connection status is reported as faulted, the Sts_IOFault status is 0 raised for dependent devices, and the Alm_ModuleFault alarm is raised. Execution The following table explains the handling of instruction execution conditions. Condition EnableIn False (false rung) Powerup (prescan, first scan) Postscan (SFC transition) Description No EnableIn False logic is provided. The raP_Dvc_LgxModuleSts instruction must always be scanned true. In relay ladder logic, the raP_Dvc_LgxModuleSts instruction must be by itself on an unconditional rung. All commands, including alarm acknowledge and reset, virtual or physical selection, maintenance bypass and check, plus all latched internal fault status bits, are cleared on prescan. No SFC Postscan logic is provided. See to the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756PM010, for more information. Programming Examples The example in the Function Description section shows the basic use of the raP_Dvc_LgxModuleSts Add-On Instruction for monitoring a module connection. The instruction can also monitor and alarm channel faults on the I/O module, using some simple external logic. For many discrete modules, the individual channel fault bits are collected into a single INT or DINT (16-bit or 32-bit integer), and if the value of this integer is not zero, there is at least one channel fault: The "NEQ" instruction determines that there is at least one channel fault, and this status is forwarded to the raP_Dvc_LgxModuleSts instruction via the Inp_AnyChanFault input pin. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 243 Chapter 15 Logix Diagnostic Objects Some analog modules use a similar grouping of channel faults; others require the user to “OR” the individual channel faults in the external logic: The raP_Dvc_LgxModuleSts also has the capability to be organized, via connecting pins or via the optional Bus, to match the I/O hierarchy. This organization can help prevent alarm floods by inhibiting the alarms from lower-level modules when a higher-level connection fault causes a cascading I/O failure. Using the following I/O configuration as an example: If the connection to the 5094-AENTR adapter fails, all devices under it will report I/O connection loss, and a flood of Module Fault alarms occur. By wiring the raP_Dvc_LgxModuleSts instructions into a hierarchy, the fault that is detected for the 5094-AENTR can be cascaded to the I/O Fault 244 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects inputs of all dependent devices, AND can be used to inhibit the Module Fault alarms at the lowerlevels, reducing the number of alarms generated. If the I/O adapter (5094-AENTR) connection fails, the HART analog input module (5094-IF8IH) and the PT101 device logic will be informed of the I/O fault condition (via the Rack01_S02IOFault and PT101_IOFault IREFs), but the analog input module and PT101 device Module Fault alarms are inhibited (via the child I/O alarm gate connections), so that only the root cause module fault alarm will be generated. 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 FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol GO_LgxModuleSts Description This global object is used for module status. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 245 Chapter 15 Logix Diagnostic Objects FactoryTalk View SE Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab The operator tab displays the status of the module. Engineering Tab 1 2 3 Item 1 2 4 3 4 246 Description Enter the delay, in seconds, after an I/O communication fault is detected before raising the Alm_ModuleFault alarm. This delay may be needed to avoid an alarm flood when a network or I/O adapter fault cascades down to several modules. The delay allows time for the parent fault to inhibit the individual module fault alarms. Select yes to bypass (block) the generation of the I/O Fault status (Sts_IOFault). Select no to enable I/O Fault status generation. Select yes to enable virtual operation; the actual module connection status is ignored, and the virtual connection status setting (#4) is used instead. Select no to enable physical operation; the actual module connection is monitored. When virtual operation is selected, use this selector to set the virtual connection status. When set to disconnected, an I/O Fault status is generated (if not bypassed). Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects HMI Configuration Tab Item 1 2 Description Select to allow Operator to shelve the alarm. Select to allow Maintenance to disable the alarm. Item 1 Description Select the type of confirmation required for Operator commands. 1 2 1 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 247 Chapter 15 Logix Diagnostic Objects Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk® View SE faceplates. See FactoryTalk View SE Faceplates on page 246 for descriptions of the features. Operator Tab Engineering Tab 248 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Task Monitor (raP_Dvc_LgxTaskMon) Logix Diagnostic Objects The raP_Dvc_LgxTaskMon (Logix Task Monitor) 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: • Display Values for Task configuration: Task Name, Priority, Rate, Watchdog settings • Display Values for Task statistics: Last and Max Execution time, Overlap Count • Display of the Task Inhibit / Active Status • Configuration of a “Plan” Execution Time, the time in which the Task is expected to always complete (including interrupts by higher priority Tasks) • An optional Alarm when Last (actual) Execution Time exceeds Plan • A Reset command, which clears and acknowledges the Over Plan Alarm. • Maintenance Commands to clear the Max Execution Time and Overlap Count. Guidelines Use this instruction in these situations: • Monitor the execution of one or more tasks in a Logix controller • Set an alarm when task execution time exceeds a ‘plan’ threshold Do not use this instruction if you are using suitable software or another method to monitor controller task execution. Functional Description The raP_Dvc_LgxTaskMon instruction includes an Add-On Instruction for use with: • Studio 5000® Logix Designer software, version 33 or later • Logix controllers, firmware revision 33 or later • Graphic symbol and faceplate display for use with FactoryTalk® View Site Edition software, version 13 or later. • Studio 5000 View Designer application 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 Files The raP_Dvc_LgxTaskMon_5.20.00_AOI.L5X Add-On Instruction must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Visualization Files See Visualization Files on page 17 for general information on visualization files. Operations The raP_Dvc_LgxTaskMon Add-On Instruction does not use modes or virtualization. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 249 Chapter 15 Logix Diagnostic Objects Command Sources The raP_Dvc_LgxModuleSts instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Dvc_LgxTaskMon Instruction uses the following alarms, which are implemented by using Tag Based Alarms. Alarm Over Plan Alarm Name Alm_OverPlan Description Task execution time exceeds plan limit. Virtualization Virtualization allows the raP_Dvc_LgxModuleSts instruction to report a virtual connection status for use in test, demonstration, or training systems. The raP_Dvc_LgxModuleSts Add-On Instruction can be selected to virtual or physical (normal) operation. When physical operation is selected, the actual module connection status is monitored, and an I/O Fault status and Module Fault alarm is reported if the connection is not running. When virtual operation is selected, the actual module connection status is ignored; the Set_VirtualConnectedSts input parameter determines the reported connection status. Set_VirtualConnectedSts value Description 1 Connected, the connection status is reported as OK Faulted, the connection status is reported as faulted, the Sts_IOFault status is 0 raised for dependent devices, and the Alm_ModuleFault alarm is raised. Programming Example Place an instance like this in each controller task and have it always scanned true. In ladder diagram, you can use an array of backing tags, assigning a different array member for each task. For the default PlantPAx® process controller task model, the following assignments are recommended and are included in the PlantPAx template application: raP_Dvc_LgxTaskMon[0] raP_Dvc_LgxTaskMon[1] raP_Dvc_LgxTaskMon[2] raP_Dvc_LgxTaskMon[3] System (1000 ms) task Fast (100 ms) task Normal (250 ms) task Slow (500 ms) task The task in which the instruction is instantiated will be checked each scan for its status and to determine whether its execution time exceeds the plan limit for that task. 250 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects Graphic Symbols Graphic Symbol Name FactoryTalk View SE Graphic Symbol Studio 5000 View Designer Graphic Symbol Description This global object provides task statistics for one task in a Logix controller. GO_TaskMon GO_TaskMonSummary This object provides a graphic representation of eight L_TaskMon objects in a controller. Click this object to display a summary screen of all eight L_TaskMon objects. — FactoryTalk View SE Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Operator Tab 3 Item 1 2 3 Description Click to reset the Max Execution Time. Click to reset Task Overlap Count. Click to reset and acknowledge all alarms. 1 2 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 251 Chapter 15 Logix Diagnostic Objects Engineering Tab The maintenance tab provides access to the planned execution time. Trends Tab The Trends tab 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 1 2 Description Planned execution time (blue line) Last execution time (green line) Item 1 2 Description Select to allow Operator to shelve alarm. Select to allow Maintenance to disable alarm. 1 2 HMI Tab 1 2 252 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Item 1 1 Logix Diagnostic Objects Description Select to configure operator command confirmation. This action would take place after any operator command. Studio 5000 View Designer Faceplates There are basic faceplate attributes that are common across all instructions. The Trends tab, Diagnostics tab, and Alarms tab all have the same basic functionality and are not described in this section. See Basic Faceplate Attributes on page 24. Any feature that is contained in the Studio 5000 View Designer® faceplates has the same functionality as used in the FactoryTalk View SE faceplates. See FactoryTalk View SE Faceplates on page 251 for descriptions of the features. Operator Tab Trends Tab Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 253 Chapter 15 Logix Diagnostic Objects Logix Event (raP_Tec_LgxEvent) The raP_Tec_LgxEvent (Logix Event) Add-On Instruction captures any of 16 event bit rising edge transitions and records the lowest-order rising edge bit as the reason of the event. The instruction provides an “I/O fault” input to monitor parent IO conditions. It also provides a Reset to clear the event reason. Guidelines Use this instruction if you want to monitor up to 16 User-defined events, per object. Functional Description The raP_Tec_LgxEvent Add-On Instruction is used to capture any of 16 bit rising edge transitions and records the lowest order rising edge bit as the reason of the event. The events are published in the Sts_Reasons parameter. Reasons are only captured if the Inp_IOFault and the Inp_Reset parameters are low. (0) Event reasons are cleared by setting the Reset input parameter. (1) Event input conditions can be connected to any user-defined logic. The following images show how the event inputs are mapped to the instruction. Ladder logic is typically used to allow for more complex trigger conditions. Here is the code showing the mapping of four event triggers, as well as the Reset and IOFault: 254 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Chapter 15 Logix Diagnostic Objects Those inputs are the source of the raP_Tec_LgxEvent instruction: The following images show how the event Reasons are assigned a User description for the Event. Each individual event is allowed a unique description to be applied. The description must be changed/updated to what the you want to be displayed in the reports. 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 Files The raP_Tec_LgxEvent_5.20.00_AOI.L5X Add-On Instruction definition file must be imported into the controller project to be able to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 255 Chapter 15 Logix Diagnostic Objects Visualization Files There are no visualization files because the raP_Tec_LgxEvent object does not use Graphic Symbols or Faceplates. Operations Command Sources The raP_Tec_LgxEvent instruction has no commands or outputs that are intended to control equipment and therefore does not have any selection of active command source. Alarms The raP_Tec_LgxEvent Instruction has no Alarms. Virtualization The raP_Tec_LgxEvent Instruction has no Virtualization. Execution The following table explains the handling of instruction execution conditions. Condition EnableIn False (false rung) Powerup (prescan, first scan) Postscan (SFC transition) Description No EnableIn False logic is provided. The raP_Tec_LgxEvent instruction must always be scanned true. In relay ladder logic, the raP_Tec_LgxEvent instruction must be by itself on an unconditional rung. No SFC Prescan logic is provided. No SFC Postscan logic is provided. See to the Logix 5000 Controllers Add-On Instructions Programming Manual, publication 1756PM010, for more information. Programming Examples The example in the Function Description section shows the basic use of the raP_Tec_LgxEvent Add-On Instruction for capturing events. Graphic Symbols There are no visualization files associated with this object. Faceplates There are no visualization files associated with this object 256 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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. We suggest that you make a copy of the color palette .xml file if you plan to use the color 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 https://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®.’ Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 257 Appendix A FactoryTalk View Customization Tool Use the Tool with Library Objects 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 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 5. Repeat step 4 to change each color. 258 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 icon. 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). 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’. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 259 Appendix A FactoryTalk View Customization Tool 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. Use the Tool with Other FactoryTalk View Software Files 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 to the color palette. You must create associations and save them in a color association 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. 260 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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 screenshot on the icon in the far right) indicates the “Normal” command source. Command Source Operator Program External Override Maintenance Out of Service Hand Description 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 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 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). 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. 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). 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. 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. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 261 Appendix B Command Sources and Device Virtualization Not all Command Sources are used in every object. PCMDSRC raP_Opr_Area raP_Opr_Unit raP_Opr_EMGen raP_Opr_EPGen Operator Program x x x x x x x x Virtualization External x x x x Override Maintenance x x x x Out of Service x x x x Hand 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 from the HMI faceplate. • For controlled devices, such as valves, motors and drives, the outputs are held deenergized (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. 262 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 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. Access to alarms is via <backing_tag>.@Alarms.<alarm_name>.<alarm_parameter>. You must select the extended properties to populate for each tag and then enter the values. raP_Dvc_LgxChangeDet Common raP_Dvc_LgxChangeDet.@Description raP_Dvc_LgxChangeDet.@Area raP_Dvc_LgxChangeDet.@Instruction raP_Dvc_LgxChangeDet.@Label raP_Dvc_LgxChangeDet.@Library raP_Dvc_LgxChangeDet.@URL raP_Dvc_LgxChangeDet.Cfg_HasMoreObj.@Navigation Alarms raP_Dvc_LgxChangeDet.Sts_ChangeDetected.@Label "Logix Change Detector" "Area01" "raP_Dvc_LgxChangeDet" "Controller Name" "raP-5_20" "n/a" "" Alarm Default Message "Logic change detected" /*S:0 %.@Description*/: Controller logic change detected Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Severity 1000 263 Appendix C Tag Extended Properties and Default Alarm Settings raP_Dvc_LgxCPU_5x80 Common raP_Dvc_LgxCPU_5x80.@Description raP_Dvc_LgxCPU_5x80.@Area raP_Dvc_LgxCPU_5x80.@Instruction raP_Dvc_LgxCPU_5x80.@Label raP_Dvc_LgxCPU_5x80.@Library raP_Dvc_LgxCPU_5x80.@URL raP_Dvc_LgxCPU_5x80.Cfg_HasMoreObj.@Navigation "Processor utilization (5380/5580, v33 and later)" "Area01" "raP_Dvc_LgxCPU_5x80" "" "raP-5_20" "n/a" "" raP_Dvc_LgxModuleSts Common raP_Dvc_LgxModuleSts.@Description raP_Dvc_LgxModuleSts.@Area raP_Dvc_LgxModuleSts.@Instruction raP_Dvc_LgxModuleSts.@Label raP_Dvc_LgxModuleSts.@Library raP_Dvc_LgxModuleSts.@URL Alarms raP_Dvc_LgxModuleSts.Sts_AnyChanFault.@Lab "I/O channel fault" el raP_Dvc_LgxModuleSts.Sts_ModuleFault.@Label "I/O module fault" "Logix - Module Status" "Area01" "raP_Dvc_LgxModuleSts" "Module Name" "raP-5_20" "n/a" Alarm Default Message Severity /*S:0 %.@Description*/: An I/O channel is faulted 500 /*S:0 %.@Description*/: I/O module or device connection fault 500 raP_Dvc_LgxRedun Common raP_Dvc_LgxRedun.@Description raP_Dvc_LgxRedun.@Area raP_Dvc_LgxRedun.@Instruction raP_Dvc_LgxRedun.@Label raP_Dvc_LgxRedun.@Library raP_Dvc_LgxRedun.@URL Alarms raP_Dvc_LgxRedun.Sts_SecNotRdy.@Label "Secondary not ready" "Logix Redundant Controller Monitor" "Area01" "raP_Dvc_LgxRedun" "Redundant Controller" "raP-5_20" "n/a" Alarm Default Message Redundancy: secondary controller not ready to take control. Severity 500 raP_Dvc_LgxTaskMon Common raP_Dvc_LgxTaskMon.@Description raP_Dvc_LgxTaskMon.@Area raP_Dvc_LgxTaskMon.@Instruction raP_Dvc_LgxTaskMon.@Label raP_Dvc_LgxTaskMon.@Library raP_Dvc_LgxTaskMon.@URL Alarms raP_Dvc_LgxTaskMon.Sts_OverPlan.@Label 264 "Task scan time over plan" "Logix Task Monitor" "Area01" "raP_Dvc_LgxTaskMon" "Logix Task Monitor" "raP-5_20" "n/a" Alarm Default Message Controller Task /*S:0 %Tag1*/: execution time over plan Severity Tag1 = raP_Dvc_LgxTaskmon.Sts_sName (Task Name as configured in the controller.):STRING 500 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix C Tag Extended Properties and Default Alarm Settings raP_Opr_ArbitrationQ Common raP_Opr_ArbitrationQ.@Description raP_Opr_ArbitrationQ.@Area raP_Opr_ArbitrationQ.@Instruction raP_Opr_ArbitrationQ.@Label raP_Opr_ArbitrationQ.@Library raP_Opr_ArbitrationQ.@URL "" "Area01" "" "" "raP-5_20" "n/a" raP_Opr_Area Common raP_Opr_Area.@Description raP_Opr_Area.@Area raP_Opr_Area.@Instruction raP_Opr_Area.@Label raP_Opr_Area.@Library raP_Opr_Area.@URL raP_Opr_Area.Cfg_HasMoreObj.@Navigation "Area" "Area01" "raP_Opr_Area" "Area" "raP-5_20" "n/a" "" General raP_Opr_Area.Sts_ExtddAlms.@Label "Extended alarm" Alarms raP_Opr_Area.Sts_EStopTrip.@Label raP_Opr_Area.Sts_SStopTrip.@Label “Emergency stop” “Software stop” Alarm Default Message "/*S:0 %.@Description*/: Emergency stop "/*S:0 %.@Description*/: Software stop Severity 750 750 raP_Opr_EMGen Common raP_Opr_EMGen.@Description raP_Opr_EMGen.@Area raP_Opr_EMGen.@Instruction raP_Opr_EMGen.@Label raP_Opr_EMGen.@Library raP_Opr_EMGen.@URL raP_Opr_EMGen.Cfg_HasMoreObj.@Navigation raP_Opr_EMGen.Sts_eStep.@Navigation raP_Opr_EMGen.Sts_eSummary.@Navigation raP_Opr_EMGen.Cfg_HasDvcAlmsObjNav@Navigation raP_Opr_EMGen.Ref_SMCfgPath@Navigation General raP_Opr_EMGen.Cfg_HasDetailDisplay.@Navigation raP_Opr_EMGen.Sts.0.@Description raP_Opr_EMGen.Sts.1.@Description raP_Opr_EMGen.Sts.2.@Description raP_Opr_EMGen.Sts.3.@Description raP_Opr_EMGen.Sts.4.@Description raP_Opr_EMGen.Sts.5.@Description raP_Opr_EMGen.Sts.6.@Description raP_Opr_EMGen.Sts.7.@Description raP_Opr_EMGen.Sts.8.@Description raP_Opr_EMGen.Sts.9.@Description Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 "Generic Equipment Module" "Area01" "raP_Opr_EMGen" "Equipment Module" "raP-5_20" "" "" “SystemStepDescriptions” "SystemSummary" "" "" "" "State 1" "State 2" "State 3" "State 4" "State 5" "State 6" "State 7" "State 8" "State 9" "State 10" 265 Appendix C Tag Extended Properties and Default Alarm Settings General raP_Opr_EMGen.Sts.10.@Description raP_Opr_EMGen.Sts.11.@Description raP_Opr_EMGen.Sts.12.@Description raP_Opr_EMGen.Sts.13.@Description raP_Opr_EMGen.Sts.14.@Description raP_Opr_EMGen.Sts.15.@Description raP_Opr_EMGen.Sts.16.@Description raP_Opr_EMGen.Sts.17.@Description raP_Opr_EMGen.Sts.18.@Description raP_Opr_EMGen.Sts.19.@Description raP_Opr_EMGen.Sts.20.@Description raP_Opr_EMGen.Sts.21.@Description raP_Opr_EMGen.Sts.22.@Description raP_Opr_EMGen.Sts.23.@Description raP_Opr_EMGen.Sts.24.@Description raP_Opr_EMGen.Sts.25.@Description raP_Opr_EMGen.Sts.26.@Description raP_Opr_EMGen.Sts.27.@Description raP_Opr_EMGen.Sts.28.@Description raP_Opr_EMGen.Sts.29.@Description raP_Opr_EMGen.Sts.30.@Description raP_Opr_EMGen.Sts.31.@Description raP_Opr_EMGen.Sts_ExtddAlms.@Label raP_Opr_EMGen.XCmd.0.@Description 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 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 266 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 "State 11" "State 12" "State 13" "State 14" "State 15" "State 16" "State 17" "State 18" "State 19" "State 20" "State 21" "State 22" "State 23" "State 24" "State 25" "State 26" "State 27" "State 28" "State 29" "State 30" "State 31" "State 32" "Extended alarm" "Command 1" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" "n/a" Appendix C Tag Extended Properties and Default Alarm Settings General raP_Opr_EMGen.XCmd.29.@Description raP_Opr_EMGen.XCmd.30.@Description raP_Opr_EMGen.XCmd.31.@Description Alarms raP_Opr_EMGen.Sts_DvcAlms.@Label raP_Opr_EMGen.Sts_IntlkTrip.@Label raP_Opr_EMGen.Sts_RptData.@Label "n/a" "n/a" "n/a" "Device alarm” "Interlock trip” "Report data not collected” Alarm Default Message "/*S:0 %.@Description*/: Device alarm "/*S:0 %.@Description*/: Interlock trip "/*S:0 %.@Description*/: Report data Severity 500 500 500 raP_Opr_EPGen Common raP_Opr_EPGen.@Description raP_Opr_EPGen.@Area raP_Opr_EPGen.@Instruction raP_Opr_EPGen.@Label raP_Opr_EPGen.@Library raP_Opr_EPGen.@URL raP_Opr_EPGen.Cfg_HasMoreObj.@Navigation raP_Opr_EPGen.Sts_eStep.@Navigation raP_Opr_EPGen.Sts_eSummary.@Navigation raP_Opr_EPGen.Cfg_HasDvcAlmsObjNav@Navigation General #2.Cfg_HasDetailDisplay.@Navigation #2.Sts_ExtddAlms.@Label Alarms raP_Opr_EPGen.Sts_DvcAlms.@Label raP_Opr_EPGen.Sts_IntlkTrip.@Label raP_Opr_EPGen.Sts_RptData.@Label "Generic Equipment Phase" "Area01" "raP_Opr_EPGen" "Equipment Phase" "raP-5_20" "n/a" "" "SystemStepDescriptions" "SystemSummary" "" "" "Extended alarm" "Device alarm” "Interlock trip” "Report data not collected” Alarm Default Message "/*S:0 %.@Description*/: Device alarm "/*S:0 %.@Description*/: Interlock trip Severity 500 500 "/*S:0 %.@Description*/: Report data 500 raP_Opr_ExtddAlm Common raP_Opr_ExtddAlm.@Description raP_Opr_ExtddAlm.@Area raP_Opr_ExtddAlm.@Instruction raP_Opr_ExtddAlm.@Label raP_Opr_ExtddAlm.@Library raP_Opr_ExtddAlm.@URL "Extended alarm" "Area01" "raP_Opr_ExtddAlm" "Alarm" "raP-5_20" "n/a" raP_Opr_OrgScan Common raP_Opr_OrgScan.@Description raP_Opr_OrgScan.@Area raP_Opr_OrgScan.@Instruction raP_Opr_OrgScan.@Label raP_Opr_OrgScan.@Library raP_Opr_OrgScan.@URL Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 "" "Area01" "" "" "raP-5_20" "n/a" 267 Appendix C Tag Extended Properties and Default Alarm Settings raP_Opr_OrgView Common raP_Opr_OrgView.@Description raP_Opr_OrgView.@Area raP_Opr_OrgView.@Instruction raP_Opr_OrgView.@Label raP_Opr_OrgView.@Library raP_Opr_OrgView.@URL "" "Area01" "" "" "raP-5_20" "n/a" raP_Opr_Prompt Common raP_Opr_Prompt.@Description raP_Opr_Prompt.@Area raP_Opr_Prompt.@Instruction raP_Opr_Prompt.@Label raP_Opr_Prompt.@Library raP_Opr_Prompt.@URL raP_Opr_Prompt.Cfg_HasMoreObj.@Navigation "Operator Prompt" "Area01" "raP_Opr_Prompt" "Prompt" "raP-5_20" "n/a" "" Alarms Alarm Default Message Severity raP_Opr_Prompt.Sts_AlertTimeOut.@Label “Prompt timed out" /*S:0 %.@Description*/ Prompt time out alarm 500 raP_Opr_Prompt_Core Common raP_Opr_Prompt.@Description raP_Opr_Prompt.@Area raP_Opr_Prompt.@Instruction raP_Opr_Prompt.@Label raP_Opr_Prompt.@Library raP_Opr_Prompt.@URL raP_Opr_Prompt.Cfg_HasMoreObj.@Navigation raP_Opr_Unit.Sts_eMtrl.@Navigation raP_Opr_Unit.Sts_eSummary.@Navigation 268 "Operator Prompt" "Area01" "raP_Opr_Prompt" "Prompt" "raP-5_20" "n/a" "" "SystemMaterialNames" "SystemSummary" Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix C Tag Extended Properties and Default Alarm Settings raP_Opr_Unit Common raP_Opr_Unit.@Description raP_Opr_Unit.@Area raP_Opr_Unit.@Instruction raP_Opr_Unit.@Label raP_Opr_Unit.@Library raP_Opr_Unit.@URL raP_Opr_Unit.Cfg_HasMoreObj.@Navigation General raP_Opr_Unit.Sts.0.@Description raP_Opr_Unit.Sts.1.@Description raP_Opr_Unit.Sts.2.@Description raP_Opr_Unit.Sts.3.@Description raP_Opr_Unit.Sts_ExtddAlms.@Label raP_Opr_Unit.XCmd.0.@Description raP_Opr_Unit.XCmd.1.@Description raP_Opr_Unit.XCmd.2.@Description raP_Opr_Unit.XCmd.3.@Description raP_Opr_Unit.Val_Actl.@EngineeringUnit Alarms raP_Opr_Unit.Sts_EStopTrip.@Label raP_Opr_Unit.Sts_GroupCmd1Fail.@Label raP_Opr_Unit.Sts_GroupCmd2Fail.@Label raP_Opr_Unit.Sts_GroupCmd3Fail.@Label raP_Opr_Unit.Sts_GroupCmd4Fail.@Label raP_Opr_Unit.Sts_IntlkTrip.@Label raP_Opr_Unit.Sts_SStopTrip.@Label "Unit" "Area01" "raP_Opr_Unit" "Unit" "raP-5_20" "n/a" "" "State 0" "State 1" "State 2" "State 3" "Extended alarm" "Group Command 0" "n/a" "n/a" "n/a" "Kg" "Emergency stop” "Group Command 1 Failed” "Group Command 2 Failed” "Group Command 3 Failed” "Group Command 4 Failed” "Interlock trip” "Software stop” Alarm Default Message "/*S:0 %.@Description*/: Emergency stop "/*S:0 %.@Description*/: Group Command 1 Failed "/*S:0 %.@Description*/: Group Command 2 Failed "/*S:0 %.@Description*/: Group Command 3 Failed "/*S:0 %.@Description*/: Group Command 4 Failed "/*S:0 %.@Description*/: Interlock trip "/*S:0 %.@Description*/: Software stop Severity 750 500 500 500 500 500 750 raP_Tec_ParRpt Common raP_Tec_ParRpt_PAR_XX.@Description raP_Tec_ParRpt_PAR_XX.@Area raP_Tec_ParRpt_PAR_XX.@Instruction raP_Tec_ParRpt_PAR_XX.@Label raP_Tec_ParRpt_PAR_XX.@Library raP_Tec_ParRpt_PAR_XX.@URL raP_Tec_ParRpt_PAR_XX.@EngineeringUnit raP_Tec_ParRpt_RPT_XX.@Description raP_Tec_ParRpt_RPT_XX.@Area raP_Tec_ParRpt_RPT_XX.@Instruction raP_Tec_ParRpt_RPT_XX.@Label raP_Tec_ParRpt_RPT_XX.@Library raP_Tec_ParRpt_RPT_XX.@URL raP_Tec_ParRpt_RPT_XX.@EngineeringUnit Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 "Parameter" "Area01" "raP_Tec_ParRpt" "Parameter Label" "raP-5_20" "n/a" "%" "Report" "Area01" "raP_Tec_ParRpt" Report Label" "raP-5_20" "n/a" "%" 269 Appendix C Tag Extended Properties and Default Alarm Settings Notes: 270 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix D HMI Navigation Tag Naming Conventions Instruction PAH Navigation / References — Nav to HART Device PAI Nav to EH Objects Nav to FF/PA Objects PAID PAIM PAO PBL PDBC PDI PDO PDOSE PFO PHLS — — Nav to HART Device Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 — — — Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive — — — The following table describes the tag naming conventions and syntax to follow when programming to achieve navigation among HMI Faceplate objects. Instruction Tag Reference/ Navigation Syntax Navigation / Reference Tag Name Syntax Navigation / Reference Tag Name Example — — If PAI Tag Name = XT100 PAH : _Dvc PAH tag name = XT100_Dvc If PAI tag name = XT100 raP_Dvc_EH_Flowmeter/Sensor: _Dvc EH Object tag name = XT100_Dvc raP_Dvc_AP_FFLink/PALink: _Dvc If PAI tag name = XT100 raP_Dvc_EN2FFR/EN2PAR: _Dvc FF/PA Object tag name = XT100_Dvc — — — — If PAO Tag Name = XC100 PAH : _Dvc PAH tag name = XC100_Dvc PINTLK : _Intlk_0 PINTLK Bank0 tag name = XC100_Intlk_0 : _Intlk_1 PINTLK Bank0 tag name = XC100_Intlk_1 : _Intlk_2 PINTLK Bank0 tag name = XC100_Intlk_2 : _Intlk_3 PINTLK Bank0 tag name = XC100_Intlk_3 : _Intlk_4 PINTLK Bank0 tag name = XC100_Intlk_4 : _Intlk_5 PINTLK Bank0 tag name = XC100_Intlk_5 : _Intlk_6 PINTLK Bank0 tag name = XC100_Intlk_6 : _Intlk_7 PINTLK Bank0 tag name = XC100_Intlk_7 — — — — — — If PDO Tag Name = XY100 PINTLK : _Intlk_0 PINTLK Bank0 tag name = XY100_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = XY100_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = XY100_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = XY100_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = XY100_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = XY100_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = XY100_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = XY100_Intlk_7 PPERM : _Perm PPERM tag name = XY100_Perm — — — — — — Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 271 Appendix D Instruction PLLS PINTLK PMTR PPERM PPID PPTC PRI PRT PTST 272 HMI Navigation Navigation / References PLLS Ref_Tag(InOut) Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive PINTLK (InOut)_Intlk_BankSts Device Reference Control Set Device Reference Control Commands Device Reference Control Commands Status Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive 1 Nav to Permissive 2 Nav to RunTime Nav to Restart Inhibit Nav to Device Object — Instruction Tag Reference/ Navigation Syntax Navigation / Reference Tag Name Syntax Navigation / Reference Tag Name Example If PLLS Tag Name = GRPMTR100 PLLS Ref_Motors (InOut) : _Motors PLLS Ref_Motors (InOut) = GRPMTR100_Motors PINTLK : _Intlk_0 PINTLK Bank0 tag name = GRPMTR100_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = GRPMTR100_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = GRPMTR100_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = GRPMTR100_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = GRPMTR100_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = GRPMTR100_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = GRPMTR100_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = GRPMTR100_Intlk_7 PPERM : _Perm PPERM tag name = GRPMTR100_Perm If PDO Tag Name = XY100 PINTLK Ref_IntlkBankSts (InOut) : _Intlk_BankSts PINTLK (InOut) - XY100_Intlk_BankSts If PMTR = MT321 PMTR Ref_Ctrl_Set (InOut) : _CtrlSet PMTR Ref_Ctrl_Set (InOut) = MT321_CtrlSet PMTR Ref_Ctrl_Cmd (InOut) : _CtrlCmd PMTR Ref_Ctrl_Cmd (InOut) = MT321_CtrlCmd PMTR Ref_Ctrl_Sts (InOut) : _CtrlSts PMTR Ref_Ctrl_Sts (InOut) = MT321_CtrlSts PINTLK : _Intlk_0 : _Intlk_1 : _Intlk_2 : _Intlk_3 : _Intlk_4 : _Intlk_5 : _Intlk_6 : _Intlk_7 PPERM : _1Perm PPERM : _2Perm PRT : _RunTime PRI : _ResInh Device Object : _Dvc — PINTLK Bank0 tag name = MT321_Intlk_0 PINTLK Bank1 tag name = MT321_Intlk_1 PINTLK Bank2 tag name = MT321_Intlk_2 PINTLK Bank3 tag name = MT321_Intlk_3 PINTLK Bank4 tag name = MT321_Intlk_4 PINTLK Bank5 tag name = MT321_Intlk_5 PINTLK Bank6 tag name = MT321_Intlk_6 PINTLK Bank7 tag name = MT321_Intlk_7 PPERM 1 tag name = MT321_1Perm PPERM 2 tag name = MT321_2Perm PRT tag name = MT321_RunTime PRI tag name = MT321_ResInh Device Object tag name = MT321_Dvc — If PPID Tag Name = XIC700: PINTLK Bank0 tag name = XIC700_Intlk_0 PINTLK Bank1 tag name = XIC700_Intlk_1 PINTLK Bank2 tag name = XIC700_Intlk_2 PINTLK Bank3 tag name = XIC700_Intlk_3 PINTLK Bank4 tag name = XIC700_Intlk_4 PINTLK Bank5 tag name = XIC700_Intlk_5 PINTLK Bank6 tag name = XIC700_Intlk_6 PINTLK Bank7 tag name = XIC700_Intlk_7 — — — If PTST Tag Name = QI102 PTST Cfg_CalTable (InOut) tag name = QI102_CalTable Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 — — — PINTLK : _Intlk_0 : _Intlk_1 : _Intlk_2 : _Intlk_3 : _Intlk_4 : _Intlk_5 : _Intlk_6 : _Intlk_7 — — — Calibration Table Reference PTST Cfg_CalTbl (InOut) : _CalTable Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix D Instruction PVLV PVLVS PVSD PNPOS Navigation / References Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive 1 (Motorized Valve) Nav to Permissive 2 (Solenoid and Motorized Valve) Nav to Valve Statistics — Device Reference Control Set Device Reference Control Commands Device Reference Control Commands Status Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Forward Permissive Nav to Reverse Permissive Nav to RunTime Nav to Restart Inhibit Nav to Device Object Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive HMI Navigation Instruction Tag Reference/ Navigation Syntax Navigation / Reference Tag Name Syntax Navigation / Reference Tag Name Example If PVLV : XV110 PINTLK : _Intlk_0 PINTLK Bank0 tag name = XV110_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = XV110_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = XV110_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = XV110_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = XV110_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = XV110_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = XV110_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = XV110_Intlk_7 PPERM : _Pos1Perm (Motorized Valve) PPERM 1 tag name = XV110_Pos1Perm (Motorized Valve) PPERM : _Pos2Perm (Solenoid and Motorized PPERM 2 tag name = XV110_Pos2Perm (Solenoid and Motorized Valve) Valve) PVLVS : _ValveStats PVLVS tag name = XV110_ValveStats — — If PVSD : MT390 PVSD Ref_Ctrl_Set (InOut) : _CtrlSet PVSD Ref_Ctrl_Set (InOut) = MT390_CtrlSet PVSD Ref_Ctrl_Cmd (InOut) : _CtrlCmd PVSD Ref_Ctrl_Cmd (InOut) = MT390_CtrlCmd PVSD Ref_Ctrl_Sts (InOut) : _CtrlSts PVSD Ref_Ctrl_Sts (InOut) = MT390_CtrlSts PINTLK : _Intlk_0 : _Intlk_1 : _Intlk_2 : _Intlk_3 : _Intlk_4 : _Intlk_5 : _Intlk_6 : _Intlk_7 PPERM : _FwdPerm PPERM : _RevPerm PRT : _RunTime PRI : _ResInh Device Object : _Dvc PINTLK Bank0 tag name = MT390_Intlk_0 PINTLK Bank1 tag name = MT390_Intlk_1 PINTLK Bank2 tag name = MT390_Intlk_2 PINTLK Bank3 tag name = MT390_Intlk_3 PINTLK Bank4 tag name = MT390_Intlk_4 PINTLK Bank5 tag name = MT390_Intlk_5 PINTLK Bank6 tag name = MT390_Intlk_6 PINTLK Bank7 tag name = MT390_Intlk_7 PPERM Forward tag name = MT390_FwdPerm PPERM Reverse tag name = MT390_RevPerm PRT tag name = MT390_RunTime PRI tag name = MT390_ResInh Device Object tag name = MT390_Dvc If PNPOS Tag Name = NPO100 PINTLK Bank0 tag name = NPO100_Intlk_0 PINTLK Bank1 tag name = NPO100_Intlk_1 PINTLK Bank2 tag name = NPO100_Intlk_2 PINTLK Bank3 tag name = NPO100_Intlk_3 PINTLK Bank4 tag name = NPO100_Intlk_4 PINTLK Bank5 tag name = NPO100_Intlk_5 PINTLK Bank6 tag name = NPO100_Intlk_6 PINTLK Bank7 tag name = NPO100_Intlk_7 PPERM tag name = NPO100_Perm PINTLK : _Intlk_0 : _Intlk_1 : _Intlk_2 : _Intlk_3 : _Intlk_4 : _Intlk_5 : _Intlk_6 : _Intlk_7 PPERM : _Perm Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 273 Appendix D Instruction PVLVMP 274 HMI Navigation Navigation / References Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Open Interlock Bank 0 Nav to Open Interlock Bank 1 Nav to Open Interlock Bank 2 Nav to Open Interlock Bank 3 Nav to Open Interlock Bank 4 Nav to Open Interlock Bank 5 Nav to Open Interlock Bank 6 Nav to Open Interlock Bank 7 Nav to Upper Seat Interlock Bank 0 Nav to Upper Seat Interlock Bank 1 Nav to Upper Seat Interlock Bank 2 Nav to Upper Seat Interlock Bank 3 Nav to Upper Seat Interlock Bank 4 Nav to Upper Seat Interlock Bank 5 Nav to Upper Seat Interlock Bank 6 Nav to Upper Seat Interlock Bank 7 Nav to Lower Seat Interlock Bank 0 Nav to Lower Seat Interlock Bank 1 Nav to Lower Seat Interlock Bank 2 Nav to Lower Seat Interlock Bank 3 Nav to Lower Seat Interlock Bank 4 Nav to Lower Seat Interlock Bank 5 Nav to Lower Seat Interlock Bank 6 Nav to Lower Seat Interlock Bank 7 Nav to Cavity Interlock Bank 0 Nav to Cavity Interlock Bank 1 Nav to Cavity Interlock Bank 2 Nav to Cavity Interlock Bank 3 Nav to Cavity Interlock Bank 4 Nav to Cavity Interlock Bank 5 Nav to Cavity Interlock Bank 6 Nav to Cavity Interlock Bank 7 Nav to Valve Statistics Instruction Tag Reference/ Navigation Syntax Navigation / Reference Tag Name Syntax Navigation / Reference Tag Name Example If PVLVMP = XV120 PINTLK : _Intlk_0 PINTLK Bank0 tag name = XV120_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = XV120_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = XV120_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = XV120_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = XV120_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = XV120_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = XV120_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = XV120_Intlk_7 PINTLK : _OpenIntlk_0 PINTLK Bank0 tag name = XV120_OpenIntlk_0 : _OpenIntlk_1 PINTLK Bank1 tag name = XV120_OpenIntlk_1 : _OpenIntlk_2 PINTLK Bank2 tag name = XV120_OpenIntlk_2 : _OpenIntlk_3 PINTLK Bank3 tag name = XV120_OpenIntlk_3 : _OpenIntlk_4 PINTLK Bank4 tag name = XV120_OpenIntlk_4 : _OpenIntlk_5 PINTLK Bank5 tag name = XV120_OpenIntlk_5 : _OpenIntlk_6 PINTLK Bank6 tag name = XV120_OpenIntlk_6 : _OpenIntlk_7 PINTLK Bank7 tag name = XV120_OpenIntlk_7 PINTLK : _UpperIntlk_0 PINTLK Bank0 tag name = XV120_UpperIntlk_0 : _UpperIntlk_1 PINTLK Bank1 tag name = XV120_UpperIntlk_1 : _UpperIntlk_2 PINTLK Bank2 tag name = XV120_UpperIntlk_2 : _UpperIntlk_3 PINTLK Bank3 tag name = XV120_UpperIntlk_3 : _UpperIntlk_4 PINTLK Bank4 tag name = XV120_UpperIntlk_4 : _UpperIntlk_5 PINTLK Bank5 tag name = XV120_UpperIntlk_5 : _UpperIntlk_6 PINTLK Bank6 tag name = XV120_UpperIntlk_6 : _UpperIntlk_7 PINTLK Bank7 tag name = XV120_UpperIntlk_7 PINTLK : _LowerIntlk_0 PINTLK Bank0 tag name = XV120_LowerIntlk_0 : _LowerIntlk_1 PINTLK Bank1 tag name = XV120_LowerIntlk_1 : _LowerIntlk_2 PINTLK Bank2 tag name = XV120_LowerIntlk_2 : _LowerIntlk_3 PINTLK Bank3 tag name = XV120_LowerIntlk_3 : _LowerIntlk_4 PINTLK Bank4 tag name = XV120_LowerIntlk_4 : _LowerIntlk_5 PINTLK Bank5 tag name = XV120_LowerIntlk_5 : _LowerIntlk_6 PINTLK Bank6 tag name = XV120_LowerIntlk_6 : _LowerIntlk_7 PINTLK Bank7 tag name = XV120_LowerIntlk_7 PINTLK : _CavityIntlk_0 PINTLK Bank0 tag name = XV120_CavityIntlk_0 : _CavityIntlk_1 PINTLK Bank1 tag name = XV120_CavityIntlk_1 : _CavityIntlk_2 PINTLK Bank2 tag name = XV120_CavityIntlk_2 : _CavityIntlk_3 PINTLK Bank3 tag name = XV120_CavityIntlk_3 : _CavityIntlk_4 PINTLK Bank4 tag name = XV120_CavityIntlk_4 : _CavityIntlk_5 PINTLK Bank5 tag name = XV120_CavityIntlk_5 : _CavityIntlk_6 PINTLK Bank6 tag name = XV120_CavityIntlk_6 : _CavityIntlk_7 PINTLK Bank7 tag name = XV120_CavityIntlk_7 PVLVMP : _ValveStats PVLVS tag name = XV120_ValveStats Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix D Instruction PD4SD raP_Opr_Area raP_Opr_EMGen Navigation / References Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive 0 Nav to Permissive 1 Nav to Permissive 2 Nav to Permissive 3 Nav to Valve Statistics Nav to Extended Alarms Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive Nav to Extended Alarms Nav Parameters Nav Reports raP_Opr_EPGen Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive Nav to Extended Alarms Nav Parameters Nav Reports raP_Opr_ExtddAlm Extended Alarms HMI Navigation Instruction Tag Reference/ Navigation Syntax Navigation / Reference Tag Name Syntax Navigation / Reference Tag Name Example If PD4SD : D4SD100 PINTLK : _Intlk_0 PINTLK Bank0 tag name = D4SD100_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = D4SD100_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = D4SD100_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = D4SD100_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = D4SD100_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = D4SD100_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = D4SD100_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = D4SD100_Intlk_7 PPERM : _0Perm PPERM 0 tag name = D4SD100_Perm PPERM : _1Perm PPERM 1 tag name = D4SD100_Perm PPERM : _2Perm PPERM 2 tag name = D4SD100_Perm PPERM : _3Perm PPERM 3 tag name = D4SD100_Perm PD4SD : _ValveStats PVLVS tag name : D4SD100_ValveStats If raP_Opr_Area = Area01 raP_Opr_ExtddAlm: _ExtddAlm_00 ... raP_Opr_ExtddAlm: Area01_ExtddAlm_00 ... _ExtddAlm_32 _ExtddAlm_32 If raP_Opr_EMGen Tag Name = eTK101 PINTLK : _Intlk_0 PINTLK Bank0 tag name = eTK101_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = eTK101_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = eTK101_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = eTK101_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = eTK101_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = eTK101_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = eTK101_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = eTK101_Intlk_7 PPERM : _Perm PPERM tag name = eTK101_Perm raP_Opr_ExtddAlm: _ExtddAlm_00 ... raP_Opr_ExtddAlm tag name = eTK101_ExtddAlm_00 ... _ExtddAlm_32 _ExtddAlm_32 raP_Tec_ParRpt: _PAR_00 ... _PAR_496 raP_Tec_ParRpt tag name = eTK101_PAR_00 ... _PAR_496 raP_Tec_ParRpt: _RPT_00 ... _RPT_496 raP_Tec_ParRpt tag name = eTK101_RPT_00 ... _RPT_496 If raP_Opr_EPGen Tag Name = epAG1001 PINTLK : _Intlk_0 PINTLK Bank0 tag name = epAG1001_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = epAG1001_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = epAG1001_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = epAG1001_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = epAG1001_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = epAG1001_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = epAG1001_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = epAG1001_Intlk_7 PPERM : _Perm PPERM tag name = eTK101_Perm raP_Opr_ExtddAlm: _ExtddAlm_00 ... raP_Opr_ExtddAlm tag name = epAG1001_ExtddAlm_00 ... _ExtddAlm_32 _ExtddAlm_32 raP_Tec_ParRpt: _PAR_00 ... _PAR_496 raP_Tec_ParRpt tag name = epAG1001_PAR_00 ... _PAR_496 raP_Tec_ParRpt: _RPT_00 ... _RPT_496 raP_Tec_ParRpt tag name = epAG1001_RPT_00 ... _RPT_496 — — Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 275 Appendix D HMI Navigation Instruction Navigation / References raP_Opr_Unit Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive Nav to Extended Alarms raP_Tec_ParRpt Nav Parameters Nav Reports Parameters and Reports raP_Opr_Prompt Prompt Instance Configuration Data raP_Opr_Seq 276 Reference Sequencer Step Nav to Interlock Bank 0 Nav to Interlock Bank 1 Nav to Interlock Bank 2 Nav to Interlock Bank 3 Nav to Interlock Bank 4 Nav to Interlock Bank 5 Nav to Interlock Bank 6 Nav to Interlock Bank 7 Nav to Permissive Nav to Boolean Input Reference Boolean Input Sequencer Step Nav to Boolean Output Reference Boolean Output Sequencer Step Nav to Real Output Reference Real Output Sequencer Step Nav to Prompt Core Reference Prompt Core Prompt Instance Configuration Data Reference Prompt Core Prompt Response Data Instruction Tag Reference/ Navigation Syntax Navigation / Reference Tag Name Syntax Navigation / Reference Tag Name Example If raP_Opr_Unit Tag Name = GroupControl PINTLK : _Intlk_0 PINTLK Bank0 tag name = GroupControl_Intlk_0 : _Intlk_1 PINTLK Bank1 tag name = GroupControl_Intlk_1 : _Intlk_2 PINTLK Bank2 tag name = GroupControl_Intlk_2 : _Intlk_3 PINTLK Bank3 tag name = GroupControl_Intlk_3 : _Intlk_4 PINTLK Bank4 tag name = GroupControl_Intlk_4 : _Intlk_5 PINTLK Bank5 tag name = GroupControl_Intlk_5 : _Intlk_6 PINTLK Bank6 tag name = GroupControl_Intlk_6 : _Intlk_7 PINTLK Bank7 tag name = GroupControl_Intlk_7 PPERM : _Perm PPERM tag name = GroupControl_Perm PPERM : 1_Perm PPERM tag name = GroupControl_1Perm PPERM : 2_Perm PPERM tag name = GroupControl_2Perm PPERM : 3_Perm PPERM tag name = GroupControl_3Perm PPERM : 4_Perm PPERM tag name = GroupControl_4Perm raP_Opr_ExtddAlm: _ExtddAlm_00 ... raP_Opr_ExtddAlm tag name = GroupControl_ExtddAlm_00 ... _ExtddAlm_32 _ExtddAlm_32 raP_Tec_ParRpt: _PAR_00 ... _PAR_496 raP_Tec_ParRpt tag name = epAG1001_PAR_00 ... _PAR_496 raP_Tec_ParRpt: _RPT_00 ... _RPT_496 raP_Tec_ParRpt tag name = epAG1001_RPT_00 ... _RPT_496 — — If raP_Opr_Prompt Tag Name = MyPrompt raP_Opr_Prompt Prompts (InOut) : _Prompts raP_Opr_Prompt Prompts (InOut) Tagname = MyPrompt _Prompts raP_Opr_Prompt RespData (InOut) : _ResponseData raP_Opr_Prompt RespData (InOut) Tagname = MyPrompt_ResponseData raP_Opr_Seq Ref_Steps (InOut) : _Steps PINTLK : _Intlk_0 : _Intlk_1 : _Intlk_2 : _Intlk_3 : _Intlk_4 : _Intlk_5 : _Intlk_6 : _Intlk_7 PPERM : _Perm raP_Opr_SeqBoolInp : _BoolInp If raP_Opr_Seq : Seq_101 raP_Opr_Seq Ref_Steps (InOut) : Seq_101_Steps PINTLK Bank0 Tagname = Seq_101_Intlk_0 PINTLK Bank1 Tagname = Seq_101_Intlk_1 PINTLK Bank2 Tagname = Seq_101_Intlk_2 PINTLK Bank3 Tagname = Seq_101_Intlk_3 PINTLK Bank4 Tagname = Seq_101_Intlk_4 PINTLK Bank5 Tagname = Seq_101_Intlk_5 PINTLK Bank6 Tagname = Seq_101_Intlk_6 PINTLK Bank7 Tagname = Seq_101_Intlk_7 PPERM Tagname = Seq_101_Perm raP_Opr_SeqBoolInp Tagname = Seq_101_BoolInp raP_Opr_SeqBoolInp Ref_Steps (InOut) : _Steps raP_Opr_SeqBoolInp Ref_Steps (InOut) Tagname = Seq_101_Steps raP_Opr_SeqBoolOut : _BoolOut raP_Opr_SeqBoolOut Tagname = Seq_101_BoolOut raP_Opr_SeqBoolOut Ref_Steps (InOut) : _Steps raP_Opr_SeqBoolOut Ref_Steps (InOut) Tagname = Seq_101_Steps raP_Opr_SeqRealOut : _RealOut raP_Opr_SeqRealOut Ref_Steps (InOut) : _Steps raP_Opr_Prompt_Core : _Prompt raP_Opr_Prompt_Core Prompts (InOut) : _Prompts raP_Opr_Prompt_Core RespData (InOut) : _ResponseData raP_Opr_SeqRealOut Tagname = Seq_101_RealOut raP_Opr_SeqRealOut Ref_Steps (InOut) Tagname = Seq_101_Steps raP_Opr_Prompt_Core Tagname = Seq_101_Prompt raP_Opr_Prompt_Core Prompts (InOut) Tagname = Seq_101_Prompts raP_Opr_Prompt_Core RespData (InOut) Tagname = Seq_101_ResponseData Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example This appendix describes how to configure a HART device using a newer HART I/O module, such as the 5094-IF8IH, and the PAH instruction, in a PlantPAx® 5.0 system. This example requires a system that meets PlantPAx 5.0 system requirements, including using Version 33 or later of Studio 5000 Logix Designer® software. Download and install the 5094 HART Analog Add-On Profile The Add-on Profile can be accessed from the Product Compatibility and Download Center. 1. Search for “5094-HART”. 2. Select Download. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 277 Appendix E 5094-IF8IH to PAH Configuration Example 3. Select Files, then select the Add-on Profiles, EDS Files, and Firmware. 4. Select Download Now. The files are downloaded into a zip file using the download manager. 5. Extract the files from the ZIP folder. 6. Run mpsetup.exe as Administrator. 278 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E Add the 5094 Adapter Module to the Project I/O Configuration 1. 5094-IF8IH to PAH Configuration Example In the controller Organizer for your project, select the Ethernet network to be used to communicate with the 5094 I/O. Right-click and select “New Module...” 2. Select the catalog number of the 5094 adapter that you are using and Create. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 279 Appendix E 5094-IF8IH to PAH Configuration Example 3. Enter the name and IP address for the adapter. Add the 5094-IF8IH Module to the Project I/O Configuration 280 1. In the controller Organizer for your project, select the 5094 Backplane. Right-click and select "New Module..." Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example 2. Select the 5094-IF8IH module and “Create”. 3. To accept the module defaults, Select OK. Add the HART Device to the Project I/O Configuration 1. In the controller Organizer for your project, select the HART network. Right-click and select “New Module...”. 2. Select the type of HART transmitter and “Create”. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 281 Appendix E 5094-IF8IH to PAH Configuration Example In this example, we are using an Endress+Hauser Deltabar-S device. 3. In the New Module dialog box, enter a name for the transmitter then select Change in the Module Definition section. 282 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example 4. Change the Connection type to PlantPAx Data. 5. Changing the connection type causes a change in data types for the input and output data. Select Yes to change the module definition. 6. Verify the information and Select OK. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 283 Appendix E 5094-IF8IH to PAH Configuration Example Configure the Analog Input Channel 1. In the controller Organizer for your project, select the 5094-IF8IH module created. Doubleclick to open the Properties dialog. 2. Select the channel where the transmitter is connected. In this example, it is Channel 00. Select the box to Enable HART communication on this channel. 284 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example Add the PAH (Process In this example, we are using a Function Block routine. Ladder Diagram or Structured Text could be used. Analog HART) and PAI (Process Analog Input) Instruction Instances to the Add the PAH Instruction Instance Project 1. Right-click a blank area on the sheet and select “Add Element...”. 2. Enter PAH for the FBD Element. 3. Enter the desired tag name of the backing tag for the PAH block. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 285 Appendix E 5094-IF8IH to PAH Configuration Example 4. Right-click the new tag name and select “New <tagname>”. 5. In the New Tag dialog, enter a tag description. The required data type is automatically selected for you. The tag can be created at Controller scope, or in the Program containing this routine. For this example, we use a Controller-scope tag. 286 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example Connect PAX_HART_DEVICE:I:0 Member from Input Assembly to Ref_HARTData InOut Parameter. 1. Select the dropdown for the Ref_HARTData InOut Parameter. 2. Navigate to the input assembly tag for the HART device, expand, and select the “PAxDevice” member. The data type must be “PAX_HART_DEVICE:I:0”. Add the PAI Instruction Instance 1. Right-click a blank area of the Function Block routine sheet and select “Add Element...”. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 287 Appendix E 5094-IF8IH to PAH Configuration Example 2. Enter PAI for the FBD Element. 3. Enter the desired tag name of the backing tag for the PAI block. In this example, we used “PI1433” (for Pressure Indicator). 4. Right-click the new tag name and select “New <tagname>”. 288 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example 5. In the New Tag dialog, enter a tag description. The required data type is automatically selected for you. The tag can be created at Controller scope, or in the Program containing this routine. For this example, we use a Controller-scope tag. For HMI navigation to work properly, the PAH and PAI instance tags must be at the same scope. The tag is created and the routine contains no errors. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 289 Appendix E 5094-IF8IH to PAH Configuration Example Connect the PAH Instance to the PAI Instance 1. Select the properties of the PAH instruction. 2. Select the Parameters tab. 290 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example 3. Select the boxes in the “Vis” column to make the Raw and EU scaling Values visible as output pins. 4. From the Parameters tab of the PAI instruction properties, Select the boxes in the “Vis” column to make the Raw and EU configuration input pins visible. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 291 Appendix E 5094-IF8IH to PAH Configuration Example 5. Wire the analog input signal to the PAI block. 6. Wire the HART scaling data from the PAH block to the PAI block. 292 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix E 5094-IF8IH to PAH Configuration Example 7. From the PAI Properties, navigate to the HMI>Navigation tab. Link the PAI Input PV navigation to the PAH instance. 8. On the PAH instance, link the HART Diagnostic Lookup Table for the pressure transmitter InOut parameter. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 293 Appendix E 5094-IF8IH to PAH Configuration Example 9. Link the HART engineering units lookup table to the units InOut parameter. 294 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example This appendix shows an example of using a 1756-IF8IH (using I_1756IF8IH 4.10) with the raP_Tec_HARTChanData_to_PAH Add-On Instruction from the 5.00 or later Library download to feed PAH and PAI instructions (5.00 or later system on L85EP). Add the 1756-IF8IH Module to the Project I/O Configuration 1. In the controller Organizer for your project, select the 1756 Backplane. Right-click and select “New Module...”. 2. Select 1756-IF8IH. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 295 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 3. Enter a name for the module, Select the slot number where the module is installed, and select Change in the Module Definition. 4. In the Module Definition dialog, change the Input Data selection to “Analog and HART by Channel”. 296 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 5. Select YES to change the module definition. Configure the Channel for the HART Device 1. From the New Module dialog box, Select the configuration tab. 2. Select the Channel where the transmitter is installed and Enable HART on the channel. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 297 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example Import the raP_Tec_HARTChanData_to _PAH Add-On Instruction 1. In the Controller Organizer, expand “Assets” to show the “Add-On Instructions” folder. 2. Right-click the Add-On Instructions folder and select “Import Add-On Instruction...”. 3. Navigate to the location where you downloaded the Library of Process Objects version 5.x. 4. Navigate to the Logix Add-On Instructions. Select the “raP_Tec_HARTChanData_to_PAH” Add-On Instruction import L5X file. 298 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 5. Select OK in the Import Configuration dialog box to accept the default values. Import the I_1756IF8IH Rung into the Project 1. Open a Ladder Diagram routine in your project. 2. Click in the left margin where you want to insert the rung for the 1756-IF8IH module. Rightclick and select “Import Rungs...”. 3. Navigate to the location where you downloaded the Library of Process Objects version 4.10.xx. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 299 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 4. Navigate to the Logix Add-On Instructions. Select the I_1756IF8IH_4.10.00_RUNG.L5X file. 5. In the Import Configuration window, select the “Tags” item in the “Import Content” tree on the left. Note the names of tags in the import file. Select “Find/Replace...”. 6. Change the base that you want to use for the tag names. - In the “Find What” box, enter “R02_S04”, which is the base name for the tags in the import file. 300 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example - In the “Replace With” box, enter the base that you want to use for tag names for this rung. Since we created the module in local chassis slot 2, for this example we use “LOC_S02”. - Select “Replace All” 7. Use the same process to replace the text “Rack02:4” in the import with “Local:2”, for the tag names assigned to the module I/O data. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 301 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example The Final Name column shows the tags to be created or used. 8. Select the Other Components item in the Import Contents tree. 9. Change the Final Name items to align with the Rack name and the Module name you gave the 1756-IF8IH module when you created it. Select OK to import the rung. 302 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 10. Two rungs are imported. On the first rung, change the Rung Comment to reflect the location of the module created. Note the tag of the Ref_ChanData InOut parameter in the second rung. This tag name is used in the following steps. Add the raP_Tec_HARTChanData_to _PAH Instance to the Project 1. Add a rung after the I_1756IF8IH rung. On that rung, place an instance of the raP_Tec_HARTChanData_to_PAH instruction. 2. The first operand is the backing tag for the instruction. Enter a suitable name. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 303 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 3. Right-click and select “New (tag name)”. 4. Enter a description and select the tag scope. The tag Data Type is set for you automatically. 5. The second operand is a HART Channel Data member from the I_1756IF8IH instruction. The I_1756IF8IH instruction creates an array of 8 channels' data. Previously we configured Channel 0 on the 1756-IF8IH for this device. 304 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example Select element [0] of that array for this operand. 6. The third operand is a tag that you create that is the same data type as used by newer HART I/O modules, such as the 5094-IF8IH. This tag contains the HART data coming out of the raP_Tec_HARTChandData_to_PAH instruction and going to the PAH instruction. Enter a suitable tag name, then right-click and select “New (tag name)”. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 305 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example 7. Enter a description and select the tag scope. The tag Data Type is set for you automatically. 306 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 Appendix F Add the PAH and PAI Instances to the Project and Connect PAH and PAI Instances 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example Continue as in the example documented in Appendix E, Add the PAH (Process Analog HART) and PAI (Process Analog Input) Instruction Instances to the Project, creating the PAH and PAI instances and linking them together. The "Ref_HARTData" operand on the PAH instruction is the tag that you just created above, PT1533_PAX_HART_DEVICE. The analog input to the PAI instruction comes from the input data value from Channel 0 of the 1756-IF8IH, which is in the Local chassis, slot 2. In this example, the tag is Local:2:I.Ch0.Data. The following diagram shows the final configuration for this example. Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 307 Appendix F 1756-IF8IH with raP_Tec_HARTChanData_to_PAH Add-On Instruction Configuration Example Notes: 308 Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 PlantPAx Display and Library Guidelines Reference Manual Rockwell Automation Publication PROCES-RM200G-EN-P - June 2024 309 Rockwell Automation Support Use these resources to access support information. Technical Support Center Local Technical Support Phone Numbers Technical Documentation Center Literature Library Product Compatibility and Download Center (PCDC) Find help with how-to videos, FAQs, chat, user forums, Knowledgebase, and product rok.auto/support notification updates. Locate the telephone number for your country. rok.auto/phonesupport Quickly access and download technical specifications, installation instructions, and user rok.auto/techdocs manuals. Find installation instructions, manuals, brochures, and technical data publications. rok.auto/literature Download firmware, associated files (such as AOP, EDS, and DTM), and access product release rok.auto/pcdc notes. 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 compliance information on its website at rok.auto/pec. Allen-Bradley, ArmorStart, CompactLogix, ControlLogix, FactoryTalk, iTRAK, Kinetix, MagneMotion, PhaseManager, PlantPAx, PowerFlex, Rockwell Automation, RSLogix, RSLogix 5000, SoftLogix, Stratix, Studio 5000, Studio 5000 Logix Designer, Studio 5000 View Designer, and TechConnect are trademarks of Rockwell Automation, Inc. Excel is a trademark of Microsoft. EtherNet/IP is a trademark of ODVA, Inc. 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-RM200G-EN-P - June 2024 Supersedes Publication PROCES-RM200F-EN-P - January 2024 Copyright © 2024 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A. ">

Public link updated
The public link to your chat has been updated.
Advertisement
Key features
- Process Object Library
- Graphic Framework
- Multi-Monitor Support
- Alarm and Diagnostic Management
- Language Switching
- Studio 5000 Integration
- FactoryTalk View SE Integration
Frequently asked questions
Refer to the "Download Firmware, AOP, EDS, and Other Files" section of the viewed document for instructions on how to access and download the necessary files.
The viewed document mentions L1, L2, and L3 display levels, offering different levels of detail for navigation and visualization of process data.
The Graphic Framework is a key component of the PlantPAx Display and Library. It involves specific objects like "APP - Administrative Objects", "APP - Alarm Objects", and "APP - Diagnostic Objects", used for building HMIs.
The "Build Your PlantPAx HMI Application" section in the viewed document provides a comprehensive guide on using the PlantPAx Display and Library to create your HMI applications.
As described in the viewed document, this tool helps migrate existing PlantPAx Process Library projects to new versions.
The "Create HMI Tags for Multi-Monitor" section of the viewed document explains the steps involved in configuring tags for multi-monitor applications.
The viewed document lists various macros, including "Template_ClientStartup", "Template_Repaint", and "SetRepaint", which provide functions for managing client startup, repainting, and more.
The viewed document details the process of creating the Organizational Tree and setting up the PlantPAx Organizational View on the HMI client.
The "Organizational Scan" ("raP_Opr_OrgScan"), "Organizational View" ("raP_Opr_OrgView"), and other functionalities are key elements involved in building the PlantPAx Organizational View.
The "Ownership" element provides a mechanism for managing ownership of specific control actions within the system, as explained in the viewed document.
The "Arbitration" element plays a role in resolving conflicts when multiple clients attempt to control a particular function, as detailed in the viewed document.
The viewed document outlines the specific files and configuration steps involved in setting up the "Process Area Module".
Refer to the "Process Unit" section in the viewed document for detailed instructions on configuring this element within the PlantPAx system.