PlantPAx Configuration Tools for

Tags, Alarms, and Historian

Version 6

Quick Start Guides

Last Updated: 4/3/2019 6:22 PM

1
Software License Agreement

END-USER LICENSE AGREEMENT FOR COMPLIMENTARY SOFTWARE

IMPORTANT - READ CAREFULLY: This End-User License Agreement (“Agreement”) is a
legal contract between you ( “Licensee” or “you”) and Rockwell Automation Inc. ("Licensor")
for the software product entitled "PlantPAx Configuration Tools for Tags, Alarms, and Historian”
(the “Software”) which is being provided by Licensor to Licensee on a complimentary basis in
“AS IS” condition for Licensee's internal use. The "Software" includes all installed software
components, and sample RSLogix 5000 and FactoryTalk View project files.
BY INSTALLING, COPYING, OR OTHERWISE USING THE SOFTWARE APPLICATION,
YOU AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT
AGREE TO THE TERMS OF THIS AGREEMENT, DO NOT INSTALL OR USE THE
SOFTWARE APPLICATION.
License Terms
1. License Grant. Licensor hereby grants to you, and by accepting this Agreement in a manner
described above, you accept, a nonexclusive license to use the Software, provided in
machine-readable, object-code form, only as authorized in this Agreement.
Licensor further grants you the right to reproduce the Software solely for the purposes of your
internal use of Software on computers owned, leased, or otherwise controlled by you. Any
copies of the Software or any related user documentation shall include Licensor's copyright
and other proprietary notices.
You agree that you will not assign, sublicense, transfer, pledge, lease, rent, or share your
rights under this Agreement. You agree that you may not reverse assemble, reverse compile
or otherwise translate the Software.
2. Licensor's Rights. The Software and related user documentation are proprietary products of
Licensor protected under U.S. copyright law. All right, title, and interest in and to the
Software, including associated intellectual property rights, are and shall remain with
Licensor. This Agreement does not convey to you an interest in or to the Software, but only a
limited right of use revocable in accordance with the terms of this Agreement.
3. License Fees. The Software is provided without charge. Other fees are payable only as
separately stipulated by Licensor and agreed to by you.
4. Term. This Agreement is effective upon the earlier of your acceptance of this Agreement as
described above, and shall continue until terminated. You may terminate this Agreement at
any time by returning the Software and all copies thereof and extracts there from to Licensor.
Licensor may terminate this Agreement upon prior notice at any time. Upon such termination
by Licensor, you agree to return to Licensor the Software and all copies and portions thereof.
5. No Warranties. The Software is provided "AS IS," without any representation or warranty
whatsoever. LICENSOR DISCLAIMS ANY AND ALL WARRANTIES, WHETHER
EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED

2
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE.
Licensee assumes the entire risk of using the Software. IN NO EVENT WILL LICENSOR
BE LIABLE TO YOU FOR ANY CONSEQUENTIAL, INCIDENTAL OR SPECIAL
DAMAGES, INCLUDING ANY LOST PROFITS OR LOST SAVINGS, EVEN IF A
REPRESENTIVE OF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES, OR FOR ANY CLAIM BY ANY THIRD PARTY.
6. Governing Law. This Agreement shall be construed and governed in accordance with the
laws of the State of Wisconsin.
7. No Waiver. The failure of either party to enforce any rights granted hereunder or to take
action against the other party in the event of any breach hereunder shall not be deemed a
waiver by that party as to subsequent enforcement of rights or subsequent actions in the event
of future breaches.

3
Table of Contents
Software License Agreement ....................................................................................................................... 2

Table of Contents.......................................................................................................................................... 4

Software Overview ....................................................................................................................................... 7

Supported Software .................................................................................................................................... 8

Quick Start – Create Project ....................................................................................................................... 9

Add Controllers to Project ......................................................................................................................... 9
Enter FactoryTalk View HMI Information ................................................................................................ 9
Save Project ..............................................................................................................................................10
Context Sensitive Popup Menus ................................................................................................................11

Quick Start – Process Tree Organizer .......................................................................................................12

Adding Folders .........................................................................................................................................12
Using Logix Controller Organizer Tree ...................................................................................................13
Adding Tags .........................................................................................................................................13
Removing Tags ....................................................................................................................................14
Adding Routine ....................................................................................................................................14
Adding Program Routines ....................................................................................................................15
Removing Routine from Process Tree .................................................................................................16
Using Logix Logical Organizer Tree ........................................................................................................16
Adding Individual Organizer Folder or Program .................................................................................17
Adding the Entire Logical Model ........................................................................................................18
Merging Folders ...................................................................................................................................18
Importing Alarm Groups Structure from AE Server .................................................................................19
Importing Organizer Folders from Previous Alarm Builder Versions .....................................................20
Adding Process Tree Folder Tags using Search Filters ...........................................................................20
Adding Controller Tags Not Currently in Process Tree Folders ..............................................................21
Add HMI Displays ....................................................................................................................................22
Re-organizing Process Tree Folders and Components ............................................................................24

Quick Start – Tag Data Editing, Import, Export ......................................................................................25

Edit Individual Tags .................................................................................................................................26
Edit / Export Multiple Tags ......................................................................................................................27
Import Tag Data from Tab Delimited Text Files ......................................................................................30
Search and Edit Tags ................................................................................................................................32

4
Saving Changes to Controller ACD File ..................................................................................................33
Export Tags to Excel (32-bit) Workbook for OPC Read/Write .................................................................34

Quick Start – AE Import File Builder Tool ..............................................................................................36

Create HMI Alarm Server Organizer .......................................................................................................36
Create AE XML Import File .....................................................................................................................38
(Optional) Organize Logix Tags and HMI Displays ...........................................................................38
Appending New AE Tags or Updating Existing AE Tags ...................................................................38
Using the AE XML Import File Builder Tool......................................................................................40

Quick Start – ME Import File Builder Tool..............................................................................................41

Create HMI Alarm Server Organizer .......................................................................................................41
Create ME Alarms XML Import File ........................................................................................................43
(Optional) Organize Logix Tags and HMI Displays ...........................................................................43
Appending New ME Tags or Updating Existing ME Tags ..................................................................43
Using the ME XML Import File Builder Tool .....................................................................................44

Quick Start – Import and Export Tools for SILAlarm ............................................................................46

SILAlarm Functions ..................................................................................................................................48

Quick Start – PI Asset Framework (AF) Database Configuration .........................................................49

Setup .........................................................................................................................................................49
Information ...............................................................................................................................................53
Build .........................................................................................................................................................54

Quick Start - Create PI Points using Import File or PI Data Server ......................................................56
Setup .........................................................................................................................................................56
Information ...............................................................................................................................................59
Build .........................................................................................................................................................60

Quick Start – SE Tag Search and Navigation Tree Tools ........................................................................61

Tag List Parameter Files ..........................................................................................................................61
Process Tree Parameter Files ..................................................................................................................63
Using the Configuration Parameter Files in FactoryTalk View SE Displays ..........................................63
“_SearchTags.GFX” File .....................................................................................................................63
“_NavigationTree.GFX” File ...............................................................................................................64

