Rockwell Automation Library of Process Objects:
Configuration and Usage
Version 4.0 or Later
IMPORTANTThis manual applies to the Rockwell Automation Library of Process Objects version 4.0.
For Rockwell Automation Library of Process Objects version 5.0, see PROCES-RM200.
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.
IMPORTANTIdentifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to
potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL
Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).
Rockwell Automation Publication PROCES-RM002I-EN-P - May 20195
Table of Contents
Notes:
6Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Preface
IMPORTANT
This manual describes how to build and use library components that comprise
the Rockwell Automation® Library of Process Objects.
Procedures include how to customize HMI templates based on your system
requirements. Step-by-step instructions guide you through how to apply and
maintain HMI security depending on the responsibilities of plant personnel.
The appendix features associated productivity tools, such as the PlantPAx
Configuration Tool for creating HMI alarms.
We recommend that you use this manual along with two additional references:
• PROCES-RM013
• PROCES-RM014
— Describes the logic per Library object
— Describes the display elements per Library object
New and Updated
Information
This table contains the changes that are made to this revision.
Top icPag e
Build HMI template and configure security25
Process Library security tag descriptions193
Process Library Security Information tags are attached to this PDF as a
Microsoft Excel file. To access the Excel spreadsheet, click the paper clip icon in
the left pane of the PDF. Procedures are documented on page 193
.
Rockwell Automation Publication PROCES-RM002I-EN-P - January 20197
Preface
Additional Resources
These documents contain additional information concerning related products
from Rockwell Automation.
Figure 1 - Additional Resources for Related Library Information
FactoryTalk View Machine Edition User Guide,
publication VIEWME-UM004
FactoryTalk Alarms and Events System Configuration Guide,
publication FTAE-RM001
PlantPAx® Distributed Control System Selection Guide,
publication PROCES-SG001
PlantPAx Distributed Control System Reference Manual,
publication PROCES-RM001
PlantPAx Distributed Control System Infrastructure
Configuration, publication PROCES-UM001
PlantPAx Distributed Control System Application
Configuration, publication PROCES-UM003
Rockwell Automation Library of Process Objects: Logic
Instructions, publication PROCES-RM013
Rockwell Automation Library of Process Objects: HMI
Instructions, publication PROCES-RM014
Provides information for how to define, configure, and
program Add-On Instructions.
Provides details on how to use this software package to
develop and run HMI applications that can involve
multiple users and servers, which are distributed over a
network.
Provides details on how to use this software package for
creating an automation application.
Provides details on how to install, configure, and use
FactoryTalk Alarms and Events services as part of a
FactoryTalk-enabled automation system.
Provides information to assist with equipment
procurement for your PlantPAx system.
Provides characterized recommendations for
implementing your PlantPAx system.
Provides screen facsimiles and step-by-step procedures
to configure infrastructure components for your system
requirements.
Provides the steps necessary to start development of
your PlantPAx Distributed Control System.
Provides descriptions of the Add-On Instructions in the
Library and their parameters and local tags.
Provides descriptions of the HMI visualization files for
all Add-On Instructions.
You can view or download publications at
http://www.rockwellautomation.com/literature/
. To order paper copies of
technical documentation, contact your local Allen-Bradley® distributor or
Rockwell Automation sales representative.
8Rockwell Automation Publication PROCES-RM002I-EN-P - January 2019
Chapter 1
How to Install the Library
This chapter describes procedures for installing the HMI and controller
elements that comprise the Rockwell Automation® Library of Process Objects.
There are two methods:
• Use predefined application templates
•Import individual library objects
The following table lists the topics in this chapter.
Top icPa ge
Download the Library9
Using HMI and Controller Templates10
Import Logic into a Project10
Import Visualization Files13
Configure Your HMI Application for Language Switching23
Download the Library
For the latest compatible software information and to download the Rockwell
Automation Library, see the Product Compatibility and Download Center at
Rockwell Automation Publication PROCES-RM002I-EN-P - May 20199
Chapter 1How to Install the Library
Using HMI and Controller
Templates
Import Logic into a Project
Both controller and HMI templates are provided with the Rockwell
Automation Library of Process Objects. These templates provide a starting
point for building your PlantPAx® applications.
– The HMI templates are offered in various screen resolutions
to align with the most commonly used monitors. The templates
have a framework inclusive of a FactoryTalk® Alarms and Events
alarm banner.
See Chapter 2
configuring HMI security.
– The controller templates are provided in supported Logix firmware
revisions. The templates provide a recommended task structure in
preparation to import the Process Library Add-On Instructions and
build the control strategies.
TIPThe template ‘all’ controller applications include all the Add-On Instructions.
The ‘basic’ application includes the most commonly used Add-On Instructions.
An Add-On Instruction is defined once in each controller project, and can be
instantiated multiple times in your application code. To use pre-engineered
logic, import each Add-On Instruction into a controller project.
for procedures on customizing an HMI template and
Complete these steps.
1. In the Studio 5000 Logix Designer® application, open a new or
existing project.
IMPORTANTAdd-On Instruction definitions can be imported, but not
updated, online.
2. Right-click the Add-On Instructions folder in the Controller Organizer
and choose Import Add-On Instruction.
10Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
The Import Add-On Instruction dialog box appears.
3. Select the Add-On Instruction and click Import.
TIPThe P_CmdSrc, P_Alarm, and P_Gate Add-On Instructions are used
within many of the other instructions. We recommend that you import
these three instructions first.
Some Add-On Instructions are provided in RUNG import files.
TIPIf a RUNG import file is provided, import the rung into a ladder
diagram routine to get all required additional tags, data types, and
message configurations.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201911
Chapter 1How to Install the Library
4. On the Import Configuration dialog box, click OK.
5. Once the import is complete, the Add-On Instructions are visible in the
Controller Organizer.
IMPORTANTSee page 70
for procedures on how to change the size of the STRING-Area
string data type after importing the first Add-On Instruction.
12Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
Import Visualization Files
Each Add-On Instruction has associated visualization files that provide a
common user interface. You must import these files in the following order:
• Images (.png files)
• Global objects (.ggfx file type)
• HMI faceplates (.gfx file type)
• Tags (.csv file type)
• Macros (FactoryTalk View SE software only) (.mcr file type)
A global object is an HMI display element that is created once and referenced
multiple times on multiple displays in an application. When changes are made
to the original (base) object, the instantiated copies (reference objects) are
automatically updated. Use of global objects, with tag structures in the
ControlLogix® system, aid in consistency and save time engineering.
The import procedures in this section are to be followed in the sequence as
documented to add the visualization files to your project.
Import Images
Complete these steps to use the common icons for the global objects and
faceplates for all Process objects
.
1. In your FactoryTalk View SE or ME software (depending on which one
you are using), click the ‘+’ to open the Graphics folder.
2. Right-click Images and choose Add Component Into Application.
The Add Component Into Project dialog box appears.
3. Browse to your downloaded Rockwell Automation library files.
4. Click the graphics folder.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201913
Chapter 1How to Install the Library
5. Click the Images folder.
IMPORTANTChange the path to the image folder and the file type
to PNG. PNG files provide more control with color transparency.
6. Click the pull-down menu (as circled) and select a file type.
For example, PNG Images (*.png)
7. To highlight all .png files, press Ctrl-A.
8. Click Open to import the images.
14Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
Import Global Object Files
Global objects serve two purposes:
• Faceplate objects files contain common elements that are used to build
faceplate displays.
• Graphics Library files contain device symbols that you can use to build
your application displays. Click the symbol to open the corresponding
faceplate display.
Complete these steps to import global objects.
1. Right-click Global Objects and choose Add Component Into
Application.
The Add Component Into Project dialog box appears.
2. Browse to your downloaded Rockwell Automation Library files.
3. Click the Graphics folder.
4. Click the FactoryTalk View SE or FactoryTalk View ME folder
depending on your application.
5. Click the Global Objects folder.
6. To highlight all global object (.ggfx) files, press Ctrl-A.
7. Click Open to import the objects.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201915
Chapter 1How to Install the Library
Import HMI Faceplates
Faceplates provide operators, maintenance workers, engineers, and others with
visual components to enable interaction with instrument data. Complete these
steps to import faceplates.
1. Right-click Displays and choose Add Component Into Application.
The Add Component Into Project dialog box appears.
2. Browse to your downloaded Rockwell Automation library files.
3. Click the graphics folder.
4. Click the FactoryTalk View SE or FactoryTalk View ME folders
depending on your application.
5. Click the GFX folder.
6. Click only the displays that you need; do not import all of them.
IMPORTANTTo select multiple display files after the initial file selection, press and
hold the Ctrl key while selecting additional files.
The highlighted example with P_AIn shows that each Add-On
Instruction requires a Faceplate.gfx, Help.gfx, and Quick.gfx. Most
motors, valves, and other devices need displays for Command Source
Configuration and Help and Alarm Configuration and Help.
16Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
See the Rockwell Automation Library of Process Objects: HMI
Instructions, publication PROCES-RM014
for a list of required .gfx
files.
7. For FactoryTalk View SE applications, also import the Common Analog
Edit display.
Import the Macros
These instructions are for FactoryTalk View SE projects only. Macros must be
imported to support faceplate-to-faceplate navigation by tag name.
Complete these steps to import macros.
1. Right-click Macro and select Add Component Into Application.
2. Press Ctrl-A to select all.
3. Click Open.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201917
Chapter 1How to Install the Library
Import HMI Tags
Complete these steps to import HMI tags.
1. From the Tools pull-down menu, choose Tag Import and Export
Wizard.
The Tag Import and Export Wizard dialog box appears.
2. From the Operation pull-down menu, choose Import FactoryTalk View
tag CSV files and click Next.
18Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
The Tag Import and Export Wizard dialog box reappears with a blank
Project text box.
3. From the Project text box, click Browse (…) and select the .med project
file that you want the HMI tags imported into and click Open.
The Tag Import and Export Wizard dialog box reappears with the .med
file in the Project text box.
4. Click Next.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201919
Chapter 1How to Install the Library
The Tag Import and Export Wizard dialog box reappears with a blank
text box.
5. From the Import files text box, click Browse (…) and select the .csv file
that is contained within the downloaded Library zipped file.
6. Click Open.
The Tag Import and Export Wizard dialog box reappears with the
selected .CSV file.
7. Click Next.
20Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
The Tag Import and Export Wizard dialog box reappears.
8. Use the Skip existing (fastest) option and click Next.
The Tag Import and Export Wizard dialog box reappears.
9. Click Finish to import the HMI files.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201921
Chapter 1How to Install the Library
The FactoryTalk View - Database Import dialog box appears with the
information that the import is complete.
10. To close the window and complete the import, click the ‘X’ in the upper
right corner of the window.
22Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
How to Install the LibraryChapter 1
Configure Your HMI
Application for Language
Switching
Process Library Language Switching
FactoryTalk View language switching provides the ability to configure multiple
languages for an application and switch them dynamically at runtime.
The static strings that are used in the Rockwell Automation Library of Process
Objects (Process Library) graphic elements have been designed to use the
native FactoryTalk View Language Switching feature. This feature gives
operators the ability to switch between languages in one application at
runtime.
FactoryTalk View SE/ME Clients can run in any of the languages that an
application supports. In a network distributed application, multiple clients can
run in different languages simultaneously.
Translated versions of the Process Library static strings (distributed with the
Process Library in the /Files/Translations folder) can be imported via the
FactoryTalk View Studio Language Configuration dialog box. See Configure
Language Switching on page 23 for a summary of the steps necessary to
incorporate language switching in your applications.
For more information and details about language switching, see the following
FactoryTalk View publications:
• FactoryTalk View Site Edition User Guide, publication
VIEWSE-UM006
• FactoryTalk View Machine Edition User Guide, publication
VIEWME-UM004
Configure Language Switching
Complete these steps to configure language switching for an application:
1. Install the Windows languages that the application is going to use.
IMPORTANTWindows locale formatting determines how the application shows time,
date, and floating point values at design time and runtime. When the
application language is switched, the Windows locale settings for the new
language are used even if that language has not been installed. You do not
need to edit the default locale settings.
2. Create, open, or import the application in the language of your choice.
3. Add additional languages to your application.
IMPORTANTStatic strings with undefined translations are shown with question mark '?'
characters at runtime. Set en-US as your default English application
language and choose the option to 'display undefined strings in the default
language.'
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201923
Chapter 1How to Install the Library
4. Import Process Library graphic elements.
5. Import Process Library translated text strings for each of the desired
languages.
6. To provide operators with a mechanism to switch between the
application languages at runtime, use the Process Library Language Switch Global Objects in your application.
The Language Switch global objects are on the (RA-FRAME)
Standard Objects.ggfx display for FactoryTalk View SE and (RAFRAME-ME) Standard Objects.ggfx display for FactoryTalk View ME
software.
Configure FactoryTalk View SE Clients
Complete these steps to configure FactoryTalk View SE clients:
1. On client computers, install the Windows languages that the
application supports.
2. In client setup files, specify an initial language for the client to run.
Configure FactoryTalk View ME Runtime Device
Complete these steps to configure FactoryTalk ME runtime device:
1. For applications that are going to run on a personal computer, install the
Windows languages that the application is going to use.
2. For applications that are going to run on a PanelView™ Plus or
PanelView Plus CE terminal, configure the fonts that the application is
going to use.
24Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Chapter 2
Configure an HMI Template and Security
A flexible, configurable template is available to provide a starting point for
creating and developing an HMI application. The template supports Full HD
displays and multi-monitors, which align with PlantPAx® system best practices.
This chapter has two important subsections:
• Customize a template, starting on page 37
•Configuring HMI security, page 69
We encourage you to review the template features before implementing
displays and alarms on a single or four-monitor workstation (as shown).
Considerations
Before you complete tasks in this chapter, we suggest that you do the following:
• Determine the number of HMI, data, and alarm and event servers to be
used where they are hosted
• Make sure that PASS servers are installed and available
• Review system server configurations as described in the PlantPAx
Distributed Control System Infrastructure Configuration User
Manual, publication PROCES-UM001
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201925
Chapter 2Configure an HMI Template and Security
The following table lists the topics in this chapter.
Top icPa ge
Download Template Files26
Explore Template Features28
Customize an HMI Template37
Configure HMI Security69
Create an OWS Client File96
Download Template Files
The Process Library zip file contains a template folder that can be downloaded
from the Product Compatibility and Download Center (PCDC). Click
http://www.rockwellautomation.com/rockwellautomation/support/
downloads.page to access the PCDC.
Double-click the Files folder and choose the Template folder. There are
FTView (HMI) Templates and Logix (controller) Templates.
The FTView folder includes these HMI templates:
(1)
• FTVSE_xx
_x_Template_ProcessLib_x_x_xx.apa – Provides
faceplates, global objects, images, and macros for the current version of
the Process Library FactoryTalk® View SE
includes framework displays for headers, button bars, alarming, and
overview displays for single monitor (1 Mon) and four monitors
(4 Mon).
IMPORTANTFor most systems, you load the HMI template on the PASS server by using
the Engineering workstation (EWS). Your system data is viewed on the
Operator workstation (OWS).
Template resolution is 1920 x 1080, Full HD.
(1) ‘x’ refers to the latest version of Microsoft Windows and software version of FactoryTalk View.
26Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Configure an HMI Template and SecurityChapter 2
Observe the Template Structure
The example tree
diagram shows the HMI
template structure.
The displays that are
included in the template
have the following
naming structure:
•(FRAME) is a
prefix that is used
on items that are
intended only to
be used as is with
minimum
customization.
• P2f is a unique
template
identifier. This
prefix identifies
the template that
is being applied
and the files that
are part of the
template.
• Te m p l a t e is used to identify a template that can be copied multiple
times to create application-specific content. If the word 'Template' is
omitted, the file is not a template display. The rest of the name is a brief
description of the display file. We suggest that these names be similar
across templates.
• Macros configure the initial display structure during runtime. The
Startup macros open the framework files in the orientation intended.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201927
Chapter 2Configure an HMI Template and Security
Explore Template Features
This section describes features of the HMI template. To access the template,
Download Template Files on page 26.
see
We suggest you familiarize yourself with these features to enhance productivity
with your template, which includes the following:
• Basic display layout
• Navigation
• Alarm annunciation
• FactoryTalk View Alarm and Event displays
The template supports both single- and four-monitor configurations, as shown
in the illustrations.
28Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Display and Alarm Hierarchy
The HMI template requires that displays and alarms be organized in a specific
hierarchy. There are four levels that are used in the display and alarm hierarchy,
each level providing more detail than the previous level.
Figure 2 - Example of HMI Template Hierarchy
Configure an HMI Template and SecurityChapter 2
Level 1 displays are high-level overviews. These displays provide an overview
that can be assimilated quickly, provides clear indication of current
performance, and immediately highlights anything that needs the attention
of a viewer.
Level 2 displays are the main displays for users to perform their tasks. They
contain information and control required to perform most user tasks. We
recommend that you create these displays first.
Level 3 displays contain more detail and controls. These displays show
details of subunits, individual equipment items, components, and related
controls and indications. The displays are used for detailed investigations and
interventions, and for troubleshooting or manipulating items not accessible
from Level 2 displays.
Level 4 displays provide the most detail of subsystems, individual sensors, or
components. A faceplate is a type of level 4 display.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201929
Chapter 2Configure an HMI Template and Security
Level 1 Overview Display
The Level 1 Overview Display provides clear indication of current
performance at a high level, and highlights anything that needs your attention.
Control is not to be performed from this display.
Global objects have been developed that can be used on the Overview Display
to annunciate alarms. The global objects are on the (RA-FRAME) Alarm
Objects global object display.
Level 2 and 3 Displays
The template display can be used to configure level 2 and 3 displays. Level 2
displays are the main displays to perform tasks. Level 3 displays are used when
additional detail or controls are required.
30Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Loading...
+ 170 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.