0% found this document useful (0 votes)
189 views

PlantPAx Library Migration Tool Release Notes and User Manual

Uploaded by

alexsantoyoramos
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
189 views

PlantPAx Library Migration Tool Release Notes and User Manual

Uploaded by

alexsantoyoramos
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 87

PlantPAx Process Library

Migration Tool

Version 6.0

Release Notes and User Manual

Last Updated: 7/25/2018 3:23 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 Process Library Migration Tool” (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 / Studio 5000 Logix Designer 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

Release Notes – Version 6.0, July 2018 ....................................................................................................... 7

Release Notes – Version 1.5, August 2017 .................................................................................................. 8


Updates ...................................................................................................................................................... 8
Software Bug Fixes .................................................................................................................................... 9
AOI Size ............................................................................................................................................... 9
Logix Does Not Maintain Certain Tag Values After AOI Update .................................................. 9

Release Notes – Version 1.4, March 2017 ..................................................................................................11


Updates .....................................................................................................................................................11

Release Notes – Version 1.3, January 2017 ...............................................................................................13


Updates .....................................................................................................................................................13
Software Bug Fix ......................................................................................................................................14

Software Overview ......................................................................................................................................15

Required Software .......................................................................................................................................16

Microsoft Windows Security Access ..........................................................................................................16

What the Migration Tool Updates .............................................................................................................17


Update AOI Definitions ............................................................................................................................17
Update Tag Alarm Severity Values ...........................................................................................................17
Update Alarm Condition Strings ..............................................................................................................18
Creates New Alias Tags for Faceplate-to-Faceplate Navigation .............................................................19
Updates Global Object Parameters for Common Process Library Objects .............................................20
Automatically Restores Navigation Tag Configuration ............................................................................21
Process Library Version 4 Migration Updates .........................................................................................23
Rescale P_ResInh Time-Based Configuration Parameters ..................................................................23
Restore Local String Tag Values for STRING_Cond Tags .................................................................24
Update Cross-References for AOIs with Changed Parameter Names .................................................24
Change P_DoseFM and P_DoseWS Tags to P_Dose Tags .................................................................24
Updates Visible Pins and Wires in FBD Tags .....................................................................................25
Maintain Tag Values for Tag Elements with Changed Names ............................................................25
Rescales Cfg_FailHiLim and Cfg_FailLoLim to Raw Input Units......................................................25
Flag Tags where Cfg_PCmdClear was configure with “0” .................................................................25

4
What the Migration Tool Does NOT Update ............................................................................................27
Does Not Update Program Logic .............................................................................................................27
Does Not Change ACD Logix Version......................................................................................................28
Does Not Update SE/ME Process Library Components ...........................................................................28
Does Not Update SE/ME Display GFX Files Directly .............................................................................29
Updates Only Common Process Library Graphic Objects .......................................................................29
Does Not Delete Unused P_Mode, P_DoseFM, P_DoseWS AOI Definitions ..........................................31
Does Not Update AOI Definition Logic ....................................................................................................31

Operating Instructions ................................................................................................................................32


Starting the Software and Selecting the Migration Option .......................................................................32
Migrate ACD Files ...................................................................................................................................33
Select the Process Library Version to Upgrade To .........................................................................34
Select ACD Files to Update ............................................................................................................35
Select XML “Library” File Containing AOIs to Upgrade To .........................................................36
Logix Version of Library File to Use .........................................................................................38
Automatically Update PlantPAx Logix Tag Severity Values .........................................................39
IREF Options – Workaround for Logix Services IREF Error .........................................................39
Updating AOIs using RSLogix 5000 / Studio 5000 Logix Designer .........................................40
How to Kill Logix Services if it Locks Up .................................................................................40
Run Migration .................................................................................................................................43
Tag Data Memory Usage Change ..............................................................................................44
Microsoft Windows Security Access .........................................................................................45
Review Updated ACD Files Using Studio 5000 Logix Designer ...................................................46
Migrate FTView HMI Graphics and Logix ACD Files .............................................................................47
Migrate Graphics XML Files ...............................................................................................................47
Batch Import Files ...........................................................................................................................51
“BatchImport_MigratedFilesToCreate.xml” ..............................................................................52
“BatchImport_MigratedFilesToUpdate.xml” .............................................................................52
Faceplate-to-Faceplate Navigation Tags .........................................................................................53

Appendix A. Exporting FactoryTalk View Displays to XML Files ..................................................55

Appendix B. Importing Updated XML Files to FactoryTalk View ..................................................57


Batch Import Files Generated by Migration Tool ....................................................................................57
Importing the “BatchImport_MigratedFilesToCreate.xml” File ..........................................................59
Problem with Client Displays Not Showing Values .......................................................................62
Importing the “BatchImport_MigratedFilesToUpdate.xml” File.........................................................63

Appendix C. Global Objects with Migration Rules ............................................................................67


User-Modified Process Library Global Objects .......................................................................................68

Appendix D. Tutorial ............................................................................................................................69


Change Logix ACD File Version ..............................................................................................................70
Create FactoryTalk View XML Graphics Files to Update .......................................................................71

5
Run Process Library Migration Tool ........................................................................................................74
Update XML Graphic Files..................................................................................................................74
Update ACD File .................................................................................................................................77
Review ACD File ......................................................................................................................................78
Import Displays to FactoryTalk View Studio ............................................................................................79
Importing the “BatchImport_MigratedFilesToCreate.xml” File ..........................................................81
Importing the “BatchImport_MigratedFilesToUpdate.xml” File.........................................................83
(Optional) Run Updated Mosquito Station Controller and HMI Client ...................................................84

Appendix E. Microsoft Windows Access Violation ............................................................................85

6
Release Notes – Version 6.0, July 2018
The migration tool is updated to support migration to PlantPAx Process Library Version
4.0 AOIs. It supports the following upgrades:

 Version 1.1, 1.5, 2.0, 3.0, 3.1 to version 3.5


 Versions 1.1, 1.5, 2.0, 3.0, 3.1, 3.5 to version 4.0
 Version 3.5-xx to 3.5-yy.
 Version 4.0-xx to 4.0-yy.

Some of the specific updates for V4.0 are:

Details of the above updates are provided on page 23.

The Migration Tool version numbering has changed to Version 6 to be consistent with
the “PlantPAx Configuration Tools for Tags, Alarms, and Historian” software release.
The two software use the same code base.

7
Release Notes – Version 1.5, August 2017

Updates
The tag data memory size for Version 3.5 AOIs are typically much larger than the
memory size for Version 1 and Version 2 AOIs. Hence, the converted file will require
more memory and may require chaning to a controller with more memory. The user
should use Logix Designer to check memory usage.

Version 1.5 includes a new tag data memory usage change value in the migration status
table. For example:

The results log includes a tag data change summary for each data type updated. For
example:

8
Software Bug Fixes
AOI Size

The software includes a configuration file (LogixViewAOIs.xml) used for storing the
AOI size for the AOIs that the software encounters. The AOI size is used for
reading array tags from raw binary hex data in the XML export for Logix versions
27 and older.

In previous versions, the software calculates the AOI size by determining the
number of raw binary hex data bytes contained in a tag XML export. Logix
versions 28 and higher no longer includes raw data format in the tag XML export.
As a result, the calculated AOI size was incorrect for Logix versions 28 and higher.
The software has been updated to use another method for determining AOI size that
works for all Logix versions.

Logix Does Not Maintain Certain Tag Values After AOI Update

When an AOI definition is updated, the affected AOI tags are updated by Logix
with the new data structure. Logix copies tag element values from the old tag to the
updated tag for element names that do not change. However, Logix does not copy
the old values if the AOI parameter alias property has changed – this is true even if
the element data type has not changed. As a result, those tag element values are
reset to the updated AOI definition’s default parameter values.

For example, the gating parameters used in Version 2 AOIs are not aliased to local
tags. The gating logic is incorporated within the AOI logic:

9
Version 3.x AOIs use P_Gate local tags for gating calculations. The gating
parameters are aliased to the P_Gate local tags:

When the V2 AOI tags are updated to V3.x, the gating parameter values (e.g.,
Cfg_HiHiOnDly and Cfg_HiHiOffDly) are reset to the default V3.x AOI definition
values and do not maintain their original values.

As a work around, the Migration Tool checks if there are AOI definitions with
parameter aliasing changes. If there are, it stores the original tag element values for
the changed parameters and then restores the original values after the ACD file has
been updated with the migrated AOIs.

10
Release Notes – Version 1.4, March 2017
Updates
In order to aid customers who use a tag naming convention with tag names that exceed 20
characters, the type of Navigation Tag (“NavTag”) configuration parameters was
changed in Version 3.5-05 Process Library. Previously these were fixed at 20 characters
(type “STRING_20”). The type of all Cfg_*NavTag* items (examples: Cfg_NavTag,
Cfg_PVNavTag, Cfg_CVNavTag[0], etc.) has been changed to “STRING_NavTag”. The
default size of this type has been set to 20 characters, the same as the “STRING_20” type
previously used, in order to work with the existing graphics.

Since the data type for the local navigation string tags is changed from STRING_20 to
STRING_NavTag, a data type collision occurs when manually importing the AOI using
Logix Designer. As a result, the navigation tag parameters are reset to the default NULL
string values when the AOI tags are updated (i.e., the original navigation tag
configuration is lost).

For example, the following Version 3.5-01 P_Intlk tag has the following navigation tag
configuration:

11
If the above AOI is updated to version 3.5-05 using Logix Designer, then the updated tag
contains the following AOI definition and navigation tag values:

This version of the migration tool checks for STRING_20 to STRING_NavTag changes
in the AOI definitions. If a change is found, the tool stores the original navigation tag
configuration prior to updating the AOIs. After the AOIs are updated, it restores the
original navigation tag parameters in the updated AOI tags.

12
Release Notes – Version 1.3, January 2017

Updates
1. Coding changes made to reduce execution time for updating ACD files. The
amount of time reduction depends on the number of AOIs, IREFs and tag data
changes. For some test files, conversion time is reduced by about 40% compared
to the last version.

2. The ACD file migration tool uses Logix Services to import AOIs and other file
changes. Logix Services locks up when the importing AOIs for ACD files
containing IREFs that are linked to AOI tag parameters aliased to AOI local tags.
So far, this problem has only been found when converting Process Library AOIs
version 3.0 and older. As a workaround, the migration tool can check for these
types of IREFs and replace them with blank references before using Logix
Services to import the new AOIs. After the AOIs are imported to the ACD file,
the IREFs are restored with their original references and the ACD file updated
again using Logix Services. For this version, options are added to allow the user
to select when to run the workaround method. In the previous version, the
workaround was hidden and always executed regardless of library version.

3. New description added to the startup window to make clear which process library
versions are supported:

13
Software Bug Fix
1. Corrected problem where the IREF references to AOI parameters must match the
case of the parameters in the AOI definition. Error is generated if the IREF
reference does not match the AOI definition exactly. The IREF reference checks
are no longer case sensitive in this version.

14
Software Overview
The purpose of the PlantPAx Process Library Migration Tool is to help users update their
FactoryTalk View SE/ME graphics and Logix ACD files with the latest version of the
Process Library AOIs and HMI global objects. The tool reduces engineering time and
migration errors. Use the tool to keep up with the latest Rockwell Automation software
features and increase the life cycle of the PlantPAx DCS.

The PlantPAx Process Library Migration Tool contains the following main functions:

1. Update Logix ACD files containing one version of Process Library AOI
definitions to a different version.

 Upgrade from Process Library AOI versions:


o Version 1.1, 1.5, 2.0, 3.0, 3.1 to version 3.5
o Versions 1.1, 1.5, 2.0, 3.0, 3.1, 3.5 to version 4.0
o Version 3.5-xx to 3.5-yy.
o Version 4.0-xx to 4.0-yy.

2. Update FactoryTalk View SE/ME process graphic XML files containing items
linked to Process Library HMI global objects. This tool upgrades global object
references from Process Library versions 1.1, 1.5, or 2.5 to Version 3.5/4.0. The
process graphics global objects have the same name and parameters in version 3.5
and version 4.0

 Updates the global object parameter values to the correct Version 3.5/4.0
format and values.

 It will also update the corresponding ACD files with any necessary alias tags
with the required naming convention for faceplate-to-faceplate navigation.

A summary of what the migration tool updates and does not update are provided below.

The purpose of this document is to provide instructions on using the migration tools. A
tutorial is provided in Appendix D that walks through the conversion of the Mosquito
Station sample application from Version 2 to Version 3.5. This is a sample application
included with the PlantPAx Process Library downloads.

15
Required Software
RSLogix 5000 or Studio 5000 Logix Designer must be installed for the versions of the
ACD files used in the migration tool. The migration tool supports Logix versions 18 to
31.

FactoryTalk View Studio is used for graphics display XML files export and import.
View Studio does not have to be installed to use the migration tool (i.e., the user can
transfer the XML files to/from a different PC).

Microsoft Windows Security Access


The Windows logged in user must have full security access to the folder where the
software is installed; otherwise, the ACD file update will fail due to Windows access
violation. The migration tool must have full read/write access to certain files in the
installation folder. Refer to Appendix E for instructions on setting up the required
Windows security access.

16
What the Migration Tool Updates

Update AOI Definitions

Updates the Process Library AOI definitions from one version to another version:

to

Update Tag Alarm Severity Values

Provides option to update the alarm severity values for all Process Library AOI tags using
default values or user-defined mapping values:

From:

17
To:

Update Alarm Condition Strings

Sets the ‘Cfg_Cond’ alarm condition local tag string values to the default AOI definition
values. For example, the P_AIn Fail alarm condition string is set to “Input Failure”

The alarm condition strings are used as alarm descriptors in the HMI faceplate. Example:

18
Using Studio 5000 Logix Designer to import the AOI would have set the alarm condition
strings for the existing tags to the P_Alarm default Cfg_Cond value (‘Alarm Condition’).
For example, all the P_AIn alarms would have “Alarm Condition” as the alarm
descriptor:

Creates New Alias Tags for Faceplate-to-Faceplate Navigation


When used with the HMI graphics migration function, the ACD migration tool
automatically creates new alias tags when needed for Process Library Version 3.x HMI
faceplate-to-faceplate navigation.

The faceplate-to-faceplate navigation requires certain tags to follow naming conventions.


For example, if “P60_Motor” is a P_Motor AOI tag, then to navigate from the P_Motor
faceplate to the associated P_Intlk faceplate requires the interlock tag be named
“P60_Motor_Intlk” (naming convention: “MotorTagName_Intlk”). The tool
automatically detects that the original interlock tag (“P60_Intlk”) does not follow the
naming convention and it created a new alias tag named “P60_Motor_Intlk”.

19
Updates Global Object Parameters for Common Process Library Objects

For example, the following is the configuration of a Version 2.0 P_Motor object being
migrated to Version 3.5:

Notice that the P_Intlk and P_Perm tags do not follow the naming conventions required
in Version 3.5. The base motor tag is named P50_Motor, the required names are
P50_Motor_Intlk and P50_Motor_Perm.

The object has the following configuration after importing the updated XML file into a
HMI application using V3.5 PlantPAx Process Library components Notice that the
global object parameter definitions have changed going from V2.0 to V3.5.

20
Since the required tag names do not exist in the ACD file associated with the
“[Mosquito]” shortcut, the ACD migration tool created new alias tags:

This allows the P_Motor faceplate to navigate to the P50_Intlk faceplate using the
P50_Motor_Intlk alias tag.

Automatically Restores Navigation Tag Configuration

In order to aid customers who use a tag naming convention with tag names that exceed 20
characters, the type of Navigation Tag (“NavTag”) configuration parameters was
changed in Version 3.5-05 Process Library. Previously these were fixed at 20 characters
(type “STRING_20”). The type of all Cfg_*NavTag* items (examples: Cfg_NavTag,
Cfg_PVNavTag, Cfg_CVNavTag[0], etc.) has been changed to “STRING_NavTag”. The
default size of this type has been set to 20 characters, the same as the “STRING_20” type
previously used, in order to work with the existing graphics.

Since the data type for the local navigation string tags is changed from STRING_20 to
STRING_NavTag, a data type collision occurs when manually importing the AOI using
Logix Designer. As a result, the navigation tag parameters are reset to the default NULL

21
string values when the AOI tags are updated (i.e., the original navigation tag
configuration is lost).

For example, the following Version 3.5-01 P_Intlk tag has the following navigation tag
configuration:

If the above AOI is updated to version 3.5-05 using Logix Designer, then the updated tag
contains the following AOI definition and navigation tag values:

22
The migration tool checks for STRING_20 to STRING_NavTag changes in the AOI
definitions. If a change is found, the tool stores the original navigation tag configuration
prior to updating the AOIs. After the AOIs are updated, it restores the original navigation
tag parameters in the updated AOI tags.

Process Library Version 4 Migration Updates


Many of the AOI parameter names have been changed or deleted in the Version 4 AOIs.
In addition to the updates listed previously, the migration tool does the following
additional updates when migrating to Version 4 AOIs.

Rescale P_ResInh Time-Based Configuration Parameters

In P_ResInh AOI versions 3.5 and older, the time-based configuration parameters are in
unit of seconds. In Version 4, these parameters are in unit of hours. The migration tool
updates P_ResInh tags by rescaling the configuration parameter values to hour units.

The following parameters are updated:

 Cfg_ThreeColdStarts
 Cfg_FirstFailCold
 Cfg_SubseqFailCold
 Cfg_ FirstFailHot
 Cfg_ SubseqFailHot
 Cfg_ HotRestartOK
 Cfg_ RestartHot
 Cfg_ HotToCold

23
Restore Local String Tag Values for STRING_Cond Tags

In V4 STRING_Cond is used in the following AOI local tags:

Previous version use STRING_20:

The use of STRING_Cond allows the user to change the string length for the condition
texts and input texts without affecting other variables that use the STRING_20 data type.

Logix does not maintain the original string tag values when the string data type is
changed in the AOI definition. The migration tool copies the old string values to the
updated tags.

Update Cross-References for AOIs with Changed Parameter Names

Many AOI parameter names have changed in PlantPAx Process Library V4. The
migration tool updates tag references for tag elements with changed names. The tool
searches-and-replaces tag references in FBD, RLL, and ST.

If there are cross references using elements that no longer exist or have been changed to
local tags, then Logix Designer generates error messages when the controller file is
compiled from Logix Designer – it is up to the user to correct the errors.

Change P_DoseFM and P_DoseWS Tags to P_Dose Tags

The P_DoseFM and P_DoseWS AOIs are no longer used in V4. Their functionalities are
combined into a single P_Dose AOI. The migration tool changes P_DoseFM and
P_DoseWS tags to P_Dose tags.

24
Logix does not maintain the original tag values when the tag data type is changed. The
migration tool copies the original values to the updated tags.

Updates Visible Pins and Wires in FBD Tags

The migration tool updates FBD tags with new element names in the visible pins for
elements with changed names. Any connected wires are updated to maintain wire
connection to the updated pin element name.

The tool removes visible pins for elements that have been deleted or changed to local tags
– these pins are removed only if no wires are attached to them. If there is a wire
connection to a pin element that no longer exists, then Logix Designer generates an error
when the routine is compiled from Logix Designer – it is up to the user to correct the
error.

Maintain Tag Values for Tag Elements with Changed Names

The migration tool copies the original tag element values to the new elements for AOI tag
elements with name changes.

Rescales Cfg_FailHiLim and Cfg_FailLoLim to Raw Input Units

For version 3.5 and older, the instrument out-of-range (OOR) limits (Cfg_FailHiLim and
Cfg_FailLoLim) are in engineering units (i.e., the same units as the Cfg_PVEUMax and
Cfg_PVEUMin parameters). In version 4, the OOR limits are in raw input units (i.e., the
same units as the Cfg_InpRawMax and Cfg_InpRawMin parameters). The migration
tool rescales the OOR limits to raw input units in the updated tags.

Flag Tags where Cfg_PCmdClear was configure with “0”

For version 3.5 and older, some AOIs have a Cfg_PCmdClear parameter to clear program
commands on receipt or to leave set. The default value is “1” – clear program commands
on receipt.

25
This parameter is no longer used in version 4 AOIs. Version 4 AOIs clear program
commands on receipt.

The migration tool flag tags where Cfg_PCmdClear was configure with “0” – leave
program commands set. The tags are flagged by adding a “MigrationWarningRoutine”
ST routine to the controller file.

Structured text code is added for each tag that will purposely generate a compile error
message:

The user would need to delete the code, and decide if new logic need to be added to the
existing code to latch program commands.

26
What the Migration Tool Does NOT Update

Does Not Update Program Logic

The user has to manually update any program logic errors due to changes in the Process
Library AOI parameters.

The following is an example of a T_Sync tag using the T_Sync AOI supplied with
Version 2 Process Library:

A compiled error is generated when the tag is updated to use the T_Sync AOI supplied
with Process Library Version 3.5 because the updated definition contains a new
“Ref_SockOpenMsg” parameter. The user would need add in the new parameter tag
reference.

27
Does Not Change ACD Logix Version

For example, if the ACD file to migrate is originally a V18 Logix controller file
containing Version 2 Process Library AOIs and the user wants to update the file to a V24
Logix controller containing Version 3.5 Process Library AOIs, then the user would need
to first use Studio 5000 Logix Designer to change the ACD controller to V24. The user
would then use the V24 ACD file in the migration tool.

The migration tool does not update the L_CPU_xx AOI to match the ACD version. For
example, if the V18 ACD file uses a L_CPU_18 AOI and the controller is changed to
V24, then the migration tool updates the L_CPU_18 AOI definition to Version 3.5 – it
does not change the L_CPU_18 to L_CPU_24.

Does Not Update SE/ME Process Library Components

The migration tool does not update the Process Library components (image files, global
object files, faceplate display files) in SE/ME HMI applications. When updating a HMI
application to use a new Process Library version, the user would need to update the

28
image files, global object files, and faceplate display files – follow the instructions
included with the Process Library. Download the latest Process Library HMI files from
the Rockwell Automation Product Compatibility and Download Center (PCDC) website.
The migration tool does not include or install the HMI library files.

Use FactoryTalk View Studio to update SE/ME HMI applications from a previous
FactoryTalk View version to a new version (e.g., moving application from FactoryTalk
View Version 6 to Version 8.1, etc.). The migration tool does not update HMI projects.

Does Not Update SE/ME Display GFX Files Directly

The user must update SE/ME display files using the FactoryTalk View Studio Displays
Import and Export Wizard.

1. Use FactoryTalk View Studio to export the displays to migrate into XML files.
The displays must be exported from an application containing the Process Library
components to migrate FROM. For example, if migrating displays using
Version 2 library objects, then the HMI application must contain the Version 2
library image files and library global object files; it must also contain any user-
created images and global object files used by the displays.

2. Run the Migration Tool to update the XML files with Process Library Version 3.5
configuration. The tool also creates the FactoryTalk View batch import files used
in the next step.

3. Use FactoryTalk View Studio to import the updated XML files into the HMI
application. Use the batch import files created by the migration tool. The
displays must be imported into an application containing the Process Library
components to migrate TO. For example, if migrating to Version 3.5, then the
HMI application must contain the Version 3.5 library image files and library
global object files before the import.

Updates Only Common Process Library Graphic Objects

The migration tool updates SE/ME graphic items with global object links to the following
Process Library global object files:

29
 "(RA-BAS) BuiltIn Graphics Library", "(RA-BAS-ME) BuiltIn Graphics
Library"
 "(RA-BAS) P_AIn Graphics Library", "(RA-BAS-ME) P_AIn Graphics Library"
 "(RA-BAS) P_D4SD Graphics Library", "(RA-BAS) P_D4SD Motor Graphics
Library"
 "(RA-BAS-ME) P_D4SD Graphics Library", "(RA-BAS-ME) P_D4SD Motor
Graphics Library"
 "(RA-BAS) P_DOut Graphics Library", "(RA-BAS-ME) P_DOut Graphics
Library"
 "(RA-BAS) P_Motor Graphics Library", "(RA-BAS-ME) P_Motor Graphics
Library"
 "(RA-BAS) P_Motor2Spd Graphics Library", "(RA-BAS-ME) P_Motor2Spd
Graphics Library"
 "(RA-BAS) P_MotorHO Graphics Library", "(RA-BAS-ME) P_MotorHO
Graphics Library"
 "(RA-BAS) P_MotorRev Graphics Library", "(RA-BAS-ME) P_MotorRev
Graphics Library"
 "(RA-BAS) P_nPos Graphics Library", "(RA-BAS-ME) P_nPos Graphics
Library"
 "(RA-BAS) P_ValveMP Graphics Library", "(RA-BAS-ME) P_ValveMP
Graphics Library"
 "(RA-BAS) P_VSD Graphics Library", "(RA-BAS-ME) P_VSD Graphics
Library"
 "(RA-BAS) Process Graphics Library", "(RA-BAS-ME) Process Graphics
Library"

The displays can contain graphic items with links to Process Library global objects not
listed above or to user-defined global objects; those graphic items are left unchanged in
the migrated XML files.

The above list does not contain Process Library faceplate global objects. If the user
created custom faceplate displays using Process Library faceplate global objects, then
those displays may not be updated correctly.

The migration tool will work with user-modified Process Library global objects as long
as the following conditions are satisfied:

 The global object name is not changed.


 The global object file name containing the global object is not changed.
 The global object parameters list and parameter names are not changed.

30
As long as the above conditions are satisfied, the user can make any changes within the
global object. For example, the user can change the size, colors, font, text strings, and
add/remove/edit graphic items within the parent global object.

Does Not Delete Unused P_Mode, P_DoseFM, P_DoseWS AOI


Definitions
Version 4 AOIs no longer use the P_Mode for mode control. It is replaced with the
P_CmdSrc AOI for command source logic.

The Version 4 P_Dose AOI combines the functionalities of the P_DoseFM and
P_DoseWS AOIs from previous versions. The migration tool automatically replaces
P_DoseFM and P_DoseWS tags with P_Dose tags.

The migration tool does not delete unused P_Mode, P_DoseFM, and P_DoseWS AOI
definitions from the controller file. It is up to the user to decide to delete or keep the AOI
definitions. Note that P_DoseFM and P_DoseWS AOI definitions will generate Logix
Designer compile errors because they reference P_Alarm local tag elements that no
longer exists or have name changes in the Version 4 P_Alarm.

Does Not Update AOI Definition Logic


The migration tool does not update or examine AOI definition logic. If the user has
custom AOIs that reference Process Library AOIs, then their AOI logic will generate
Logix Designer compile errors if the logic references Process Library AOI elements that
have name changes or have been deleted.

31
Operating Instructions

Starting the Software and Selecting the Migration Option


1. Double-click on the “PAX_Migrate.exe” file from the installed program files
folder or double-click the desktop icon to start the software.

2. Select the migrate option. Refer to the next two sections for instructions on using
these two options.

32
Migrate ACD Files

The following window appears when the “Migrate Logix ACD Files…” option is
selected from the startup window:

33
The following window appears when the migrate graphics XML files tool completed
successful execution:

Select the Process Library Version to Upgrade To

Select the process library version to upgrade to:

The migration tool supports the following migration path:

 Version 1.1, 1.5, 2.0, 3.0, 3.1 to version 3.5


 Versions 1.1, 1.5, 2.0, 3.0, 3.1, 3.5 to version 4.0
 Version 3.5-xx to 3.5-yy.

34
 Version 4.0-xx to 4.0-yy.

Select ACD Files to Update

Click the button to select the Logix ACD files to update.


Multiple files can be selected in the file browser dialog window.

The selected files are added to the top table.

To remove a file from the table:

1. Click on the row header cell to select the row to remove.


2. Press the “Delete” key.

NOTE: if a library XML file has not been selected when an ACD file is first added, then
the software automatically selects a library XML file from the “PAxMigrationLibraryFiles

35
\PAX_V3_5” folder or “PAxMigrationLibraryFiles \PAX_V4_0” folder that is compatible with
the first selected ACD file. Use the “Select XML File” button to select a different file if
you do want to use the automatically selected file. See next section for details.

Select XML “Library” File Containing AOIs to Upgrade To

The data types in the selected ACD files are updated using the AOIs in a XML file (the
“library” file). Use the button to select the library file. The file
browser defaults to the “PAxMigrationLibraryFiles \PAX_V3_5” folder or
“PAxMigrationLibraryFiles \PAX_V4_0” folder in the migration tool’s installation directory.
The sub-folder contains several sample library files.

If the “PAxMigrationLibraryFiles” folder does not contain the version you want to use,
then you can create your own library XML file by supplying the Logix ACD file to use.
Click the button to select the ACD containing the AOIs that you
want to use as the library file.

36
NOTE: RSLogix 5000 or Studio 5000 Logix Designer must be installed for the version
of the ACD file selected.

It may take a few minutes to convert the ACD file to XML file format. The “Status” tab
is shown during the conversion.

The converted XML file is automatically selected as the library XML file when the
conversion is completed.

37
Refer to Appendix E if a Microsoft Windows access violation error occurs during the
library ACD file conversion.

Logix Version of Library File to Use

It is not necessary to have the ACD files and library file be at the same Logix version.
For example, if the ACD file to upgrade is V24, then it is not necessary that the library
file also be V24.

The following rules must be used when selecting or creating the library XML file to use:

1. The library file must be the same Logix version or an older Logix version than the
ACD file being migrated. For example, a V28 Logix file cannot be used as the
library file when updating V24 Logix ACD files.

2. The same encoding format must be used when updating encoded AOIs. There are
currently two encoding formats. RSLogix version 20.01, 21.01 and older (V18,
V17, etc.) use an old encoding format. All newer versions (20.03, 21.03, 22 and
newer) use a new encoding format. For example, if the ACD file to update is
V20.01, then the library XML file to use must be V18 or V20.01. Another
example, if the ACD file to update is V24, then the library XML file to use must
be V20.03, V21.03, V22 or newer.

Two Logix versions of the Process Library XML file are provided in the installation:

If a library XML file has not been selected when an ACD file is first added, then the
software automatically selects a library XML file from the “PAxMigrationLibraryFiles”
folder that is compatible with the first selected ACD file. Use the “Select XML File”
button to select a different file if you do want to use the automatically selected file.

The file with the “RSL5k_18_” prefix is automatically selected if the ACD file to migrate
is RSLogix version 20.01, 21.01 and older (V18, V17, etc.).

38
The file with the “RSL5k_20_03_” prefix is automatically selected if the ACD file to
migrate is 20.03, 21.03, 22 and newer.

It is not required that RSLogix 5000 V18 and V20.03 be installed to use the two library
XML files. For example, if the file to migrate is V24 and only Studio 5000 Logix
Designer V24 is installed, the “RSL5k_20_03_” XML library file can still be used.

Automatically Update PlantPAx Logix Tag Severity Values

For PlantPAx Process Library AOIs Version 3.1 and newer, the P_Alarm AOI used for
alarm processing uses an INT data type for the alarm severity. The default severities are
1..250=Low, 251..500=Medium, 501..750=High, 751..1000=Urgent.

For PlantPAx Process Library P_Alarm Version 3.0 and older, the AOI uses a SINT data
type for the alarm severity. The default severities are 1=Low, 2=Medium, 3=High,
4=Urgent.

Check the box to have the


software automatically update the Logix tag severity values. The default update values
used are shown in the table. Make severity value changes in the table to use other values.

IREF Options – Workaround for Logix Services IREF Error

The ACD file migration tool uses Logix Services to import AOIs and other file changes.
Logix Services locks up when the importing AOIs for ACD files containing IREFs that
are linked to AOI tag parameters aliased to AOI local tags. So far, this problem has only
been found when converting Process Library AOIs version 3.0 and older.
As a workaround, the migration tool can check for these types of IREFs and replace them
with blank references before using Logix Services to import the new AOIs. After the
AOIs are imported to the ACD file, the IREFs are restored with their original references
and the ACD file updated again using Logix Services. This workaround will increase file
conversion time.

39
Options are available to allow the user to select when to run the workaround method:

check for IREFs only when the ACD file contains Process
Library AOIs that are version 3.0 and older.

always check for IREFs regardless of the AOI version.

always skip the IREF check.

Updating AOIs using RSLogix 5000 / Studio 5000 Logix Designer

Note that using RSLogix 5000 or Studio 5000 Logix Designer to manually update
version 3.0 and older Process Library AOIs to Version 3.5 AOIs will generate the
following fatal error message if the ACD file contains IREFs that are linked to AOI tag
parameters aliased to AOI local tags. Hence, the same problem exists. The only
difference is that Logix Services will lock up and will not generate a fatal error message
(see next section).

How to Kill Logix Services if it Locks Up

As noted above, Logix Services can lock up and not generate a fatal error message when
importing AOIs to the ACD file. Unfortunately, distinguishing the difference between

40
when it is locked up or when it is running normally can be difficult. Depending on the
ACD file size and number of AOIs being updated, running Logix Services to import
AOIs will use 100% CPU (for single core processors) and can take greater than 20
minutes – same symptoms as when is is locked up.

Logix Services lockup will generally occur after the “Saving AOI and alias tag changes
to controller ACD file. This may take 5-20+ minutes.” message appears in the Execution
Status window:

If Logix Services is running normally, you will observe that the “XmlToAcdLog.txt” file
size change periodically during execution. This file is located in the same directory as
the ACD file being updated. Logix Services writes to this file to log the changes being
made to the ACD file. You can use Notepad to open this file while Logix Services is
running.

If you observe that the “XmlToAcdLog.txt” file size no longer changes and the Execution
Status hasn’t been updated for over 20 minutes, then Logix Services may be lockup up.
Do the following to kill program execution:

1. Click in the “Migrate ACD Files” window and answer “yes” to


the abort confirmation prompt.

41
2. Click the upper right “X” button in the “Migrate ACD Files” window to exit the
migration tool.

3. Open Windows Task Manager and click on the “Processes” tab.


4. Click on the “RSLogix5000Services.exe *32” process and click the “End
Process” button.

42
5. “End Process” in the confirmation window.

Run Migration

Click the button to update the selected files. It may take a couple of
minutes to 20+ minutes to update each ACD file. The update time depends on the file
size, the number of AOIs updated, the number of tags with severity changes, and
computer processor speed.

The Status tab is displayed during the update.

43
The software uses Logix Services in the background to convert the selected ACD files to
XML file format. The XML file format allows the software to read the current file
contents. It then uses Logix Services to update the ACD file with AOI changes and tag
severity changes. The CPU usage is usually near 100% (for single core processors) when
Logix Services is executing.

For each AOI, UDT, and string data type in the selected ACD file, the migrate function
checks if the same data type name exists in the library XML file. If it does, then it will
copy the data type definition from the XML file to the ACD file if the data types are
different. For example, if the selected ACD file contains a Version 2.0 P_AIn and the
library XML file contains a Version 3.5 P_AIn, then it will copy the Version 3.5 P_AIn
to the ACD file. All instances of the P_AIn tags in the ACD file will use the Version 3.5
P_AIn data structure after a successful file update.

Note that the migrate function only checks if the selected ACD file and the library XML
file contains different data types. It will update the AOI even if the library XML AOI
version is older than AOI version in the selected ACD file. For example, if the selected
ACD file contains a Version 3.5 P_AIn and the library XML file contains a Version 2.0
P_AIn, then it will copy the Version 2.0 P_AIn to the ACD file.

The migrate function will also update AOIs with same major and minor revision
numbers, but with different extended text. For example, update ACD file with Version
3.5-01 AOIs with Version 3.5-02 AOIs.

The appears during the migration process. Click the button to


terminate the migration process. If Logix Services is being executed, then it may take a
few minutes before the abort request can be implemented. Aborting will restore the
original ACD file of the current ACD file being processed. It will not restore the original
files for the ACD files that have been successfully updated prior to the abort request.

Tag Data Memory Usage Change

The tag data memory size for Version 3.5 AOIs are typically much larger than the
memory size for Version 1 and Version 2 AOIs. Hence, the converted file will require
more memory and may require chaning to a controller with more memory. The user
should use Logix Designer to check memory usage.

The migration tool calculates the tag data memory usage change for the tags updated.

44
The results log includes a summary for each data type updated. For example:

Microsoft Windows Security Access

The Windows logged in user must have full security access to the folder where the
software is installed; otherwise, the ACD file update will fail due to Windows access
violation. The migration tool must have full read/write access to certain files in the
installation folder. Refer to Appendix E for instructions on setting up the required
Windows security access. If you see a Windows access violation during the migration
process, then exit the migration tool, follow the Appendix E instructions to update
security settings, restart the migration tool and run tool again.

45
Review Updated ACD Files Using Studio 5000 Logix Designer

The migration tool will update the AOI definitions only. It does not update the logic that
use those AOI tags. Use RSLogix 5000 / Studio 5000 Logix Designer to review the
updated ACD files and check for errors due to AOI definition changes. For example, the
following errors occurred when updating an ACD file from Version 2.0 L_CPU_18 to
Version 3.5 L_CPU_18:

The Version 3.5 L_CPU_18 definition contains fewer parameters than the Version 2
AOI. The user would need to delete the unused parameters from the tag and make any
other required changes. Refer to the Process Library AOI user manuals and release notes
for instructions.

46
Migrate FTView HMI Graphics and Logix ACD Files

Migrate Graphics XML Files

The following window appears when the “Migrate FactoryTalk View HMI Graphics
XML Files and Logix ACD Files” option is selected in the opening dialog window.

47
The graphics migration tool updates the PlantPAx Process Library global object
references and global object parameter values.

Do the following:

1. Select the FactoryTalk View product type graphics files being updated:

2. Select the PlantPAx Process Library version to update from.

Tip: Use FactoryTalk View Studio and open a Process Library global object file
from your application to determine the version you are migrating from. For
example:

3. Select the PlantPAx Process Library version to update to.

4. Use FactoryTalk View Studio to export the displays to migrate into XML format.
Make sure to export the files using a FactoryTalk View HMI application
containing the images and global object files that you want to migrate FROM.
For example, if you want to migrate from Version 2.0 to Version 3.5, then export
the displays from the application that contains the Version 2.0 images and global
object files (NOT the Version 3.5 images and global object files). Refer to
Appendix A for instructions.

5. Click to select the folder containing the XML files exported


from FactoryTalk View Studio in the last step.

48
6. The XML files in the selected folder are displayed in the box. Select the XML
files to migrate. Use the “Select All” button to select all files.

7. Many Process Library Version 3.x global objects contains a #122 parameter for
determining the faceplate type to launch from the graphics object. Example:

Select the #122 value to use in the updated files:

8. Click the button to update the selected XML files with the target
library global object references and global object parameter values.

The tool will generate a listing of global objects not updated in the “Some Display
Objects Not Updated” report window. This does not mean the migration has
failed. The most likely reason why the items were not updated is because the
linked global objects were not configured with migration rules (for example, the
objects are linked to user custom global objects). These objects will still be
imported as long as the import application contains the referenced global objects.
Refer to Appendix C for a discussion of global objects with and without migration
rules.

49
9. The tool creates a “MigratedXmlFiles” sub-folder that contains the migrated
XML files, and one or two FactoryTalk View Studio batch import files. The sub-
folder is under the directory selected in Step 5. Use FactoryTalk View Studio to
import the graphics files to your HMI server. Make sure the HMI application
contains the Process Library image files and global object files that you are
migrating TO. For example, if you are migrating from Process Library Version
2.0 to Version 3.5, then the application that you are importing the files to must
contain the Version 3.5 Process Library image and global object files. Refer to
Appendix B for instructions.

A “Files Migrated” report window appears listing the batch import files generated
and the XML files that were successfully updated. The report window also
contains brief instructions of using the FactoryTalk View graphics import tool.

50
Batch Import Files

As noted above, the tool generates one or two FactoryTalk View displays batch import
files. These batch import files are always named “BatchImport_MigratedFilesToUpdate.xml” and
“BatchImport_MigratedFilesToCreate.xml”. The “…Create.xml” file must be imported by creating
new objects and displays. The “…Update.xml” file can be imported by updating existing
displays or by creating new displays. These two files are described below. Appendix B
provides instructions on using FactoryTalk View Studio to import these files.

51
“BatchImport_MigratedFilesToCreate.xml”

If a selected XML graphics file to migrate contain links to global objects with name
changes and/or global object parent file name changes, then the
“BatchImport_MigratedFilesToCreate.xml” file is created and the XML graphics file name is added to
that batch import file.

For example, the “GO_P_AIn” global object in the Version 1.5 "(RA-BAS) Process
Graphics Library" global object file is moved to the "(RA-BAS) P_AIn Graphics
Library" file in Version 3.5. Any links referencing the “GO_P_AIn” object are updated
with the V3.5 global object file name in the migration tool.

The FactoryTalk View XML displays import wizard does not allow updating of existing
graphic items where the referenced global object link has changed. Hence, the item must
first be deleted and recreated using the wizard’s “Create new objects on the display”
option. Rather than going in and manually deleting those items, it is easier to either
delete the existing display or rename the existing display before using the import wizard.
Another alternative is to import the files into an application that does not have the
displays. The import wizard will recreate the entire display with the new updated objects.

The “Files Migrated” report window generated by the migration tool list the display files
in the batch file. These display files must be deleted or renamed before using the
FactoryTalk View Import Wizard.

Use the FactoryTalk View “Import and Export” wizard to import the
“BatchImport_MigratedFilesToCreate.xml” file. Refer to the instructions in Appendix B,
page 59.

“BatchImport_MigratedFilesToUpdate.xml”

If a selected XML graphics file to migrate does NOT contain links to global objects with
name changes and/or global object parent file name changes, then the

52
“BatchImport_MigratedFilesToUpdate.xml” file is created and the XML graphics file name is added to
that batch import file. In other words, the XML graphics file contains only updates to the
global object paramters list or no updates at all.

In this case, use the FactoryTalk View XML displays import wizard with the “Update
existing objects on the display” option if the displays are already in the application. If the
displays are not in the application, then use the wizard’s “Create new objects on the
display” option.

The “Files Migrated” report window generated by the migration tool list the display files
in the batch file.

Follow the instructions in Appendix B, page 63, to use the FactoryTalk View “Import and
Export” wizard to import the “BatchImport_MigratedFilesToUpdate.xml” file.

Faceplate-to-Faceplate Navigation Tags

PlantPAx Process Library Version 3 and newer use Logix naming conventions for
faceplate-to-faceplate navigation. For example, if a P_Motor object has the Logix tag
name “Motor123", then its Interlock object must be named “Motor123_Intlk".

For example, the following V2 P_Motor object is configured with the following:

The configured interlock and permissive tags (P50_Intlk and P50_Perm) do not following
the V3.x naming conventions. Since the base motor tag is named P50_Motor, the
required names are P50_Motor_Intlk and P50_Motor_Perm.

53
When migrating from Version 2 or older to Version 3 and newer, the migration HMI tool
makes a list of tags that must be checked for correct naming conventions. This
information is passed to the Logix ACD file migration window. In the above example,
the ACD migration tool would check if the P50_Motor_Intlk and P50_Motor_Perm tags
exist. If they do not, then the tool would create a new alias tag named P50_Motor_Intlk
that is aliased to P50_Intlk (the existing interlock tag), and it would create a new alias tag
named P50_Motor_Perm that is aliased to P50_Perm (the existing permissive tag).

The following window appears when the migrate graphics XML files tool completed
successful execution:

54
Appendix A. Exporting FactoryTalk View Displays to XML Files

This appendix provides instructions on using the FactoryTalk View Studio graphics
displays Import and Export wizard to create XML graphics files. These XML files are
used as the input to the HMI graphics migration tool (see page 47)

1. Start FactoryTalk View Studio.

2. Load the application containing the graphics display to migrate. Make sure to
export the files using a FactoryTalk View HMI application containing the images
and global object files that you want to migrate FROM. For example, if you want
to migrate from Version 2.0 to Version 3.5, then export the displays from the
application that contains the Version 2.0 images and global object files (NOT the
Version 3.5 images and global object files).

3. Make sure the displays you want to migrate are not opened in the FactoryTalk
View displays editor.

4. Right-mouse click on the “Displays” folder and click on the “Import and
Export…” pop-up menu item:

5. Select the “Export graphic information from displays” option and click next.

55
6. Select the process display files that use Process Library global objects and click
Next. Do not select the Process Library faceplate displays (“(RA-BAS)…”) since
new faceplate display versions are provided with the new library.

7. Use the button to select or create the folder containing the exported files.
This folder is used in the migration tool (Step 5, page 48).

8. Click the button.

56
Appendix B. Importing Updated XML Files to FactoryTalk View

This appendix provides instructions on using the FactoryTalk View Studio graphics
displays Import and Export wizard to import the XML files updated by the migration tool
(see “Migrate Graphics XML Files”, page 47).

1. Start FactoryTalk View Studio.

2. Load the HMI application that you want to import the graphics files into. The
application must contain the target Process Library image files and global object
files. For example, if you are migrating from Process Library Version 2.0 to
Version 3.5, then the application you are importing into must contain Version 3.5
image files and global object files.

An alternative to using your actual project application is to create a temporary


HMI application that contains only the Process Library image files and global
object files. The XML files will be imported as new display files. Copy the
display files from the temporary application to your actual application.

Batch Import Files Generated by Migration Tool


It was discussed on page 51 that the migration tool generates one or two batch import
files. These batch import files are always named “BatchImport_MigratedFilesToUpdate.xml” and
“BatchImport_MigratedFilesToCreate.xml”. The “…Create.xml” file is created if changes to the
global object linkes were made in the graphics XML files; i.e., global object names or
global object source file names were changed when migrating to Version 3.5. The
“…Update.xml” file is created when only global object parameter lists or values were
changed.

The “Files Migrated” report window generated by the migration tool lists the batch
import file(s) created and the XML displays files in each batch file.

57
If you don’t have the “Files Migrated” window still opened or you didn’t save the report
to a text file, then use Windows Explorer to open the “MigratedXmlFiles” sub-folder
created by the migration tool. The “MigratedXmlFiles” sub-folder is created under the
folder you used for selecting the XML files in the migration tool (this is usually the folder
where you use the Import and Export wizard to export the display files to XML files).

You will see one or two “BatchImport_” files in the folder and the updated copies of the
display XML files.

Double-click on a “BatchImport_” file to open the file in Windows Explorer, and see
which display XML files will be imported using that batch file. You can also open the
file using Notepad. Example:

58
Importing the “BatchImport_MigratedFilesToCreate.xml” File

If the migration tool created the “BatchImport_MigratedFilesToCreate.xml” file in the


“MigratedXmlFiles” folder, then follow the instructions in this section; otherwise,
proceed to the next section.

The “Files Migrated” report window includes a list of the display files that are included
in the batch import file. You can also get a listing by opening the batch import file in
Notepad or Windows Explorer. Example:

1. If the listed display files are in the HMI application, then those displays must be
deleted or renamed before running the Import and Export Wizard. Removing the
display from the HMI application will not work, it must be deleted or renamed.
Right-mouse click on the display under the “Displays” tree node and use the pop-
up menu to Delete or Rename the display:

2. Right-mouse click on the Displays tree node and click “Import and Export”.

59
3. Select the “Import graphic information into displays” option and click Next.

4. Select “No” for backup and click Next.

5. Select the “Multiple displays batch import file” option and click Next.

6. Use the button to browse to the “MigratedXmlFiles” folder created by the


migration tool. Select “BatchImport_MigratedFilesToCreate.xml”.

60
7. Select the “Create new objects on the display” option. This will create new GFX
display in the application.

8. Click the button. The Import Wizard creates a new display for each
XML file listed in the batch import file.

9. Open the newly created displays in the FactoryTalk View Studio display editor.
Check for broken link objects. These objects appear as red squares or red
rectangles with a red “X” mark.

For example, the following contains broken link objects because the user-defined
global object name (OkalaxaxObjects.Group1) does not exists in the imported
application.

The migration tool is configured for PlantPAx Process Library HMI objects. It does not
include user-defined global objects. If the broken link objects are due to missing links to
user-defined global objects, then check to make sure you have included the required user-
defined global object files in your application. Refer to Appendix C for details.

61
10. Resave the display file. For example, move a graphic item and then move it back
to the original position to enable the “Save” display icon in FactoryTalk View
Studio. Resaving the display will update the global object links.

Problem with Client Displays Not Showing Values

Problem description: when opening a display that was created by the import wizard, the
items in the display do not appear and many expression errors appear in the FactoryTalk
View diagnostics window:

Solution: resave the display in FactoryTalk View Studio. For example, move a graphic
item and then move it back to the original position to enable the “Save” display icon in
FactoryTalk View Studio. Save the display and the items appear in the runtime client
display.

62
Importing the “BatchImport_MigratedFilesToUpdate.xml” File

If the migration tool created the “BatchImport_MigratedFilesToUpdate.xml” file in the


“MigratedXmlFiles” folder, then follow the instructions in this section.

The “Files Migrated” report window includes a list of the display files that are included
in the batch import file. You can also get a listing by opening the batch import file in
Notepad or Windows Explorer. Example:

All the displays listed in the batch file must be in the HMI application to use the
instructions in this section.

63
If none of the displays are in the HMI application, then follow the instructions in the
previous section, but use the “BatchImport_MigratedFilesToUpdate.xml” file instead of
the “BatchImport_MigratedFilesToCreate.xml” file.

If some of the displays are in the HMI application, then it would be easiest to remove or
rename all the displays and follow the instructions in the previous section, but use the
“BatchImport_MigratedFilesToUpdate.xml” file instead of the
“BatchImport_MigratedFilesToCreate.xml” file.

If all the displays listed in the batch file are in the HMI application, then use the
following instructions:

1. Right-mouse click on the Displays tree node and click “Import and Export”.

2. Select the “Import graphic information into displays” option and click Next.

3. Select the desired backup option and click Next.

64
4. If ‘Yes’ was selected to making backup files, then select the folder for storing the
backup files and click Next.

5. Select the “Multiple displays batch import file” option and click Next.

6. Use the button to browse to the “MigratedXmlFiles” folder created by the


migration tool. Select “BatchImport_MigratedFilesToUpdate.xml”.

65
7. Select the “Update existing objects on the display” option.

8. Click the button.

9. Open the updated displays in the FactoryTalk View Studio display editor. Check
for broken link objects. These objects appear as red squares or red rectangles
with a red “X” mark.

For example, the following contains broken link objects because the user-defined
global object name (OkalaxaxObjects.Group1) does not exists in the imported
application.

The migration tool is configured for PlantPAx Process Library HMI objects. It does not
include user-defined global objects. If the broken link objects are due to missing links to
user-defined global objects, then check to make sure you have included the required user-
defined global object files in your application. Refer to Appendix C for details.

10. Resave the display file. For example, move a graphic item and then move it back
to the original position to enable the “Save” display icon in FactoryTalk View
Studio. Resaving the display will update the global object links.

66
Appendix C. Global Objects with Migration Rules

When the migration tool updates graphics XML files, it does the following:

1. For each XML file, search for graphic items with links to global objects.

2. If the referenced global object is configured with a migration rule, then it updates
the global object parameters list and values based on the migration rule. For
example, if the referenced global object is a P_Motor object in the “(RA-BAS)
P_Motor Graphics Library.ggfx” global object file, then there is a migration rule
that defines how a Version 2 P_Motor object maps to a Version 3.5 P_Motor
object.

3. If the referenced global object is a Process Library global object, but it is not
configured with a migration rule, then the global object parameter values from the
old version are copied to the corresponding global object parameter values in the
Version 3.5 object. It is possible that the global object parameters list for some
of these objects may have changed between the versions and the updated files do
not contain all the required parameter values. For such cases, the graphic item is
included in the “Some Display Objects Not Updated” report. For example, the
global objects in the “(RA-BAS) BuiltIn Faceplate Objects” are not configured
with migration rules.

4. If the referenced global object is not part of the Process Library global object
files, then the graphic item is left unchanged and the graphic item is included in
the “Some Display Objects Not Updated” report. These objects will migrate
correctly if the same global object file and global object names are used in both
versions.

Global objects in the following PlantPAx global object files are configured with
migration rules:

 "(RA-BAS) BuiltIn Graphics Library", "(RA-BAS-ME) BuiltIn Graphics


Library"
 "(RA-BAS) P_AIn Graphics Library", "(RA-BAS-ME) P_AIn Graphics Library"
 "(RA-BAS) P_D4SD Graphics Library", "(RA-BAS) P_D4SD Motor Graphics
Library"
 "(RA-BAS-ME) P_D4SD Graphics Library", "(RA-BAS-ME) P_D4SD Motor
Graphics Library"
 "(RA-BAS) P_DOut Graphics Library", "(RA-BAS-ME) P_DOut Graphics
Library"

67
 "(RA-BAS) P_Motor Graphics Library", "(RA-BAS-ME) P_Motor Graphics
Library"
 "(RA-BAS) P_Motor2Spd Graphics Library", "(RA-BAS-ME) P_Motor2Spd
Graphics Library"
 "(RA-BAS) P_MotorHO Graphics Library", "(RA-BAS-ME) P_MotorHO
Graphics Library"
 "(RA-BAS) P_MotorRev Graphics Library", "(RA-BAS-ME) P_MotorRev
Graphics Library"
 "(RA-BAS) P_nPos Graphics Library", "(RA-BAS-ME) P_nPos Graphics
Library"
 "(RA-BAS) P_ValveMP Graphics Library", "(RA-BAS-ME) P_ValveMP
Graphics Library"
 "(RA-BAS) P_VSD Graphics Library", "(RA-BAS-ME) P_VSD Graphics
Library"
 "(RA-BAS) Process Graphics Library", "(RA-BAS-ME) Process Graphics
Library"

The global objects in all other “(RA-BAS)” or (RA-BAS-ME” global object files are not
configured with migration rules. Direct mapping is used for those objects; i.e., the global
object value from the old version is copied to the new version if the same global object
parameter exists for both versions.

The above list does not contain Process Library faceplate global objects. If the user
created custom faceplate displays using Process Library faceplate global objects, then
those displays may not be updated correctly.

User-Modified Process Library Global Objects


The migration tool will work with user-modified Process Library global objects as long
as the following conditions are satisfied:

 The global object name is not changed.


 The global object file name containing the global object is not changed.
 The global object parameters list and parameter names are not changed.

As long as the above conditions are satisfied, the user can make any changes within the
global object. For example, the user can change the size, colors, font, text strings, and
add/remove/edit graphic items within the parent global object.

68
Appendix D. Tutorial

In this tutorial we will update the Version 2 Mosquito Station sample application to
Version 3.5 using FactoryTalk View Studio Version 8.1 and Studio 5000 Logix Designer
Version 24. It is assumed the reader has basic understanding of FactoryTalk View Studio
and Studio 5000 Logix Designer.

The Mosquito Station sample files are included with the Version 2.0-10 Process Library
software package:

The steps used are:

1. Use Studio 5000 Logix Designer to change the “RSL5k_18_Mosquito_PlantPAxLib_2_0_10.acd”


file to Logix Version 24. The ACD file contains Process Library Version 2 AOIs.

2. Use FactoryTalk View Studio to export the Mosquito Station SE displays to XML
format. The displays must be exported from a SE application containing the
Process Library Version 2 global object files and image files.

3. Run the PlantPAx Process Library Migration Tool to update the graphics XML
files with Process Library Version 3.5 global object references.

4. Run the PlantPAx Process Library Migration Tool to update the V24 ACD file
with Process Library Version 3.5 AOI definitions. The tool will also update the
alarm tag severities, alarm condition strings, and add any necessary alias tags used
in the Version 3.5 faceplate-to-faceplate navigation.

69
5. Use Studio 5000 Logix Designer to check for errors in the updated ACD file. The
migration tool does not update program logic. If an updated AOI definition
contains additions or deletions to the AOI parameters, then the user must
manually update program logic that reference those AOI tags and parameters.

6. Use FactoryTalk View Studio to import the modified XML files. The files must
be imported into a SE application containing the Process Library Version 3.5
global object files and image files.

Change Logix ACD File Version


For this tutorial, the original “RSL5k_18_Mosquito_PlantPAxLib_2_0_10.acd” file is changed to a Logix
V24 controller using Studio 5000 Logix Designer. Other versions of Logix can also be
used (the migration tool currently supports versions 18 to 28).

Verify the controller and notice the “invalid signature ID” errors for the AOIs. The
Version 2 Process Library AOIs use signature IDs. These IDs are broken when the
controller is changed to a different version. These errors can be ignored.

The “RSL5k_18_Mosquito_PlantPAxLib_2_0_10.acd” file name is changed to


“RSL5k_24_Mosquito_PlantPAxLib_2_0_10”.

70
Create FactoryTalk View XML Graphics Files to Update
1. Double-click on the “FTVSE_6_0_Mosquito_PlantPAxLib_2_0_08.apa” archive
file to restore the SE HMI server files.

2. Trying to open the restored SE application in FactoryTalk View Studio Version


8.1 generates the following message:

3. The only things that are important when generating the graphics XML files is to
have the global object files, image files, and the display files to update in the SE
application. So rather than using the Legacy Tag Database Conversion utility to
update the SE application, we will use a temporary HMI application that contains
the Mosquito Station global object files, image files, and display files. These files
can be found in the restored SE HMI server directory and then added to the
temporary HMI application.

71
4. Open the “Oklaxas_MosquitoMainLine1” display and examine the global object
parameter values for the P50 motor object. You will notice that the global object
parameters list and values will be changed when migrated to Process Library
Version 3.5. Note also that the P50 interlock and permissive tags do not follow
the Version 3.5 faceplate-to-faceplate navigation naming convention – this will be
discussed in detail below.

72
5. Use FactoryTalk View Studio to export the “Oklaxax_*” display files to XML
format. Refer to Appendix A for instructions on exporting displays to XML files.

73
Run Process Library Migration Tool
1. Start the Process Library Migration Tool.
2. Select the second option (migrate HMI graphics and Logix ACD Files) option and
click Next.

Update XML Graphic Files

3. Make sure the “SE” View Product option is selected.


4. Select “2” from the “Version to Migrate FROM” drop-down list box.
5. Click the “Browse” button and select the directory containing the XML files
created in Step 5, page 73.
6. Click the “Select All” button to select all the “Oklaxas” files.
7. Select the “Quick (‘2’) option for #122 global object parameter value.

74
8. Click the Migrate button to update the selected XML files.

9. The displays contains some custom Okalaxas global object links and some library
objects without migration rules. A report window is generated that list those
objects as warnings. The migration tool uses migration rules for common library
global objects. Appendix C provides of summary the global objects with
migration rules and how it handles library objects without migration rules. Click
OK to close the report window.

75
10. The migration tool generated two batch import files. As explained on page 51,
the migration tool generates one or two batch import files. The Mosquito Station
contains some displays with items that reference global object links that are
changed when migrating from Version 2 to Version 3.5. Those displays are
added to the “BatchImport_MigratedFilesToCreate.xml” batch import file. The
other displays do not contain global object link changes; those displays are added
to the “BatchImport_MigratedFilesToUpdate.xml” file. These batch import files
will be used in the “Import Displays to FactoryTalk View Studio” section, page
79. A summary of the batch import files and import instructions are shown in the
“Files Migrated” report window. Click OK to close the window.

11. The migration tool created a “MigratedXmlFiles” folder containing the batch
import files and the updated XML display files. The folder is opened in Windows
Explorer. Keep this Explorer window opened, it will be used later.

76
Update ACD File

12. The migration tool opens the “Migrate ACD Files” dialog window.

13. Click the button and select the ACD file created in the
“Change Logix ACD File Version” section, page 70.

14. The HMI migration tool extract tags that must be checked for Version 3.x
faceplate-to-faceplate naming convention. These tags are grouped based on the
device shortcuts used in graphics XML files. The device shortcuts must then be
associated with the selected ACD files. There is only one device shortcut,
“[Mosquito]”, used in the Mosquito Station demo. Use the drop-down list box to
select “[Mosquito]” for the added ACD file:

77
15. When the ACD file is added, the software automatically selects a default library
XML file to use. The library XML file contains the Version 3.5 AOI definitions
that will be used in updating the ACD file. We will use the automatically selected
library XML file. Refer to “Select XML “Library” File Containing AOIs to
Upgrade To”, page 36, for details.

16. Make sure the “Update Logix Tag Severity Values…” box is checked.

17. Click . It will take several minutes for the migration to


complete.

18. After the migration is completed, click to exit the migration


tool.

Review ACD File


1. Use Studio 5000 Logix Designer to open the ACD file updated by the migration
tool.

78
2. Verify the controller. There is one error. A compiled error is generated when the
tag is updated to use the T_Sync AOI supplied with Process Library Version 3.5
because the updated definition contains a new “Ref_SockOpenMsg” parameter.
The user would need to add in the new parameter tag reference.

3. While not a complied error, the L_CPU_18 AOI needs to be replaced with a
L_CPU_24 AOI. The migration tool does not update the L_CPU_xx AOI to
match the controller version.

4. Refer to the “What the Migration Tool Updates” section, page 17, to review the
changes made by the migration tool.

Import Displays to FactoryTalk View Studio


We did the following in the previous sections:

1. Created a temporary FactoryTalk View SE HMI application using Process Library


Version 2.0 global object files and image files.
2. Added the Mosquito Station process displays, global object file, and image file to
the SE application.
3. Used the FactoryTalk View displays Import and Export Wizard to export the
displays to XML files.

79
4. Run the PlantPAx Process Library Migration Tool and updated the XML graphic
files with Process Library Version 3.5 configuration. The Migration Tool created
two FactoryTalk View displays batch import files.

We will now use the batch import files to create/update the Mosquito Station process
displays using the Version 3.5 Process Library HMI components.

The updated graphics XML files must be imported into a SE application containing
Process Library Version 3.5 global object files and images. We are using FactoryTalk
View Version 8.1 for this tutorial. As noted previously, the original Mosquito Station SE
application was pre-Version 6. Rather than convert the original SE application, we are
going to create a new SE application using Process Library Version 3.5 HMI
components.

1. Create a new SE application.

2. Add Process Library Version 3.5 image files, global objects files, and faceplate
displays to the SE application. Also make sure to add the “NavToDisplay”
macro – this macro is used in the Version 3.5 faceplate-to-faceplate navigation.
The Version 3.5 files can be downloaded from the Rockwell Automation Product
Compatibility and Download Center (PCDC) website.

3. Add the original “Oklaxas_*” Mosquito Station process displays to the SE


application.

4. Add the “CustomizableObjects” and “OkalaxasObjects” global object files from


the original Mosquito Station application to the SE application.

80
5. Add the Mosquito Station macros to the application

6. Open the “Oklaxas_MosquitoMainLine1” display and examine the P50 motor


graphics object. Compare it to the Version 2 display on page 72 (Step 4). The
object uses the Version 3.5 P_Motor global objects list, but the #103 value is
from the Version 2 display and is incorrect.

Importing the “BatchImport_MigratedFilesToCreate.xml” File

The migration tool created a “BatchImport_MigratedFilesToCreate.xml” file. The


contents are:

81
As discussed on page 52, the import files in the batch file must be imported by creating
new displays. Any existing displays in the application must be deleted or removed before
using the FactoryTalk View Import Wizard.

Go to the SE application and delete the four displays listed in the batch import file:

Use the FactoryTalk View “Import and Export” wizard to import the
“BatchImport_MigratedFilesToCreate.xml” file. Refer to the instructions in Appendix B,
page 59.

The four deleted displays are recreated and added back into the application after running
the import wizard.

Open the “Oklaxas_MosquitoMainLine1” display and examine the P50 motor graphics
object. The #103 parameter now shows the correct value. Also note that #122 is set to
the value specified in the migration tool.

82
Importing the “BatchImport_MigratedFilesToUpdate.xml” File

The migration tool created a “BatchImport_MigratedFilesToUpdate.xml” file. The


contents are:

As discussed on page 52, the import files in the batch file cab be imported by updating
the existing displays, or by creating new displays (existing displays must be deleted or
renamed first). Since the five displays are already in the SE application, we will use the
update existing displays method. Follow the instructions in Appendix B, page 63, to use

83
the FactoryTalk View “Import and Export” wizard to import the
“BatchImport_MigratedFilesToUpdate.xml” file.

(Optional) Run Updated Mosquito Station Controller and HMI


Client
Using the updated controller ACD file and the updated SE application from the previous
two sections, create and run a SE client. Tip: configure the SE client to use the startup
and shutdown macros.

Exercise the displays by clicking on the graphic objects and faceplates.

84
Appendix E. Microsoft Windows Access Violation

If an access violation error occurred when running the ACD update migration tool, then
the Windows security settings for the program configuration files must be changed.

Sample error message:

To change the Windows security settings:

1. Exit the migration tool software.


2. Log in as a Windows user with Administrator privileges.
3. Use the Windows Explorer to open the “C:\Program Files (x86)\Rockwell
Automation” folder.
4. Right-mouse click on the “PlantPAx Process Library Migration Tool” folder and
select “Properties” from the popup menu item.

85
5. Click on the “Security” tab.

6. Click .

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

8. Click OK to close the properties dialog window.

87

You might also like