Quick Start – Miscellaneous Logix Tools ..................................................................................................66

AOI Definitions Export Tools ...................................................................................................................66
AOI Definitions L5X Files Import Tool ....................................................................................................67
Controller XML Search Tool ....................................................................................................................69
Routines and Programs Bulk Export to L5X Files ....................................................................................72

5
Appendix A. Microsoft Windows Access Violation ............................................................................77

Appendix B. Alarm Data Type Definitions .........................................................................................81

Appendix C. Define Tag Description Format .....................................................................................83

Example 1 ............................................................................................................................................85
Example 2 ............................................................................................................................................86

6
Software Overview
The PlantPAx Configuration Tools for Tags, Alarms, and Historian (PAX_Config)
provide the following functions:

1. Define a project containing multiple controller ACD files and associated

FactoryTalk View HMI applications.
2. Organize Logix code, Logix tags, and FTView SE HMI displays in a Process Tree
organizer. The tree structure can be used in creating AE alarm groups and Asset
Framework elements structure.
3. Tag Data Editing, Import, Export:
a. Edit Logix tag data in off-line controller ACD files.
b. Export and import Logix tag data to/from text files.
c. Create Microsoft Excel workbook for online OPC tag data read/writes.
4. Create AE XML import files using tag data from controller files.
5. Create ME XML import files using tag data from controller files.
6. Import and export functions for SILAlarm alarm rationalization software.
SILAlarm is developed by exida, L.L.C., a Rockwell Automation Encompass
Partner.
7. Bulk configuration of OSI PI Asset Framework (AF) databases with Logix tag AF
elements. This includes automatic configuration of related PI points in the
FactoryTalk Historian (FTH) data server (i.e., PI data server).
8. For systems without AF, a separate tool is provided for bulk configuration of PI
points in the FTH data server. The tool provides the option of generating a bulk
import file, or adding the PI points directly if a FTH data server connection is
available. The bulk import file can be used with the PI Point Builder Excel AddIn
to create points in the data server.
9. Two tools are provided for building specially formatted FactoryTalk View SE
parameter files. These parameters files are used with SE graphic files for tag
search or navigation tree displays. One tool is used for building a parameter file
containing a list of controller tags with associated HMI faceplate displays. Users
can search for tags using tag names and tag descriptions. The user can open tag
faceplates from the returned search results. The other tool is used for creating a
navigation tree from the project Process Tree structure.

This document provides abbreviated, or “quick start” instructions to the above functions.
Refer to the user manuals for detailed instructions and explanations.

New users should read the “Create Project” quick start. The other quick start sections can
be read independently. It is assumed that a project has been loaded in these other quick
start sections. Tip: Use the Adobe Reader’s Bookmarks feature to navigate this
document and all user manuals.

7
Supported Software
RSLogix 5000 or Studio 5000 Logix Designer must be installed. This software uses
Logix Services for accessing information in controller ACD files. RSLogix 5000 or
Studio 5000 versions 16 to 31 are supported.

FactoryTalk View Studio Version 5 or higher. View Studio does not need be installed for
this software to function.

FactoryTalk Historian Version 5.01 and newer must be installed to use the historian
configuration tools.

PlantPAx Configuration Tools has been tested in Microsoft Windows 7.

8
Quick Start – Create Project
Add Controllers to Project
Right-mouse click on the “Logix Controllers” tree node and add controller file to project.
Each project can contain multiple controllers. Repeat to add additional controllers.

Note that you are prompted for the Logix description format when a controller is added.
The format is used for parsing the RSLogix 5000 tag description into field values (e.g.,
tag label, tag description, tag engineering unit, etc.). Refer to Appendix C for details.

Refer to Appendix A if a Windows 7 Access Violation error message appears.

Enter FactoryTalk View HMI Information

FactoryTalk View HMI information for the controllers are required if you are using the
AE or ME alarm builder tools.

Right-mouse click on the controller and select the following popup menu items:

9
Repeat for each controller in the project.

Tip: If you are entering HMI information for more than one controller and
the controllers are in the same HMI application, it may be easier to copy
the HMI information from one controller and paste it to the other
controllers:

1. Right-mouse click on the controller with HMI information to copy and

select the “Copy HMI Information…” popup menu item.

2. Right-mouse click on the controller you want to configure, and select

the “Manually Enter HMI Information…” sub-menu popup item.

3. Click the button in the HMI information

entry form.
4. Enter the device shortcut name and click OK.

Save Project
The “Save Project” toolbar icon is enabled when changes have been made.

10
Note that the project file has file extension “lvu”.

Context Sensitive Popup Menus

Almost all the program functions are lauched from popup menus. Right-mouse click on a
tree branch in the project tree to display the available functions for that tree node.

11
Quick Start – Process Tree Organizer
The Process Tree can be used for organizing Logix code, tags, and HMI displays using
user-defined folders. The Process Tree structure is used as the Alarm Groups structure
when building the AE XML import file (refer to the “Create Alarm Import Files” user
manual). The structure is also used for organizing alarms when building the SILAlarm
import file (refer to the “exida SILAlarm Import and Export Files” user manual).

Adding Folders
1. Click on the “Process Tree” tab.

2. Right-mouse click on an empty area in the Process Tree tab to add a root-level
folder. (The empty area must be below any existing Process Tree folders. Using
the empty area to the right of existing folders will add it to the nearest folder.)

3. Right-mouse click on an existing folder to add a child folder.

12
Using Logix Controller Organizer Tree
Routines and tags from the Logix Controller Organizer tree can be added to the process
tree:

1. Select the “Controllers & HMI” tab.

2. Double-click on a controller to open the controller in a child window.

3. Click on the “Controller Organizer” tab in the controller child window.

Adding Tags

1. Drag a tag from the controller tree and drop it to a process tree folder.

2. The controller tree “Tags” folders can also be dragged-and-dropped to the process
tree.

A tags selection window appears after that “Tags” folder is dropped. The window
contains the tags from the “Tags” folder.

13
Removing Tags

Right-mouse click on the tag and select “Remove Tag” to remove a single tag from the
process tree.

Right-mouse click on the “Tags” folder and click “Remove Selected Tags” to open a
dialog window for selecting tags to remove.

Adding Routine

Drag a routine from the controller organizer tree and drop it on a process tree folder.

14
The routine and associated tags are added to the process tree folder. The software
uses LogixServices to export the routine to determine the tags referenced by the
routine. It may take a few minutes for the export/import (the first time takes
additional time for connecting to LogixServices).

Adding Program Routines

Drag a program from the controller organizer tree and drop it on a process tree folder.

A dialog window appears prompting to add only tags referenced by the program
or routines and associated tags.

15
Removing Routine from Process Tree

Right-mouse click on the code in the process tree and click on the “Remove Code” popup
menu item. This removes the code node from the “Logix Code” folder and all associated
tags from the “Tags” folder. This does not remove the code from the controller ACD file.

Using Logix Logical Organizer Tree

If the controller ACD file is Studio 5000 Designer Version 24 or higher, then the
controller window has two tabs, “Controller Organizer” and “Logical Organizer”;
otherwise, it will only have the “Controller Organizer” tab.

