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.
Page 2
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
Page 6
Table of Contents
Notes:
6Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 7
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
Page 8
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
Page 9
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
Page 10
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
Page 11
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
Page 12
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
Page 13
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
Page 14
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
Page 15
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
Page 16
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
Page 17
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
Page 18
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
Page 19
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
Page 20
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
Page 21
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
Page 22
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
Page 23
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
Page 24
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
Page 25
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
Page 26
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
Page 27
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
Page 28
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
Page 29
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
Page 30
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
Page 31
Configure an HMI Template and SecurityChapter 2
On four-monitor clients, monitors 3 and 4 display the level 2 or 3 displays.
Button bars are used to navigate through the level 2 and 3 displays.
Alarm Group Hierarchy
Alarm groups can be configured following the same hierarchy as displays.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201931
Page 32
Chapter 2Configure an HMI Template and Security
Alarm AccessAlarm Silence
Alarm and Event BannerClient Login/Logout ButtonsClose ClientSystem Status
Display Navigation MapReturn to Home Screen
Refresh all Monitors
Template Headers
Headers contain functionality that provides access to information. There
are two headers: one for a single monitor client, the other a four-monitor
client.
Single Monitor Header
This header includes navigation display, system status, and alarm access.
Four-monitor Header
The four-monitor header includes the same buttons as the single monitor
header, except for the alarm access button. The multi-monitor header also
excludes an alarm and event banner. In the four-monitor configuration, the
alarm summary is continuously displayed on monitor 2.
Navigation Utilities
Navigate your plant areas by using the following tools.
Map
The Display Navigation Map lets you switch between multiple process areas. A
display map is required for each monitor configuration.
32Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 33
Configure an HMI Template and SecurityChapter 2
Navigation Bars
Level 2 HButton Bar is used for navigating through level 2 displays. For
example, Units or Process Areas.
Level 3 HButton Bar is used for navigating through level 3 displays. For
example, Unit Detail or Process Area Detail.
Alarm Annunciation
Level 1 Alarm Group Annunciation objects can be used to ‘frame’ the display
elements that are associated with Level 2 groups. For example, Process Areas or
Units. These objects are available in various sizes.
Level 2 and 3 HButtonBars use global objects on top of the navigation buttons
to annunciate an alarm that is associated with the Level 2 or 3 alarm group.
These global objects are on the (RA-FRAME) Alarm Objects global
object display.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201933
Page 34
Chapter 2Configure an HMI Template and Security
Alarm Access Alarm Silence
Additional Alarm Access
The alarm server path and alarm group names must be configured in the global
object parameters.
See page 135
for more information on parameter values.
Alarm Tools
Click the bell icon (on the single monitor header) to access active alarms. Tabs
appear near the bottom-left of the window to access several alarm screens.
Click the speaker icon to silence the alarms.
TIP: On the four-monitor client, the alarm summary and alarm navigation are
continuously displayed on monitor 2.
34Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 35
Configure an HMI Template and SecurityChapter 2
System Status
You can view the health of your system by displaying diagnostics.
Macros
In a FactoryTalk View Site Edition (SE) application, a macro is a series of
commands stored in a text file. In a FactoryTalk View Machine Edition (ME)
application, a macro is a list of tag assignments stored in a text file.
Table 1 - Process Library and HMI Macros Descriptions
MacroDescription
Process Library (FactoryTalk View SE)
NavToChildFaceplate.mcrMacro navigates to the faceplate for the object specified
NavToFaceplate with line of sight.mcrMacro navigates to the faceplate for the object specified
NavToFaceplate.mcrMacro navigates to the faceplate for the object specified
NavToP_LLS_Motor.mcrMacro navigates to the faceplate for the motor specified
NavToQuick with line of sight.mcrMacro navigates to the Quick display for the object
NavToQuick.mcrMacro navigates to the Quick display for the object
Process Library (FactoryTalk View ME)
FTViewME_ProcessLibrary_Tags_x_x_xx.CSV
where x_x_xx = the current software version and
service release number
HMI Template
P2f Template 1Mon FixScreenProvides displays on a single, Full HD monitor.
P2f Template 4Mon FixScreenProvides displays on four, Full HD monitors.
by the given path and tag names. For this macro, the
security uses the parent's faceplate area, and that area is
passed as the No. 4 parameter.
by the given path and tag names.
by the given path and tag names.
by the given path and tag names.
specified by the given path and tag names.
specified by the given path and tag names.
These tags must be imported into the FactoryTalk View
ME project to support switching tabs on any Process
Object faceplate.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201935
Page 36
Chapter 2Configure an HMI Template and Security
Importing Security-based Macros
For area-based security, you must import the NavToFaceplate and NavToQuick
macros into your application. The NavToFaceplate passes parameters to display
faceplates. The NavToQuick access the faceplate for a specified
object.Customize an HMI Template
IMPORTANTThe ‘NavToFaceplate with line of sight’ and ‘NavToQuick with line of sight’
macros add Line of Sight Security to the application. This functionality
allows equipment operation within a straight path of computers configured
for this type of activity.
After you import the macros into your distributed system, add the desired
computer to the specified area to a group. See
Rename ‘NavToFaceplate with line of sight’ to ‘NavToFaceplate’. The renamed
‘NavToFaceplate ‘ (with line of sight) uses the command ‘If
CurrentComputerHasGroup( ) Then’ to check the location of the login.
page 87 for procedures.
36Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 37
Configure an HMI Template and SecurityChapter 2
Levels
2
3
1
Customize an HMI Template
This section details how to customize a template in FactoryTalk
View Studio SE software.
Figure 3 shows a Studio 5000 Logic Designer®
application that shows a level hierarchy. Setting the level hierarchy is critical to
alarm setup.
The example shows that the application consists of one process area.
Within the process area are two sub areas, which each contains two pieces
of equipment.
Figure 3 - Example Application Logical Model
Modify the Template
This section describes how to modify the HMI template by using the Studio
5000 Logix Designer application.
1. Open an Architect project.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201937
Page 38
Chapter 2Configure an HMI Template and Security
2. In the Project Explorer tree, right-click an application (PlantPAx in the
example) and choose Open Project in Designer.
Wait a short time while the FactoryTalk View Studio software opens.
Notice that the project structure and content in FactoryTalk View
Studio appears as it does in an Architect project.
A window appears on the Studio canvas to choose a name.
4. Rename the display ‘Process01 Overview Display’ and click OK.
The name is for training purposes for this specific application. Your
application name is going to be different.
5. Open the Process01 Overview Display and delete the bottom two
alarm objects.
38Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 39
Configure an HMI Template and SecurityChapter 2
6. Right-click the first alarm object and select Global Object
Parameter Values.
7. Type the values as shown in the example, and click OK.
8. Repeat
step 6 and step 7 for the second global object on the display.
Set parameter #103 to Area02 for this alarm object.
The alarm objects for Process01 Overview Display are configured for
Area01 and Area02.
Adding Key Performance Indicators (KPI)
Do these steps to add KPIs to the Process01 Overview Display. In this example,
the KPI shows temperature values.
1. In FactoryTalk View Studio, expand Global Objects and double-click
‘(RA-FRAME) P_AIn Graphics Library’.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201939
Page 40
Chapter 2Configure an HMI Template and Security
A collection of display elements for analog input objects appears.
2. Copy the global object and paste into the Process01 Overview Display.
3. Right-click the pasted object and choose Global Object
Parameter Values.
4. Type the value as shown in the example.
5. Repeat
40Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
step 2 through step 4 to add three more KPI objects.
Page 41
Configure an HMI Template and SecurityChapter 2
6. Make sure to type the appropriate parameter values into the Global
Object Parameter Values table.
The three objects are TT02001, TT03001, TT04001.
At this stage, the Process01 Overview Display is complete.
Creating Area Overview Displays
Do these steps to create the Level 2 Area Overview Display. The procedures for
creating Area01 must be repeated for Area02.
1. Navigate to the HMI template display as shown in the example.
2. Right-click ‘(FRAME) P2f Template Display’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201941
Page 42
Chapter 2Configure an HMI Template and Security
3. Rename the display ‘Process01 Area01 Display’ and click OK.
4. Update the display title text to ‘Area01’.
5. Expand Global Objects and copy objects from RA-FRAME Displays to
represent Equipment01 and Equipment02.
6. For each object that is added to the display, right-click the object and
configure the global object parameter values.
7. Repeat
step 1 through step 6 for Area02.
At this stage, you have configured the Level 2 displays.
Creating Equipment Detail Displays
Do these steps to create the Level 3 Equipment Detail Displays. The
procedures for creating the first detail display must be repeated for all
equipment.
1. Navigate to the HMI template display as shown in the example.
42Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 43
Configure an HMI Template and SecurityChapter 2
2. Right-click ‘(FRAME) P2f Template Display’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
3. Rename the display ‘Process01 Area01 Equipment01 Display’ and
click OK.
4. Update the display title text to ‘Area01 Equipment01’.
5. Expand Global Objects and copy objects from RA-BAS Displays to
represent Equipment01.
6. For each object that is added to the display, right-click the object and
configure the global object parameter values.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201943
Page 44
Chapter 2Configure an HMI Template and Security
At this stage, your equipment detail looks as shown in the example.
7. Repeat step 1
through step 6 for Equipment02 through Equipment04.
Make sure that the titles are correct for the additional equipment.
Creating Level 2 Navigation Displays
Do these steps to create Level 2 button bars that are used for
navigating displays.
1. In FactoryTalk View Studio, right-click ‘(FRAME) P2f Template Level2
HButtonBar’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
44Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 45
Configure an HMI Template and SecurityChapter 2
2. Rename the display ‘Process01 HButtonBar’ and click OK.
3. Right-click ‘(FRAME) P2f Template Level3 HButtonBar’ and choose
Duplicate.
A window appears on the Studio canvas to choose a name.
4. Rename the display ‘Process01 Area01 HButtonBar’ and click OK.
5. Repeat
step 3 and step 4 to create another button bar, but rename
‘Process01 Area02 HButtonBar’.
6. Open the Process01 HButtonBar display.
7. Right-click the alarm object that surrounds the first navigation button
and choose Global Object Parameter Values.
8. Configure the global object parameter values as shown.
9. Repeat
step 7 and step 8 for the alarm objects that surround the second
navigation button.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201945
Page 46
Chapter 2Configure an HMI Template and Security
Make sure parameter #103 is Area02.
10. Right-click on the first navigation button and choose Properties.
11. Click the Action tab and update the Release Action based on the
example shown.
12. Click the Up Appearance tab.
46Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 47
Configure an HMI Template and SecurityChapter 2
13. Update the caption as shown in the example.
14. Click OK.
15. For the second navigation button, repeat
step 9 through step 13.
Make sure the action and caption are for Area02.
16. Delete all unused navigation buttons from the Process01 HButtonBar
display.
17. Close the Process01 HButtonBar display.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201947
Page 48
Chapter 2Configure an HMI Template and Security
Creating Level 3 Navigation Displays
Do these steps to create Level 3 button bars that are used for
navigating displays.
1. Open the Process01 Area01 HButtonBar display.
2. Right-click the alarm object that surrounds the first navigation button
and choose Global Object Parameter Values.
3. Configure the global object parameter values as shown.
4. Repeat
step 2 and step 3 for the alarm objects that surround the second
navigation button.
Make sure parameter #104 is Equipment02.
5. Right-click on the first navigation button and choose Properties.
48Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 49
Configure an HMI Template and SecurityChapter 2
6. Click the Action tab and update the Release Action based on the
example shown.
7. Click the Up Appearance tab.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201949
Page 50
Chapter 2Configure an HMI Template and Security
8. Update the caption as shown in the example.
9. Click OK.
10. For the second navigation button, repeat
step 5 through step 9.
Make sure the action and caption are for Equip02.
11. Delete all unused navigation buttons from the Process01 Area01
HButtonBar display.
12. Close the Process01 Area01 HButtonBar display.
13. Open the Process01 Area02 HButtonBar display.
14. Repeat
step 1 through step 13 for this display using Equipment03
and Equipment04.
50Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 51
Configure an HMI Template and SecurityChapter 2
At this stage, your HMI application contains the following displays.
Create Alarm Displays
Do these steps to create the Alarm displays for the HMI application.
IMPORTANTAs stated at the beginning of the Customizing an HMI Template section,
organize and group your alarms based on the level hierarchy (Levels 1…3)
of your system. For additional information, see Chapter 4 in the PlantPAx
DCS Application User Manual, publication PROCES-UM003
.
1. In FactoryTalk View Studio, right-click ‘(FRAME) P2f Template
Alarm-Summary’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
2. Rename the display ‘Process01 Alarm-Summary’ and click OK.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201951
Page 52
Chapter 2Configure an HMI Template and Security
3. Right-click ‘(FRAME) P2f Template Alarm-HistoryDisplay’ and
choose Duplicate.
A window appears on the Studio canvas to choose a name.
4. Rename the display ‘Process01 Alarm-HistoryDisplay’ and click OK.
5. Right-click ‘(FRAME) P2f Template Alarm-ShelvedDisplay’ and
choose Duplicate.
A window appears on the Studio canvas to choose a name.
6. Rename the display ‘Process01 Alarm-ShelvedDisplay’ and click OK.
7. Right-click ‘(FRAME) P2f Template Alarm-Explorer’ and
choose Duplicate.
A window appears on the Studio canvas to choose a name.
52Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 53
Configure an HMI Template and SecurityChapter 2
8. Rename the display ‘Process01 Alarm-Explorer’ and click OK.
9. Open the Process01 Alarm-Summary Display.
10. Close the Process01 Alarm-Summary Display.
IMPORTANTThe next steps allow your alarm displays to perform on single
and four-monitor operator workstations.
11. Right-click ‘(FRAME) P2f Template Alarm-HButtonBar_1Mon’ and
choose Duplicate.
A window appears on the Studio canvas to choose a name.
12. Rename the display ‘Process01 Alarm HButtonBar_1Mon’ and
click OK.
13. Open the Process01 Alarm HButtonBar_1Mon Display.
14. Right-click the button group and choose global object parameter values.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201953
Page 54
Chapter 2Configure an HMI Template and Security
15. Type the value shown in the example and click OK.
16. Close the Process01 Alarm HButtonBar_1Mon Display.
17. Right-click ‘(FRAME) P2f Template Alarm-HButtonBar_4Mon’ and
choose Duplicate.
A window appears on the Studio canvas to choose a name.
18. Rename the display ‘Process01 Alarm HButtonBar_4Mon’ and
click OK.
19. Open the Process01 Alarm HButtonBar_4Mon Display.
20. Right-click the button group and choose global object parameter values.
54Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 55
Configure an HMI Template and SecurityChapter 2
21. Type the value shown in the example and click OK.
22. Close the Process01 Alarm HButtonBar_4Mon Display.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201955
Page 56
Chapter 2Configure an HMI Template and Security
Create a Single-monitor Header Display
Do these steps to create a banner at top of a display for a single monitor display.
1. In FactoryTalk View Studio, right-click ‘(FRAME) P2f Header_1Mon’
and choose Duplicate.
A window appears on the Studio canvas to choose a name.
2. Rename the display ‘Process01 Header_1Mon’ and
click OK.
3. Open the Process01 Header_1Mon Display.
4. Double-click the header title text and update as shown in the example.
56Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 57
Configure an HMI Template and SecurityChapter 2
5. Click OK.
6. Right-click the Horn Silence button and choose global object parameter
values.
7. Type the values as shown in the example, and click OK.
8. Right-click on the Alarm Navigation button and choose global object
parameter values.
9. Type the values as shown in the example and click OK.
10. The single monitor header display includes an alarm banner.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201957
Page 58
Chapter 2Configure an HMI Template and Security
11. Right-click the Home button and choose global object
parameter values.
12. Type the values as shown in the example and click OK.
13. Right-click the System button and choose global object
parameter values.
14. Type the values as shown in the example and click OK.
58Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 59
Configure an HMI Template and SecurityChapter 2
15. Right-click the Display Map button and choose global object
parameter values.
16. Type the values as shown in the example and click OK.
17. Close the Process01 Header_1Mon Display.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201959
Page 60
Chapter 2Configure an HMI Template and Security
Create a Four-monitor Header Display
Do these steps to create a banner at top of a display for a four-monitor display.
1. In FactoryTalk View Studio, right-click ‘(FRAME) P2f Header_4Mon’
and choose Duplicate.
A window appears on the Studio canvas to choose a name.
2. Rename the display ‘Process01 Header_4Mon’ and
click OK.
3. Open the Process01 Header_4Mon Display.
4. Double-click the header title text and update as shown in the example.
5. Click OK.
60Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 61
Configure an HMI Template and SecurityChapter 2
6. Right-click the Horn Silence button and choose global object
parameter values.
7. Type the values as shown in the example, and click OK.
8. Right-click the Fix Screen button and choose global object
parameter values.
9. Type the values as shown in the example and click OK.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201961
Page 62
Chapter 2Configure an HMI Template and Security
10. Right-click the System button and choose global object
parameter values.
11. Type the values as shown in the example and click OK.
12. Right-click the Display Map button and choose global object
parameter values.
13. Type the values as shown in the example and click OK.
14. Close the Process01 Header_4Mon Display.
62Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 63
Configure an HMI Template and SecurityChapter 2
Create the Display Map Single Monitor Display
Do these steps to configure high-level navigation that lets operators view
different process areas within the same HMI application. This instruction is
for single monitors.
1. In FactoryTalk View Studio, right-click ‘P2f Template 1Mon Display
Map’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
2. Rename the display ‘Process 1Mon DisplayMap’ and
click OK.
3. Open the Process 1Mon DisplayMap Display.
4. Right-click Process Area 1 button and choose Properties.
5. Select the Action tab and update the release action as shown in
the example.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201963
Page 64
Chapter 2Configure an HMI Template and Security
6. Click the Up Appearance tab and update the caption as shown in
the example.
7. Click OK.
8. Close the Process 1Mon DisplayMap Display.
This display configuration is application-specific.
Create the Display Map Four-monitor Display
Do these steps to configure high-level navigation that lets operators view
different process areas within the same HMI application. This instruction is
for a four-monitor operator workstation.
1. In FactoryTalk View Studio, right-click ‘P2f Template 4Mon Display
Map’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
2. Rename the display ‘Process 4Mon DisplayMap’ and
click OK.
3. Open the Process 4Mon DisplayMap Display.
64Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 65
Configure an HMI Template and SecurityChapter 2
4. Right-click Process Area 1 button and choose Properties.
5. Select the Action tab and update the release action as shown in
the example.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201965
Page 66
Chapter 2Configure an HMI Template and Security
6. Click the Up Appearance tab and update the caption as shown in
the example.
7. Click OK.
8. Close the Process 4Mon DisplayMap Display.
This display configuration is application-specific.
Create the System Display
Do these steps to configure a display for system diagnostics.
1. In FactoryTalk View Studio, right-click ‘P2f Template System’ and
choose Duplicate.
A window appears on the Studio canvas to choose a name.
2. Rename the display ‘Process System’ and click OK.
66Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 67
Configure an HMI Template and SecurityChapter 2
At this stage, the displays for this example HMI application are created
and resemble the example.
For basic system diagnostics, see Chapter 9 in the PlantPAx DCS
Application User Manual, publication PROCES-UM003
.
Rename HMI Template Macros
Do these steps to rename HMI macros, which are used for the client
startup configuration.
1. From the Project Explorer in FactoryTalk View Studio, expand Macros.
2. Right-click ‘P2f Template 1Mon FixScreen’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
3. Rename the display ‘Process01 1Mon FixScreen’ and
click OK.
4. Open the Process01 1Mon FixScreen macro.
5. Update the macro as shown in the example.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201967
Page 68
Chapter 2Configure an HMI Template and Security
6. Close the Process01 1Mon FixScreen macro.
7. Right-click ‘P2f Template 4Mon FixScreen’ and choose Duplicate.
A window appears on the Studio canvas to choose a name.
8. Rename the display ‘Process01 4Mon FixScreen’ and
click OK.
9. Open the Process01 4Mon FixScreen macro.
10. Update the macro as shown in the example.
11. Close the Process01 4Mon FixScreen macro.
Your customization of the HMI template is complete.
68Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 69
Configure an HMI Template and SecurityChapter 2
Configure HMI Security
This section describes how to configure security to assign HMI privileges to
your staff members. Without security privilege, personnel cannot access
faceplates for specific areas of the plant.
IMPORTANTBefore performing the following procedures, you must have assigned user
groups with roles to specific plant areas. See Chapter 6 in the Infrastructure
User Manual, publication PROCES-UM001
.
Configure Object Area
Add-On Instructions for the objects include a parameter for a configurable
object area (tag parameter Cfg_Area), which can be used to assign the object to
an area of the facility. Only users with the privileges for the assigned area can
operate or configure the device. For example, an engineer in Area 1 cannot
modify pump attributes in Area 2, unless assigned security for Area 2.
Configure Security Area
Each Library faceplate has a configurable ‘Area Name for Security’ value, which
is used to assign the object instance to an area of the facility.
To make an area assignment, you must do the following:
• Change the area string size (optional)
• Configure the Cfg_Area tag parameter
• Configure the area by using a PlantPAx tool
Each task is explained in the following pages.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201969
Page 70
Chapter 2Configure an HMI Template and Security
Changing Area String Size
You can change the default area string size to accommodate your system
naming convention. For example, we name our domain
‘System.PlantPAx.local’ where the NetBIOS™ is SYSTEM. We need to increase
the string size to contain the number of characters in the area name, such as
SYSTEM\Area1.
IMPORTANTThe string area name depends on whether you are using a domain. In the
example, ‘System’ is a child domain of parent domain PlantPAx. If you are
not using a domain, your HMI could be named Area 1. For details, see
Chapters 3 and 6 in the PlantPAx Distributed Control System Infrastructure
Configuration User Manual, publication PROCES-UM001
1. In the Logix Designer Controller Organizer, expand Assets and click
Data Types>Strings>String Area.
.
2. Type a value for the maximum characters.
The example shows 20 characters.
3. Click OK.
IMPORTANTChanging the definition of a string type clears the values of all
strings of that type. Decide on string sizes early in the project.
70Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 71
Configure an HMI Template and SecurityChapter 2
A message window appears.
4. Click Yes.
Configuring Area Manually
This section describes how to manually configure an object tag parameter
(Cfg_Area) by using Logix Designer to modify tags in the controller
application file (ACD file).
1. In the Controller Organizer, expand Assets and click Add-On
Instructions>P_AIn.
Our example is P_AIn, but the procedure applies for any
Add-On Instruction that requires area string modification.
2. Click Parameters and Local Tags to open the Add-On Instruction.
3. From the Data Context pull-down, choose an object.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201971
Page 72
Chapter 2Configure an HMI Template and Security
The object attributes appear.
4. Click the value column for Cfg_Area to access a Browse
(‘ellipse’ …) button.
5. Click Browse to open the String Browser window.
6. Type your area name and click OK.
The area name appears in the Cfg_Area Value field.
7. Repeat
step 2 through step 6 for all objects in your system that require
the area string to be modified.
For larger systems, a configuration tool is provided to modify area
strings. See
72Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Using the PlantPAx Tool to Change Area on page 73.
Page 73
Configure an HMI Template and SecurityChapter 2
Using the PlantPAx Tool to Change Area
The Rockwell Automation Library of Process Objects contains the ‘PlantPAx
Configuration Tools for Tags, Alarms, and Historian’ software. The PlantPAx
Configuration Tool can be used to configure area strings for large systems with
multiple objects. This software tool is part of the Rockwell Automation
Library of Process Objects download at
Follow the documentation supplied with the tool to import the
controller file into the tool.
3. Right-click a Controller and choose Edit/Export Controller Tags.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201973
Page 74
Chapter 2Configure an HMI Template and Security
4. From the Data Type pull-down, select a data type.
5. From the Filter pull-down, select Cfg_Area.
Tags that associated with the selected data type appear.
6. For each tag, type the area name for the object.
7. Click Apply Changes.
A message window appears.
8. Click OK.
9. Repeat
step 4 through step 8 for each data type in your system.
74Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 75
10. Click Save.
Configure an HMI Template and SecurityChapter 2
A message window appears.
11. Click OK.
Be patient while the tool updates the controller .acd file.
12. Click OK.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201975
Page 76
Chapter 2Configure an HMI Template and Security
Create User Groups
This section describes how to create user groups.
1. From the FactoryTalk View Studio, click ‘+’ to expand System and click
Users and Groups.
2. Right-click User Groups and choose New>User Group.
3. Name the user group HMI_Operators and click OK.
Later we assign the security code A (only) to this user group. See page 79
for procedures.
4. Right-click User Groups (again) and choose New>User Group.
76Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 77
Configure an HMI Template and SecurityChapter 2
5. Name the user group HMI_Operating_Supervisor and click OK.
6. Repeat step 2
and step 5 to add the following five user groups:
•HMI_Maintenance
• HMI_Maintenance Supervisor
• HMI_Engineering
•HMI_Manager
•HMI_Admin
7. Verify that the user groups shown are added.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201977
Page 78
Chapter 2Configure an HMI Template and Security
Assign Security Codes to User Groups
This section describes how to assign security codes to user groups. Runtime
security is organized based on the role of a user. Each role is assigned a security
letter (A …G).
1. From the FactoryTalk View Studio, double-click Runtime Security and
choose Security Accounts.
2. To expand the FactoryTalk View Security Codes, click the ‘+’.
78Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 79
Configure an HMI Template and SecurityChapter 2
3. Scroll and select the User ‘HMI_Operators’.
4. Expand the FactoryTalk View Security Codes, then click the Allow
check box for security code A.
5. Click OK.
6. Repeat
step 1 though step 5 to assign the security codes to the following
six user groups:
• HMI_Operating Supervisor (code B only)
• HMI_Maintenance (code C only)
• HMI_Maintenance Supervisor (code D only)
• HMI_Engineering (code E only)
•HMI_Manager (code F only)
•HMI_Admin (code G only)
List of Security Codes
FactoryTalk View software security codes help protect information that is
contained within the HMI faceplates. Operators, maintenance personnel,
and engineers must have security permissions to modify their respective
faceplate tabs.
Ta b l e 2 references the security codes that are recommended for each tag.
Table 2 - Security Codes
FTView TagDescriptionSecurity
Security\AlarmAckAcknowledge/Reset AlarmsABCDEF
Security\AlarmConfigAlarm ConfigurationE
Security\AlarmDisableDisable AlarmsBCDEF
Security\AlarmShelveShelve AlarmsABCDEF
Security\BypassFeedbackCan Bypass FeedbackCDE
Security\BypassInterlocksBypass Permissives and InterlocksBCDEF
Codes
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201979
Security\ProcedureManualCont rolManual Procedure; Sequence; and Batch Processing
(Stop; Abort; Reset)
Security\ResetAccumulatorsReset Run Time AccumulatorsCDE
Security\RespondToPromptsRespond to PromptsABCDEF
Security\ShowFaceplateNavigate to full faceplateCDE
Codes
CDE
BCDEF
E
BCDEF
ABCDEF
ABCDEF
ABCDEF
80Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 81
Configure an HMI Template and SecurityChapter 2
Security Code Differences from Version 3.5 to Version 4.0 (or Later)
In the previous versions of the library (version 3.5 and earlier), the faceplates
used all the security codes ‘A…P’. The drawback with using security codes A…P
in the faceplates was that there were no available spare codes for customer use
to customize their security model. Also, the security codes had to be assigned
per user.
Starting with the Rockwell Automation Library of Process Objects, version 4.0
(or later), release, each object (and faceplate) has a configurable ‘Area Name for
Security’ value. The configurable value can be used to assign the object (or
faceplate) to a specific process area of the facility. This functionality frees up
most of the ‘H…P’ codes for customer assignable security and makes assigning
users to groups much easier.
With version 4.0 (or later), the user groups are assigned the ‘roles’ (the
appropriate security codes) by using new Security tags. Users are assigned to
groups. The new security tags can be imported into the version 4.0 (or later)
application from a library supplied import file.
The Rockwell Automation Library of Process Objects, version 3.5, used the
following user groups. Each group used various security codes (A…P):
• HMI_ Operators (various codes)
• HMI_ Operating Supervisor (various codes)
• HMI_ Maintenance (various codes)
• HMI_ Maintenance Supervisor (various codes)
•HMI_ Engineering (various codes)
• HMI_ Manager (various codes)
• HMI_ Admin (various codes)
For the version 4.0 (or later) Area-based Security feature (runtime security),
the Rockwell Automation Library of Process Objects, version 4.0 (or later),
recommends the same seven User Groups per HMI. However, each group is
assigned only a single security code:
•HMI_ Operators (code A)
•HMI_ Operating Supervisor (code B)
• HMI_ Maintenance (code C)
• HMI_ Maintenance Supervisor (code D)
•HMI_ Engineering (code E)
•HMI_ Manager (code F)
IMPORTANTIt is a requirement to have at least one area configured within your projects
with basic and advanced user assignments. If you do not add {Area}_Basic
and {Area}_Advance groups you have view only access to the HMI
faceplates. The area name must match the .Cfg_Area tag string value in the
Add-On Instruction instance for security to function correctly.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201981
Page 82
Chapter 2Configure an HMI Template and Security
Import Area-based HMI Tags
Complete these steps to import the HMI tags (.CSV file) that is provided with
the Process Library download.
1. From FactoryTalk View Studio main menu, click Tools and choose Tag
Import and Export Wizard.
2. From the Tag Import and Export Wizard, select Import FactoryTalk
View tag CSV files from the pull-down, and click Next.
3. Choose the Project Type and then click the ellipsis (‘…’) to navigate to
the folder that contains the HMI project.
4. Click Next.
5. Click the ellipsis (‘…’) and navigate to the folder with the .CSV file with
the Process Library download.
6. Click Next.
82Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 83
Configure an HMI Template and SecurityChapter 2
7. Select Update existing (slower) and click Next.
8. Click Finish.
9. After importing the tags, double-click Tags (from the HMI tree) and
verify that two HMI folders exist: Const and Security.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201983
Page 84
Chapter 2Configure an HMI Template and Security
TIPUsing the A…P codes assigned to the HMI user groups, you can determine
which groups have permission for each security task. Add or remove that
group's security code in the Initial Value field of the corresponding HMI tag.
By importing the tags, all (library download) recommended assignments
have been configured.
Before changing initial values to customize your security on HMI faceplates,
when the HMI server is started, it loads the initial value of the memory tag into
memory. But when changes are made to the initial value in FactoryTalk View
Studio, those changes only go to the hard disk drive. To get the newly edited
initial value into memory, the HMI server needs to be restarted. Do the
following:
a. Use the SE Service Manager utility, which stops and restarts the HMI
server services. This action forces the HMI server to load the new
initial value into memory.
b. Create a display (or use an existing display), and draw a
numeric/string input and tie it to the tag in question. Enter the new
value and press Enter to force the value to update.
c. Restart the computer.
For more information, see the Knowledgebase Answer ID 54147 at
https://rockwellautomation.custhelp.com/app
.
For each object instance in your Logix code, you assign an area using the tag
member, Cfg_Area, as shown. Two user groups must be created in the
FactoryTalk directory for each area. One named ‘{cfg_Area}_Advanced’ and
one named ‘{cfg_Area}_Basic’. These groups are used to grant or deny
permissions on the faceplates for these objects.
84Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 85
Configure an HMI Template and SecurityChapter 2
The Rockwell Automation Library of Process Objects, version4.0, added one
new controller tag per Object (Cfg_Area):
When configuring security for your application, if your area name exceeds
eight characters, you must increase the string size of STRING_Area found
under Data Types>Strings.
Create Area User Groups
Complete these steps to create area user groups for multiple security areas of a
production facility.
1. From the FactoryTalk Administration Console, click ‘+’ to expand
System and then click ‘+’ to expand Users and Groups.
2. Right-click User Groups and choose New>User Group.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201985
Page 86
Chapter 2Configure an HMI Template and Security
On the New User Group dialog box, you must add two groups:
‘area01_Advanced,’ ‘area01_Basic’. These groups define which Area01
Users have basic functions on the faceplate or advanced functions
(engineering, maintenance).
3. To add groups, type the name (example, area01_Advanced) and
click Add.
4. Select Authenticated Users and use the default ‘Show groups only’ and
click OK.
5. Click OK again.
86Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 87
Configure an HMI Template and SecurityChapter 2
Your two groups for area01 look like the example.
6. Repeat step 3
and step 4 to add two groups for Area02
(‘area02_Advanced,’ ‘area02_Basic’).
Line of Sight Functionality
The procedures for this functionality, which requires a distributed system, is
outlined on page 36
group (‘Computer Group’) and to an area of the plant.
IMPORTANTThe files ‘NavToFaceplate with line of sight’ and ‘NavToQuick with line of
1. From the FactoryTalk View Distributed application, click ‘+’ to expand
System and then click ‘+’ to expand Computers and Groups.
. This section describes how to add a desired computer to a
sight’ must be renamed to replace ‘NavToFaceplate’ and ‘NavToQuick’.
2. Right- click Computer Groups and choose New Computer Group.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201987
Page 88
Chapter 2Configure an HMI Template and Security
3. Type the area name and click Add.
The area name is the same name as the area name configured in the
controller. The computer area name does not have the ‘Basic’ or
‘Advanced’ suffix.
4. On the Select Computer window, click Create New and
choose Computer.
88Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 89
Configure an HMI Template and SecurityChapter 2
5. Type a desired computer name and click OK.
6. Select the name of the desired computer and click OK.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201989
Page 90
Chapter 2Configure an HMI Template and Security
7. To add the computer group to the area, click OK.
Create FactoryTalk Users
Complete these steps to assign a user to one or more HMI security groups and
to any Area groups that they can have access.
1. From the FactoryTalk Administration Console, click ‘+’ to expand
System and then click ‘+’ to expand Users and Groups.
2. Right- click Users and choose New>FactoryTalk User.
3. Type Area01Oper in the User Name text box and click the Group
Membership tab.
90Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 91
Configure an HMI Template and SecurityChapter 2
4. Click Add.
With multiple process areas defined (example Area01, Area02), each
user must be assigned to the HMI_{group} (example HMI_Operator)
and the ‘area’ group. Operators can be assigned to the HMI_Operator
group and also to the Area01_Basic group. This limits operator access to
the faceplate operator controls only.
5. For our example, select the group that is named HMI_Operators and
click OK.
6. Click Add again, and select the group that is names ‘area01_Basic’.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201991
Page 92
Chapter 2Configure an HMI Template and Security
7. Click OK.
8. Click OK again.
We repeat the same steps to add an operator for Area02.
1. From the FactoryTalk Administration Console, click ‘+’ to expand
System and then click ‘+’ to expand Users and Groups.
2. Right- click Users and choose New>FactoryTalk User.
3. Type Area02Oper in the User Name text box and click the Group
Membership tab.
92Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 93
Configure an HMI Template and SecurityChapter 2
4. Click Add.
5. Select the group that is named HMI_Operators and click OK.
6. Click Add again, and select the group that is names ‘area02_Basic’.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201993
Page 94
Chapter 2Configure an HMI Template and Security
7. Click OK.
8. Click OK again.
You now have an operator that is assigned to Area01 and Area02.
Follow these exact steps to assign each HMI_{group} and the
‘area’ group.
For example, HMI_Engineer and Area01_Advanced. Advanced
provides engineers access to the advanced engineering features on the
faceplates. If an engineer is to be able to do operator tasks, an engineer
needs to be a member of both groups: ‘Basic’ and ‘Advanced’.
94Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 95
Configure an HMI Template and SecurityChapter 2
Security Code Differences for FactoryTalk View ME Groups
Area-based security is typically not needed on a PanelView™ terminal. Security
is located on an OEM skid in the area and doesn't access other areas. In
previous Process Library releases, the engineering functions were enabled from
the A…P codes, and available to the ‘default’ user. You could power up the skid,
including the PanelView terminal, and be ready to operate the skid without any
login credentials.
With the release of Version 4.0 (or later) for the Rockwell Automation Library
of Process Objects, at least one area is required to be configured. Since there is
no ability in FactoryTalk View Machine Edition to automatically log in a user,
the customer has to know a valid UID and password to operate their unit.
Thus, you must log into the PanelView system at least one time when a skid has
been powered on.
Refer to Knowledgebase Answer ID 617466 at
https://www.rockwellautomation.custhelp.com
FactoryTalk View Machine Edition, version 8.0, changes how security codes
are applied across multiple groups. Security codes are now ANDed across
groups instead of being ORed.
.
Thus, you cannot assign a user to multiple groups that has A…P codes
configured. As stated in this document, we do not specify that the
{Area}_Basic and {Area}_Advanced have A…P codes. These groups cannot be
included in the ‘Runtime Security’ list. By doing it this way, one does not have
the problem of assigning a user to multiple {Area} groups. The illustration
shows an example of ‘Runtime Security’.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201995
Page 96
Chapter 2Configure an HMI Template and Security
Use an Engineering Workstation
or Operator Workstation with
these procedures
EWS or OWS
Create an OWS Client File
In this section, you create a FactoryTalk View SE client file. Client files are used
to launch a FactoryTalk View software client from the Operator Workstation
(OWS). Once created, this client file can be copied to each OWS.
IMPORTANTOur procedure shows how to create the client file on an OWS. This procedure
also can be used on an EWS.
Complete the following steps.
1. Click the Windows Start button and locate the FactoryTalk View Site
Edition Client application. Click the application to launch the client
wizard.
2. Click the application icon to open the client wizard.
3. To create a client file, click Create a FactoryTalk View SE Client
configuration file.
96Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
4. Type a client file name and location.
5. Click Continue.
Page 97
Configure an HMI Template and SecurityChapter 2
6. In the startup components section, do the following:
a. Select an application type
b. Select an application name from the pull-down menu
c. Select a language from the pull-down menu
d. Select an HMI server name from the pull-down menu
e. From the Startup macro pull-down menu:
– If a single monitor display, select the single monitor macro
– If a 4Mon display, select the 4 monitor macro
7. Click Advanced.
8. Make the selections as shown.
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201997
Page 98
Chapter 2Configure an HMI Template and Security
9. Click Save only if you are using a single monitor.
10. If you select the multi-monitor option, specify the monitor size
and layout.
IMPORTANTYou can configure the starting displays for each monitor by using
11. Click Save.
the configuration wizard rather than a startup macro.
98Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Page 99
Chapter 3
Common Configuration Considerations
This chapter includes programming considerations that are common for
Process Objects.
The following table describes the topics in this chapter.
Top icPa ge
Library Programming Considerations99
Command Source Configuration103
Alarm Considerations103
Alarm with FactoryTalk Alarms and Events Server111
Alarm with FactoryTalk View ME Software118
Global Object Configuration125
Maintain Library Releases127
Customize the Library128
Library Programming
Considerations
Multiple programming languages are available in Logix controllers. Based on
the type of application that you are creating, the Add-On Instruction logic
can be used with Ladder Diagram, Function Block Diagram, and Structured
Text languages.
Review the following programming language examples for the P_Motor
instruction. Use whatever language is ‘best’ for your application.
Figure 4 - Ladder Diagram
Rockwell Automation Publication PROCES-RM002I-EN-P - May 201999
Page 100
Chapter 3Common Configuration Considerations
Figure 5 - Function Block Diagram
Figure 6 - Structured Text
Ladder Diagram logic executes simple Boolean logic, timers, and counters the
fastest. Function Block Diagrams and Structured Text can give you an
advantage of the more advanced process and drives instructions available in
those languages.
There are fundamental differences on how the different languages execute and
are compiled. Nevertheless, Add-On Instruction execution time is the same
regardless of language in which the instruction is used.
100Rockwell Automation Publication PROCES-RM002I-EN-P - May 2019
Loading...
+ 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.