The “Logical Organizer” is used in Studio 5000 Designer for organizing controller
programs in user-defined folders. The programs and folders from the Logical Organizer
can be added to the Process Tree.

1. Double-click on a controller in the “Controllers & HMI” tab to open the controller
in a child window.

16
2. Click on the “Logical Organizer” tab.

Adding Individual Organizer Folder or Program

Drag a Logical Organizer folder or program and drop it on an existing Process Tree
folder to automatically create a new child folder. The new child folder’s name is set to
the folder/program being dropped. Drop it on the blank area in the Process Tree tab to
create a new root level folder (the blank area must be below existing Process Tree
folders). All the child folders and child programs from Logical Organizer source are also
added. All the routines in each Logical Organizer program are also added. (Note that the
Process Tree organizes code based on routines, not programs.)

17
Adding the Entire Logical Model

Drag the top Logical Model folder and drop it to an existing Process Tree folder or to a
Process Tree blank area to add the entire Logical Organizer tree. Since the Logical
Organizer contains all the controller programs, adding the entire tree can be time
consuming if the controller contains many routines (the software uses LogixServices to
export/import every routine).

When dropping the entire Logical Organizer, the software creates the following in the
Process Tree:

 A folder with the controller name.

 A “Logical Organizer” sub-folder under the controller folder.
 Sub-folders under the “Logical Organizer” folder for all the folders and programs
from the Logix Logical Organizer.

Merging Folders

Folders with the same display name can be merged by drag-and-drop. For example, the
following two process tree nodes were created by adding the Logical Organizer from two
controller files:

18
The two Logical Organizer folders can be merged by dropping the Logical Organizer
from one folder and dropping it on the Logical Organizer in the other folder. All child
folder contents with the same display names are also automatically merged. This allows
contents from controllers with the same Logical structure be merged without having to
drag-and-drop of each individual folder.

Importing Alarm Groups Structure from AE Server

AE alarms can be organized into alarm groups in FactoryTalk View SE version 8.1 and
higher. The AE alarm group structure can be imported into the Process Tree. The AE
alarms are organized as Logix tags rather than individual alarm elements.

1. Use FactoryTalk View Studio 8.1 or higher to export an AE server containing

alarm groups to a XML file. Include all AE tags in the export file. Refer to
FactoryTalk View Studio for export instructions.

2. Create an AE server organizer in the Alarm Builder project. (Refer to the “Create
Alarm Import Files” user manual.)

3. Click on the AE server tree node

4. Select the XML file export from FactoryTalk View Studio in Step 1.

If the process tree already contains a root folder with the same name as an alarm group
root folder, then the alarm group folder and all its child folders are automatically merged

19
with the existing process tree folder. Any child folders with the same names are also
merged.

Importing Organizer Folders from Previous Alarm Builder

Versions
If the custom builder method was used to create the AE XML import file from Alarm
Builder version 5.4 and older, then the organizer folders configured in the custom build
method can be imported into the Process Tree.

1. Load the Alarm Builder project created from previous versions.

2. Right-mouse click on the AE server tree node and click on the “Import Alarm
Builder Organizer Folders to Process Tree” pop-up menu item. The menu item is
enabled only if the Process Tree does not contain any folders and the AE server is
configured with organizer folders.

Adding Process Tree Folder Tags using Search Filters

1. Right-mouse click on a Process Tree folder and click on the “Add Tags” popup
menu item.

2. Use the “Search Tags” dialog window to select tags using filters based on
controller, data type, tag names, and tag descriptions.

20
Adding Controller Tags Not Currently in Process Tree Folders
Do the following to list the alarm tags in an AE server’s controllers list that are not in
process tree folders:

1. Create an AE server organizer in the Alarm Builder project. (See “Create HMI
Alarm Server Organizer”, page 36)

2. Right-mouse click on the AE server and click on the “List Alarm Tags Not in
Process Tree” pop-up menu item. This opens a child window containing the tags.

21
Alarm tags are Logix tags that have Alarm Builder alarm definitions (refer to the Alarm
Definitions Builder Tool for creating Logix data type alarm definitions).

3. Tags in the list can be selected and added to process tree folders by drag-and-
drop. Click on any row, hold down the left mouse button, drag, and then release
the left mouse button over the target process folder (or target Tags folder).

NOTE: it is NOT required that tags be organized in process tree folders to use the AE
XML Import File Builder Tool or the SILAlarm Import File Builder Tool.

Add HMI Displays

FactoryTalk View SE HMI displays can also be organized under process tree folders.
The AE XML Import File Builder Tool has an option to incorporate HMI display launch
in the AE tag’s FactoryTalk View command configuration (refer to the “Create Alarm
Import Files” user manual).

Do the following to add HMI displays to process tree folders:

1. Right-mouse click on the “Logix Controllers” tree node in the “Controllers &
HMI” tab, and click on the “Open FactoryTalk View SE Displays List…” popup
menu item. (This menu item is enabled only if the project contains one or more
FactoryTalk View application associated with the controllers.)

22
2. Click on the “Process Tree” tab.

3. Drag a display file from the SE display files window and drop it to a Process Tree
folder.

After drag-and-drop:

23
All the tags in the “Pumps” process tree folder are associated with the “Mos_MainLine1”
HMI display.

Re-organizing Process Tree Folders and Components

Process tree folders, tags, Logix code, and HMI displays can be reorganized by drag-and-
drop.

For example: drag-and-drop the “L1_FeedTankB” folder over the “L1_FeedTanks”

folder.

After drag-and-drop:

A child folder that is dragged-and-dropped to the white area below the

lowest folder becomes a root-level folder.

Note that when dragging-and-dropping Logix Code, the tags referenced by the code are
automatically added to the target folder. Also, make sure to drop the Logix Code on a
process tree folder, not a “Logix Code” folder.

24
Quick Start – Tag Data Editing, Import, Export
The software includes tools for editing tag descriptions and tag data:

1. Edit single tag data or multiple tag data using child windows. Tag elements to edit
can be filtered.

2. Export selected tags into text files. Use text editors, such as Microsoft Excel, to edit
the tag data values. The updated text files can be imported back into the controller
files.

3. Convert tag data text files to a file format used by the Rockwell Automation Tag
Upload Download Tool. This tool is used for downloading data to a running Logix
controller using OPC. The tool is provided with RSLogix 5000.

4. Export Logix tags to a Microsoft Excel (32-bit version) workbook. The workbook
uses VBA code for reading or writing to an online controller via OPC.

5. Search tags. Tags can be searched from a single controller or from all project
controllers. The search results are opened in a tag data editing window.

25
Edit Individual Tags
1. Load the controller to edit in a child window. The controller child window can be
opened by double-clicking on the controller tree node, or by right mouse clicking on
the controller tree node and using the popup menu item:

2. Expand the “Controller Scoped Tags” folder or the “Program Scoped Tags” folder
containing the tag to edit.

3. Click on the tag to edit in the Logix project tree, then right-mouse click to display the
popup menu. Select the “Edit Tag Data” menu item to open the tag editor window..
The editor window can also be opened by double-clicking on the tag tree node.

A tag editor window appears on the right portion of the main window.

Note: Double-clicking on a tag in the Process Tree will also open the tag editor window.
Refer to the “Process Tree Organizer” user manual for details.

26
For non-atomic data types, use the button to configure the data type
elements to edit. The data type elements are grouped into user-defined filters. The
element values in the selected filter are listed in the middle table.

The bottom table is used for editing the Logix tag description. The tag description is
parsed into fields based on the Logix description format definition. The field definitions
are configured when the controller is added to the project. Refer to Appendix C for
details.

Edit / Export Multiple Tags

Load the controller to edit in a child window. The controller child window can be
opened by double-clicking on the controller tree node, or by right mouse clicking on the
controller tree node and using the popup menu item:

27
Use the “Edit / Export Multiple Tags” popup menu item from the Logix tree. The popup
menu is available on different tree nodes in the Logix tree. The tags available depend on
the tree node:

1. Controller tree node – all tags in the controller.

2. Task tree node – all tags in the task.
3. Program tree node – all tags in the program.

Note: The “Tags” folders in the Process Tree also have an “Edit / Export Tag Data” pop-
up menu item for editing tags. Refer to the “Process Tree Organizer” user manual.

28
Note: The Edit/Export Tag Data window can also launched by right-mouse clicking on
the controller tree node and using the “Edit / Export Controller Tags” pop-up menu item.
All tags in the controller are used.

Tags in the tag data window are displayed based on data types and data type element
filters. Click the button to add/edit data types and filters. If you don’t
see the data type you want to edit in the in the drop-down list box, then click Edit to add

29
in the data type. The data type would also not be shown in the drop-down list box if the
input tags do not contain any tag of that data type.

Change tag values by typing in the table cells. Tag values can also be copied-and-pasted
winthin the table or between Windows applications using hot keys (Ctrl+C, Ctrl+V) or
right-click on cells for menu pop-ups. Cells from multiple columns and rows can be
copied-and-pasted.

Use the Commands drop-down list for export commands.

Exported tab delimited text files can be edited using Microsoft Excel. Tag values from
the delimited text files can be imported back to the controller ACD files – see next
section.

Import Tag Data from Tab Delimited Text Files

As described in the last section, tag data can be exported into tab delimited text files. The
text file can be edited using Microsoft Excel or other text editors. To import tag values
from the delimited text files:

1. Open a controller in a child window. (The text file contains data from one controller.
Separate data files are used for separate controllers.)

2. Right-mouse click on the top controller folder and select “Import Tag Data”.

30
3. Click to select the data text file.

4. Click to import the tag values to the project.

5. Save the project to update the controller ACD files with the imported tag data.

31
Search and Edit Tags
Right-mouse click on the “Logix Controller” tree node in the proejct tree and click
“Search and Edit Tags” to search all controllers or to select a particular controller from
the search window.

32
The search window can also be launched by right-mouse clicking on the top controller
folder in a Logix tree to search tags in that controller.

Use the upper-left portion of the search window to define the filter criteria.

Filter results are listed in the upper-right table.

Selected filter results can be added to the bottom table. This allows you to run multiple
filters and store the cumulative results in the bottom table. Click OK when completed.
The tags in the bottom table are opened in the Edit/Export Multiple Tags window.

Note that if tags from multiple controllers are found, then a separate tag data editing
window is opened for each of the controllers.

Saving Changes to Controller ACD File

The “Save Project” icon is enabled if tag data changes have been made and saved in the
tag data editor windows. Save the project to save the changes to the controller ACD file.

33
Export Tags to Excel (32-bit) Workbook for OPC Read/Write
The tag data editing, export, and import discussed above operates on off-line controller
files. Controller tags can be exported to an Excel (32-bit versions) workbook for on-line
read/write:

1. Right-mouse click on a controller in the project controllers tree or on the top

controller folder in a Logix tree and select the “Export Tags to Excel OPC
Read/Write Workbook…” menu item.

34
2. Controller tags with data types that have been configured with data type element
filters are exported. These filter definitions are the same ones used in the tag data
editing windows. Click the “Edit” button to add/delete/edit the data types and data
type filters.
3. By default all controller tags with data type filter are exported – this option is shown
as “All” in the Filters drop down list box. Use the “Edit Export Filters” button to
create subsets of data types and data type elements to export.
4. Click the “Save As” button to specify the Excel file name.
5. Click “Export” to create the Excel workbook. It may take a few minutes for the
Export. The Excel workbook is opened when completed.

The controller tags are added to separate worksheets based on data types. The tag
worksheets have green color tabs. If the “Create Separate Worksheets for each Data
Tupe Element Filter” box was checked in the export window, then a separate worksheet
is created for each filter definition (for example, “P_AIn”, “P_AIn_1”, … in the above
screen captore). If the box is not checked, then all the data elements are combined into
the same worksheet.

The “Setup” worksheet contains information used by the Excel workbook’s VBA code
for executing the OPC read/write functions.

Each tag worksheet contains two macros for running the OPC tag read and write for that
worksheet.

35
Quick Start – AE Import File Builder Tool
The software creates AE XML import files that can be imported to a FactoryTalk AE
server. AE tags are created for Logix tags with alarm data type definitions. Alarm
definitions are user configurable. Alarm definitions for the PlantPAx Process Library
Version 3 AOIs have been preconfigured and supplied with the software. Refer to
Appendix B for instructions on configuring alarm definitions.

Create HMI Alarm Server Organizer

1. Multiple AE alarm servers can be used in FactoryTalk applications. Each AE alarm

server can provide alarms from multiple Logix controllers. The project can contain
multiple controllers. Select the controllers to use for each AE alarm server XML
import file you want to create. Right-mouse click on “HMI Alarm Servers” and “Add
Alarm Server”:

2. Enter alarm server name and description. It is recommended that the FactoryTalk AE
server name be used.

36
The software does not have the capability of accessing the FactoryTalk
AE server. The alarm server created here is merely used for organizing
the controllers associated with the server. Any name can be used.
However, it is recommended to use the actual AE server name to avoid
confusion.

3. Select the controllers to associate with the alarm server. Only Logix tags from the
selected controllers will be used.

The alarm server and associated controllers are added to the project tree.

37
Create AE XML Import File
(Optional) Organize Logix Tags and HMI Displays

Use the Process Tree tab to organize Logix tags and HMI displays in user-defined folders
before building the AE XML import file. Refer to the “Process Tree Organizer” user
manual for instructions. The tree structure is used in the AE XML import file builder
tool:

1. For FactoryTalk View Version 8.1 and newer, the process tree folders are used as AE
alarm groups.

2. For FactoryTalk View Version 8.0 and older, the process tree folder full path display
name is added to the AE tag’s “Alarm Class” configuration. This allows the user to
filter alarms using the folder names in “Alarm Class”.

Note that it is not required to organize Logix tags in the Process Tree to use the AE XML
Import File Builder. For tags not organized in Process Tree folders, the Logix tag’s
owner name (ControllerName.ProgramName) is automatically used for alarm grouping
and in the alarm class configuration.

If HMI displays are organized in Process Tree folders and the AE Import File Builder
option to include a display macro command is enabled, then macro commands are added
to the AE tag’s FactoryTalk View Command.

Appending New AE Tags or Updating Existing AE Tags

The AE XML Import File Builder Tool allows you to append new tags or update an
existing AE tag database. You must do the following before running the AE import file
builder tool:

1. Use FactoryTalk View Studio to export all tags and all messages from the AE
database to a XML file. Refer to FactoryTalk View Studio documentation for
instructions on exporting the AE database to a XML file.

2. If you are using FactoryTalk View Version 8.1 or newer and want to keep the
existing AE database alarm groups configuration, then do the following:

a. Right-mouse click on the AE alarm server in the “Controllers & HMI” tab
and select the “Import Alarm Groups to Process Tree” menu item.

38
b. Select the AE XML file you exported from Step 1. Refer to the “Process
Tree Organzier” user manual for details.
c. Make any changes to the Process Tree folders as desired.

3. Run the AE XML XML Import File Builder Tool (see next section for
instructions).

4. Use the AE XML file you exported in Step 1 when selecting the XML file to use
with the tool. Select on the “Append…” option.

5. Use FactoryTalk View Studio “Alarm Import Export Wizard” to import the
updated AE XML file after running the tool. Make sure to select the first option
(Update existing alarm definitions and create new alarm definitions from the
import file) or the third option (Delete all existing alarm definitions and then
create new alarm definitions from the import file) when importing.

39
Using the AE XML Import File Builder Tool

Right mouse click on the alarm server node and click the “Build FactoryTalk A&E
Alarms XML Import File” popup menu.

The “OK” button is enabled after an AE XML import file name has been selected. Click
OK to build the import file. Use FactoryTalk View Studio to import the XML file to the
AE tag database.

40
Quick Start – ME Import File Builder Tool
The software creates ME XML import files that can be imported to a FactoryTalk ME
application. ME alarms tags are created for Logix tags with alarm data type definitions.
Alarm definitions are user configurable. Alarm definitions for the PlantPAx Process
Library Version 3 AOIs have been preconfigured and supplied with the software. Refer
to Appendix B for instructions on configuring alarm definitions.

Create HMI Alarm Server Organizer

1. The project can contain multiple controllers. The controllers can be associated with a
FactoryTalk View SE or ME application. Select the controllers to use for each alarm
server XML import file you want to create. Right-mouse click on “HMI Alarm
Servers” and “Add Alarm Server”:

2. Enter alarm server name and description.

The software does not have the capability of accessing the FactoryTalk
ME application. The alarm server created here is merely used for
organizing the controllers associated with the server. Any name can be
used.

41
3. Select the controllers to associate with the alarm server. Only Logix tags from the
selected controller will be used.

The alarm server and associated controllers are added to the project tree.

If the project has controllers that are used with both SE and ME
applications and you want to create AE and ME alarm files using the
same controllers, then you have to create separate projects. One project
with the controllers associated with the SE application, and the other
project with the controllers associated with the ME application. The
software currently does not support associating a controller to more than
one HMI application.

42
Create ME Alarms XML Import File
(Optional) Organize Logix Tags and HMI Displays

Use the Process Tree tab to organize Logix tags in user-defined folders before building
the ME XML import file. Refer to the “Process Tree Organizer” user manual for
instructions. The alarm file builder tool provides an option to use only the tags in the
process tree folders when building the ME XML import file. The other option is to use
all tags in all the controllers in the HMI alarm server organizer.

Appending New ME Tags or Updating Existing ME Tags

The ME XML Import File Builder Tool allows you to append new tags or update an
existing ME tag database. You must do the following before running the ME import file
builder tool:

1. Use FactoryTalk View Studio to export all alarm triggers and all messages from
the ME database to a XML file. Refer to FactoryTalk View Studio
documentation for instructions on exporting ME AE database to a XML file.

2. Run the ME XML XML Import File Builder Tool (see next section for
instructions).

3. Use the ME XML file you exported in Step 1 when selecting the XML file to use
with the tool. Select on the “Append…” option.

4. Use FactoryTalk View Studio “Alarm Import Export Wizard” to import the
updated ME XML file after running the tool.

43
Using the ME XML Import File Builder Tool

Right mouse click on the alarm server node and click the “Build FactoryTalk A&E
Alarms XML Import File” popup menu.

44
The “OK” button is enabled after an ME XML import file name has been selected. Click
OK to build the import file. Use FactoryTalk View Studio to import the XML file to the
ME tag database.

45
Quick Start – Import and Export Tools for SILAlarm
Alarm rationalization is the process of finding the minimum set of alarms that are needed
to keep the process safe and in the normal operating range. Rationalization entails
reviewing potential or existing alarms to justify that they meet the criteria for being an
alarm. It includes defining and documenting the design attributes (such as priority, limit,
type and classification) as well the cause, consequence, time to respond, and
recommended operator response. Rationalization is a critical activity in the alarm
management lifecycle. When executed properly it has proven successful at knocking
down “bad actors” and reducing the number of alarms presented to the operator.

SILAlarm is a tool for facilitating and recording the results of alarm rationalization in a
Master Alarm Database. SILAlarm guides an alarm rationalization team through the
alarm review and justification process for new or existing facilities. It supports
configuration management of the Master Alarm Database and acts as an audit trail for
ongoing alarm system maintenance and changes. SILAlarm is a software product of
exida L.L.C. – a Rockwell Automation Encompass Partner.

SILAlarm has been developed in accordance with the ISA-18.2 standard “Management of
Alarm Systems for the Process Industries” and the EEMUA Publication No. 191: “Alarm
Systems – A Guide to Design, Management and Procurement”. exida’s personnel are
heavily involved with the development of these key industry standards and guidelines for
alarm management.

SILAlarm provides import tools used for populating the Master Alarm Database using
DCS configuration information. The import is also used for comparing and auditing DCS
configuration with rationalization results after the Master Alarm Database has been
populated.

SILAlarm also provides export tools for exporting the rationalization results into various
file formats. The export file can be used for configuring the alarm parameters in the DCS
tags.

The PlantPAx Alarm Builder Tool provides the following functions to support SILAlarm
import and export files:

1. Generate SILAlarm import files containing relevant Logix tag data. The import
file is used for populating the SILAlarm Master Alarm Database with PlantPAx
DCS configuration information. It is also used for comparing and auditing the
Logix controller configuration with rationalization results.

46
2. Import SILAlarm rationalization results to update offline Logix controller tag
configuration.

3. Import SILAlarm rationalization results to update online Logix controller tag

configuration using RSLinx Classic OPC/DA.

4. Import SILAlarm rationalization results to update AE tag configuration for the

Alarm Class parameter and FTView command parameter. The FTView
command is configured to open the SILAlarm operator response display.

The SILAlarm database contains a large number of parameters. Many of these

parameters are not relevant for the PlantPAx DCS. The SILAlarm parameters that will
be used in the PlantPAx import/export files are defined using data type definitions. The
Alarm Builder Data Type Definition Tool provides a user-interface for configuring
SILAlarm definitions and FactoryTalk View HMI alarm definitions.

The SILAlarm rationalization results also include operator response instructions. These
instructions can be launched from FactoryTalk View SE alarm faceplates. For example:

47
SILAlarm Functions

The SILAlarm functions are launched from a popup menu by right-mouse clicking on the
“Logix Controllers” node in the project tree:

Refer to the “SIlAlarm Import/Export Functions” user manual for instructions.

48
Quick Start – PI Asset Framework (AF) Database
Configuration
A configuration tool is provided for the bulk configuration of OSI PI Asset Framework
(AF) databases with Logix tag AF elements. This includes automatic configuration of
related PI points in the FactoryTalk Historian (FTH) data server (i.e., PI data server).

An OSI PI client must be installed to add Logix elements to AF databases. Refer to OSI
PI documentation for instructions. If Excel and PI Builder Add-In is installed, then one
way to check that the PI client is properly installed and connected to the server is to open
Excel and click on the PI Builder tab. It should show the PI servers and database
connections available on the Excel toolbar.

Setup
1. Right-mouse click on the project historian server tree node and select “Import to
Asset Framework (AF) Database”:

49
2. Click the “Connect” button.

Select the servers and AF database to use and click OK. The login Windows user
must have administrative rights to the PI server and AF server.

50
3. The server names and AF database name appears on the Setup tab if the
connection is successful.

4. As part of the build process, PI points associated with the AF Logix elements are
automatically added to the PI data server. Click the PI Point Builder Options to
review the options.

If tags from different controllers have the same tag name, then make sure to check
the box for “Include the controller name”.

5. Controller tags are selected for addition to the AF database and PI data server
based on data types. Tags with data types configured with historian builder
definitions are included. Click the “Definitions” button to review the data type
configuration.

51
6. Since PlantPAx Process Library V3.x AOIs and V4.x AOIs can have the same
AOI names containing different AOI parameter names, separate sets of historian
library definitions and templates are used. Select the library version using the
drop-down list box:

7. Use the “PlantPAx Elements to Import to AF Database” drop-down box to select

the project elements to use.

a. “ControllerLogicalOrganizer”. For controllers V24 and newer, the logical

organizer structure and tags are used. For versions older than V24, the
controller structure is used.

b. “ProcessTree”. The contents of the project Process Tree are used. Refer to
the “Process Tree Organizer” user manual for configuration instructions.

c. “ControllerTagsInFlatStructure”. All the tags from the historian controllers

list are added to the AF database as root elements.

The “PlantPAx Elements to Import to AF Database” tree in the Information 

Elements tab is updated when the selection is changed. The

52
Information
The Information tab provides information of the library components that are added to the
AF database and PI data server on import. The user can proceed to the Build tab (i.e., the
user does not have to select anything in the Information tabs), or continue with this
section to review the information provided.

The import tool adds or updates the following AF database library components during the
build process:

1. AF database enumeration sets.

2. AF database library element templates and event frame templates.
3. AF database library analysis, attribute, and element categories with library
components.

The AF database are updated with the software’s AF library components. Preconfigured
AF library components for PlantPAx Process Library AOIs are included with the
software.

The import tool also adds or updates the PI data server digital state sets during the import
process. Preconfigured digital state sets are included with the software for Process
Library AOIs.

53
Build

Click the Build button to add the Logix elements to the connected AF database. PI points
referenced by the AF elements are automatically added to the PI data server. As noted
previously, the AF element templates, categories, enumerations, and PI digital state sets
are also added.

54
You can verify that the new elements and components have been added to the AF
database using PI System Explorer. Note that you may need to refresh the database for
the new elements to appear:

55
Quick Start - Create PI Points using Import File or PI
Data Server
For systems without AF, a separate tool is provided for bulk configuration of PI points in
the FTH data server. The tool provides the option of generating a bulk import file, or
adding the PI points directly if a FTH data server connection is available. The bulk
import file can be used with the PI Point Builder Excel AddIn to create points in the data
server.

Setup
1. Right-mouse click on the project historian server tree node and select “Build PI
Points or Import File”:

56
2. Select the Build Option to create a import file or add PI points directly to a FTH
Data Server. An OSI PI client must be installed to add PI points directly. Refer
to OSI PI documentation for instructions.

3. If the “Build PI Points in FTH Data Server” option is selected, then use the drop-
downl list box to select the data server and click Connect.

57
4. As part of the build process, PI points associated with the AF Logix elements are
automatically added to the PI data server. Click the PI Point Builder Options to
review the options.

If tags from different controllers have the same tag name, then make sure to check
the box for “Include the controller name”.

5. Controller tags are selected for addition to the AF database and PI data server
based on data types. Tags with data types configured with historian builder
definitions are included. Click the “Definitions” button to review the data type
configuration.

58
6. Since PlantPAx Process Library V3.x AOIs and V4.x AOIs can have the same
AOI names containing different AOI parameter names, separate sets of historian
library definitions and templates are used. Select the library version using the
drop-down list box:

7. Use the “PlantPAx Elements to use for PI Points” drop-down box to select the
project elements to use.

a. “ControllerLogicalOrganizer”. All the tags from the historian controllers list

are added (same as ControllerTagsInFlatStructure option).

b. “ProcessTree”. The contents of the project Process Tree are used. Refer to
the “Process Tree Organizer” user manual for configuration instructions.

c. “ControllerTagsInFlatStructure”. All the tags from the historian controllers

list are added (same as ControllerLogicalOrganizer option).

Information
If the “Build PI Points in FTH Data Server” setup option is selected, then the build
process will automatically add or update the PI data server digital state sets during the
import process. Preconfigured digital state sets are included with the software for
Process Library AOIs.

59
Build
Click the Build button to create the import file or add PI points to the PI data server.

If the build import file setup option was selected, then a text file with PI points
configuration generated. Use PI Builder Excel add-in to import the points to the PI data
server.

If the PI points in FTH data server setup option was selected, then the build function
updates the connected data server with library digital states sets and PI points.

60
Quick Start – SE Tag Search and Navigation Tree Tools
Two tools are provided for building special FactoryTalk View SE parameter files. These
parameters files are used with SE graphic files for tag search or navigation tree displays.

Tag List Parameter Files

Tag list parameter files contains tags from the project controllers that have associated SE
HMI faceplate displays. The file can be used in a SE tag search display. For example,
enter “AI_” as the search string returns all tags containing “AI_” in the tag name or tag
description. Double-clicking on the AI_173 list item opens the associated faceplate
display:

61
The tag list parameter file can also be used with a SE navigation tree display. The tags
are organized under the associated programs. Clicking on a tag node launches the tag
faceplate display.

62
Process Tree Parameter Files

The process tree can be used for organizing tags and HMI process displays based on user-
defined folder structure. The process tree can be displayed as a navigation tree SE
display. Clicking on a tree node opens the corresponding tag HMI faceplate or process
display.

Using the Configuration Parameter Files in FactoryTalk View SE

Displays

Previous sections demonstrated how to create navigation tree parameter files. Two
sample FactoryTalk View SE display files are included with the software for using the
files. Sample SE files are in the “Sample_SE_Files” folder in the program’s installation
directory.

“_SearchTags.GFX” File

Use the “_SearchTags.gfx” file to allow the user to enter a search string. The tree node
descriptions in the navigation tree parameter file are searched. The results are displayed
in a list box. Double-clicking on an item in the results list box executes the command
associated with that tree node.

63
For example, configure the release action of a SE button object to open the display by
passing it the navigation tree parameter file.

“_NavigationTree.GFX” File

Use the “_NavigationTree.gfx” file to display the contents of the navigation tree
parameter file in a tree structure. For example, configure the release action of a SE
button object to open the display by passing it the navigation tree parameter file created
in the previous two sections.

Example of the navigation tree display in SE client. Click on a tree branch executes the
command configured for that branch (opening HMI display, tag faceplate and/or trend
display).

64
The “_NavigationTree” display file uses the “LogixViewOCX” ActiveX control for
displaying the contents in the tree structure. The ActiveX control also has click events so
that when the user clicks on a tree node, the click event executes the SE command
configured for that tree node. The control is included with the software package. Refer
to the help file for details:

65
Quick Start – Miscellaneous Logix Tools

AOI Definitions Export Tools

Double-click on the controller under the “Logix Controllers” project tree to open the
controller in a child window:

Right-mouse click on the “Add-On Instructions” folder to run the four export tools:

66
The parameters list text file export tools export the selected AOIs to a tab-delimited text
file. The text file contains a listing of the AOI parameters and local tags and includes the
usage, data type, description, and external access.

The revision information text file export tool exports the selected AOIs to a tab-delimited
text file with the AOI revision, revision extension, created date, created by, edited date,
and edited by information. Example:

The “Export Selected AOIs to L5X files” tool allows the export of multiple AOIs to
individual L5X files. The L5X files can be imported into a controller ACD file using
Studio 5000 Logix Designer or imported using AOI definitions bulk import tool (see next
section)

AOI Definitions L5X Files Import Tool

From the main window, click Tools  Import AOI L5X Files to Controller ACD File.
Note that you do not need to create a project before running this tool. This tool is
independent of the loaded project.

67
Use the “Select” button to selected the ACD file where the AOI definitions are imported
to.

Use the “Browse” button to select the directory containing the AOI L5X files to import.

Click “Import” to import the selected L5X files to the ACD file. Note that RSLogix 5000
or Studio 5000 Logix Designer must be installed for the version of the ACD file being
used. Each L5X import overwrites any existing AOIs and data types referenced in the
L5X file.

68
The Import L5X Files can also import L5X routine files by selecting the “Routine” target
type from the drop-down list box.

Controller XML Search Tool

From the controller child window, right-mouse click on the top controller folder and click
the “Search Controller XML…” menu item.

69
The window is opened using the controller XML file. The tool works with any XML file.
Use the “Select XML File” button to select a different XML file if desired.

The tool searches the XML file using XPath expressions. XPath is a query language for
selecting nodes from an XML document. In addition, XPath may be used to compute
values from the content of an XML document. Enter XPath expressions in the text box.
Click “Get Nodes” if the XPath expression is used for selecting nodes. Click “Get
Value” if the XPath expression evaluates to a value.

The tool allows XPath expressions to be saved with a description. Saved expressions are
added to the drop-down list box. Some predefined XPath expressions are included with
the software for checking AOI definitions:

70
The “Get Nodes” search results are displayed in the bottom area of the window. The
result contents can be varied using the following controls:

Typically, the “Find All” option is used to find all nodes satisfying the XPath search
string. The “Find First Occurrence” option returns only the first node found – this option
may be useful to get an idea of what the result may look like and is faster than finding all
nodes.

The “Exclude Child Nodes in Result” option is useful since in most cases only the node
found is of interest. The child nodes only clutter the results display.

Depending on the desired search, the found node may not provide enough information to
easily determine the node’s context. In such cases, including the node’s parent or
ancestor may provide the needed contect.

For example, the following XPath search returns LocalTag nodes whose name contains
“Cfg_” and is not configured with “Read/Write” external access. In PlantPAx V4 AOIs,
almost all “Cfg_” local tags are used for HMI configuration and require “Read/Write”
external access. The XPath search is to find local “Cfg_” tags that are configured
incorrectly.

Returning only the LocalTag nodes does not provide context of which AOI the LocalTag
node belongs to. Selecting the “AddOnInstructionDefinition” option in the “Include
parent node in results” drop-down list box provides the needed context.

Checking the “Exlude Child Nodes in Result” box returns results that are much more
readily readable that returning the entire node contents.

71
Routines and Programs Bulk Export to L5X Files
This tool is useful to Logix library code builders who want to export multiple routines
and programs as code templates.

Double-click on the controller under the “Logix Controllers” project tree to open the
controller in a child window. Right-mouse click on the top controller folder and select
the “Export Programs or Routines to L5X Files…” pop-up menu item.

72
Select the Export Target option to export routines or programs:

The bottom portion lists all the controller tasks, programs, and routines. If the controller
contains unscheduled programs, then those programs and routines are also included in the
tree. Check the boxes of the programs or routines to export. Note that if the “Program”
is the “Export Target”, then all routines in a selected program are includes – the
checkboxes for the individual routines are ignored.

Use the “Browse” button to select the directory where the L5X files are saved to:

All the exported L5X file names follow a naming format:

73
The text boxes are used for changing the file title prefix (e.g., “(RA-LIB)”), file title
version suffix (e.g., “4_10-00”), and export type suffix (“_ROUTINE”). Note that
selecting the “Program” Export Target option automically changes the export type suffix
to “_PROGRAM”, and selcting the “Routine” option changes it to “_ROUTINE”.

Use the “TaskName”, “ProgramName”, and “RoutineName” check boxes to include

those names in the file title.

If the “RoutineName” box is not checked and multiple routines from the same program
are exported as L5X files, then the file title includes one of the following to ensure the
L5X routine file has an unique name:

1. If the routine is a FBD, then the sheet 1 description is used. For example, “(RA-
LIB)PS_PID_Casc_AInAdv_Pri_4_10-00_ROUTINE.L5X” for the following
program and routine:

2. If the FBD sheet 1 description results in a file title that has already been exported,
then the FBD routine name is used.
3. If the routine is not a FBD, then the routine name is used.

If the program or routine contains AOIs with different revision numbers and it is desired
to associate the file title revision with a particular AOI revision, then do the following:

1. Add the AOI name to use in the program description. For example, the following
routine contains a P_Motor tag and a P_E300Ovld tag. Add “P_E300Ovld” to the

74
program description to use the “P_E300Ovld” AOI revision in the file title (note
that the program description must contain only the AOI name).

75
2. Check the box:

3. The software converts the AOI’s major, minor, extented text properties to a
revision format used in the PlantPAx process control strategy templates. The “.”
in the revision is replaced with “_”, and the revision and extended text is
separated by “-”. Any starting “.” and ending “ Release” in the extended text are
removed. For example, the following AOI properties are converted to “4_10-
00”.

76
Appendix A. Microsoft Windows Access Violation

If an access violation error occurs when adding a controller to the project, then the
Windows security settings for the program configuration files must be changed.

Sample error message:

To change the Windows security settings:

1. Exit “PlantPAx Configuration Tools for Tags, Alarms, and Historian”.

2. Log in as a Windows user with Administrator privileges.
3. Use the Windows Explorer to open the “C:\ProgramData\Rockwell Automation”
folder.

77
4. Right-mouse click on the “PlantPAx Configuration Tools for Tags, Alarms,
Historian” folder and select “Properties” from the popup menu item.

5. Click on the “Security” tab.

78
6. Click .

7. Select the “Users” group. Check the Allow “Full control” box. Click OK.

8. Click OK to close the properties dialog window.

79
9. Run “PlantPAx Configuration Tools for Tags, Alarms, and Historian” and add in the
controller file. The access violation error should no longer appear.

80
Appendix B. Alarm Data Type Definitions

Alarm definitions are based on Logix tag data types. Define the data type elements to use
as alarm triggers. For each alarm element, configure the default definition for each type
of alarm servers. For example, the Process Library P_AIn uses the “Alm_HiHi” element
for the high-high alarm, “Alm_Hi” for the high alarm and so on.

The steps for using the alarm builder tools are:

1. Configure alarm definitions for each Logix data type for which you are interested
in generating alarms. For each Logix data type, define the data type elements that
are used for alarming and define the type of alarming (e.g., digital, or bit triggers).
2. For each type of alarm server you are interested in, configure default parameter
values for the alarms in that particular server type.

The above would only have to be configured once. You can reuse the same alarm
definitions and alarm server configuration parameters for different controllers in different
HMI projects.

An alarm data type configuration tool is provided with the software. Do the following to
use the tool:

1. Load project. The project must contain controllers associated with a FactoryTalk
View HMI.
2. Right-mouse click on the controller containing the data types that you want to
configure. Click the “Configure HMI Alarm Definitions…” popup menu item.

The popup menu item is enabled only for controllers associated with a
FactoryTalk View HMI application.

81
The “Data Types” drop-down list box lists all the data types that have been configured
for alarming. The “Digital Alarms” box lists the data type elements used as alarm
triggers. Use the two edit buttons to configure the default alarm configuration for AE and
ME alarms. Refer to the “Alarm Definitions Builder” user manual for details.

82
Appendix C. Define Tag Description Format

When an RSLogix 5000 controller file is loaded into PlantPAx Alarm Builder Tool, the
software reads the RSLogix 5000 tag description from the controller file and parses it into
different fields. Hence, the RSLogix 5000 tag description entry can be thought of as
containing different fields with each field separated by a delimiter.

The PlantPAx Alarm Builder Tool tag description tool and tag data tool can be used to
export the tag descriptions into a text file. The text file can be edited using a text editor,
such as Microsoft Notepad, or spreadsheet software, such as Microsoft Excel. The text
file can be imported back to the controller ACD file using the PlantPAx Alarm Builder
Tool tag description import tool or tag data import tool.

In addition, the fields can be defined as having three special meanings: (1) tag label, (2)
tag descriptor (this should not be confused with the entire RSLogix 5000 tag description
entry), and (3) tag engineering unit. These tag information are used in many of the
PlantPAx Alarm Builder Tool tools (e.g., alarm export, and parameter files).

NOTE: the PlantPAx Process Library AOIs use local string tags for
storing tag label, description, engineering unit, and other information. The
AE and ME alarm builder tools provide options to automatically read
these local string values for use in building alarm messages (i.e., the
fields parsed from the Logix description are not used). Since local string
tags cannot be easily edited in RSLogix 5000, it is still recommended that
a consistent Logix description format be used for better readability of the
tags. The tag data editing tools can be used for editing the Logix fields
and the local tags (for example, you can copy-and-paste the field values
to the local tag values, and vice-versa).

For example, the “Brew_MT_AddH2OFlow” tag in the following RSLogix 5000 tag
editor screen capture contains the description “FI-1001 Mash Tun H2O Flow GPM”.

The description can be parsed into three fields with each of the field separated by a
carriage-return-line-feed delimiter:

83
Field1 = “FI-1001”
Field2 = “Mash Tun H2O Flow”
Field3 = “GPM”

You are prompted for the Logix description format when you add a controller to a
prompt. The format can be changed by right-mouse clicking on the controller in the
project tree and selecting the

1. Enter the number of fields, delimiter, and field numbers for the tag label, tag
description, and tag engineering unit. Enter “0” for the tag information field
number if it is not used. For example, if tag engineering unit is not included as
part of the Logix description entry, then enter “0”. See additional examples
below.

84
2. Click the “Edit Field Descriptors” button to add descriptors for the fields. These
descriptors are used in the tag data editing tables.

3. Click the “OK” button to save the changes.

Note that the default Logix description format can also be edited by clicking “Tools 
Options  Logix Description Format” tab. (Whenever changes to the Logix description
format are saved, it automatically becomes the default format.)

Example 1

Suppose the “Description” entry for a tag contains the following:

TIC-123
Area 2, Reactor 1
Overhead Temperature
degC
DWG 100070A

Each of the above field is in a separate line; i.e., they are separated by carriage-return-
line-feed (CR-LF) characters. One way of defining the format is:

85
Number of fields = 5
Delimiter = CR-LF
Tag Label Fields = 1
Tag Description Fields = 2,3
Tag Engineering Unit Field = 4

When PlantPAx Alarm Builder Tool loads in the controller file, it will parse the above
tag description entry into the following fields:

Field1 = “TIC-123”
Field2 = “Area 2, Reactor 1”
Field3 = “Overhead Temperature”
Field4 = “degC”
Field5 = “DWG 100070A”

Inside PlantPAx Alarm Builder Tool, the tag would have the following values:

TagLabel (Field1) = “TIC-123”

TagDescription (Field2 + Field3) = “Area 2, Reactor 1 Overhead
Temperature”
TagEngineeringUnit (Field4) = “degC”

Example 2

Suppose the “Description” entry for a tag contains the following (same as Example 1):

TIC-123
Area 2, Reactor 1
Overhead Temperature
degC
DWG 100070A

Each of the above field is in a separate line; i.e., they are separated by carriage-return-
line-feed (CR-LF) characters. Suppose the format is changed to the following:

Number of fields = 5
Delimiter = CR-LF
Tag Label Fields = 1,5
Tag Description Fields = 2,3
Tag Engineering Unit Field = 4

86
When PlantPAx Alarm Builder Tool loads in the controller file, it will parse the above
tag description entry into the following fields:

Field1 = “TIC-123”
Field2 = “Area 2, Reactor 1”
Field3 = “Overhead Temperature”
Field4 = “degC”
Field5 = “DWG 100070A”

Inside PlantPAx Alarm Builder Tool, the tag would have the following values:

TagLabel (Field1) = “TIC-123 DWG 100070A”

TagDescription (Field2 + Field3) = “Area 2, Reactor 1 Overhead
Temperature”
TagEngineeringUnit (Field4) = “degC”

87