RA Foundations Manual Part 2 V2

Download as pdf or txt
Download as pdf or txt
You are on page 1of 301

RA Foundations

Studio Logix Designer


Part 2

c
Important User Information
This documentation, whether, illustrative, printed, “online” or electronic (hereinafter “Documentation”) is intended for use only as
a learning aid when using Rockwell Automation approved demonstration hardware, software and firmware. The Documentation
should only be used as a learning tool by qualified professionals.

The variety of uses for the hardware, software and firmware (hereinafter “Products”) described in this Documentation, mandates
that those responsible for the application and use of those Products must satisfy themselves that all necessary steps have been
taken to ensure that each application and actual use meets all performance and safety requirements, including any applicable
laws, regulations, codes and standards in addition to any applicable technical documents.

In no event will Rockwell Automation, Inc., or any of its affiliate or subsidiary companies (hereinafter “Rockwell Automation”) be
responsible or liable for any indirect or consequential damages resulting from the use or application of the Products described in
this Documentation. Rockwell Automation does not assume responsibility or liability for damages of any kind based on the
alleged use of, or reliance on, this Documentation.

No patent liability is assumed by Rockwell Automation with respect to use of information, circuits, equipment, or software
described in the Documentation.

Except as specifically agreed in writing as part of a maintenance or support contract, equipment users are responsible for:
• properly using, calibrating, operating, monitoring and maintaining all Products consistent with all Rockwell Automation
or third-party provided instructions, warnings, recommendations and documentation;
• ensuring that only properly trained personnel use, operate and maintain the Products at all times;
• staying informed of all Product updates and alerts and implementing all updates and fixes; and
• all other factors affecting the Products that are outside of the direct control of Rockwell Automation.

Reproduction of the contents of the Documentation, in whole or in part, without written permission of Rockwell Automation is
prohibited.

Throughout this manual we use the following notes to make you aware of safety considerations:

Identifies information about practices or circumstances


that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.

Identifies information that is critical for successful application and understanding of the product.

Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you:
• identify a hazard
• avoid a hazard
• recognize the consequence

Labels may be located on or inside the drive to alert people that dangerous voltage may be present.

Labels may be located on or inside the drive to alert people that surfaces may be dangerous temperatures.

Rockwell Automation | 2021 2


Studio 5000 Logix Designer: Advanced Lab

Contents
Before you begin ........................................................................................................................................... 7
About this lab .................................................................................................................................................................................... 7
Tools & prerequisites ........................................................................................................................................................................ 7

Lab 1: New Features in Versions 32 and 33 <40 minutes> .................................................... 11


1.1 Workflow Enhancements .......................................................................................................................................................... 11
1.2 Function Block Diagram (FBD) Enhancements ........................................................................................................................ 31
1.3 Logix Tag-Based Alarms (LTBA) .............................................................................................................................................. 35
1.4 ControlFLASH Plus ................................................................................................................................................................... 46
1.5 Studio 5000 Data Exchange ..................................................................................................................................................... 58

Lab 2: Enhancements introduced in version 31 <50 minutes> ............................................. 60


2.1 Logix Designer User Interface Refresh ..................................................................................................................................... 60
2.2 Structured Text Editor ............................................................................................................................................................... 64
2.3 Function Bock Diagram (FBD) Features ................................................................................................................................... 81
2.5 Detect a Lonely Routine with Verify .......................................................................................................................................... 87
2.4 On-Line Power Rail Display ...................................................................................................................................................... 89
2.6 Delete a Program Without Having to Unschedule It ................................................................................................................. 95
2.7 Output Window ......................................................................................................................................................................... 97

Lab 3: Introduction to the Logical Organizer <10 minutes> ................................................ 101


3.1 Using the Logical Organizer.................................................................................................................................................... 101
3.2 Find in Organizer .................................................................................................................................................................... 106

Lab 4: Compare and Merge Tool <15 minutes> ........................................................................ 108


4.1 Open the Logix Designer Compare Tool ................................................................................................................................ 109
4.2 Comparing Project Files .......................................................................................................................................................... 111
4.3 Comparing Project Exports ..................................................................................................................................................... 117
4.4 Merging Project Files .............................................................................................................................................................. 121
4.5 Saving Merged Project............................................................................................................................................................ 128
4.6 Reviewing Merged Project ...................................................................................................................................................... 130

Rockwell Automation | 2021 4


Lab 5: Using AOI’s to Monitor Module Status <15 minutes> ............................................... 131
5.1: Using Module as an InOut Parameter.................................................................................................................................... 131
5.2: Using the Module Object Path Attribute ................................................................................................................................. 139

Lab 6: Improving Efficiency Using Partial Import Online <30 minutes> .......................... 145
6.1 Code Library Example ............................................................................................................................................................ 145
6.2 Line Expansion Example ........................................................................................................................................................ 154
6.3 PIO Search and Replace Example ......................................................................................................................................... 170

Lab 7: Introduction to Program Parameters <40 minutes>.................................................. 186


7.1 Input Parameters .................................................................................................................................................................... 187
7.2 Output Parameters.................................................................................................................................................................. 194
7.3 InOut Parameters.................................................................................................................................................................... 202
7.4 Public Parameters................................................................................................................................................................... 205
7.5 Direct Access of Program Parameters.................................................................................................................................... 211

Lab 8: Add-On Instructions (AOI) <25 minutes> ...................................................................... 217


8.1 AOI Basics .............................................................................................................................................................................. 218
8.2 Creating an Add-On Instruction (AOI) ..................................................................................................................................... 222
8.3 Entering the Logic ................................................................................................................................................................... 226
8.4 Using the AOI in RLL (Ladder Logic) ...................................................................................................................................... 228
8.5 Using the AOI.......................................................................................................................................................................... 230
8.6 Creating Alias Tags................................................................................................................................................................. 233
8.7 Using an Add-On Instruction Output in Ladder ....................................................................................................................... 234
8.8 Using the AOI in a Function Block (FB) Routine ..................................................................................................................... 235
8.9 Re-Using an AOI ..................................................................................................................................................................... 238
8.10 AOI Signatures...................................................................................................................................................................... 242
8.11 Export AOI ............................................................................................................................................................................ 244

Lab 9: Using a SD card with a Logix Controller <15 minutes> ........................................... 248
9.1 Opening an Existing Controller Project ................................................................................................................................... 249
9.2 Using code to list files and directories..................................................................................................................................... 250
9.2 Create a Directory ................................................................................................................................................................... 254
9.3 Create, Edit, and Delete a File ................................................................................................................................................ 255
9.4 Read Data from SD card......................................................................................................................................................... 257
9.5 Storing and Loading Recipe Data ........................................................................................................................................... 259

Lab 10: Controller Change Log <10 minutes> .......................................................................... 263

Rockwell Automation | 2021 5


Lab 11: Drives Integration into Logix Designer <15 minutes> ........................................... 279
Exercise 1: Exploring the Add-On Profile for the PowerFlex 525 Drive ........................................................................................ 280
Exercise 2: Taking Advantage of Having the Drive in the Controller Organizer ........................................................................... 285

Lab 12: Extended Data Types and 64 Bit Math Instructions <5 Minutes> ...................... 288
12.1 V33 Data Type Enhancements ............................................................................................................................................. 289

Lab 13: Highly Integrated HART (HIH) <7 Minutes> ............................................................... 293
13.1 Highly Integrated HART ........................................................................................................................................................ 293

Lab 14: Automatic Diagnostics <10 Minutes> .......................................................................... 299


14.1 Hardware Diagnostics Workflow Enhancements .................................................................................................................. 299

Unguided Exercises ........................................................................................................................... 300


Clock Sync Service ....................................................................................................................................................................... 300
Convert Project to Previous Revision ........................................................................................................................................... 300
Data Preserve Download .............................................................................................................................................................. 300
Socket Communication ................................................................................................................................................................. 301

Notes ......................................................................................................................................................... 302

Rockwell Automation | 2021 6


Before you begin

About this lab


Welcome to this lab! This session provides you with an opportunity to explore advanced concepts within the Logix platform. The
following sections explain what you will be doing in this lab session, and what you will need to do to complete the exercises.
You will have approximately 90 minutes to complete as many sections of this lab as you would like to.

Important! Please be aware that it would take approximately 240 minutes (4 hours) to complete all the
sections in this lab manual! You do not need to complete all the sections and you do not need to do them in
order!

The intent of this lab to present a variety of topics for the user to select from; each lab section is independent so you can pick
and choose what you are interested in reviewing during the time available.

Important! Since this lab is intended to be run in different environments (see sub-section Logix Controller for
more details on lab setup options), understand that certain lab sections in this lab manual have been
adjusted to accommodate for those different environments. For specific details, please pay special attention
to any notes that will look similar to this one. [beginning with Important!]

Tools & prerequisites


This lab is intended for individuals who use:
 Studio 5000 Logix Designer
 ControlLogix or CompactLogix

Lab Files
This lab uses the following Logix Designer application files:
Lab 1: New Features in Version 32 and 33  Whats_New.ACD

Lab 2: Usability and Workflow Enhancements  Usablity_Enhancements.ACD

Lab 3: Introduction to the Logical Organizer  Logical_Organizer.ACD

Lab 4: Compare and Merge Tool  Line_Expansion.ACD


L75_Project_Start.ACD

Lab 5: Improving Efficiency Using Partial Import Online  Tank_Controller.ACD


Tank_Supervisor.ACD
Station_Section3.L5X

Lab 6: AOI Hardware Monitoring  Hardware_Monitoring_ModuleSts.ACD


Hardware_Monitoring_ModuleWho.ACD

Lab 7: Introduction to Program Parameters Sample_Project_Start.ACD

Rockwell Automation | 2021 7


Lab 8: Add-On Instructions AOI  AOI_Start.ACD
AOI_Next.ACD
Lab 9: Using a SD card with a Logix Controller  SD_Read_Write.ACD
(Files to be placed on SD card)

Lab 10: Controller Change Log  Controller_Log.ACD


(ControllerLogSample.txt)

Lab 11: Drives Integration into Logix Designer  PowerFlex_Lab.ACD

Lab 12: Extended Data Types and 64 Bit Math Instructions  ExtendedDataTypes_64BitMath.ACD

Lab 13: Highly Integrated HART (HIH)  HighlyIntegrated_HART.ACD

Lab 14: Automatic Diagnostics  Automatic Diagnostics Demo.MP4

Unguided Exercises  Clock Sync Service

Convert Project to Previous Revision

Data Preserve Download

Socket Communication

Rockwell Automation | 2021 8


Logix Controller
This lab can be completed using one of the following forms of Logix controller:
A. ControlLogix 1756-L85E demo box (1756-L85E, 1756-OB16IEF, 1756-IB16IF, 1756-IF8I, 1756-OF8I)

B. ControlLogix hardware (1756-L85E, 1756-OB16IEF, 1756-IB16IF, 1756-IF8I, 1756-OF8I)


with an HMI faceplate, all located in cloud (e.g. onCourse)

C. Emulated Logix controller (FactoryTalk Logix Echo) with an HMI faceplate – local or cloud-based (e.g. onCourse)

Rockwell Automation | 2021 9


Software
This lab uses or discusses the following software:
 Studio 5000® Logix Designer
 Studio 5000® Logix Designer Compare & Merge Tool
 ControlFLASH Plus

Rockwell Automation | 2021 10


Lab 1: New Features in Versions 32 and 33 <40 minutes>

This section will introduce some of the features that were added in version 32 and 33 of Studio 5000 Logix Designer.
Goals of this lab section:
 Highlight new usability and workflow enhancements available in latest versions
 Introduce Function Block Diagram (FBD) functions
 Introduce Logix Tag-Based Alarms
 Introduce ControlFLASH Plus
 Show Studio 5000 version 32 data exchange capabilities
Additional new features introduced in version 33 can be reviewed in individual lab sections:
 Lab 12: Extended Data Types and 64 Bit Math Instructions
 Lab 13: Highly Integrated HART (HIH)
 Lab 14: Automatic Diagnostics

1.1 Workflow Enhancements


In this sub section you will introduce workflow and other enhancements that were added in the latest versions.

Task Period Display

1. Double-click on the Lab Files shortcut on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 01 Whats New.

3. Open the project named Whats_New.ACD.

Note: This same ACD file will be used for each section of this lab. So, keep it open until you are instructed to
close Studio 5000 Logix Designer.

Rockwell Automation | 2021 11


4. Review the contents of the Controller Organizer. Notice that the Periodic Task now displays the configured
period next to it’s name:

Task Period Display


New since version 33, this enhancement brings an easy overview of tasking model defined in the controller
project.

Rockwell Automation | 2021 12


Web Page Configuration

Embedded controller web pages can be easily enabled / disabled.

5. Open Controller Properties by Edit  Controller Properties.

6. Controller Properties window pops up. Click on the Security tab.

7. Select the Enable Controller Web Pages check box to make the embedded controller web page
accessible and then click OK to accept the changes and close the dialog.

Web Page Configuration


New since version 33, this enhancement allows the user to easily enable / disable the embedded diagnostic
webpages of the controller (the webpages are discussed later in section Increased Diagnostics).
In the firmware revisions earlier than 33, it was possible to enable / disable the embedded diagnostic
webpages using a CIP message, as described in ControlLogix 5580 and GuardLogix 5580 Controllers User
Manual (publication 1756-UM543), Chapter 12.

Rockwell Automation | 2021 13


Nested I/O Delete

8. Navigate to the I/O Configuration.


Notice there are inhibited 1756-EN2TR modules named R01_220, R02_221 and R03_222 with various child
I/O modules configured.

9. Select R03_222, right-click and select Delete.

10. You will see the following window. Select Yes.

Nested I/O Delete


New since version 32, you can delete a parent module and all the children are deleted in a single operation.
As mentioned in the warning window, this operation cannot be undone.

Rockwell Automation | 2021 14


Trend Selection Options

The options for selecting trends has expanded.

11. In the project navigate to AssetsTrends.

12. Expand the Trends folder (if needed).

13. While holding the Ctrl key, click on more than one trend to select them similar to what is shown below; you
do not need to match the exact selection.

Rockwell Automation | 2021 15


14. Right-click and you will see several familiar options (Cut, Copy, Delete, Export).

15. Click on the Trends folder to remove selections.

16. Click on Trend_02.

17. While holding the Shift key, select Trend_09. You will see this result:

Trend Selection Options


New since version 32, there are expanded trend selection options. In the above exercise, you used both Ctrl-
select (allowing you to select any trend on the list) and Shift-select (making a continuous selection between
your first and second click).
You can now manage trends much faster with these new multi-select options which allow the same previous
trend actions:
- Copy/Cut/Paste
- Delete
- Export/Import

Rockwell Automation | 2021 16


Close All But This

18. Open at least 3 routines to populate the editor window similar to what is shown below. The exact routines
are not important. It’s only important that you open multiple routines.

19. Right-click on an open routine and select Close All But This:

You will see that all the open editor tabs are closed except for the selected item.

Close All But This


New since version 32, this enhancement allows you to quickly clean up your workspace.
Note: This only affects the window or frame that is in focus.
Example: You are using two monitors with a single project. You tear off routines to your second monitor and
group them so that they are in the same frame.
Selecting Close All But This in the frame on your second monitor will close everything but the selected item
and it will not change the window or frame on your first monitor.

Rockwell Automation | 2021 17


Download Options

20. For the remaining sections, you will need to be online with the controller.
Select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the controller with
IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

21. Select Download.

Rockwell Automation | 2021 18


22. There is a new Download window. Select the Options tab.

23. There are now new download options that allow for greater user flexibility when downloading to a Logix
controller.

Data Preserve Download Options


New since version 32.01, there are new options to preserve data during a download.
Preserve online tag values creates a snapshot of the controller’s tag memory before the download takes
place and restores the tag memory after the download completes. You have the additional option to save this
data to a .XML file.
Restore online tag values from file restores the controller tag memory using a .XML file.
For additional information on this feature see QA45741 - Studio 5000 Logix Designer Download Options.

Rockwell Automation | 2021 19


Increased Diagnostics

24. Select Download to begin downloading the project file.

It may take a few minutes to download the project. Continue with the lab.

Important! The following few steps explain what you would see on the 4-character LCD display of the
controller while you are downloading a program to it.
If you run a version of lab with emulator (FactoryTalk Logix Echo), you will not be able to monitor the LCD
display during this lab.
You can either read through this section or skip to section Quick Watch.
When using hardware located in cloud, you should be able to watch the LCD display through a web cam.

25. For 5580 ControlLogix controllers, the 4-character scrolling status display is in the location highlighted
below.

When a project is downloading, it will display “Download in Progress” so that you can actively monitor the
download progress if you are physically local to the controller.

Rockwell Automation | 2021 20


Important! The following few steps explain what information can be reached using controller’s diagnostic
webpage.
If you run a version of lab using emulator (FactoryTalk Logix Echo), you will not be able to access
controller’s diagnostic webpage, since that is not supported by FactoryTalk Logix Echo.
You can either read through this section or skip to section Quick Watch.

26. Open the Microsoft Edge web browser from the task bar.

27. In the URL field, enter the IP address of the controller: 192.168.1.20.

28. The default webpage is the embedded controller webpage which includes additional sections of Controller
Diagnostics and Status Indicators from previous firmware revisions. View the information that is provided
on the webpage

29. Close Microsoft Edge.

Rockwell Automation | 2021 21


4-Character Scrolling Status Display
Additional messages were introduced to the 4-character display in version 31 firmware including “Download
in Progress” and “Download Aborting”. A full list of these messages are included in the ControlLogix 5580
and GuardLogix 5580 Controllers User Manual (publication 1756-UM543) in Appendix A under General
Status Messages.

Increased Webpage Diagnostics


The embedded webpage got updated in version 32 firmware to include:
- 4-character status display information
- Key switch position
- Controller mode
- LED status
- Forces status
- Controller change log signature
- Controller change log
- Major and minor faults
- Safety diagnostics (applies to GuardLogix® 5580 & Compact GuardLogix® 5380)

Rockwell Automation | 2021 22


Quick Watch

30. Once the download is complete, put the controller into RUN mode by selecting Yes in the window.

31. If not prompted, switch the controller to RUN mode by selecting Rem Prog and then Run Mode.

32. Navigate to MainTaskMainProgramQuickWatchSample and open it.

Rockwell Automation | 2021 23


33. Use the keyboard shortcut Alt+3 or select ViewWatch which will bring up the Watch pane.

To make the pane larger hover over the top of the pane until you see the cursor change, left-click and drag up.

You may need to make the Watch pane larger and pin it, so it does not Auto Hide.
The Auto Hide option selector is found on the right side of the pane as highlighted in the image below.

If the window is auto hiding then you should toggle the selector. As shown, the window will not auto hide.

34. Enter the name MyWatch in the Quick Watch input box.

Rockwell Automation | 2021 24


35. In the Watch pane drop-down, select MainProgram-QuickWatchSample from the drop-down list.

The Watch pane auto populated with the tags referenced in the routine.

36. Click on the row selector for the top row (with the tag Dime). Once the row selector is clicked the row will
highlight as shown.

Rockwell Automation | 2021 25


37. Hold the Shift key and select the row selector for the 5 th row (with the tag Quarter). The first five rows should
be selected as shown.

38. Use the keyboard shortcut Ctrl+C OR right-click on a row selector and select Copy.

39. In the Watch pane drop-down, select MyWatch from the drop-down list.

Rockwell Automation | 2021 26


40. Click the top row selector, right-click and select Paste.

41. Now your MyWatch list is populated with several tags

42. In the Watch pane drop-down, select MainProgram-QuickWatchSample.


Then re-select MyWatch.

Notice that the tags we added in MyWatch remain. You created a Watch by using a copy and paste to
populate the Watch fields.

Rockwell Automation | 2021 27


43. Close the MainProgram-QuickWatchSample routine.

Notice that MyWatch is still open and selectable in the Watch pane.
However, if you try to select MainProgram-QuickWatchSample you cannot because it is no longer open.

44. Close the Quick Watch pane.

Quick Watch
Version 32 enhanced the Quick Watch functionality by including a drop-down selection for any open routine.
That also includes routines in a tear away outside of the main Logix Designer window. In past revisions, you
could only select the currently opened routine.

Rockwell Automation | 2021 28


Rename User-Defined Data Type (UDT) Members Online

45. Navigate to AssetsUser-DefinedConveyor and open the Conveyor UDT.

Notice that there are members that start with Spare_ indicating these are elements that have been reserved
for future use by whoever created the UDT.

46. Update Spare_DINT_00 to Motor_Temp and select OK.

Rockwell Automation | 2021 29


47. Navigate to the Controller Tags and find the tag UDT_Rename.
Expand the tag and adjust the name column so that you can see all the members.

The name of the member that you changed in the definition is reflected in the instances of the UDT.

48. Navigate to the Conveyor UDT definition (AssetsUser-DefinedConveyor), change the member
Spare_BIT_00 to Okay_To_Stop_Motor, and click OK.

49. Navigate to Controller Tags and find UDT_Rename. Again, notice that the member updated in the instance
of the UDT.

50. Navigate to AssetsTrendsTrend_UDT and open Trend_UDT.

Both UDT members that were renamed were updated in the trend.

Online Editing Enhancements


A common practice is to design a UDT with excess or spare members for future use. You can now update
the names of the spare members online without the need to download to see your changes reflected in
Studio 5000 Logix Designer version 32.
The current releases of FactoryTalk Linx and PanelView 5000 include the ability to update tag
names/members while the tag is on scan.
Tags that are updated are also updated in a configured trend while online.

Rockwell Automation | 2021 30


1.2 Function Block Diagram (FBD) Enhancements
This subsection will guide you through FDB enhancements which include
 FBD Functions
 Enhanced Wire Routing and Wire Jumps
Both items were introduced in version 32, with additional FBD functions coming in version 33.

FBD Functions

51. Navigate to TasksT01_PP01 and open the routine FBD_Math.

52. The left side of the sheet includes some new FBD functions while the right side shows traditional FBD
instructions.

With the default zoom (100%) you will see all the FBD functions on this sheet. To see all the FBD
instructions on this sheet you would have to scroll down. Notice that the functions and instructions are
performing the same operations.

Rockwell Automation | 2021 31


FBD Functions
New to version 32, FBD functions include compute/math, compare and Boolean logic operations.
FBD functions have a smaller visual footprint and use less controller memory because they do not use a
backing tag. These functions are meant to replace existing instructions that share the same function or
operation.
Below is the full list of 20 FBD functions introduced in version 32:
Compute/Math:
Add Function
Subtract Function
Multiply Function
Divide Function
Modulo Function
Square Root Function
Negate Function
Absolute Value Function

Compare:
Limit Test Function
Mask Equal Function
Not Equal Function
Not Equal Function
Greater Than Function
Greater Than Or Equal Function
Less Than Function
Less Than Or Equal Function

Boolean:
Boolean And Function
Boolean Or Function
Boolean Exclusive Or Function
Boolean Not Function
Additional 16 FBD functions were introduced in version 33, as listed below:
Compute/Math/Conversion:
Sine Function
Cosine Function
Tangent Function
Arcsine Function
Arccosine Function
Arctangent Function
Neutral Log Function
Log Base 10 Function
X to Power of Y Function
Radians to Degrees Function
Degrees to Radians Function
Truncate Function
Logical:
Bitwise AND Function
Bitwise OR Function
Bitwise Exclusive OR Function
Bitwise NOT Function

This feature is only available for 5580/5380/5480 controllers.

Rockwell Automation | 2021 32


Wire Routing and Wire Jumps

53. Open the SampleRouting routine

54. Compare the routing on screen to a similar layout that was created in version 31 shown below.

Rockwell Automation | 2021 33


FBD Wire Routing
Wire routing has been optimized in version 32 of Studio 5000 Logix Designer making the layout simpler and
more intuitive. Wire jumps also were added (shown below) in version 32.

Wire jumps simplify the wire routing and make the FBD easier to read and interpret.

Rockwell Automation | 2021 34


1.3 Logix Tag-Based Alarms (LTBA)
This subsection will introduce Logix Tag-Based Alarms (LTBA) and review some of the enhancements for versions 32 and 33.
LTBAs were originally introduced in version 31 of Logix Designer. You will:
 Create a new LTBA
 Use Extended Tag Properties to construct an alarm message
 View the alarms in the Alarm Manager
 Programmatically access to Alarm Sets and Attributes

Create new LTBA

55. Navigate to the Controller at the top of the Controller Organizer, right-click and select Properties.

56. Select the Date/Time tab, click the Set Date, Time and Zone from Workstation button and click OK.

This sets the time in the controller so that the referenced times used later in the lab are accurate.

Rockwell Automation | 2021 35


57. Navigate to TasksMainTaskLTBA and open the Parameters and Local Tags.

58. Right-click on TankTemp and select Add Alarm for “TankTemp”.

59. Fill in the alarm properties as noted below and click OK.

Rockwell Automation | 2021 36


60. Navigate to Alarm ManagerAlarms and double-click to open Alarms.

61. Check the box in the Use column for all the alarms you see.

The alarm that you created (LO) is in the list as well as 3 other alarms linked to TankTemp.
By checking the Use column we are enabling the alarms.

Logix Tag-Based Alarms (LTBA)


At this point in this subsection, you created a new LTBA for a simulated tank temperature.
There were 3 existing LTBAs configured for the TankTemp tag indicating various temperature conditions.
You enabled all the LTBAs for the TankTemp tag. This was all done while online with the controller.
LTBAs were originally introduced in version 31 of Studio 5000 Logix Designer.

Rockwell Automation | 2021 37


Use Extended Tag Properties in alarm messages

62. In the Alarms list, double-click the LO alarm that you just created.

63. The Alarm Properties dialog appears. Click on Editor button next to the Message text area.

64. We will add tag description of tag TankTemp to the alarm message:
In the Variable drop-down list choose Select Tag Extended Properties
Click on the three dots next to the Tag: and pick \LTBA.TankTemp
From the Extended Property drop-down list select Description
Click <- Add

Rockwell Automation | 2021 38


65. Modify the appearance of the alarm message as desired and click OK to close the Alarm Message Editor.

66. Click OK again to close the Alarm Properties dialog.

Extended Tag Properties in alarm messages


Use of Extended Properties allows the users to build alarm messages using contextual data that is already
available in the project.
It adds flexibility to alarm messages build process and ensures data consistency throughout the control
system.
This feature was added in version 33 of Studio 5000 Logix Designer.

Rockwell Automation | 2021 39


Alarm Manager View Status

67. Navigate to TasksMainTaskLTBA and open the Parameters and Local Tags.
Make sure you are on the Monitor tab in Parameters and Local Tags and change the Value column to 25.

68. Navigate to Alarm ManagerAlarms and open Alarms. Notice the change in the State column.

There is an indication that the specific alarm is active by the bell icon.

69. Navigate to TasksMainTaskLTBA and open the Parameters and Local Tags and update the value to
40.

70. Navigate to Alarm Manager->>Alarms and open Alarms.

Notice that icons are slightly different now. Let us look at the difference.

71. Right-click on the LOLO row and select Alarm Properties.

Rockwell Automation | 2021 40


72. Select Status.

73. The Alarm State indicates Normal, Unacknowledged meaning that the alarm is no longer active, but it has
not been acknowledged.

74. Click the Acknowledge button and see the state change.

Note the other status information on this page including various times.

75. Click OK to exit.

76. Open the properties of LO and select Status.

The Alarm State is InAlarm, Unacknowledged.

Rockwell Automation | 2021 41


77. Click Acknowledge and then OK to exit the properties.

78. Once back at Alarms note the change in the icon.

Alarm Manager View Status


The State column, which provides a high-level view of your configured alarms, was added in version 32 of
Logix Designer. The icons in the State column gives status information of the alarm. Some states include:
- In alarm, unacknowledged
- In alarm, acknowledged
- Normal, unacknowledged
- Alarm disabled

Rockwell Automation | 2021 42


Alarm List Sorting and Filtering

79. Click on the Name column to sort the column in descending order.

Notice the order of the list updated.

80. Type lo in the Search box.

The Alarm List updates with items that contain the search string.

Alarm List
The Alarm List includes all tag-based alarms in the project. Use the Alarm List to view the status of alarms,
sort alarms, and enable and disable alarms.
In the lab we used the sorting and searching to narrow down the list of alarms. There is also the Show menu.

These give you options to find any alarm in your project.

Rockwell Automation | 2021 43


Programmatic Access to Alarm Attributes

81. Navigate to TasksMainTaskLTBA->MainRoutine.

82. Focus on rungs 1 and 2.


Some status information of TankTemp.@AlarmsHIHI & [email protected] are reported using XICs.

83. Read the rung descriptions for rungs 3, 4, and 5 and toggle SetHIHI, SetNormal and Ack_HI_HIHI.
Toggle the Set bits for rungs 3, 4, and 5 and notice how the XICs on rungs 1 and 2 update as you toggle the
various bits.

Rockwell Automation | 2021 44


Programmatic Access to Alarm Attributes
In the example above, .InAlarm and .Acked attributes were shown. There are many other available attributes.
Details for the other attributes can be found in the Help file (click F1 to access the Help file) under
AlarmsTag-based alarmsAccess tag-based alarms in logic.
Depending on the attribute, they can have read or read and write access.
You can also use different access levels to get additional alarm information. On Rungs 1 and 2, some alarm
attributes for the tag TankTemp were referenced.
Examine Rung 0:

Notice ::THIS and \THIS were used to get different groupings of alarm information.
::THIS is for alarm attribute information for the whole controller.
\THIS is for alarm attribute information for the program. For this example, these values were the same
because all the Logix Tag-based Alarms were linked to TankTemp which is in this program.

84. When complete with this subsection you can close the Whats_New project. Do not need to save the
changes to the project file.

Rockwell Automation | 2021 45


1.4 ControlFLASH Plus

Important! The following subsection focuses on the ControlFLASH Plus software.


Please be aware that if you work with remotely based lab, firmware flashing has been disabled to
avoid inadvertently flashing remotely located hardware.
If you run a lab using FactoryTalk Logix Echo, you will not be able to flash the devices either, as
there is no hardware used.
You will still be able to experience the interface of ControlFLASH Plus and test features that do not involve
the actual firmware change operation. Note that some features require internet connectivity [see A reminder]

This sub section will introduce the flashing tool ControlFLASH Plus and demonstrate some new features including:
 Updating multiple devices in the same operation
 Firmware library management
 Favorite capabilities
ControlFLASH Plus was originally introduced with the same FactoryTalk system components as version 31 of Logix Designer.

ControlFLASH New Controller Group Listings


Version 31 and up of controller firmware are now shown in controller groups:

These controller groups are no longer listed by catalog number (1756-L*, 1769-L*, etc.) and appear at the
bottom of the ControlFLASH selection window. The new controller firmware groups include all the firmware
for the group in a single .dmk file.
You will not be using ControlFLASH in this lab subsection, but this is a common tripping point for
ControlFLASH users updating to version 31 and later controller firmware.

Flash Devices

1. Open ControlFLASH Plus from the desktop shortcut or Start menu item.

Rockwell Automation | 2021 46


2. Examine this sample ControlFLASH Plus window.

Note: As already mentioned in the introduction: If you work with a remote version of this lab, firmware
flashing operations have been disabled You can still follow the manual instructions, but you will not be able to
finish the actual operation of firmware write.
You will see an informational message “User not permitted to Flash”.

The tool uses a modern interface that utilizes tabs to organize activities.

A reminder: The window might contain less information if there is no internet connection:

Rockwell Automation | 2021 47


3. Select the Flash Devices tab (if not selected already) and click the highlighted icon.

4. The Network Browser will be active. Navigate to the location shown below (IP address 192.168.1.20 under
AB_ETHIP-1 driver) and highlight the Backplane until the modules in the chassis are populated.

5. Click OK once the Network Browser window displays the module in slot 6 (1756-OF8I).

Note: As already mentioned in the introduction: If you use a FactoryTalk Logix Echo version of the lab
(emulator), you will not see any I/O modules. You will not be able to perform the flashing operation, but you
can still follow the lab manual.

Rockwell Automation | 2021 48


6. The Network Browser is like previous RSWho windows. It utilizes FactoryTalk Linx to navigate your
network.

7. The Network Browser has enhanced capabilities including a Search feature that will filter results, in-window
driver configuration, level-based browsing and more.
A demonstration of these mentioned features are skipped for this section for time.
Click Cancel to close the Network Browser.

8. On the Flash Devices tab:


Select the checkboxes for 1756-IF8I and 1756-OF8I
Choose firmware revisions available locally on the PC
Click Next.

9. The next screen is a final acknowledgement before you begin the flash operation.
Put the controller into remote program mode by moving the controller keyswitch to PROG and then to REM
(a key is available with the demo hardware).

10. Click Flash to begin updating the modules.

Rockwell Automation | 2021 49


11. Notice the information being displayed in the Status column as the modules are flashed.

12. The flash should complete successfully, and you will see the Flash Results window.

13. Click Close to close the Flash Results window.

14. Select Done in the lower-right corner to complete the operation.

Flashing Multiple Devices


ControlFLASH Plus added the capability to flash multiple devices. In the above steps, notice that the
modules were flashed at the same time (concurrently).
ControlFLASH Plus can flash up to 20 devices concurrently and potentially all the devices that were browsed
from the Network Browser in a single session! That means as a user you can flash all of your modules with a
single operation!
ControlFLASH Plus uses an algorithm to determine flashing order. The algorithm schedules the flashes
without user input so that all the selected modules are flashed.
Imagine that you are commissioning a system and you need to update 50 devices. With ControlFLASH Plus,
you can browse the network to detect your devices, select the devices, set the desired firmware revision and
start the flash operation. Once started, all the flashing operations are completed without user input so take a
break, get a coffee or get some lunch!

Rockwell Automation | 2021 50


Manage Firmware
Now that you have flashed some modules with ControlFLASH Plus, let us explore other aspects of the tool.

15. Select the Manage Firmware tab.

The list under the Manage Firmware tab displays all the available firmware on the computer. For this lab, a very limited set of
firmware is on this PC. In a real-life environment, this list would likely be much larger.

16. In the Filter by device input box type 1756-L

Notice the input box gives the number of filtered devices out of the total list. It also gives a color indication in the device list to
emphasize that the list is filtered.

17. For one of the entries, hover over the File Path.

The tooltip displays the file path where the firmware is located.

Rockwell Automation | 2021 51


18. Click on a file path

This hyperlink opens an Explorer window to the file location of the selected firmware.

19. Close the Explorer window.

20. Click on + Add Revisions.

A reminder: ControlFLASH Plus needs internet connection to search and download firmware from PCDC. If
the internet is not accessible, the + Add Revisions choice will not be available. In such case, feel free to read
through this part the lab. You will be able to work again with Deleting Firmware Revisions on the next page.

21. The Add Firmware Revisions dialog will appear.

Rockwell Automation | 2021 52


22. Click in the Search devices field and type in a part of a catalog number: e.g. 1756-L85.

23. Expand the 1756-L85E/B and select multiple firmware versions for download.

24. Click on the Download button.

25. In order to finalize the firmware download, you would need to sign into PCDC with your account.
Click on Cancel to close the Download Center dialog
and then on Cancel again to close the Add Firmware Revisions dialog.

26. Click on Delete Revisions.

Rockwell Automation | 2021 53


27. Notice that check boxes become available for the firmware in the filtered list.

28. Check a box and select Delete in the lower right corner of the window.

29. You will be prompted with a Delete Firmware window.

30. Select Don’t delete.

31. Click on the Delete Revisions again to clear all selections.

Firmware Management
ControlFLASH Plus added the capability to manage firmware. You can view all the available firmware from
the Manage Firmware tab.
You can download firmware from PCDC within the user interface of ControlFLASH Plus.
Obsolete or unused firmware can be easily removed from your PC.
Clicking on the file path and managing the firmware files from Windows Explorer can be extremely useful
when doing bulk removal of firmware.

Rockwell Automation | 2021 54


Favorites

32. Select the Manage Favorites tab.

33. In the New Favorite List input box type DemoKitAnalog and press the enter key.

34. The Add Devices window appears. In the Filter by device input box, type 1756.

35. In the resulting list, check the box for the 1756-IF8I and 1756-OF8I modules as shown.

36. Click the Add button.

Rockwell Automation | 2021 55


37. You are now back to the Manage Favorites tab which should now have the DemoKitAnalog entry with the
two selected items in the device list.

38. Navigate to the Flash Devices tab in the Flash To drop-down select the DemoKitAnalog entry.

The 1756-IF8I and 1756-OF8I are both selected and set to the firmware revision.

39. Close ControlFLASH Plus.

Favorites
Favorites are new in ControlFLASH Plus. You can create named lists of specific firmware revisions. The
favorite lists can be imported and exported.

Note: The exported lists do not include the firmware files. Those are not needed, because ControlFLASH
Plus is integrated with the Product Compatibility and Download Center (PCDC), thus allowing download of
the firmware files directly within the user interface of the tool.

Scenario – There was a recent PSA released for a several devices in your plant and you need to update all
the devices during your next shutdown. You create a favorite list with the updated revisions, browse your
network and select your favorite list. Now all the devices affected by the PSA are selected and ready to be
updated.

Rockwell Automation | 2021 56


Additional Items and New Features

Good to know
Here are some items that you should know about ControlFLASH Plus:
Coexists with ControlFLASH – both tools can be installed on the same computer.
ControlFLASH Plus is the flashing tool of the future and it will be updated to include new features.
ControlFLASH will be maintained but no new features will be added.
Supports all firmware kit types – install-based (generally *.msi files) and file-based (*.dmk) firmware are both
supported with ControlFLASH Plus.
Seamless integration with FactoryTalk Security.
FREE SOFTWARE – like ControlFLASH, this tool is available for free on the PCDC.
Depending on internet connection availability and your actions, you may have noticed one of the following
during the lab:

Major release 2 of ControlFLASH Plus added direct integration into the Product Compatibility and Download
Center (PCDC). With an internet connection and your PDCD credentials, you can download firmware and
view relevant information (lifecycle status, release notes, PSAs, etc.) directly in ControlFLASH Plus
- The yellow indicator shows that internet connectivity is available and PCDC could be reached.
- The red indicator shows that the PC cannot connect to the PCDC server.
- The green indicator shows that you are logged into PCDC.
For more information on ControlFLASH plus refer to ControlFLASH Plus Quick Start Guide, (publication
CFP-QS001).

Rockwell Automation | 2021 57


1.5 Studio 5000 Data Exchange
This subsection includes accompanying videos to show two workflows for Logix Designer Data Exchange to 3 rd party eCAD
tools. The workflows covered are:
 Logix Designer to AutoCAD Electrical through the Studio 5000 Data Adapter Tool.
 EPLAN to Logix Designer though AutomationML (.aml) file format.

The list below shows various software packages involved with the Data Exchange that were used in making the videos:
 Studio 5000 Logix Designer v32 Professional Edition
 Studio 5000 Data Adapter Tool v1.00.00
 EPLAN Electric P8 v 2.8
 AutoCAD Electrical v 2018

For each workflow (AutoCAD Electrical and EPLAN), it is assumed that the viewer has a working knowledge of the 3 rd party
software. The videos cover the workflow and data exchange capabilities with Logix Designer and there is little to no overview of
the 3rd party tools in the video. For a novice user of the 3rd party tool, this lack of context could be confusing which is why it is
noted here.

Data Exchange Workflow Videos

1. The Data Exchange videos are in C:\Lab Files\_2_Advanced Logix\Lab 01 Whats New\DataExchange.

2. Double-click on the video to open and view it.

3. Watch one or both videos!


There are supplemental information sections included in this manual on the next page. Feel free to review them if you would like
to investigate further.

Rockwell Automation | 2021 58


Studio 5000 data exchange to AutoCAD Electrical - Supplemental Information
In version 32 and greater include enhanced capabilities for data exchange between Studio 5000 Logix Designer (professional
edition) and AutoCAD Electrical. This initial release focuses on controller I/O schematic diagrams and 2-D footprint drawings.
The Data Adapter Tool (available for download from the Product Compatibility and Download Center) will auto-generate
drawings in AutoCAD Electrical from Studio 5000 Logix Designer and Studio 5000 Architect data. This will improve efficiency and
cut down on design or engineering time. Additional information can be found in the online help files accessible within the
software. The Data Adapter Tool user manual, DATAAT-UM001, is also on the Rockwell Automation Literature Library.

There are supplemental files (IO drawings and .ACD project) included on the lab image for the workflow shown in the video. See
location C:\Lab Files\_2_Advanced Logix\Lab 01 Whats New\DataExchange\AutoCAD_Supplemental for the files.

If viewing the IO drawings in Microsoft Edge (default program), using CTRL + mouse wheel is an effective
way to zoom and generally navigate the .PDF document.

Note: AutoCAD Electrical 2018 is not installed on the lab image.

Studio 5000 data exchange to EPLAN - Supplemental Information


In version 32 and greater of Studio 5000 Logix Designer (professional edition), there is a data exchange interface supporting
import and export of device property data in AutomationML format (Automation Markup Language, .AML files). You can now
import and export .AML files directly into Logix Designer which will enhance the capabilities for bi-directional exchange of data
between Studio 5000 other 3rd party engineering tools. We are working closely with Encompass Partner EPLAN on this bi-
directional exchange for shortening design cycles and improving engineer efficiency.
AutomationML (.AML) is an open standard that is based on extensible markup language (XML) data files. The goal of
AutomationML is to allow data exchange between engineering tools across different disciplines (CAD systems, electrical/panel
design systems, PLC programming, robot control, etc.) with a common file format.
Additional information can be found in the online help files within the software. High level best practice and guidelines for the
AML data exchange can be found in Rockwell Automation Knowledgebase article QA44519 - PLC Data Exchange Between
Studio 5000 and EPLAN Using AutomationML.
There are supplemental files (.ACD and .AML) included on the lab image for the workflow shown in the video. See location
C:\Lab Files\_2_Advanced Logix\Lab 01 Whats New\DataExchange\EPLAN_Supplemental for the files.

Note: EPLAN Electric P8 v 2.8 is not installed on the lab image.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 59


Lab 2: Enhancements introduced in version 31 <50 minutes>

This section will introduce some of the features that came with version 31 of Studio 5000 Logix Designer. These changes work
together to give you a large increase in usability. All of these changes are a result from customer input.
Goals of this lab section:
 Get familiar with the updated Logix Designer user interface
 Experience Structured Text Editor updates
 Experience Function Block Diagram (FBD) updates

Enhancements from v28 included in this lab:


 Delete a program without having to unschedule it
 Online power rail display

2.1 Logix Designer User Interface Refresh

1. Double-click on the Lab Files shortcut on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 02 Usability Enhancements.

3. Open the project named Usablity_Enhancements.ACD.

Note: This same ACD file will be used for each section of this lab. So, keep it open until you are instructed to
close Studio 5000 Logix Designer.

Rockwell Automation | 2021 60


Many items have changed, but many items have stayed the same!
In version 31 and up, colors and fonts have changed, but the names have stayed the same.
Top Menu - Menu items are identical to v30. The display font has changed, but item names are all the same.
Controller Organizer - Naming and Organization is similar as v30. Icons and fonts have changed.
Logical Organizer - Naming and Organization is the same as v30. Icons and fonts have changed.
Toolbars - Icons have been updated, but selections are the same.

4. Explore the New Look and Feel!


Colors, Icons, instruction displays have all been updated.

5. Open any routine from the Controller Organizer.

6. Routine tabs are now shown at the top.

Rockwell Automation | 2021 61


7. You can now drag a routine out of the Logix Designer framework.
The CommSts_Local – MainRoutine tab is shown being moved out of the main window.

Routine Tab was dragged


with the mouse from Left
to Right into its own
window.

Now the Routine that you opened is shown in a separate window. Being limited to one monitor for this lab does not allow
you to experience the full capability of this feature. Any tab can be a separate window. Separate windows can be sized like
any other window and put onto separate monitors.

8. Open at least 5 additional routines (do more if you like) to fill the top bar with routines.

9. Click the down list button on the far right of the routines tabs. This will then bring up a list of all the routines
that are currently open.

Rockwell Automation | 2021 62


10. Hover the cursor over the Find Next icon in the toolbar.

Information provided in the Tool Tips has been expanded.

Tooltips Now Have Expanded Descriptions


In version 31 and higher, tooltips have been expanded to include:
- Icon of the selection
- Selection name
- Shortcut key for selection
- Description of selection
Expanded information is not just for toolbar icons. Tooltip descriptions have been expanded throughout Logix
Designer.

Rockwell Automation | 2021 63


2.2 Structured Text Editor
In this sub section, you will explore the enhancements made in the completely new Structured Text Editor including:
 Line Numbers
 Change and Verify Bars
 Code Outlining
 Completion Prompt
 Smart Indent
 Code Snippets
 Inline Value Monitoring
Other New Structured Text enhancements:
 Header Auto Populate
 String to String Literal Assignment
 String to String Literal Comparison

Line Numbers

11. Navigate to TasksMainTaskStructured_Text folder.

12. Open the routine STX_Routine.

Line Numbers are now displayed on the left hand side of the routine display.

Rockwell Automation | 2021 64


13. Open the Controller Tags.

14. Select the tag Product_Selection.

15. Right-click and select Go to Cross Reference for “Product_Selection”.

16. Tag cross references now include the structured text line number as well as the ladder rung number.

Rockwell Automation | 2021 65


Structured Text Editor Display Configuration
You access Workstation Options from the top menu TOOLS Options…

Many display items can be configured. Line numbers can be turned off, etc...

Rockwell Automation | 2021 66


Change and Verify Bars

17. Open the STX_Routine in the Structured_Text Program.

18. Select Line 16. This is an empty line.

19. Press the Enter key twice.

You will now see two yellow bars on the lines that you have added: lines 16 through 18. The yellow bars indicate that
changes have been made and that they have not been verified.

Rockwell Automation | 2021 67


20. Verify the STX_Routine.

21. Now the change bar color is green indicating that the changes have been verified.

About Track Changes Indicator

Tracked Changes color bars are removed when the routine is closed.

Rockwell Automation | 2021 68


Code Outlining

22. Go to Line 20 in STX_Routine.

23. Click the “– box” to the left of if to contract the code region.

24. Hover the cursor over the ellipse box.

25. This will bring up a Tooltip that contains all the text that is hidden by the collapsed region.

26. Go to Line 38 in STX_Routine.

The use of the #Region and #EndRegion syntax indicates a User Defined Region of code.

27. Use the box to the left of #Region to collapse the code region.

28. The Region syntax is now hidden, and the user only sees the + box and the description that was entered to
the right of #Region.

Rockwell Automation | 2021 69


29. Like the if…then example above, you can bring up a tooltip that contains all the text in the hidden region.
Do this by hovering the cursor over the box containing the hidden region.

User Defined Regions of Code


You can now create a user defined region of code anywhere in your Structured Text Routine.
Syntax:
#region<region description>
#endregion
Text immediately following #region will be the description for the region. This text and a + box will be the only
items displayed when the region is closed.

30. Go to Line 35 in STX_Routine.

31. Close the Region.

32. This is an example of a very large region that closes lines 37-68. Since this region is very large the tooltip is
not able to display all the text that is hidden.

Rockwell Automation | 2021 70


Code Snippets

33. Open the Routine STX_Code_Snippets.

What are Code Snippets?


A code snippet inserts a predefined syntax with template parameters.
To insert a code snippet:
1. Type in first word of the syntax.
2. Press the Tab key
3. Code snippet is automatically inserted.
Supported Constructs:
IF… THEN
ELSEIF… THEN
CASE… OF
FOR… DO
WHILE… DO
REPEAT… UNTIL
When a Code Snippet is inserted placeholder tags are added. Placeholder tags are highlighted in yellow and
must be replaced with the tags you will use for your Routine.

Tooltips can be used to further explain what the placeholder tag is used for.

Rockwell Automation | 2021 71


34. Start on Line 17. This is the second blank line after the header.

35. Type if.

36. Press the TAB key

37. An ‘if..then’ code snippet is now added.

38. Replace bool_expression by typing ‘Product_Running’. You do not need to move the cursor before typing.

39. Enter the expression in Line 18: System_Status := ‘Running’;

40. Your if..then Structured Text code is now complete.

41. Experiment with code snippets for the other syntaxes. Type the first word or first few characters of the
syntax and then press Tab.
 ELSEIF… THEN
 CASE… OF
 FOR… DO
 WHILE… DO
 REPEAT… UNTIL

Rockwell Automation | 2021 72


Automatically Insert a Header with Auto Populated Fields

42. Click on TOOLS in the top menu and select Options….

43. The Workstation Options dialog window is shown.

44. Under the Categories list, select Structured Text Editor.

Rockwell Automation | 2021 73


45. The Change Structured Text Editor Preferences dialog allows you to configure how the Structured Text
Editor works.

Structured Text Editor Preferences


Auto-indent Automatically sets the indentation of new lines at the same value
Tab Size The number of spaces that each tab represents. Press the Tab key to insert a tab
Insert Paces Creates spaces instead of tabs (ASCII spaces)
Keep Tabs Inserts regular tabs. (ASCII tab character)
Include Header on Create
Enables text header to be automatically added to the beginning of new Structured Text routines. You can edit
the text that is automatically inserted in the text box below this checkbox.

46. Check the Include Header on Create checkbox. This will automatically create a header in any newly
created Structured Text Routine.

Rockwell Automation | 2021 74


47. Edit the information inside the automatic header. Information in < > is automatically populated.

48. Click OK.

49. Create a new Structured Text Routine named STX_Header inside the Structured_Text Program.

You can see that Logix Designer has automatically created a header!

Note: The routine Type must be set to Structured Text.

50. Open the new routine. See that Logix Designer has automatically created a header .

Rockwell Automation | 2021 75


51. Open the No_Header routine inside the Structured_Text_Header program. This routine was created
before the Include Header on Create checkbox was checked.
Note: The default setting is no header.

Rockwell Automation | 2021 76


String to String Literal Assignment

52. Open the STX_Routine.

53. Go to Line 38 and expand the region if needed.

54. Lines 39 through 42 give us an example of a String literal to String assignment.

String Literal Assignment


String Literal Assignment allows the user to set tags of the string data type to a hard-coded value. We have
been able to do this to Booleans, DINTs, REALs, etc. data types. Now this functionality is available for
STRING data type tags.
You can also assign String Literals to a STRING data type tag in Ladder. This can be done with a MOV
instruction.

NOTE: String Literal Assignment and Comparison features are only applicable to:
- ControlLogix 5580
- CompactLogix 5380 & 5480
- It is not applicable to ControlLogix 5570 and CompactLogix 5370

Rockwell Automation | 2021 77


String to String Literal Comparison

55. In the STX_Routine, go to Line 46.

56. The syntax Str_Product = ‘Chocolate Chip’ is an example of a String literal to String Comparison.

String Literal Comparison


String Literal Comparison allows the user to compare a tag of the string data type to a hard-coded string
value. We have been able to do this to Booleans, DINT, REAL, etc. data types. Now this functionality is
available for STRING data type tags.
This is an ASCII character value comparison.
You can also assign String Literals to a STRING data type tag in Ladder. This can be done with an EQU
instruction.

Rockwell Automation | 2021 78


Putting it All Together
Depending on your work from the earlier section, the pictured line numbers may differ.

57. Open the STX_Code_Snippets Routine in the Structured_Text Program

58. Go to the last empty line of the Routine.

Note: The line numbers could be different then the captures shown for the STX_Code_Snippets routine
depending on your previous activity.

59. Press Enter to insert a blank line

60. Type ‘if’ then press the TAB key. This will give you the if…then Code Snippet.

61. We will then replace the ‘bool_expression’ placeholder text with the following expression:
Str_Product = 'Sugar Cookie'

This is an example of a String Literals Comparison.

62. In the blank line, enter the follow expression:


Str_Product_List[4] := 'Sugar Cookie'; as shown

This is an example of a String Literals Assignment.

63. Verify the STX_Code_Snippets Routine. Address any errors.

64. Go to or create a blank line above the if..endif structure you just created.

65. Type #Region Set Product to Sugar Cookie

66. Go to the last line of the Routine.

67. Press Enter to insert a blank line.

68. Type #EndRegion.

69. Press Enter.

70. You have now added a user defined code region in the routine. Close the region.

Rockwell Automation | 2021 79


Inline Value Display

71. Open the STX_Routine.

72. Select the Toggle Inline Value Display option.

73. The inline values are now displayed below the tags.

74. Close Studio 5000. If prompted to save the file respond with No.

Inline Value Display


Tag values are now displayed under the tag. These values are show with a grey highlight. Values are shown
both offline and online.
You can also hover over tags to see

Inline Value Display

Note: You can turn Inline Value Display Off in Workstation Options.
You can also hover over tags to see their value!

Rockwell Automation | 2021 80


2.3 Function Bock Diagram (FBD) Features
In this sub section we will explore the enhancements made in the Function Bock Diagram (FBD) editor.
 Modify operand values from FBD sheet
Other New Structured Text enhancements:
 Organize FBD sheets while Online

FBD Modify Sheet Size while Online


V31 allows to you size FBD Sheets while online!
Also, V30 changes the default FBD sheet size to 11x17 Landscape.

Modify Operand Values from FBD sheet

1. Double-click on the Lab Files shortcut on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 02 Usability Enhancements.

3. Open the project named Usablity_Enhancements.ACD.

4. Once open, select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the
controller with IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

5. Select Download and acknowledge any other windows to start the download.

Rockwell Automation | 2021 81


6. Put the controller into RUN mode by selecting Yes in the window.

7. If not prompted, switch the controller to RUN mode by selecting Rem Prog and then Run Mode.

8. Expand the _1100_Boiler program.

9. Open the AT1131 routine.

Rockwell Automation | 2021 82


10. Double-click the value of input reference Rack_01_01_AI.Ch0Data.

11. Change the value to 80.8.

12. Press the Enter key.

You can open other FBD Routines and experiment with changing operand values while online.

Rockwell Automation | 2021 83


Organize FBD Sheets while Online

13. Expand the program Sim_1100_Boiler.

14. Double-click on the FBD routine Boiler1Sim. This will open FBD routine on Sheet 1 named Fuel.

15. Click on the Start Pending Routine Edits icon in the FBD toolbar.

Rockwell Automation | 2021 84


16. Click on the Organize Sheets icon in the FBD toolbar.

17. From the Organize Sheets dialog box we can select a sheet name and use the mouse to move sheets up
or down to reorder them.

Fuel sheet name is


selected. Use the mouse
to drag it down the list.

18. While moving the sheet, a green line will indicate where the sheet will be placed .

Rockwell Automation | 2021 85


19. In the screen capture below, the sheet named Fuel was moved from 1 to 3.

Note: The sheet number did not change. It will change to 3 after the OK button is clicked.

Sheet number still at 1. It


will change to 3 once the
OK button is pressed.

20. Click the OK button and verify that the sheets have be reordered.

21. Click Accept Pending Routine Edits button.

The sheets have now been re-ordered! You can Use the Organize Sheets dialog box to move the order of other sheets in
this Project.

Note: Keep the Logix Designer project open.

Rockwell Automation | 2021 86


2.5 Detect a Lonely Routine with Verify

22. Select the program Lonely_Routine from MainTaskLonely_Routine.

23. Right-click and select Verify.

24. View the Errors window at the bottom of Logix Designer (use the scroll bar to scroll up to see warnings).

Note: Lonely Routines warnings that were found.

Note: You may need to make the Errors pane larger to see the same view.

What are “Lonely Routines”?


Lonely Routines are routines that are not called by their program’s Main Routine. The Lonely Routine Verify
Warning alerts you to a routine that will not be executed by the Logix controller. This would be the same as
being unscheduled.
A Logix controller’s application code scan starts with tasks. tasks are either scheduled or continuous.
Task contain programs. The order programs are scanned in a task that is set by the user.
Each program has a routine configured as main. The main routine is the only routine that the Logix controller
automatically scans. All other routines in a program need to be called by the user application code.
So, a Lonely Routine warning alerts you to a routine that is not being called automatically by Logix or the
user application code!

Rockwell Automation | 2021 87


25. Check the logic to see if these are Lonely Routines by opening the Main_Routine of the Lonley_Routine
Program. Notice there are no call instructions in this routine or the other Lonely Routines.

Note: A call to a Routine would be one of the following instructions: JSR or FOR.

26. You can also cross reference each routine to search for calls.
Perform a cross reference for Lonely_Ladder_Routine.

27. In the results of the cross reference of Lonely_Ladder_Routine, you can see that nothing was found. This
indicates that no instructions reference Lonely_Ladder_Routine. Since no instructions reference the
Lonely_Ladder_Routine, no calls are being be made to execute logic in Lonely_Ladder_Routine.

Rockwell Automation | 2021 88


2.4 On-Line Power Rail Display

28. Navigate to MainTask_1100_BoilerAIC1131_O2_LAD.

29. Open the Routine AIC1131_O2_LAD.

Green Power Rail – They indicate that


these ladder rungs are being scanned by
the controller and outputs can be
energized.

From this online view of the Logix Designer ladder editor you will see green power rail on the right and left-hand sides of the
ladder rungs.

Note: This is the same green Power Rail display that has been used in all Logix versions.

Rockwell Automation | 2021 89


30. Navigate to TasksMainTaskLonely_Ladder_Routine and open Lonely_Ladder_Routine.

Notice how this routine does not have a green power rail. As we saw in the Lonely Routine section of this lab, the
Lonely_Ladder_Routine is not being scanned by the Logix controller.

Note: The screen capture above was taken online. Since the routine is not being scanned, its power rails
look the same as you would see in an offline application.

31. Navigate to TasksMainTask_1100_BoilerMainRoutine and open MainRoutine.

32. Delete rung 0.

33. Right-click on rung 0 and choose Accept Pending Program Edits.

34. Next, select the Test Accepted Program Edits button on the routine’s toolbar.

Rockwell Automation | 2021 90


35. Click Yes to the following dialog to test the program edits.

36. Your rung should look like the one below.

Note: This change needs to be made online.

37. Now the routine AIC1131_O2_LAD is not being called by any programs in our online project.

Rockwell Automation | 2021 91


38. Open the routine AIC1131_O2_LAD.

Notice how this routine does not have a green power rail. As we saw in the Lonely Routine section of this lab,
AIC1131_02_LAD is not being scanned by the Logix controller.

Note: The screen capture above was taken online. Since the routine is not being scanned its power rails are
the same as an offline application.

39. Click the Untest Accepted Program Edits button on the routine toolbar.

40. Click Yes to the dialog that appears.


Notice that power rails in AIC1131_02_LAD change to green after the edit was taken out of test mode.

41. Click Cancel Accepted Program Edits. Click Yes to the dialog that appears.

Rockwell Automation | 2021 92


42. Open the Routine MainRoutine in program _1100_Boiler.

43. In rung 0, insert an AFI instruction before the JSR instructions.

44. Using the buttons on the routine toolbar, accept and test the rung edit. Your rung should look like the one
below.

Note: This change needs to be made online.

45. Now the routine AIC1131_O2_LAD is not being called by any programs in our online project.

46. Open the routine AIC1131_O2_LAD.

Rockwell Automation | 2021 93


47. Notice how this routine still has a green power rail. Why is this?

Limitations of the Online Power Rail Display


Studio 5000 Logix Designer can detect when there are no calls to a routine. But, conditional calls to a routine
will always contain green power rails.
The same scenario would be true if we used a timer to periodically call a routine.

48. Click the Untest Accepted Program Edits button on the routine toolbar. Click Yes to the dialog that
appears.

49. Click Cancel Accepted Program Edits. Click Yes to the dialog that appears.

Rockwell Automation | 2021 94


2.6 Delete a Program Without Having to Unschedule It

50. Go Offline with Logix Designer by selecting COMMUNICATIONSGo Offline.

51. Select the CommSts_Local Program.

52. Right-click on the CommSts_Local program and select Delete.


The program CommSts_Local is currently scheduled to run as the first program in the MainTask.

53. Click Yes on the dialog to delete the program.

That’s it! program is completely deleted.

Rockwell Automation | 2021 95


Removing programs from a Logix Designer project has become much easier!
Prior to Logix Designer v28, you needed to follow a long and tedious workflow to delete a program.
Program deletion steps prior to v28:
Unschedule the program from the task
Individually delete all the routines
Manually delete all the program-scoped tags
Right-click on the program and select delete

Program Deletion Step for v28 and greater:


Right-click on the program and select delete

As you can see, the updated workflow is much simpler and more intuitive!

Rockwell Automation | 2021 96


2.7 Output Window

54. Navigate to TasksMainTaskLonelyRoutine.

55. Select the Program LonelyRoutine, right-click and select Verify.

56. Make note of the new filter buttons.

57. Click on the 6 Messages box.


This will toggle off the updates that are status messages.

58. Select the 6 Messages box and deselect the 4 Warnings box.
This will enable the status messages and toggle off the warnings.

59. Deselect the 6 Messages box.


This will filter to only the Errors but since there are not errors none are displayed.

Rockwell Automation | 2021 97


60. Navigate to TasksMainTaskLonelyRoutine and open Lonely_Ladder_Routine.

61. Insert a blank rung into the routine.

62. Close the Lonely_Ladder_Routine.

63. Select the program Lonely_Routine in the Controller Organizer, right-click it, and select Verify.

64. Configure the error window to display the Errors and Warnings.

65. With the Error window active, hit F4 to cycle through the list. Shift + F4 moves backwards through the list.
As you move through the warnings on the list, the noted routine is highlighted.

Rockwell Automation | 2021 98


66. Navigate to the entry Error: Rung 2: Empty Rung.

When you got to the error on the list the routine that contained the error was automatically opened and the rung
selected.

67. Click in the Search… input box and type Ladder.

This input box is an additional text-based filter for the Errors pane.

Rockwell Automation | 2021 99


68. Click on the Messages box to toggle the filter on.

Notice that an additional line is displayed that includes Ladder.

Updated Output Window


The Output window appears at the bottom of the Logix Designer application main window when an operation
yields multiple results or errors. The Output window also appears when a routine is opened online. The
Output window contains Errors, Search Results, and Watch tabs.

The Output Window added filter buttons in version 31. The filtering allows you to display a combination of
errors, warnings or messages. As noted in the lab, you can toggle the corresponding button to enable/disable
the displayed items. For example, to display the errors and messages, click the Errors and Messages
buttons.
Version 32 added the filter input box allowing you to filter on specific text.

69. Close the project and do not save.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 100


Lab 3: Introduction to the Logical Organizer <10 minutes>

This section will introduce a feature that was introduced in version 24 of Studio 5000® Logix Designer. You will be organizing the
project from Introduction to Program Parameters section into logical groups.
Goals:
 Organize the Introduction to Program Parameters section project.
 Understand the different options available within the Logical Organizer.

3.1 Using the Logical Organizer

1. Double-Click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 3 Introduction to the Logical Organizer.

3. Open the project named Logical_Organizer.ACD.

Note: This may take up to a minute to open.

Rockwell Automation | 2021 101


4. Locate and select the Logical Organizer tab in the bottom left window.

Note: The Controller Organizer is used to organize programs into a task structure that defines how the logic will be
executed. This view does not always present code modules in a logical format that is applicable to the machine or process
design. The Logical Organizer gives users a new way to group and view programs in an application. This can be extremely
helpful when viewing code modules that have been developed at the program level. The remainder of this section will walk
you through the Logical Organizer.

5. Click on the Logical Organizer tab.

6. Right-click on the root folder (Logical Model Tank_Controller) and select Add  New Folder…

7. Name the folder Simulation_Logic and click OK.

Note: This folder will hold the simulation program used to fill and drain the tank.

Rockwell Automation | 2021 102


8. Create two additional folders using the same steps. Name one folder Tank_Manager and the other
Station_1.

Now that we have some folders created, let us move the programs around.

9. Click on the Simulation1 program and drag it to the Simulation_Logic folder.

10. Click on the Station_1 folder and drag it to the Tank_Manager folder.

Rockwell Automation | 2021 103


11. Click on the Auto_Cycle1 Program and drag it to the Station_1 folder.

12. Click and drag Pump1 and Tank1 into the Station_1 folder.

Once completed, the Station_1 folder should be the same as below.

Rockwell Automation | 2021 104


General Information about the Logical Organizer
The Logical Organizer allows the user to separate the application into a multi-level, logical hierarchy of
folders, programs, and phases. This view also supports the same functionality as the Controller Organizer to
view, create, or delete code. The Logical Organizer also allows you to drag / drop programs and program
structures (sub-programs) within the same project or across multiple instances of Studio 5000 Logix
Designer. This is particularly powerful if a code library exists in the form of an ACD file. You will see an
example of this functionality later in the lab.
Logical Organizer Facts:
New programs that are created in the Logical Organizer will appear in the Unscheduled Programs / Phases
folder in the Controller Organizer or can be assigned to a Task.
The Logical Organizer hierarchy is stored in the controller upon a download.
Up to 15 sub-programs can be nested under one program or folder.
The number of programs that can be added to a task has been increased from 100 to 1000.

13. Change to the Controller Organizer and verify the results!

Note: There are no changes to the Controller Organizer. Changes made in the Logical Organizer do not
change the organization in the Controller Organizer.

Rockwell Automation | 2021 105


3.2 Find in Organizer
You can quickly find a task, program, or routine in the Controller Organizer by right-clicking on the task, program, or routine in the
Logical Organizer. The same is true in reverse!

14. Open the Logical Organizer and select the Tank1 program.

Note: You will need to navigate to Tank_Manager Station_1Tank1.

15. Right-click on Tank1 and select Find in Controller Organizer.

Logix Designer will take you to the Tank1 program in the Controller Organizer.

Rockwell Automation | 2021 106


16. Right-click on Tank1 and select Find in Logical Organizer.

Logix Designer will then take you to the Tank1 program in the Controller Organizer

17. Close the project.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 107


Lab 4: Compare and Merge Tool <15 minutes>

Long gone are the days when a single controls engineer completed a project all by themselves. With today’s complex control
systems, it is not uncommon to have 2-5 engineers working on their specific parts of the project and chances are they are
working from different Logix Designer projects. Wouldn’t it be nice if you had a tool that could compare and merge these different
projects together and let you control the granularity to choose what parts of the projects to merge?
Since v17, the Compare Tool has been available to help you find differences in Logix projects. This tool is also available in
Studio 5000 with enhancements to accommodate the new features in as versions of Logix Designer are released. In this lab we
will cover the new compare and merge capabilities and then explore the ability to create a new merged file from the result of the
compare.

Note: At several points during this lab you will be prompted with:

Unless it is specifically stated, you do not need to save the compare projects.

Note: Also, you will be asked to close an in-application window. Close the window as indicated below.

Rockwell Automation | 2021 108


4.1 Open the Logix Designer Compare Tool

1. Double-Click on the Logix Designer Compare Tool on the desktop.

The Logix Designer Compare Tool window will appear:

2. In the toolbar, click the New Compare icon.

The Project Compare pop-up will appear.

This window allows you to pick the two projects you want to compare.

Rockwell Automation | 2021 109


3. For the Left Content:, click the ellipsis button, navigate to
the C:\Lab Files\_2_Advanced Logix\Lab 04 Compare and Merge Tool folder, and select the
L75_Project_Start.ACD file.

4. For the Right Content:, follow the same path and select the Line_Expansion.ACD file.

Notice the options provided. We will stay with the defaults here, but you could eliminate tag values and include descriptions
as part of the compare. You could also filter out some of the tags.

5. Click OK. The Compare Progress window will appear while the compare is occurring.

It may take a minute before the progress bar to start to populate and about two minutes for the compare process to
complete.

Rockwell Automation | 2021 110


4.2 Comparing Project Files

1. When the compare process is done, the Compare Results window will show where the differences were
found. You may need to expand the window and resize the Compare Results pane to make it large enough
to see everything like what is shown below. Alternatively, you can scroll through the results.

The left-most column, titled Compare Summary, shows the categories where differences were found. The middle and right
columns report how many differences were found in each category.

Rockwell Automation | 2021 111


Color Codes Used in the Information Display
Information displayed in the Compare Summary, Left Project, and Right Project is color-coded:
Red
Indicates items that exist in one project but not the other.
Blue
Indicates items that are common between the two projects, but they have a difference. For example, you
might have a ladder routine that exists in both projects, but with a rung that does not match, or a tag that
exists, but contains different data. Double-clicking on these items brings up more detailed compare
information.
Black
Indicates common items that contain child elements.
Gray
Indicates common items in which no differences were found. These are for context only; no further details
can be displayed. Logix Designer can detect when there are no calls to a Routine. Conditional calls to a
Routine will always contain Green Power Rails.

Rockwell Automation | 2021 112


2. Since the Properties entry under the Controller folder is Blue, some differences exist between the
properties of the controllers.

3. Double-click on Properties.

4. The difference is also highlighted in blue. In this case the only difference is the Controller Properties Name.

5. Close the Controller Properties window.

Note: If you want to see the differences in the Compare Summary, click the Summary folder in the left
column.

Rockwell Automation | 2021 113


6. The next folder in the Summary column is labeled Modules. Click on the Modules folder.

7. Expand the Local folders.

8. This shows the I/O Configuration from the completed ACD file. The EN2T is Red signifying it does not exist
in the L75_Project_Start.ACD file.

9. Double-click on the EN2T.

Rockwell Automation | 2021 114


The module’s full definition is displayed.

Remember! Red - Indicates items that exist in one project but not the other.

Rockwell Automation | 2021 115


10. Close the I/O Module window.

11. There are two other folders in the Summary window indicating other project differences: Tasks and Logical
Organizer View. Using what you have learned above, click on each different folder and observe what is
different.

12. Double-click on Tasks and expand the sub-folders.

13. Double-click on Logical Organizer View and expand the sub-folders.

Rockwell Automation | 2021 116


4.3 Comparing Project Exports

Since version 6.10 of the Logix Designer Compare Tool we can compare project export files. This allows us to
compare exported programs, routines, rungs, AOIs, etc... In the example below, we will step you through the
comparison of two exported programs. Then you will have to opportunity to compare routines, rungs, and AOIs.

14. Start a new comparison by clicking on FileNewProject Compare in the top menu.

Note: Our open project files path is: C:\Lab Files\_2_Advanced Logix\Lab 04 Compare and Merge Tool\
If prompted, do not save.

15. For the Left Content: select the Pump1.L5X file using the path above.

16. For the Right Content: select the Pump2.L5X file using the path above.

Rockwell Automation | 2021 117


Compare Options
For this lab we compared the Left and Right Content using only the tag values. But you can also compare
descriptions, constant tags, filter on tags or only include tracked components.
Tracked Components is a new feature in version 30. In Studio 5000 Logix Designer you can configure
components in your application to be tracked. These components will then be flagged whenever they are
changed. The Logix Designer Compare tool, Studio 5000 Logix Designer and even the controller project can
then check if the component has been changed.

17. Click OK to start the compare.


There are multiple Parameter Connection Differences.

Let us dig deeper.

18. Click on Tasks in the Compare Summary.


19. Expand the Left Content and Right Content results.

20. Double-click on one of the blue Connections folders.

21. The results below show the differences between the two Programs in red text. These differences are all on
the Program Parameter Connections.

Rockwell Automation | 2021 118


The two Programs that we are comparing are shown under Unscheduled Programs / Phases because the compare files are
Program Exports. Since the files that are being compared only contain the program data and not the information for the
entire controller the Programs are Unscheduled. No Tasks have been configured to own these Programs.

Rockwell Automation | 2021 119


22. You can also compare other types of export files! The table below contains a list files that are available in
the lab file folder that can be compared. Use this section of the lab to explore compare options.

Note: All files are in the C:\Lab Files\_2_Advanced Logix\Lab 04 Compare and Merge Tool\ folder.

Export Type to Compare File Name File Name

Program Pump1.L5X Pump2.L5X

Routine Tank1_MainRoutine.L5X Tank2_MainRoutine.L5X

Rungs Auto_Cycle1_Rungs0to3_from_Main Auto_Cycle2_Rungs0to3_from_MainRouti


Routine.L5X ne.L5X

AOI AOI_ModuleSts_V01.L5X AOI_ModuleSts_V02.L5X

Note: Not all the files have differences! Some of the differences may be different then what you expect
because these examples use Program Parameters.

Rockwell Automation | 2021 120


4.4 Merging Project Files

Now that we have a comparison of the two files, we can use the merge feature to combine them.

1. To start the merge, click on the New Project Merge icon in the toolbar.

This will open the Project Merge dialog box.

2. For the Left Content:, click the ellipsis button, navigate to the Lab 04 Compare and Merge Tool folder and
select the L75_Project_Start.ACD file using the path above.

3. For the Right Content: follow the same path and select the Line_Expansion.ACD file.

4. Leave the default settings and press OK.


It may take a few minutes for the merge process to complete.

Rockwell Automation | 2021 121


5. This will open the comparison between the two projects.

An Error pane may be displayed at the bottom on the window. Close it by clicking the X noted below.

Notice certain icon / boxes are checked. Refer to the table below for icon definition.
Blue text is from unresolved items. These items must be resolved to complete the Merge.
Black is for resolved items. All items must be resolved to complete the Merge.
Grayed out checkboxes indicate that the result of the merge will have items from both files.

6. The table below describes the meaning of the icons you will see in this comparison window.

Rockwell Automation | 2021 122


7. Check the checkbox for Controller Tank_Controller in the left-hand column.

8. Click on the right arrow next to the Tasks folder to expand the entry.

9. Notice that a navigation aid exists in the toolbar in the form of the home icon, an arrow and Tasks. Clicking
on the Home icon (house) will take us back to the original screen .

10. Check all three checkboxes in the left-hand column for MainTask, unnamed middle check box, and
Sim_Periodic.

11. Check the Sim_Logic checkbox in the right column.

12. Verify that all the Sim_Logic checkboxes are unchecked in the right column.
The unnamed box in the left-hand column must be checked to have the Sim_Logic box in the right column unchecked.
This unnamed box indicates that one of the tasks will not be merged. In this case it is Sim_Logic.

13. Double-click on MainTask.

Rockwell Automation | 2021 123


14. Verify the ScheduledPrograms checkbox is checked in the left column.

15. Double-click on ScheduledPrograms in the left column.

16. Check the: Pump2, Tank2 and Auto_Cycle2 checkboxes in the right column.

17. Click on the Home icon to navigate back home.

18. Double-click on the Programs folder.

The blue text is from unresolved items. These items must be resolved to complete the Merge.

Rockwell Automation | 2021 124


19. Check the following checkboxes in the left-hand column:

a. Auto_Cycle1

b. Pump1

c. Tank1

20. Verify the following check boxes in the right-hand column are checked:

a. Auto_Cycle2

b. Pump2

c. Simulation2

d. Simulation_Logic

e. Station_1

f. Station_2

g. Tank2

h. Tank_Manager

Rockwell Automation | 2021 125


21. Verify the items on the right-hand side match the boxes shown below.

This configuration will keep the Auto_Cycle1, Pump1 and Tank1 from our L75_Project_Start.ACD. We will be
combining these items with the additional items from Line_Expansion.ACD in our new merged project.

22. Navigate back home by clicking on the Home icon

23. Verify the items in the Resulting Project window. This is the bottom pane in the Merge Tool.
The Resulting Project window may be floating outside the Merge Tool window.

Rockwell Automation | 2021 126


The representations for each of these icons in this lower pane are as follows.

This pane shows which direction the merged items will be flowing. Using the key above, we can see that most of the items
will be taken from the right pane. If you made some changes, you would see those indicated in the directional arrows. For
example, if you click on Auto_Cycle1 we will see why the icon is the arrow.
Grayed out checkboxes indicate that the result of the merge will have items from both files.

Rockwell Automation | 2021 127


4.5 Saving Merged Project

24. Once the Merge project is set to your satisfaction, we can save it in any of 3 formats: ACD, L5K, or L5X.

25. Click the Save icon in the toolbar to begin the save.

If the window below is displayed your application still has merge items that you will need to resolve before the application
merge results can be saved. Go back to Merging Project Files section and resolve all remaining items with blue text.

26. The Save As window will open.

Rockwell Automation | 2021 128


27. By default, the file will be saved as MergeResult.ACD, but you can change the name or the file type before
saving.

28. Select Save to save the MergeResult.ACD file.

29. Once the merge process is complete a message will be displayed showing that the merge is complete with
no error and no warnings.

Any errors or warnings in the new Merged ACD file will be show in the Error window.
You must confirm all merged project information prior to deploying the project in a product environment. We will confirm the
merged project in the following steps.

30. Click the Open Merge Result button on the toolbar.

31. The Open Merge Result button will open the merged project in Logix Designer.

Rockwell Automation | 2021 129


4.6 Reviewing Merged Project

32. Verify the project.

You may see some errors and warnings, but they are well documented and most likely the result of program connections
that are missing. Notice the merged program has a Tank2, Pump2, and Auto_Cyle2 Program along with an EN2T Module
in the local chassis.

Program Connections are described in another lab session.

33. Close Logix Designer and the Compare and Merge Tool without saving.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 130


Lab 5: Using AOI’s to Monitor Module Status <15 minutes>

This section will introduce features that were first introduced in version 24 of Studio 5000 Logix Designer. This feature is
designed to extend the functionality of Logix Add-On Instructions (AOI).

AOI Hardware Status:


 Module as an InOut Parameter in an AOI: The predefined data type Module can now be added as an InOut
parameter to an AOI. When instantiating the AOI, the user can use a pull down of the I/O Configuration to select the
module linked to the AOI. This gives the user a great method of linking a module to the logic inside of an AOI.
 Module Class available inside an AOI: GSV instructions can now access the Module Class inside of an AOI. This
allows the AOI to monitor attributes such as: EntryStatus, FaultCode, LEDStatus and the new Path attribute.
 Module Path Attribute: The Module Class of a GSV instruction now has a new Attribute called Path. This returns the
module path. The module path can be used in a message instruction to point the message directly at the module.

In this section, you will learn the benefits of these new features. Examples will be given of how they can be used in your next
application. You will be using an existing program to conserve time.

5.1: Using Module as an InOut Parameter

This section will review an example using the Module predefined data type in an AOI. The example uses the Module
predefined data type and retrieved the module’s EntryStatus attribute. The EntryStatus attribute is analyzed to set
descriptive status bits for the module.

1. Double-click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 05 AOI Hardware Monitoring and double-click


Hardware_Monitoring_ModuleSts.ACD to open it in Logix Designer.

Rockwell Automation | 2021 131


3. Once open, select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the
controller with IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

4. Select Download and acknowledge any other windows to start the download.

5. Put the controller into RUN mode by selecting Yes in the window.

6. In the Main Task, expand the program CommSts_Local and open the routine Slot03_ModSts.

Rockwell Automation | 2021 132


7. Monitor Rung 1. Notice in the AOI_Module_Sts_V01, the IO_Mod_Ref parameter uses the MODULE
datatype (place your mouse over the Digital_Input tag). We are only able to pass the MODULE datatype into
the AOI. The AOI_ModuleSts_V01 returns the running status of the module inputted in to the AOI.

A reminder: Depending on your lab setup, you might see Running, or Faulted status of the I/O module.
When using emulator (FactoryTalk Logix Echo), there is no physical hardware accessible, thus the Faulted
state will be active.

Note: The branch below the AOI_ModuleSts_V01 instruction is used only to show the values of the output of
the AOI without having to look them up in the Monitor Tags view.

Rockwell Automation | 2021 133


8. To see the AOI work we will inhibit the Digital_Input module in slot 3.

9. Right-click the Digital_Input module in slot 3 under the I/O Configuration. Select Properties.

10. Select the Connection section. Check Inhibit Module. Then click on OK.

Rockwell Automation | 2021 134


11. Press Yes on the “DANGER. Connection Interruption.” screen that will pop-up.

12. Navigate back to the Slot03_ModSts routine.

13. Now you can see that the Local_03_ModSts.Inhibited tag is True and the local
Local_03_ModSts.Running tag is False.

14. You can now remove the inhibit from the Digital_Input module in slot 3 in the I/O Configuration.

15. Go back to the Slot03_ModSts routine and verify that Local_03_ModSts.Inhibited tag is False and the
local Local_03_ModSts.Running (or Local_03_ModSts.Faulted when using emulator) tag is True.

16. Now, let us take a closer look at the linking of the module into the AOI. This linking is done by selecting the
module from the I/O Configuration.

17. Select rung 1 of the Slot03_ModSts routine. Press the Start Pending Rung Edits button in the toolbar on
top of the ladder viewer/editor window.

Rockwell Automation | 2021 135


Now, let us change the module that IO_ModRef in the AOI_ModuleSts_V01 instruction is referencing.

18. Double-click Digital_Input in the AOI to get the pull down to appear.

You can browse to another module using the I/O Configuration tree to select the module. Any module can be
selected. However, we can also choose to use program parameters of the Module datatype for code reuse.

Note: You might need to scroll up to see the program parameters in the pull-down window.

Rockwell Automation | 2021 136


19. Select the parameters IO_LocalSlot_03.

20. Open the Program Properties - CommSts_Local window by right-clicking on the program and selecting
Properties from the drop-down menu.

21. Select the Parameters tab and click IO_LocalSlot03. Now you can see the configuration of
IO_LocalSlot03 and how it links to the module in the I/O Configuration named Digital_Input.

22. Click OK to close the Program Properties window.

Note: By using this method, we can have the same logic in many projects and just change the connection for
each use!

23. Go to routine Slot03_ModSts.

24. Click the Finalize All Edits in Program button. Select Yes to the dialog that appears.

Rockwell Automation | 2021 137


In the AOI_ModuleSts_V01 instruction of this rung you will notice that the parameter is used in place of the module name
that was used in our first example.

25. Verify that this logic functions accordingly by inhibiting and un-inhibiting the module Digital_Input as you did
earlier.

26. Close Studio 5000 Logix Designer. If prompted to save the file respond with No.

Rockwell Automation | 2021 138


5.2: Using the Module Object Path Attribute
This section will review an example of using the Path attribute of the Module Object. This example re-uses a single message
instruction to return the module firmware revision from multiple modules. The message instruction performs a “Device Who”. This
returns the same information that you would see in RSLinx Classic when you right-click on a device in the RSWho screen and
select Device Properties.

Module Object Path Attribute


Example of Use:
The Path attribute of the Module object can be retrieved by using a GSV instruction. It returns the data
shown below.

Since SINT array indexes 0 and 1 contain the length, some additional logic is required to copy the Path
attribute output into the Message Datatype Path STRING member. The logic shown below from the
AOI_ModWho_V01 uses this logic. This logic only uses byte 0 which limits us to a maximum of 255
characters for our length. This should be more than enough for a real-world MESSAGE datatype Path.

The BTD copies the SINT path length from the SINT array to the LEN member of the String. The GSV
returns SINT’s, but the STRING datatype using a DINT for the LEN (length). Using the BTD we insure that
the value is not converted. The COP instruction copies the remaining data to the Path DATA member – the
string value of the message path. This time we are copying from SINT to SINT.

Rockwell Automation | 2021 139


27. Double-click on the Lab Files folder on the desktop.

28. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 05 AOI Hardware Monitoring and open
Hardware_Monitoring_ModuleWho.ACD to open it in Logix Designer.

29. Once open, select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the
controller with IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

30. Select Download and acknowledge any other windows to start the download.

31. Put the controller into RUN mode by selecting Yes in the window.

32. In the MainTask, expand the program ModuleWho_Local and open the routine Slot03_ModWho.

Rockwell Automation | 2021 140


33. Monitor rung 1. The AOI_Module_Who_V01 retrieves the Major_Firmware and Minor_Firmware revisions
of the module linked to the InOut parameter IO_ModRef. On controller’s first scan, all the major and minor
firmware revision tags are cleared.
The AOI uses the new Path attribute of the MODULE object to point the message instruction to the module linked to
IO_ModRef. This gives us an easy way to get module information. It also reuses a single message instruction, single
message tag and associated code!
The message instruction in the AOI uses the DeviceWho message. This returns more data than just the module’s firmware
revision. Reference Rockwell Automation Knowledgebase Article titled QA6236 - Logix Processors: Obtaining the key
switch position using a CIP Generic Message, for details on all the data returned by the DeviceWho message.

Important! If you work with a lab setup based on controller emulator (FactoryTalk Logix Echo), the
remaining part of this lab section will not work as described. The program will not read any information about
the I/O module, as there is no physical hardware available.
You can still read and work through the rest of the section, you will just not get the same results.

Rockwell Automation | 2021 141


34. Select the XIC instruction Cmd_Local03_ModWho. Right-click and select Toggle Bit from the menu or
press Ctrl-T.

Note: The Cmd_Local03_ModWho bit is immediately set back to 0.

35. This triggers AOI_Module_Who to go out and retrieve the Major_Firmware and Minor_Firmware revisions
from the linked module Digital_Input.
You can see the final values in the Local03_Major_Firmware and Local03_Minor_Firmware in Controller
Tags on the Monitor Tags tab.

Rockwell Automation | 2021 142


36. Open RSLinx Classic from the desktop and use Communications/ RSWho to browse to the Digital_Input
module (IO Module in Slot 3).

Note: you may have to launch RSLinx Classic from the system tray in the lower right-hand corner of the
desktop.

37. Right-click on the input module and select Device Properties.

38. From the screen that pops up, verify the values you have in Local01_Major_Firmware and
Local01_Minor_Firmware Logix controller scope tags.

The Major and Minor firmware revisions of your modules may be different than what is shown but the values
reported in the AOI_Module_Who_V01 instruction and RSLinx Classic will align.

Rockwell Automation | 2021 143


39. You can follow the same steps with the AOI in routine Slot04_ModWho. This AOI monitors the
Digital_Output module in Slot 4.

40. Just like with the module in Slot 3, you can verify the results by bringing up the digital output module’s
Device Properties in RSLinx Classic.

41. Close Logix Designer. If prompted to save the project respond with No.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 144


Lab 6: Improving Efficiency Using Partial Import Online <30 minutes>

This section will cover how to use some of the features that where introduced in version 24 of Studio 5000 Logix Designer to
improve efficiency. We will be working in both the Controller and Logical Organizer windows. We will also be discussing the
Partial Import Online (PIO) functionality.

6.1 Code Library Example


This section will demonstrate an example using an ACD file as an overall code library. We will start by opening two Studio 5000
Logix Designer ACD files.

1. Double-click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 06 Improving Efficiency Using Partial Import Online
and double-click Tank_Supervisor.ACD and Tank_Controller.ACD to open them in Logix Designer.

3. Size the Logix Designer windows for Tank_Supervisor and Tank_Controller so they look like the screen
shot below so that they are side-by-side
(you can use key combination Win+ while having Tank_Supervisor project active).

Rockwell Automation | 2021 145


Let’s assume that the Tank_Controller.ACD file is your company’s code module repository. This essentially
means the overall code library for your company is stored in an ACD file. For this example, we will assume
you must roll out a tank control system. We created a new ACD file called Tank_Supervisor.ACD. You’ve
opened both projects, and now it’s time to drag and drop some of our code modules from our library to the
actual Tank_Supervisor.ACD file.

4. Make sure you select the Controller Organizer for each application.

5. Select the 1756_IB16IF module in the Tank_Controller.ACD file and drag and drop it into the
Tank_Supervisor.ACD file. Make sure you drop it onto the 1756 backplane.

Rockwell Automation | 2021 146


6. Select the rest of the I/O modules (1756_OB16IEF, 1756-IF8I and 1756-OF8) modules in the
Tank_Controller.ACD file and drag and drop them into the Tank_Supervisor.ACD file in the same
manner.

7. The I/O Configuration should look like the following screen shot in the Tank_Supervisor.ACD file.

8. Click on the Logical Organizer in both applications.

Rockwell Automation | 2021 147


9. Select the Simulation_Logic folder in the Tank_Controller.ACD file and drag and drop it onto the Logical
Model Tank_Supervisor in the Tank Supervisor.ACD.

10. Select the Tank_Manager folder in the Tank_Controller.ACD file and drag and drop it into the Logical
Organizer for the Tank_Supervisor.

It is easy and fast to drag and drop items between instances of Logix Designer. Many users will store their code libraries in
an ACD file for this purpose. The introduction of the Logical Organizer gives the user a much better visual representation of
a system or process and its components from a modular view.

11. We are finished with the Tank_Controller.ACD now. Minimize the Tank_Controller.ACD file,
but do not close it.

12. Maximize the Tank_Supervisor.ACD file.


When you drag and drop items into the Logical Organizer, a “deep” copy will be performed. This means that when a folder
or program is copied, all sub-folders and sub-programs are copied. Additionally, when you drag and drop items into the
Logical Organizer, programs are not scheduled. We must now schedule the new programs.

Rockwell Automation | 2021 148


13. Click on the Controller Organizer in the Tank_Supervisor.ACD file.

14. All programs should be in the “Unscheduled*” folder. Let’s create the periodic task for the Simulation Logic.

15. Right-click on the Tasks folder and select New Task…

16. Enter Sim_Logic into the name. Leave everything else at the default value, and then click OK.

Rockwell Automation | 2021 149


17. Drag and drop the Simulation1 program into the Sim_Logic Task.

18. While holding CTRL, select Auto_Cycle1, Pump1 and Tank1.

19. Drag and drop the selection into the MainTask task.

20. Drag and drop the Tank1 program into the MainTask task.

21. Drag and drop the Auto_Cycle1 program into the MainTask task.
Once complete the tasks should look like the following image.

You created this project from scratch extremely quickly using an ACD file that contains the same code modules (programs). This
is one major advantage to using modular coding design practices.

Rockwell Automation | 2021 150


22. Select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the controller with
IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

23. Select Download and acknowledge any other windows to start the download.

24. Put the controller into RUN mode by selecting Yes in the window.

25. Verify the application works as expected by going through the following steps.

Note: For the lab there are push buttons and lights. Depending on the lab format you use, these are
 either on the physical demo box,
 or within the FactoryTalk View ME application (HMI running on the desktop)

or

Rockwell Automation | 2021 151


If you do not work with a physical demo box, there is a FactoryTalk View ME application available in your
desktop environment which provides interface to either a remotely located ControlLogix controller, or
ControlLogix emulator (FactoryTalk Logix Echo) The FactoryTalk View ME application should already be
running.

If the FactoryTalk View ME application is not running (you accidentally closed it, etc.), you can launch it by
double-clicking the Studio_5000_Logix_Labs.mer file found in the following location.

Rockwell Automation | 2021 152


26. Make sure the toggle switch at DI4 is turned to the RIGHT. This switch allows the user to select between
Auto (Right) and Manual (Left) mode.

27. When the green light at DO0 is illuminated, the simulated Fill Pump is ON.

28. When the light at DO2 is illuminated, the simulated Drain Pump is ON.

29. The analog meter / voltmeter AO0 simulates the tank level. 0 volts means EMPTY, 10 volts indicates FULL.

30. Adjust the AI0 slider / knob to 5. The potentiometer slider / knob simulates the pump speed. As you adjust
the value higher, the pump speed will increase.

Note: You should notice the tank slowly filling and draining. As the voltmeter swings from left to right, the
DO0 light should be illuminated (filling). As the voltmeter swings from right to left, the DO2 light should be
illuminated (draining).

31. Adjust the AI0 slider / knob to 10.

Note: The rate at which the tank is filling and draining should have increased.

32. Turn the DI4 toggle switch to the LEFT position. This will put the system into Manual Mode.

Note: The lights should both turn off. The voltmeter (i.e. the simulated level in the tank) should stop moving.
Since the system is now in manual mode, you must manually operate the fill and drain pumps.

33. Press and HOLD the green button at DI0. This will manually turn the fill pump ON.

Note: You should notice the green light will turn ON and the voltmeter will begin to increase. When the tank
is full, the green light should turn off even if the button remains depressed.

34. Press and HOLD the green button at DI2. This will manually turn the drain pump ON when the system is in
Manual Mode.

Note: You should notice the light will turn ON when it is pressed, and the voltmeter will begin to decrease.
When the tank is empty, the greenlight should turn off even if the button remains pressed.

35. Go Offline with the controller by selecting COMMUNICATIONSGo Offline.

Rockwell Automation | 2021 153


6.2 Line Expansion Example
This section will demonstrate an example of using modular programming techniques to simulate a line expansion. Let’s assume
this application was already in operation in the field. During the design phase, we knew we would be adding a second Tank
Station after the initial startup. With that in mind, we made sure to include enough I/O to support the expansion. Let’s walk
through the process of adding the second Tank Station.

Partial Import Online (PIO)


PIO brings even more power and flexibility to the design environment when implementing Program
Parameters. You have the flexibility to store all code modules (programs / AOIs) in a dedicated library ACD
file or as exported xml files. When these files are imported or copied into the ACD file, you will have a
detailed utility (GUI) that will allow the user to view / handle collisions, rename items, and most importantly
configure connections. PIO will allow you to import these programs while offline OR online, while giving you
quick access to all the program’s parameters and connections prior to the import.

36. Click on the Logical Organizer in the Tank_Supervisor.ACD file.

37. Expand the Simulation_Logic folder.

38. Right-click on the Simulation_Logic folder. Select Add  Import Program….

Rockwell Automation | 2021 154


Note: Additionally, you can left-click, drag and drop components which will function similarly to copy and
paste. Using right-click drag and drop of components will give you a few more options with how the
component is pasted or imported.

39. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 06 Improving Efficiency Using Partial Import
Online\Library.

40. Select the Simulation.L5X file and click Open.

Note: This file is an export of the Simulation_1 program. We will be using the PIO functionality to import this
program into our application.

Rockwell Automation | 2021 155


41. The Import Configuration window will be displayed.

Note: This window allows us to see the details about the import. We can view and correct collisions as well
as make changes to connections.

Rockwell Automation | 2021 156


42. Verify the Simulation1 program in the “Import Content” window is highlighted.

Note: If a red flag appears in the yellow margin, it indicates that an item is flagged for review. The user
should investigate all flags prior to the import.

43. In the Configure Program Properties window, change the Final Name to Simulation2.

44. Click in the Description box. Clicking in a different box will accept the name change.
Notice how the Operation changed from Overwrite to Create.

Rockwell Automation | 2021 157


45. In the “Schedule In” drop-down, verify Sim_Logic is selected.

This will schedule the Simulation2 program in the Sim_Logic periodic task.

46. The Configure Program Properties pane should look like the screen shot below.

47. Click on the Connections folder in the Import Content window.

48. In the Configure Connections window, scroll to the right to view the Final Connection column.

Rockwell Automation | 2021 158


This window will allow you to create new connections, change the connections on the imported tags, or disconnect
connections. For this example, you will notice all connections are tied to Pump 1 and Tank 1. Since we have not imported
Station 2, we should disconnect these four connections. They will be properly connected on the import of Station 2.

49. Click in the Operation box and select the drop-down. Select Disconnect for each connection.

All the changes to the import Simulation program have been made.

50. Click OK.

51. The Simulation_Logic folder should now have a new program called Simulation2.

Now it’s time to import the station programs for station 2.

52. Expand the Tank_Manager folder.

53. Right-click on the Tank_Manager folder. Select AddImport Program….

Note: Additionally, you can left-click drag and drop components which will function similarly to copy and
paste. Using right-click drag and drop of components will give you a few more options on how the component
is pasted / imported

Rockwell Automation | 2021 159


54. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 06 Improving Efficiency Using Partial Import
Online\Library.

55. Select the Station.L5X file and click Open.

Note: This file is an export of the Station_1 folder. We will be using the PIO functionality to import this
program into our application.

Rockwell Automation | 2021 160


56. The Import Configuration window will be displayed. It should look like the screen shot below.

Rockwell Automation | 2021 161


57. Make the noted changes so that the Configure Program with Parenting Information screen
matches the capture below.

Note: This will schedule all programs in the Station_2 folder in the MainTask.

58. Click on the Programs folder in the Import Content window.

Rockwell Automation | 2021 162


59. In the Final Name column, make the following changes:

a. Auto_Cycle1  Auto_Cycle2

b. Pump1  Pump2

c. Tank1  Tank2

60. Click on the Connections folder in the Import Content window.

This is where the PIO feature can really start to improve efficiency. The Configure Connection window will allow you to
make changes to connections in the parent program as well as all children programs that are within the parent program.
In this example, the Station_2 folder is the parent and the Pump2, Tank2, and Auto_Cycle2 programs are children. We will
have access to all connections from a single window. Since Station_2 must control an entirely different set of hardware, we
must make the applicable changes to several connections. The following steps will walk you through this process.

Rockwell Automation | 2021 163


61. Widen the Import Configuration window and expand the Final Connection column so you can see the
Parameter Name and the Final Connection columns.

62. For the Final Connections that start with \Simulation1. update the text to \Simulation2.
Once complete with this step the Final Connection column should match the capture below.

Next the I/O tags will be updated.

Rockwell Automation | 2021 164


63. Use the following key to aid in updating the I/O tags.

a. Local:3:I.Pt[0].Data change to Local:3:I.Pt[1].Data.

b. Local:3:I.Pt[2].Data change to Local:3:I.Pt[3].Data.

c. Local:3:I.Pt[4].Data change to Local:3:I.Pt[5].Data

d. Local:4:O.Pt[0].Data change to Local:4:O.Pt[1].Data.

e. Local:4:O.Pt[2].Data change to Local:4:O.Pt[3].Data.

f. Local:6:O.Ch[0].Data change to Local:6:O.Ch[1].Data.

Once complete with this step, the entries in Final Connection column that start with Local: should match
the capture below.

You might have noticed that there are parameters that use the same tag. This is called “fanning”. Fanning is when multiple
connections are configured to one tag/parameter.
We are not changing the connection for \Pump2.Inp_PumpSpeed. It will be connected to the same input as Station_1.

64. Change the Final Connection for MSG_PLC5Read_Station_1 to MSG_PLC5_Read_Station_2.

65. Change the Final Connection for PLC_LeakStatus_Tank1 to PLC_LeakStatus_Tank2.

Rockwell Automation | 2021 165


66. The Final Connection column should look like the screen shot below.

Verify that all final connections match the screen shot above.
The tag MSG_PLC5_Read can only have one connection. You will need to create a new Message tag to connect to the
‘Tank2.Pv_MSG_PLC5Read' parameter. The new message tag is not shown.

67. Click OK in the Import Configuration window.

68. Once the import completes, the Tank_Manager folder should now have a new folder called Station_2.
Expand the Station_2 folder and verify that the programs imported successfully.

Rockwell Automation | 2021 166


69. Select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the controller with
IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

70. Select Download and acknowledge any other windows to start the download.

71. Put the controller into RUN mode by selecting Yes in the window.

Rockwell Automation | 2021 167


72. Verify the application works as expected for the new Station 2.

Note:
Station 1 and Station 2 will share the same Pump Speed AI0 slider controls
If you work with a physical demo box, it might only have one AO voltmeter. In such case you will need to
monitor the Station 2 level by reading the output tag data in Logix Designer. Go to Controller Organizer, open
Controller Tags and expand Local:6:O.Ch[1].

When using remotely located hardware or emulator, Station 2 level can be monitored using AO1 in the HMI
application

Rockwell Automation | 2021 168


73. Make sure the switch at DI5 is turned to the RIGHT. This switch allows the user to select between Auto
(Right) and Manual (Left) Mode for Station 2.

74. When the light at DO1 is illuminated, the Fill Pump is ON.

75. When the light at DO3 is illuminated, the Drain Pump is ON.

76. The Local:6:O.Ch[1].Data tag / AO1 simulates the tank level. 0 indicates EMPTY,
30000 (tag value) / 10 V (AO1 reading) indicates FULL.

77. Adjust the AI0 slider / knob to 5. The potentiometer slider simulates the pump speed. As you turn the knob /
slider clockwise, the pump speed will increase.

Note: You should notice the tank slowly filling and draining. As the Local:6:O.Ch[1].Data / AO1 increases,
the DO1 light should be illuminated (filling). As the Local:6:O.Ch[1].Data / AO1 decreases, the DO3 light
should be illuminated (draining).

78. Adjust the AI0 slider to 10.

Note: The rate at which the tank is filling and draining should have increased.

79. Turn the DI5 switch to the LEFT position. This will put the system into Manual Mode.

Note: The green lights should both turn off. The Local:6:O.Ch[1].Data / AO1 should become a constant
value. Since the system is now in manual mode, you must manually operate the fill and drain pumps.

80. Press and HOLD the green button at DI1. This will manually turn the fill pump ON.

Note: You should notice the green light will turn ON and the Local:6:O.Ch[1].Data / AO1 increasing. When
the tank is full, the green light should turn off even if the button remains depressed.

81. Press and HOLD the green button at DI3. This will manually turn the drain pump ON.

Note: You should notice the green light will turn ON and the Local:6:O.Ch[1].Data / AO1 decreasing.
When the tank is empty, the green light should turn off even if the button remains depressed.

82. Go Offline with the controller by selecting COMMUNICATIONSGo Offline.

83. Close Studio 5000 Logix Designer. If prompted to save the file respond with No.

Rockwell Automation | 2021 169


6.3 PIO Search and Replace Example
This section will perform some of the same changes that we made in section 2, but we will use the Find/Replace features in the
PIO window.

PIO Find and Replace


Using Find and Replace in the PIO allows you to quickly change many tags at one time.
PIO will allow you to import these programs while offline OR online, while giving you quick
access to all the program’s parameters and connections prior to the import.

84. Double-click on the Lab Files folder on the desktop.

85. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 06 Improving Efficiency Using Partial Import Online
and double-click Tank_Supervisor_Section3.ACD to open in Logix Designer.

86. Minimize the Tank_Controller.ACD project after it opens.

87. Click on the Logical Organizer in the Tank_Supervisor_Section3.acd file.

88. Expand the Simulation_Logic folder.

Rockwell Automation | 2021 170


89. Right-click on the Simulation_Logic folder and select AddImport Program….

Note: Additionally, you can left-click drag and drop components which will function similarly to copy/paste.
Using right-click drag and drop of components will give you a few more options on how the component is
pasted / imported.

90. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 06 Improving Efficiency Using Partial Import
Online\Library.

91. Select the Simulation.L5X file and click Open.

Rockwell Automation | 2021 171


92. The Import Configuration window will be displayed.

Note: This window allows us to see the details about the import. We can view and correct collisions as well as make
changes to connections.

Rockwell Automation | 2021 172


93. Verify the Simulation1 program in the “Import Content” window is highlighted.

Note: If a red flag appears in the yellow margin it, indicates that an item is flagged for review. The user
should investigate all flags prior to the import.

94. In the Configure Program Properties window, change the Final Name to Simulation2.

95. Click in the Description box. Clicking in a different box will accept the name change.
Notice how the Operation changed from Overwrite to Create.

Rockwell Automation | 2021 173


96. In the “Schedule In” drop-down, verify Sim_Logic is selected.

This will schedule the Simulation2 program in the Sim_Logic Periodic Task.

97. The Configure Program Properties window should look like the screenshot below.

98. Click on the Connections folder in the Import Content window.

99. Select Find/Replace….

Rockwell Automation | 2021 174


100. Enter 1. in the Find What: box. (Be sure the Use Wildcards checkbox is not selected).

101. Enter 2. in the Replace With: box

Be sure the options match the capture below.

102. Click Find Next.

In this example the Find / Replace has found the “1.” In the Final Connection \Pump1.Out_DrainPumpON.
Verify that you find \Pump1.Out_DrainPumpON before continuing.

103. Click Replace All and move the Find / Replace window to so that you can see the Final Connection
column.

The Final Connection column in the Configure Connections pane should match the capture below.

The red flags are expected in this step.

Rockwell Automation | 2021 175


104. Close the Find / Replace window and select OK in the Import Configuration window.

105. The Simulation_Logic folder should now have a new program called Simulation2.

In the next steps you will import Station_2.

106. Expand the Tank_Manager folder.

107. Right-click on the Tank_Manager folder and select AddImport Program…

108. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 06 Improving Efficiency Using Partial Import
Online\Library.

109. Select the Station_Section3.L5X file and click Open.

Rockwell Automation | 2021 176


110. Make the noted changes so that the Configure Program with Parenting Information pane matches the
image below.

111. Click on the Programs folder in the Import Content window.

Rockwell Automation | 2021 177


112. The Import Configuration window should match the image below.

113. Select the Find/Replace… button and match the options with the screenshot below

You want to replace 1 with 2 for the three programs.

Important: Make sure the Search current view only box is checked before continuing.

114. Click the Replace All button to update the 3 programs.

115. Close Find / Replace window and verify that the Final Name column was updated as shown below.

Rockwell Automation | 2021 178


116. Select the Tags section from the Import Content: section.

117. Select the Find/Replace… button and match the capture below

118. Click the Replace All button to update two tags.

119. Close Find / Replace window and verify that the Final Name column was updated as shown below.

None of the “Local” tags were updated with this operation.

120. Select the Connections section from the Import Content: section.

Rockwell Automation | 2021 179


121. Select the Find/Replace… button and match the capture below

122. Click the Replace All.

123. Close Find / Replace window and verify that the Final Name column was updated in the portion shown
below.

124. Manually update the I/O Tags in the Configure Connections section to match the I/O shown below.

You can use the Find / Replace functionality for the I/O tags. Because of the small number of Find / Replace items (only
one or two) per replacement, manual updating was selected for this step.

Rockwell Automation | 2021 180


125. Click OK in the Import Configuration window to start the import.

126. In the Logical Organizer the Tank_Manager folder will now have a new folder called Station_2.

127. In the Controller Organizer new programs have been added for Auto_Cycle2, Pump2, Tank2 and
Simulation2.

PIO – You can quickly change names before importing!


The PIO dialog window guides you through the names in the import file and the new names that are going to
be used in the controller. You can quickly and easily change these names before anything is added to the
controller!
PIO – Partial Import Online - Offline and Online workflows are the same!
You can complete the same steps while online with a running controller. The workflow is the same. The
changes can be automatically accepted or added into test mode.

Rockwell Automation | 2021 181


Let us verify the import and that the application works as expected.

128. Select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the controller with
IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

129. Select Download and acknowledge any other windows to start the download.

130. Put the controller into RUN mode by selecting Yes in the window.

Rockwell Automation | 2021 182


131. Verify the application works as expected for the new Station 2.

Note:
Station 1 and Station 2 will share the same Pump Speed AI0 slider controls
If you work with a physical demo box, it might only have one AO voltmeter. In such case you will need to
monitor the Station 2 level by reading the output tag data in Logix Designer. Go to Controller Organizer, open
Controller Tags and expand Local:6:O.Ch[1].

When using remotely located hardware or emulator, Station 2 level can be monitored using AO1 in the HMI
application

Rockwell Automation | 2021 183


132. Make sure the switch at DI5 is turned to the RIGHT. This switch allows the user to select between Auto
(Right) and Manual (Left) Mode for Station 2.

133. When the light at DO1 is illuminated, the Fill Pump is ON.

134. When the light at DO3 is illuminated, the Drain Pump is ON.

135. The Local:6:O.Ch[1].Data tag / AO1 simulates the tank level. 0 indicates EMPTY,
30000 (tag value) / 10 V (AO1 reading) indicates FULL.

136. Adjust the AI0 slider / knob to 5. The potentiometer slider simulates the pump speed. As you turn the knob /
slider clockwise, the pump speed will increase.

Note: You should notice the tank slowly filling and draining. As the Local:6:O.Ch[1].Data / AO1 increases,
the DO1 light should be illuminated (filling). As the Local:6:O.Ch[1].Data / AO1 decreases, the DO3 light
should be illuminated (draining).

137. Adjust the AI0 slider to 10.

Note: The rate at which the tank is filling and draining should have increased.

138. Turn the DI5 switch to the LEFT position. This will put the system into Manual Mode.

Note: The green lights should both turn off. The Local:6:O.Ch[1].Data / AO1 should become a constant
value. Since the system is now in manual mode, you must manually operate the fill and drain pumps.

139. Press and HOLD the green button at DI1. This will manually turn the fill pump ON.

Note: You should notice the green light will turn ON and the Local:6:O.Ch[1].Data / AO1 increasing. When
the tank is full, the green light should turn off even if the button remains depressed.

140. Press and HOLD the green button at DI3. This will manually turn the drain pump ON.

Note: You should notice the green light will turn ON and the Local:6:O.Ch[1].Data / AO1 decreasing.
When the tank is empty, the green light should turn off even if the button remains depressed.

Rockwell Automation | 2021 184


141. Go Offline with the controller by selecting COMMUNICATIONSGo Offline.

142. Close Studio 5000 Logix Designer. If prompted to save the file respond with No.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 185


Lab 7: Introduction to Program Parameters <40 minutes>

Since applications often consist of many code modules, each module must have a means of interacting with other modules or
devices. This interaction is often referred to as the Linking Layer. Code Modules are linked together using clearly defined “inputs”
and “outputs” that are required for a module to complete its task. Once a code module’s inputs and outputs have been defined,
they can be linked to other modules using Connections.
Within the Logix environment, users can implement modular design techniques in several ways including the use of Routines,
Programs, and AOIs. Execution varies depending on the type of container used. i.e. scheduled (Programs) versus called (AOI’s
and Routines). Prior to version 24, if the application was segregated using programs, users were forced to use controller scoped
tags for the linking layer. Version 24 introduces a feature called Program Parameters. This feature allows the user to configure
program-to-program connections, without the use of controller scoped tags. The ability to define program-to-program interfaces
adds an additional level of Encapsulation for an improved modular programming environment.
This section will introduce several powerful features introduced in version 24 of Logix Designer. These features are designed to
provide a design environment that enables users to fully implement modular programming methodologies.
Program parameters define a data interface for Programs. Data sharing between Programs can be achieved either through pre-
defined connections between parameters or directly through a special notation. Unlike local tags, all program parameters are
publicly accessible outside of the program. Additionally, HMI external access can be specified on individual basis for each
parameter.
There are two types of parameters for Programs: standard parameters, which are Input and Output, and special usage
parameters, which are InOut and Public.
 Input parameters: An Input parameter defines the data that is passed by value into the executing program. Because
Input parameters are passed by value, their values cannot change from external sources during the execution of the
program when connected to Output or Public parameters. An Input parameter supports a maximum of one connection
or InOut binding.
 Output parameters: An Output parameter defines the data that is produced as a direct result of executing the
program. Because Output parameters are always passed by value, their values cannot change outside of the
execution of the Program nor can they be changed from other programs. Output parameters can be connected to one
or several Input and Public parameters or Controller scope tags.
 InOut parameters: An InOut parameter represents a reference to data that can be used both as input and output
during the execution of a program. Because InOut parameters are always passed by reference, their values can
change from external sources during the execution of the program. An InOut parameter must be bound to exactly one
target including Input and Public parameters as well as Controller scope tags. Some restrictions apply when binding an
InOut to an Output parameter.
 Public parameters: A Public parameter defines the data that is passed by value into a program or is produced by the
executing program. A Public parameter accepts several connections or InOut bindings (except for Controller scope
tags) and can function as a data concentrator or shared memory between programs.

In this section, you will learn how connections are made between code modules (Programs). We will cover existing and new
methods. We will primarily focus on how to create and connect Program Parameters (New in version 24). You will be using an
existing program to conserve time.

Rockwell Automation | 2021 186


7.1 Input Parameters
This section will cover Input parameters. The example application contains three code modules (Pump, Tank, and Auto_Cycle).
The code module interface has been defined and parameters are already created. This was done to conserve time. In this
section, you will be setting up several connections to Input parameters.
Goals:
 Create an Input Parameter
 Configure a connection
 Understand when an Input connection can be used

1. Double-click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 07 Introduction to Program Parameters and double-


click Sample_Project_Start.ACD to open in Logix Designer.
3. In the Controller Organizer navigate to TasksMainTaskPump1 and open Parameters and Local
Tags.

Notice that Program Tags are now Parameters and Local Tags. This change was required to reflect the addition
of Program Parameters. Additionally, the naming convention introduced for Programs in version 24 now matches
the naming convention used for Add-On Instructions (AOIs).

4. Highlight the tag Inp_DrainPumpPB. This is can be done by pressing the gray button to the left of the tag
name. You may need to expand the name column.

Rockwell Automation | 2021 187


5. Locate the tag properties window on the right side of the screen. If Parameter Connections is not
expanded, do so now by clicking on the arrow symbol.

A Parameter must be “connected” to another Parameter or Controller Tag. For example, connecting an Output parameter to
an Input parameter will ensure that data is copied from the Output parameter to the Input on every scan. The screen shot
above indicates that this input parameter has no connections. The steps below will walk you through creating a connection.

6. Click in the box that says New Connection.

This input parameter is for the Drain Pump Pushbutton input. It will be connected to the physical input point in the
Controller Tags.
7. Once you click in the box, click the gray browse button on the right.

8. Click the drop-down arrow when the tag selection pop-up appears.

9. Locate and expand Local:3.I.Pt

Rockwell Automation | 2021 188


There are many ways to filter or search through tags on this screen. Take a moment to familiarize yourself with the many
options. We will explore some of them as we progress through the lab.

10. Expand Local:3:I.PT[2] and double-click on Local:3:I.PT[2].Data.

11. Once you select the Local:3:I.PT[2].Data bit, the tag selection pop-up should look like the capture below.

If you know the exact tag name you can also enter it manually

Rockwell Automation | 2021 189


12. Press the OK button on the tag selection pop-up. You screen should match the image below.

The Parameter Connections changed from {0:0} to {1:0}.


The number on the left between the brackets indicates the number of connections to the parent tag. In this case,
the parent tag is Inp_DrainPumpPB. The number on the right indicates the number of connections to members
of the parent tag. For example, if the parent tag was a User-Defined data type, then any connection to a member
of the tag will be reflected in the number on the right. This also applies to connections that are configured to bits
in a SINT, INT or DINT.

We need to create one more Input connection. Let us create this connection by adding a connection column in
our tag database.

13. Click on the Edit Tags tab for the Pump1 Parameters and Local Tags.

14. Right-click on any one of the column headers. Select Toggle Column and then select Connection if not
checked.

15. Locate the tag Inp_FillPumpPB.

Rockwell Automation | 2021 190


16. Click in the Connection box for this tag. (You may have to scroll to the right to see the Connection column).

At this point, you can click the gray browse button. This button will display the Connection Configuration screen. This
window would be required if more than one connection exists or must be configured. If only one connection exists or is
desired, you can click the drop-down arrow. This will display the tag selection pop-up. You can also just type the name of
the connection tag into the connection box. We are going to configure this connection through the Connection Configuration
Screen.

17. Click on the browse button to open the Connection Configuration Dialog Box.

18. Click in the box with the text New Connection.

Rockwell Automation | 2021 191


19. Click on the gray button on the right side of the name box.

20. Navigate to Local:3:I.Pt[0].Data. Click OK.

21. Click OK to close the Connection Configuration window.

22. Inp_FillPumpPB now has a connection to Local:3:I.Pt[0].Data.

Rockwell Automation | 2021 192


Additional Information – Input Parameters
When to use Input Parameters
Input Parameters can be connected to Controller Scoped tags, Output Parameters, Public Parameters, and
InOut Parameters. This makes input parameters a great option for connecting input card data to a code
module or object. It also is a good option for code module or object commands that are point-to-point. If
multiple code modules or objects must have access to the command, there may be better options available
and they will be discussed later in the lab.
Input Parameter General Information
Input parameters (including members) can only support ONE connection. For example, let’s assume you
have a DINT input parameter in Program A named Input1. Let’s also assume that Program B has a BOOL
output parameter named Output1 that is connected to bit 0 of Input1 in Program A. An error will occur if any
additional connection is defined for Input1 at the DINT level. The same rule applies for User-Defined
Structures.
Input Parameter values are refreshed BEFORE each scan of a program. The values will not change during
the logic execution. Users will no longer have to write code to buffer inputs if they don’t want them to change
during program execution.
A program can write to its own input parameters.

Rockwell Automation | 2021 193


7.2 Output Parameters
This section will cover Output parameters. The example application contains three code modules (Pump, Tank, and Auto_Cycle).
The code module interface has been defined and parameters are already created. This was done to conserve time. In this
section, you will be setting up several connections to Output parameters.
Goals:
 Create an Output Parameter
 Configure a connection
 Understand when an Output connection can be used

23. In the Controller Organizer, right-click on the Tank1 Program and select Properties.

Note: There are several ways to configure connections. In the previous section, we used the Tag Properties
window. In this section we will use the Parameters Tab in the Program Properties window. Both methods are
available and can be used based on user preference.

Rockwell Automation | 2021 194


24. Select the Parameters Tab.

The Parameters tab was introduced in version 24 of Logix Designer. This gives the user another way to see and configure
parameters and connections. (Do not worry about the Red “X” next to Pv_MSG_PLC5Read.)

25. Click in the Name box for the tag Out_VoltMeter. (DO NOT click on the graphic. See the note below
for more details).

Note: If you click the button next to the parameter name, it will allow you to view the tag parameters
members (bits). You will have to click the home icon (house) to return to the normal view.

Rockwell Automation | 2021 195


26. In the Connections pane at the bottom of the screen, type Local:6:O.Ch[0].Data in the New Connection
input box.

If a red “X” appears next to this connection, it is possible that you typed the number “0” instead of the letter “O”.

27. Click Apply in the Program Parameters window.

Notice there is still a mark on Out_VoltMeter. This is because there is a data type mismatch with the parameter and
the selected tag.

28. Update the Out_VoltMeter datatype to REAL and click Apply in the Program Properties window.

Rockwell Automation | 2021 196


29. Click OK to close the Program Properties window.

For this application, the Auto_Cycle code module must be able to command the Drain and Fill pumps to run. The Pump
code module has been configured to have a public run command for both the Drain and Fill pumps. Since the
Auto_Cycle module must be connected to the Pump module, an output parameter must also be configured for both the
Drain and Fill pumps in the Auto_Cycle module. We will be configuring these connections as well as explore some of
the filter/search mechanisms throughout the next several steps .

30. In the Controller Organizer navigate to TasksMainTaskAutoCycle1 and open Parameter and Local
Tags.

So far, all connections that have been configured have been to Controller Tags (I/O). The next two connections will be
connections between two programs.

Rockwell Automation | 2021 197


31. Highlight the parameter Out_DrainPump. In the tag properties window, expand Parameter Connections
from the Properties pane on the right.

32. Click in the New Connection input box.

33. Click on the browse button on the right.

34. Click the drop-down arrow when the tag selection pop-up appears.

35. Remove the checkbox on Show controller tags.

36. Remove the checkbox on Show Auto_Cycle1 tags.

37. For the Show Parameters from other Program dropdown select Pump1.

Your window should match the image below.

The selections displayed are filtered to show Pump1 parameters that can be connected to an output parameter. All local
tags and parameters that would make invalid connections are not visible.

Rockwell Automation | 2021 198


38. Double-click on \Pump1.Cmd_PublicDrain. You may have to expand the name column to see the entire
parameter name.

39. \Pump1.Cmd_PublicDrain is now in the tag pop-up. Click OK finalize this connection.

Rockwell Automation | 2021 199


40. Highlight the parameter Out_FillPump. In the tag properties window, expand Parameter Connections.

41. Click in the box that says New Connection.

42. Click on the browse button on the right.

43. Click the drop-down arrow when the tag selection pop-up.

44. In the upper left corner of the parameter selection pop-up, enter PublicFill.

This filtering can be a quick way to parameters, especially if you know some key words in the tag name.

45. Double-click on \Pump1.Cmd_PublicFill.

46. \Pump1.Cmd_PublicFill is now in the tag pop-up. Click OK finalize this connection

Rockwell Automation | 2021 200


Additional Information – Output Parameters
When to use Output Parameters
Output Parameters can be connected to Controller Scoped tags, Input Parameters, and Public Parameters.
This makes output parameters a great option for connecting a code module or object to an output card. It
also is a good option for configuring a code module or object to invoke operations (commands, settings, etc.)
in other code modules or objects. Additionally, multiple connections can be configured for an output
parameter. This allows one code module or object to send multiple commands to multiple modules or objects
using one output parameter. This is often referred to as “fanning”.
Output Parameter General Information
• Output parameters (including members) can support multiple connections. For example, lets
assume you have a BOOL input parameter in Program A and Program B named Input1a and Input1b.
You are allowed to connect a single output parameter in Program C to Input1a AND Input1b. As stated
earlier, this is often referred to as “fanning”.
• Output Parameter values are refreshed AFTER each scan of a program. Updated output parameter
values will NOT be available to the parameters connected to that output parameter until the program
execution is complete.
• An Output parameter can ONLY be connected to an InOut parameter if both the Output and InOut
parameters are configured as Constants. InOut parameters will be discussed in the next section. The
primary reason for this requirement is InOut parameters are passed by reference, which functions
similarly to alias tags. In other words, the InOut parameter is merely a pointer to the original tag. If a
non-constant InOut parameter could be connected to a non-constant Output parameter, values written
to the InOut parameter would overwrite the value in the Output parameter. This is prohibited when the
InOut and Output parameters are configured as Constants which means the value cannot be changed
by logic. This would be a good technique for configuring a code module to monitor the output value of a
different code module.

Rockwell Automation | 2021 201


7.3 InOut Parameters
This section will cover InOut parameters. The example application contains three code modules (Pump, Tank, and Auto_Cycle).
The code module interface has been defined and parameters are already created. This was done to conserve time. In this
section, you will be setting up several connections to InOut parameters.
Goals:
 Create an InOut Parameter
 Configure a connection
 Understand when an InOut connection can be used

47. In the Controller Organizer navigate to TasksMainTaskTank1 and open Parameters and Local
Tags.

Let us assume this system has a PLC5 that is running remotely at the tank location. That PLC5 has several inputs that
gather leak detection status of the tank area. This application will retrieve the leak detection status from the PLC5
using a PLC5 Word Read MSG instruction. Message instructions must reside in the Controller Tags. An InOut
parameter can be used to connect directly to the Message instruction at the Controller scope. This provides an extra
layer of encapsulation. The following steps in this section will walk you through the process of connecting a Message
instruction to a program InOut parameter.

48. Highlight Pv_MSG_PLC5Read. This tag should have a mark which indicates an error.

49. In the Properties pane, click in the New Connection input box.

50. Once you click in the box, click the gray browse button on the right.

51. Click the drop-down arrow when the tag selection pop-up appears.

Rockwell Automation | 2021 202


52. Remove the checkbox on Show Tank1 Tags and set the Show Parameters from other Program
dropdown to None.

53. Scroll down in the list and double-click the MSG_PLC5_Read controller tag.

54. Press the OK button on the tag selection pop-up to finalize the connection.
If you look in the Parameters and Local Tags for Tank1, you will also see an input parameter named
Inp_LeakDetectionPLC5. Since Message instruction source and destination tags must also be at the controller scope,
we created an additional parameter to connect to the result (destination) of the Message instruction.

Rockwell Automation | 2021 203


Additional Information – InOut Parameters
When to use InOut Parameters
InOut Parameters can be connected to Controller Scoped tags, Input Parameters, Public Parameters, and
Output Parameters (Constants). InOut parameters are especially unique because they pass by reference
rather than by value. In other words, they are merely a pointer to the original data and closely resemble the
behavior of an alias tag. With that in mind, it is possible that the InOut parameter values could change during
the execution of a program. Depending on your task structure, this behavior may be necessary. One
example of a structure that could potentially take advantage of InOut parameters is an application that
contains multiple tasks with different priority assignments. In this scenario, a lower priority task will be
interrupted by a higher priority task. If the higher priority task is referencing data in the lower priority task, the
InOut parameter will allow the higher priority task to point directly to a tag’s value in the lower priority task.
This will ensure that the higher priority task is using the most up-to-date value of a tag. Another useful
scenario where InOut parameters would be required is the use of instructions whose tags can only be placed
at the controller scope. A prime example would be MSG instructions. InOut parameters would allow a
program to connect directly to the MSG instruction tags in the controller scope.
InOut Parameter General Information
• InOut parameters can only support ONE connection. You cannot configure connections to any
member of an InOut parameter.
• InOut parameters are passed by REFERENCE, which means they simply point to the base tag. In
other words, when an InOut parameter is used in logic, the current value of the parameter connected to
the InOut Parameter will be used.
• An InOut parameter can ONLY be connected to an Output parameter if both the Output and InOut
parameters are configured as Constants. See the tool tip for Output Parameters for a more detailed
explaination.
• InOut parameters CANNOT be changed online, unless using the Partial Import Online (PIO).

Rockwell Automation | 2021 204


7.4 Public Parameters
This section will cover Public parameters. The example application contains three code modules (Pump, Tank, and Auto_Cycle).
The code module interface has been defined and parameters are already created. This was done to conserve time. In this
section, you will be setting up several connections to Public parameters.
Goals:
 Create a Public Parameter
 Configure a connection
 Understand when a Public connection can be used

55. In the Controller Organizer navigate to TasksMainTaskAuto_Cycle1 and open Parameters and
Local Tags.

56. Select the Edit Tags tab.

57. Click inside the usage box for Sts_AutoMode. Select the drop-down arrow and select Public Parameter.

This tag was originally configured as a Local Tag. It can easily be converted to a public parameter so other programs
can get access.

58. In the Properties pane, click in the New Connection input box.

59. Once you click in the box, click the gray browse button on the right.

Rockwell Automation | 2021 205


60. Click the drop-down arrow when the tag selection pop-up appears.

61. Set Show Parameters from other Programs to Pump1 and complete the connection.

62. Type Auto in the filter box.

63. Double-click \Pump1.Inp_AutoMode and click OK in the tag selection pop-up to finalize the connection.

64. Follow similar steps as above for Sts_ManualMode. Set it to a Public Parameter. Connect it to parameter
\Pump1.Inp_ManualMode.

Rockwell Automation | 2021 206


65. Right-click on any one of the column headers. Select Toggle Column and then select Connection if not
checked.

66. Verify Sts_AutoMode and Sts_ManualMode are configured as shown in the capture below.

The remaining steps will demonstrate how to connect to members of a parameter. We will also observe how to quickly
identify how many total connections are configured for a parameter.

67. In the Controller Organizer navigate to TasksMainTaskTank1 and open Parameters and Local
Tags.

Rockwell Automation | 2021 207


68. Highlight Val_LeakDetection. Look at the Parameter Connections for this tag in the Properties window.

Let us do a quick review of what we discussed earlier in the lab. You can quickly identify the number of connections for
the parameter and its members by looking at the numbers between the brackets. The example above indicates that 0
connections are made to the parent parameter, which is Val_LeakDetection.
However, 2 connections are made to one or more members of the parent parameter. In this example, that would mean
there are two connections to one or more of the 16 bits (INT data type) of Val_LeakDetection. Logix Designer (version
24 and higher) software will allow you to view all the connections to a given parameter in the parameters tab of the
program properties.
Let’s create another connection to a member of the Val_LeakDetection parameter.

69. In the Controller Organizer navigate to TasksMainTaskPump1 and open Parameters and Local
Tags.

70. Create a connection for Inp_PumpAreaLeak. Define this connection to \Tank1.Val_LeakDetection.0.

71. Navigate to TasksMainTaskTank1 and open Parameters and Local Tags.

72. Highlight Val_LeakDetection. Look at the Parameter Connections for this tag in the Properties window.
Note how the {0:2} changed to {0:3}.

73. Navigate to TasksMainTaskAutoCycle1 and open Parameters and Local Tags.

74. Create a connection for Inp_LeakStatusWord. Define this connection to \Tank1.Val_LeakDetection.

75. Navigate to TasksMainTaskTank1 and open Parameters and Local Tags.

Rockwell Automation | 2021 208


76. Highlight Val_LeakDetection. Look at the Parameter Connections for this tag in the Properties window.
Note how the {0:3} changed to {1:3}.

77. The Connection column in the Parameters and Local Tags window will display the same information. You
may have to configure the Connection column to be visible.

78. Mouse over the connection box for the Val_LeakDetection Public Parameter.

The popup will show you all the connections that are configured for a given parameter.

Rockwell Automation | 2021 209


When to use Public Parameters
Public Parameters can be connected to Input Parameters, Output Parameters, and InOut Parameters. Public
parameters have the look and feel of controller scoped tags, but at the program level. The key benefit to
using Public parameters over controller scoped tags is better encapsulation. If a code module or object
contains data that must be globally available to other code modules, then a Public parameter would be an
excellent option. Public parameters are updated as the source updates, so higher priority tasks that interrupt
a program during execution will have access to any updated values in the lower priority task. Additionally,
“fanning” is supported with Public Parameters. A possible scenario where this would be useful would be if a
code module or object could receive a command from many modules or objects. Input parameters could be
used, but an individual input parameter would be required for each connection. In other words, if a code
module or object had a command that could be invoked by 10 different code modules or objects then 10
input parameters would be required. However, if the command is configured as a Public parameter, then all
10 code modules or objects could have an output connected to a single Public parameter.
Public Parameter General Information
• Public parameters can support MULTIPLE connections. You can configure connections to the base
Public parameter or any member of a Public parameter. This includes User-Defined Structures.
• Public parameters are updated when the source is updated. In other words, when a Public
parameter value updates, it is immediately available to any higher priorty tasks that are connected to
that parameter.
• Public parameters can be aliased to Controller Scope Tags. If this functionality is desired, it is
important to remember that the alias update will be asynchronous to program execution. The public
parameter will contain the real-time value of the controller scope tag.

Rockwell Automation | 2021 210


7.5 Direct Access of Program Parameters
This section will cover the direct access of Program Parameters. You will be configuring logic and directly accessing several
program parameters.
Goals:
 Configure logic to use direct access
 Understand how direct access behaves in logic

What is Direct Access?


Direct access allows the user to reference another programs parameters in logic without configuring
parameters in the local program. For example, if Program A had an output parameter called Tank_Level,
Program B could reference the Tank_Level parameter in logic without creating a corresponding parameter to
connect to Program A. When direct access is implemented on Input and Public parameters, the values of the
referenced parameters are updated in real time. When direct access is implemented on Output parameters,
values will be updated when the program that contains the output parameter completes execution. When
directly referencing Input and Public parameters, higher priority tasks will be using parameter values that are
up-to-date, minimizing the risk of performing actions on stale data.
Direct Access General Information
• Program local tags CANNOT be accessed using direct access
• Input, Output, and Public parameters can all be directly accessed.
• Using Direct Access of input parameters is a good way to circumvent the “one connection” limit for input
parameters. If you create an input but do not configure any connections for that input, you can directly
reference it from multiple programs.

Rockwell Automation | 2021 211


79. Navigate to TasksMainTaskAutoCycle1 and open MainRoutine.

Rungs 2 and 3 have errors because XIOs are not tied to anything. You are going to link them to parameters from
Tank1 program.

80. Double-click the “?” above this instruction on rung 2.

81. Click the drop-down arrow. Use the filters to find and select \Tank1.Sts_TankFull for the operand.

82. With similar steps above set the operand for the XIO on rung 3 to \Tank1.Sts_TankEmpty.

83. Rungs 2 and 3 should match the capture below.

We want to make sure that we turn the pumps operate correctly when the tank is full or empty. You used direct
reference to acquire the value of the tank full status and tank empty status. The Auto_Cycle1 program can directly
access the value of the Sts_TankFull and Sts_TankEmpty parameters from the Tank program without creating a
connection.

84. Verify the Controller.

No Errors or Warnings should be present. If the Error window is not visible, click Alt+1. Correct any errors.

Rockwell Automation | 2021 212


85. Select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the controller with
IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

86. Select Download and acknowledge any other windows to start the download.

87. Put the controller into RUN mode by selecting Yes in the window.

88. Verify the application works as expected by going through the following steps.

Note: For the lab there are push buttons and lights. Depending on the lab format you use, these are
 either on the physical demo box,
 or within the FactoryTalk View ME application (HMI running on the desktop)

or

Rockwell Automation | 2021 213


If you do not work with a physical demo box, there is a FactoryTalk View ME application available in your
desktop environment which provides interface to either a remotely located ControlLogix controller, or
ControlLogix emulator (FactoryTalk Logix Echo) The FactoryTalk View ME application should already be
running.

If the FactoryTalk View ME application is not running (you accidentally closed it, etc.), you can launch it by
double-clicking the Studio_5000_Logix_Labs.mer file found in the following location.

Rockwell Automation | 2021 214


89. Make sure the toggle switch at DI4 is turned to the RIGHT. This switch allows the user to select between
Auto (Right) and Manual (Left) mode.

90. When the green light at DO0 is illuminated, the simulated Fill Pump is ON.

91. When the light at DO2 is illuminated, the simulated Drain Pump is ON.

92. The analog meter / voltmeter AO0 simulates the tank level. 0 volts means EMPTY, 10 volts indicates FULL.

93. Adjust the AI0 slider / knob to 5. The potentiometer slider / knob simulates the pump speed. As you adjust
the value higher, the pump speed will increase.

Note: You should notice the tank slowly filling and draining. As the voltmeter swings from left to right, the
DO0 light should be illuminated (filling). As the voltmeter swings from right to left, the DO2 light should be
illuminated (draining).

94. Adjust the AI0 slider / knob to 10.

Note: The rate at which the tank is filling and draining should have increased.

95. Turn the DI4 toggle switch to the LEFT position. This will put the system into Manual Mode.

Note: The lights should both turn off. The voltmeter (i.e. the simulated level in the tank) should stop moving.
Since the system is now in manual mode, you must manually operate the fill and drain pumps.

96. Press and HOLD the green button at DI0. This will manually turn the fill pump ON.

Note: You should notice the green light will turn ON and the voltmeter will begin to increase. When the tank
is full, the green light should turn off even if the button remains depressed.

97. Press and HOLD the green button at DI2. This will manually turn the drain pump ON when the system is in
Manual Mode.

Note: You should notice the light will turn ON when it is pressed, and the voltmeter will begin to decrease.
When the tank is empty, the greenlight should turn off even if the button remains pressed.

Rockwell Automation | 2021 215


98. Go Offline with the controller by selecting COMMUNICATIONSGo Offline.

99. Close Studio 5000 Logix Designer. If prompted to save the file respond with No.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 216


Lab 8: Add-On Instructions (AOI) <25 minutes>

Version 16 of RSLogix5000 Logix introduced the concept of reusable code objects called Add-On Instructions (AOI). Add-On
Instructions allow you to encapsulate your most used logic as sets of reusable instructions, like the built-in instructions already in
the Logix controllers. This saves you time by allowing you to easily re-use sets of your commonly used instructions in your
projects and promotes project consistency because commonly used algorithms will all work in the same manner, regardless of
who is implementing the project.

Add-On Instructions may be created using the standard ladder, function block diagram, and structured text
editors already available in Studio 5000 Logix Designer. Once created, an Add-On Instruction may then be
used in any of the Studio 5000 Logix Designer editors without any additional effort on your part.
Online troubleshooting of your Add-On Instructions is simplified by the provision of context views which allow
you to visualize the logic for your instruction for a specific instance of its use. Custom help for your
instructions makes it easier for users to have a successful application of the Add-On Instruction.
Finally, you can use the Add-On Instruction’s source protection capability to prevent unwanted changes to
your instruction and/or to protect your intellectual property.

In this lab, we will take all the conveyor code we were using in the previous lab and encapsulate it within a single Add-On
instruction. We will then use the Add-On instruction in another project to show how much time you can save with them. In this lab
you will:
 Get an overview of AOI Basics
 Create an AOI
 Use an AOI
 Apply signature to an AOI
 Export / Import AOI with a signature

Rockwell Automation | 2021 217


8.1 AOI Basics
This section provides an overview of the basic parts of an Add-On Instruction and their uses. It is informational. The file that will
be used in the next subsection is AOI_Start.ACD which can be opened while you review this information.

1. General Tab.

The General tab contains the information from when you first created the instruction. You can use this tab to update
the information. The description, revision, revision note, and vendor information is copied into the custom help for the
instruction. The revision is not automatically managed by the software. You are responsible for defining how it is used
and when it is updated.

2. Parameters

The Parameters define the instruction interface; how the instruction appears when used. The Parameter order defines
the order that the Parameters appear on the instruction call.

InOut tag values are not displayed even when Required and Visible is selected because they can be
configured as arrays – displaying arrays can consume excessive amounts of space.

Rockwell Automation | 2021 218


3. Local Tags

Local Tags are hidden members private to the instruction. Local Tags are not visible outside the instruction and cannot
be referenced by other programs or routines.

4. Data Type

Parameters and Local Tags are used to define the data type that is used when executing the instruction. The software
builds the associated data type. The software orders the members of the data type that correspond to the Parameters
in the order that the Parameters are defined. Local Tags are added as hidden members .

5. Logic Routine

The Logic routine of the Add-On Instruction defines the primary functionality of the instruction. It is the code that
executes whenever the instruction is called. Shown below is the interface of an Add-On Instruction and its primary logic
routine that defines what the instruction does .

Rockwell Automation | 2021 219


6. Optional Scan Mode Routines

7. Change History

The Change History tab displays the creation and latest edit information that is tracked by the software. The By: fields
show who made the change based on the Windows username at the time of the change.

Rockwell Automation | 2021 220


8. Help

The Name, Revision, Description, and Parameter definitions are used to automatically build the Instruction help. Use
the Extended Description Text to provide additional Help documentation for the Add-On Instruction. The Instruction
Help Preview shows how your instruction will appear in the various languages, based on Parameters defined as
Required or Visible.

Rockwell Automation | 2021 221


8.2 Creating an Add-On Instruction (AOI)
In this section of the lab, we will take one portion of sample conveyor code and use it to create part of an AOI.

Currently, each conveyor code section is made up of one program and four routines. By using an AOI we can
reduce all of this to one custom instruction that can be used anywhere in the application.

9. Open AOI_Start.ACD (if not already open) in


C:\Lab Files\_2_Advanced Logix\Lab 08 AddOn Instructions AOI folder.

10. From the Controller Organizer, expand the Assets folder.

11. Right-click on the Add-On Instructions folder and select New Add-On Instruction… from the drop-down
menu.

Rockwell Automation | 2021 222


12. Name the Add-On Instruction Conveyor_Core and complete the rest of the New Add-On Instruction
window as follows:

13. Click OK button to accept.

14. The instruction definition will open.

Rockwell Automation | 2021 223


15. Click on the Parameters tab to view the parameters for the instruction.

‘EnableIn’ and ‘EnableOut’ parameters are predefined and are added by default to each Add-On
Instruction. The ‘EnableIn’ is manipulated by factors unique to each language environment and can be used
for specialized functionality. This is an advanced topic and is beyond the scope of this lab. The ‘EnableOut’
generally follows the state of the ‘EnableIn’ but can be manipulated by user programming.
The Parameters tab is a tag database editor window for parameters specific to this Add-On Instruction with
the inclusion of definition specific fields:

‘Usage’ allows the user to designate the parameter as:

‘Input’ An input to the instruction (atomic type)

‘Output’ An output from the instruction (atomic type)

‘InOut’ A parameter which is passed ‘by reference’ to the instruction (any data type including UDTs,
arrays, etc.)

‘Default’ allows the user to specify a default value for the associated parameter. This is the value the
parameter assumes when the instance tag for an instruction call is first created.

‘Req’ - A parameter which has been checked as ‘Required’ will force the user to enter a tag or make a FB
(Function Block) connection to this parameter when an instruction instance is used in a routine. This modifier
defines verification behavior in the languages as will be seen later. A ‘Required’ parameter is also ‘Visible’ by
default.

‘Vis’ - A parameter which has been checked as ‘Visible’ will be visible by default on the instruction when it is
used in a routine. Use of this modifier causes differing results depending upon the data type and the
language (LD, FB, ST, SFC) in which an instruction instance is used.

‘Description’ field is important because any information used here will be ‘passed through’ to any instruction
instance of the user program. This ‘self-documents’ the instruction for usage, units, etc.

‘External Access’ field determines whether the are Read/Write, Read Only, or no access (None) from
external applications such as HMI.

‘Can Be Null’ field was introduced in version 33. It allows an InOut parameter to be substituted in the
instance of the AOI with ‘0’ (no need to specify a tag, which is normally mandatory for the InOut parameter).

We will be copying and pasting code from an existing routine for this lab, but we need to create some new tags first.

Rockwell Automation | 2021 224


16. Enter the following tags as shown on the Parameter tab.

Note: Parameters are Input, Output, and InOut tags only. Local tags are entered on a separate tab. Click
the Apply button to accept changes.

17. Click the Local Tags tab and enter the tags as shown.

18. Click Apply.

19. Click on OK to close the dialog.

Rockwell Automation | 2021 225


8.3 Entering the Logic
We are going to re-use and copy the logic to save lab time. Typically, a user would enter logic from scratch.

20. From the Controller organizer locate the C_Start_Stop routine and double-click it to open it.

21. From the toolbar menu select Edit> Select All. This will select all the rungs in the routine.

22. Right-click on rung 0 and select Copy Rung.

23. Expand the Add-On Instructions folder if it is not already expanded in the Controller Organizer.

24. Double-click on Logic to open it.

25. Right-click on the End rung and select Paste.

26. Delete the empty rung that appears at the top.

27. All the logic should now appear without any errors.

Note: Errors may occur if the tags were not typed in correctly in the definition of the AOI. A complete working
example is provided in the next step so don’t worry if errors exist at this point.

Rockwell Automation | 2021 226


That’s it. We just created our first Add-On Instruction. In real life, we probably would want to put all of the routines in it but we just
wanted to show how to construct one.
In the next section we will open an existing program and begin working with a complete AOI.

28. Close the file within Logix Designer using File  Close. Respond with No if prompted to save the file.

Rockwell Automation | 2021 227


8.4 Using the AOI in RLL (Ladder Logic)
Add-On Instructions may be created using the standard ladder, function block diagram, and structured text editors already
available in Studio 5000 Logix Designer. Once created, an Add-On Instruction may then be used in any of the Studio 5000 Logix
Designer editors without any additional effort on your part.
In this section of the lab, you will open an existing program and create the AOI.

29. Open AOI_Next.ACD located in C:\Lab Files\_2_Advanced Logix\Lab 08 AddOn Instructions folder.

This file has the completed Conveyor_Core AOI already completed for you. All three Routines that make up one
conveyor have been combined into one custom instruction.

30. Under AssetsAdd-On Instructions, expand the Conveyor_Core AOI until you can see
the Parameters and Local Tags.

31. Right-click on Conveyor_Core and select Open_Definition.

This will open the definition so you can see all the tags that are now part of the instruction’s definition.

32. Click the Parameters tab.

33. Notice which ones are marked REQ and VIS. This will determine how the instruction looks and acts once we
place it in an application.
You may want to make the Add-On Instruction Definition window larger for easier viewing.

Rockwell Automation | 2021 228


34. Click on the Logic button in the bottom left of the dialog to open the AOI logic and close the Definition
window.

35. You should see ten rungs (0-9) total in the AOI.

Rockwell Automation | 2021 229


8.5 Using the AOI

36. In the MainTask, open the Conveyor_1 routine located in the Conveyor program.

37. You should see a blank rung that we can add the AOI to.

38. Select the Add-On tab and then click the Conveyor button.

39. This will add a Conveyor instruction to the rung.

AOI tag structure: At this point the instruction behaves like any other Logix Designer instruction. It has inputs
and outputs that need to be defined and other parameters that need to be filled in – just like a Timer does.

The parameters with a single question mark (?) after them require a tag name to be entered. The parameters
with a double question mark (??) after them are tag value fields. These fields show the current values of
those parameters.

Rockwell Automation | 2021 230


40. Right-click on the top question mark and select New Tag.

41. Complete the New Parameter or Tag dialog as shown

Data Type is Conveyor_Core. This is what we named our AOI. This follows the same conventions as any
other built in instruction in Logix. If this were a TON instruction, the Data Type would be Timer.

42. Click Create to accept and create the tag.

Rockwell Automation | 2021 231


43. The rest of the operands are inputs. We can assign some real I/O to these inputs the way we would for any
other input arguments.

44. Double-click on the Motor_Overload_Input question mark and select Local:3:I.Pt[0].Data as shown:

45. Do the same for the rest of the AOI inputs, selecting the next sequential input points for each input in the
instruction, until all the question marks are gone.

46. The rung should match the image below:

47. Verify the routine by clicking on the Verify icon.

Rockwell Automation | 2021 232


8.6 Creating Alias Tags

48. Click on the Motor_Overload_Input operand and type My_Motor_Overload. After you accept it you should
see question marks for the value because the entered tag name does not exist yet.

49. Right-click on the new tag name and select New “My_Motor_Overload”.

50. Fill in the dialog as shown. Make sure you fill in the Alias For: as shown by using the pull-down menu and
selecting the correct I/O point.

51. Click Create to accept it. The instruction should now have your Alias filled in.

Rockwell Automation | 2021 233


8.7 Using an Add-On Instruction Output in Ladder

52. On the next rung below the AOI, create the logic pictured below to demonstrate how to access non-visible
tags from an AOI programmatically.

How do you know what the internal elements are named? The AOI follows the same conventions that any other instruction
does.

Tag Name

Parameter

Rockwell Automation | 2021 234


8.8 Using the AOI in a Function Block (FB) Routine

53. Create a new routine named Conveyor_2 by right-clicking on the Conveyor program and then selecting
Add New Routine.

54. Fill out the dialog as shown specifying Function Block Diagram as the Type: and click OK button when
you are finished.

55. Double-click on the new Conveyor_2 routine to open it.

Rockwell Automation | 2021 235


56. Select the Add-On tab and click the Conveyor button. The Conveyor instruction will be added to the page.

Note, the pins associated with parameters designated as Visible in the instruction definition are visible on the instruction by
default.
The data tag for the instruction Conveyor_Core_01 has already been created. This conforms to the behavior of any
instruction created in the function block environment.
The nubs on the input pins is an indication that this parameter requires a connection. The instruction will not successfully
verify until all “Required” parameters have connections.

Rockwell Automation | 2021 236


Let us add 6 input references for each of the 6 input pins on the AOI.

57. Click the Input Reference (IREF) button six times as the AOI requires six inputs.

58. Drag the IREF’s to align roughly with the AOI inputs on the sheet and wire them to the
Motor_Overload_Input connectors.

59. Select the addresses for all the IREF’s as shown below for the required input points.
You could use an Alias here just like we did for the ladder instruction.

60. The instruction will now verify. Notice the “x” is gone from the upper left corner.

Changing Routine Languages


In this subsection, we used a ladder-based AOI in a FBD routine. AOIs allow the developer to program in the desired
editor and the end user to select their preferred editor when utilizing the AOI.

Rockwell Automation | 2021 237


8.9 Re-Using an AOI
Remember in the PIO lab section how we saved time by copying and pasting or exporting and importing code? We can do the
same things with AOI’s to save even more time or to simplify program design and re-use. In this section we will also apply
security to a routine and an AOI.

Storing your Instructions


There are two ways to store and use a group of instruction definitions together.
 Keep them in a project file (.ACD file) and then use Copy/Paste feature to use them
 Export them to an .L5X file and then import them as you need them

Copy and Paste

61. Continue working with AOI_Next.ACD file (this should be the file that you currently have open).

62. From the controller organizer in our Conveyor application, right-click on the Conveyor_Core AOI and select
Copy.

63. Open a second instance of Studio 5000 Logix Designer using the shortcut for Studio 5000 Logix Designer

on the desktop or the button selecting Rockwell Software\Studio 5000.

64. Create a new project file by selecting New Project from the Launcher page.

Rockwell Automation | 2021 238


65. Select a Logix Controller. For this example, we selected a 1756-L85E located under ControlLogix 5580
Controller family. Enter the name AOI_LAB

66. Click Next when finished.

67. Be sure to select Revision 33 of Logix Designer.

Rockwell Automation | 2021 239


68. Click Finish once complete.
It will take a minute to create the new ACD file.

69. In the Controller Organizer right-click on Add-On Instructions.

70. Select Paste With Configuration.

Note: If you select Paste the copy may fail. “Paste With Configuration” opens the Partial Import Online
(PIO) dialog window which is different than just a Paste.

71. Click OK.

Rockwell Automation | 2021 240


72. The Conveyor_Core AOI should now be present and ready for our use in the new program.

73. Close this instance of Logix Designer. Respond with No if prompted to save the file.

Rockwell Automation | 2021 241


8.10 AOI Signatures
Copying and pasting requires you to have two instances of Studio 5000 Logix Designer open at the same time. This is fine if you
are using your own AOI’s. How do you send someone else a copy of the AOI? What if you want to apply security to the AOI?
Perhaps you want the other user has edited the AOI?

AOI Signatures allows the application developer to monitor changes to an AOI. The AOI signature value can be monitored to
record “version” of AOI that was created. Users can view AOIs with Signatures, but they will need to remove the Signature to edit
the AOI. Signatures will also need to be removed and reapplied when the Major revision of a project has changed.

In the following subsections we will:


 Apply a signature to the Conveyor_Core AOI
 Export the AOI
 Import the AOI in a new application

Applying Signatures

Before we export the Conveyor_Core AOI, we will apply a signature to it. Then we will import it into a new ACD file.

74. Continue using the AOI_Next.ACD file.

75. In the Controller Organizer, navigate to the Conveyor_Core AOI. Double-click on the AOI to display its
properties. Navigate to the Signature tab, shown below.

76. Click on Generate, to generate a new Signature for this AOI.

Rockwell Automation | 2021 242


77. A warning message will be displayed. Click Yes to confirm and generate the instruction signature.

AOIs with signatures cannot be modified. The AOI signature will need to be removed before the AOI can
be modified. There is no security associated with removing AOI signatures, so anyone can remove the
signature and change the AOI. But, if a new AOI signature is created it will not match the original
signature.

78. Below is the AOI with a signature.


Your signature value will be different then what is shown below.

79. Click OK.

80. In the Controller Organizer, the icon for the Conveyor_Core AOI has now changed since a signature has
been added. The blue dot in the icon indicates that the AOI has a signature.

Rockwell Automation | 2021 243


8.11 Export AOI
We will look at how to export an AOI and then import it into a new Logix Designer application.

81. In the Controller Organizer, right-click the Conveyor_Core AOI and select Export Add-On Instruction… .

82. Enter Conveyor_Core as the file name for the AOI .

83. Set the window to save to C:\Lab Files\_2_Advanced Logix\Lab 08 AddOn Instructions AOI.

84. Click Export.

The Include all referenced Add-On Instructions and User-Defined Types checkbox in the Export AOI dialog box is
checked by default.

Rockwell Automation | 2021 244


Next we will create a new Logix Designer application

85. Open a second instance of Studio 5000 Logix Designer.

86. Create a new project file by selecting New Project from the Launcher page.

87. Select a Logix Controller. For this example, we selected a 1756-L85E. Enter the name AOI_LAB2.

88. Click Next.

89. Select Revision 32 of Logix Designer and click Finish. It may take a moment for Logix Designer to open.

Rockwell Automation | 2021 245


90. In the controller organizer, navigate to AssetsAdd-On Instructions and right-click on the Add-On
Instructions folder and select Import Add-On Instruction….

91. Browse to Conveyor_Core.L5X file that you created above and click Open.

92. This will bring up the Partial Import Online (PIO) dialog box. Our operation is to create a new AOI in this new
application.

93. Click OK to import the AOI.

94. Now you can view the imported AOI in the new Logix Designer application.

Rockwell Automation | 2021 246


95. You can also compare the AOI Signature values in each of Logix Designer application. They will match.

96. Close both instances of Logix Designer using File  Close. Respond with No if prompted to save the file.

Lab Summary
This lab shows that with Add-On Instructions, you can generate code in hours versus days. When you use
code segments repeatedly, you can simply place an AOI in your program instead of re-generating the code
again and again. We saw that we can develop complex code segments and ship them to customers that
need. We can apply signatures to AOIs that will allow customers to view and change the code inside, but
give us indication that something has changed.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 247


Lab 9: Using a SD card with a Logix Controller <15 minutes>

Important! The actions described in this lab section cannot be completed when working with physical
controller in remote location (e.g. onCourse with cloud hardware). This is because the section of the lab
would require you to physically interact with the SD card that is local to the remote controller.
This lab section can be completed when working with emulator (FactoryTalk Logix Echo).
If you are still interested in learning about how you can use a local SD card with a Logix controller, please
feel free to read through this lab section.

All Logix Controllers have a SD card slot designed to read and write data to a SD card. This allows critical process data or
recipes to be saved external to the memory of the controller. Custom message instructions are used to do file operations on the
SD card. The messages are used to create, write, read, and delete both files and directories on the SD card.

Before you Begin


This lab requires that a SD card be installed in the controller. All ControlLogix and CompactLogix controller ship with SD Cards
installed. Please double check that your controller contains a SD card. It may have been misplaced in a prior lab session.

When working with local physical controller, request an instructor to load the SD card before starting the lab.
When working with emulator (FactoryTalk Logix Echo), the contents of the emulated SD card can be
accessed from the FactoryTalk Logix Echo Dashboard:
 Start FactoryTalk Logix Echo Dashboard by double-clicking the desktop shortcut or Start menu item

 Right-click the emulated controller in slot 0 – [00] CLX5580_slot00  Select View SD Card

 The contents of the emulated SD card gets opened in file explorer

The files to be placed on the SD card are stored in


C:\Lab Files\_2_Advanced Logix\Lab 8 Using a SD card with a Logix Controller\Files to be placed on SD.

Rockwell Automation | 2021 248


9.1 Opening an Existing Controller Project
In this section of the lab, we load the controller project.

1. Double-Click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 09 Using a SD card with a Logix Controller and
double-click the project named SD_Read_Write.ACD to open it in Logix Designer.

Note: This may take up to a minute to open.

3. Once open, select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the
controller with IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

4. Select Download and acknowledge any other windows to start the download.

5. Put the controller into RUN mode by selecting Yes in the window.

Rockwell Automation | 2021 249


9.2 Using code to list files and directories
The code used in this section messages at the lowest level to perform operations on the SD card. The interface will be numerical
commands to the Add-On Instructions and routines developed to interface to the SD card. You will enter numeric commands and
see results displayed in the tags of the controller.

Functions to Write and Read SD card

1 – Clear data from UDT


2 – Read data from file with offset
3 – Write data to file with offset
4 – Append Data to file
5 – Delete file/directory
6 – Rename file/directory
7 – Create directory
8 – List files/directories with search pattern
9 – List file attributes
10 – List directories only

Note: SD card Logix functions are the same as the CompactFlash function(s) used in prior Logix controllers.
Note: All of the current Logix controllers use SD cards. An SD card comes shipped with every controller.
Note: Screen captures shown in this manual may differ slightly from what you seen when in your lab
instance. This is expected.

6. Double-click to open Controller Tags in the project tree.

Rockwell Automation | 2021 250


7. Expand the arrow symbol next to the tag CF_RW_functions and expand the arrow symbol next to
CF_RW_functions.strings array member. Make sure you are in Monitor Tags and not Edit Tags.

8. In CF_RW_functions.command member, set it to a value of 8. After the number is entered, press Enter on
the keyboard. This completes the write to the controller tag. It will disappear immediately .

9. Look at the value of CF_RW_Functions.result. When positive, it displays the number of files found. When
negative, an error has occurred performing an operation.

Note: You may have more or less files on your SD card than the number shown. If you have an issue that
results in a negative error value, please alert the instructor.

Rockwell Automation | 2021 251


10. Names of files and directories found on the SD card are displayed in the CF_RW_Functions.string’ array
members.

Note: The .command field clears automatically. You may have different or additional files on your SD card.

The 8 function is a list command. It is equivalent to a DOS ‘dir’ or Unix ‘s’ command. It lists all files and
directories. Using the ‘name’ member, you can search for specific file or directories. Simply set the tag
‘name’ to *o* and it will display all files with an ‘o’ in the name.

11. Enter a 1 in the command member. It will disappear and so will result and string values.

The 1 function is a clear command. It clears all values for arrays used to message the controller. It does not
send any messages to perform SD card operations.

Rockwell Automation | 2021 252


12. Enter a 9 in the command member. It will disappear, and in the ‘string’ values, we see the list of files with
attributes listed and sizes in Kbytes.

You may need to expand the Value column in the tag browser to see the file attributes.

Again, you may have different or additional files on your SD card.

The ‘9’ function is useful for viewing files and their attributes including size.

Rockwell Automation | 2021 253


9.2 Create a Directory

13. Enter a 10 in the command member. It will disappear, and in the ‘string’ values, we see the list of
directories on the SD card.

The ‘10’ function is used to list directories only.

14. Enter the text NewDirectory in the CF_RW_functions.name member (Click the browse button on the left
side of the field to bring up the string editor).

15. Set the Command value to 7. You have now created a directory called ‘NewDirectory’. To verify and see
this result, set the Command to 1 and then set Command to 10.

The ‘7’ function creates a directory on the SD card.

16. Set the Command value to 1 to clear the fields.

Rockwell Automation | 2021 254


9.3 Create, Edit, and Delete a File

17. Set the Name member to mistake.tx. Set the REQ_Length to 235.

18. Set Command to 3.

The ‘3’ function creates a file on the SD card.

19. You have now created a file called mistake.tx.

20. To verify this result set Command to 1 then to 8. You will see mistake.tx in list of files on the SD card.

21. Now we will rename this file since we have a mistake in the file extension. Set name member to mistake.tx.
Set the newname member to correctedmistake.txt.

22. Set Command to 6.

The ‘6’ function renames a file on the SD card.

Rockwell Automation | 2021 255


23. Check the result and see that the name was changed. Set Command to 1 then to 8. The name has changed
in the list.

24. To delete the file, Set Name member to correctedmistake.txt and Set the Command to 5.

The ‘5’ function deletes a file on the SD card.

25. Check the result and see that the file was deleted from the SD card. Set Command to 1 then to 8.

Note: You may have additional files on your SD card.

Rockwell Automation | 2021 256


9.4 Read Data from SD card

Now you will read data from the SD card and compare to how the file looks on a PC.

26. Fivek.txt is a repeating pattern of the alphabet. You can view the file in notepad by browsing to C:\Lab
Files\_2_Advanced Logix\Lab 09 Using a SD card with a Logix Controller\Files to be placed on SD
folder in windows explorer.
If using emulator (FactoryTalk Logix Echo), you can also review the file directly in the folder representing the
emulated SD card (as mentioned earlier at the beginning of the Lab)

27. Navigate to Studio 5000 Logix Designer and the controller tags window.

28. Set Name member to fivek.txt. Set REQ_Length member to 200 and the Command to 2.

29. Expand the CF_RW_functions.data array. If needed, set the Style to ASCII (ifnot already) of
CF_RW_functions.data array. Compare this to the data we see in Notepad.

The ‘2’ function reads a file on the SD card.

Rockwell Automation | 2021 257


30. Set the Offset member to 990 and then set Command to 2.

31. Array elements 7-9 are now ‘X’, ’$r’, and ‘$I’. In Notepad, this corresponds to the end of the tenth line,
where control characters represent Carriage Return and Line Feed. The offset is the number of bytes from
the start of the file, where the code starts to read. Since all the lines in the text file are exactly 100
characters, that means just before the end of the tenth line.

Rockwell Automation | 2021 258


9.5 Storing and Loading Recipe Data

32. In Studio 5000 Logix Designer, expand the Check_CFcode program and double-click to monitor the
Parameters and Local Tags.

33. Expand the active_recipe tag. You can leave the names or values provided or change them as you desire.

Note: Names and values where already populated. You can change them to verify that then are loaded on
the SD card in a later step.

34. Open the recipe_handling routine and trigger rung 0 (toggle the bit store_recipe2recipe1). It will
immediately reset back to 0.

35. Switch back to Controller Tags (CTRL+Tab) or double-click Controller Tags again to see that DN_Length
and Result are both equal to 216.

Rockwell Automation | 2021 259


36. Return to Check_CFcode and double-click on Parameters and Local Tags again. Change some names
and values in the active_recipe tag.

37. Open the recipe_handling routine and trigger rung 2 (toggle the bit load_recipe_from_recipe1).

38. Check the values by double-clicking on Parameters and Local Tags. The values were read back from the
recipe 1 file. The value will return to the original recipe values for Beer.

39. Open the Recipe_Handling routine and trigger rung 1 (toggle the bit store_recipe2recipe2).

Rockwell Automation | 2021 260


40. Switch back to our Controller Tags window. Set Command to 1 then to 8.

41. Two extra files called recipe1 and recipe 2 have been created on the SD card.

Rockwell Automation | 2021 261


Lab Summary

Use of an industrial SD card is recommended (part number 1784-SD1; 1GB capacity or 1784-SD2; 2GB
capacity) for reading and writing data. One must make sure the card is formatted correctly to accept file reads
and writes. This open interface to read and write data provides the user a number ways in which to use this
feature.

Warning: The life expectancy of flash media is strongly dependent on the number of write cycles that are
performed. Even though flash media controllers use wear leveling, users should prevent frequent writes. This
is particularly important when logging data. The best approach is to log data to a buffer and write that buffer
data to the SD card.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 262


Lab 10: Controller Change Log <10 minutes>

Important! Some of the actions described in this lab section cannot completed when working with
physical controller in remote location (e.g. onCourse with cloud hardware).
This lab section can be completed when working with emulator (FactoryTalk Logix Echo).
If you are still interested in learning about the Controller Change Log features, please feel free to read
through this lab section.

The Controller Change Logging feature allows a developer to implement controller level change management. A probable
scenario for implementation is for a machine developer, such as an OEM, who would like to understand what controller changes
occurred with a machine that has been put into service for a customer. To view the diagnostic information in the log file a user
removes the SD card then uses a SD card reader to view a log file in TSV (Tab Separated Variable) format on a PC.
The changes are logged to internal memory and include:
 Download
 Online edits occurred
 Forces enabled/disabled
 Mode changes (Program, Run)
 Major faults
 And more….
The Logix Controller will temporarily store up to 100 log entries in its internal memory which is separate from the user (Studio
5000 Logix Designer project) memory. When the Log file is 80% full in the controller, it can automatically write to a file on a SD
card or a user can force a write to the SD card using a message instruction. In the event of a power loss (without battery backup)
or a controller firmware update, the log files in the controller memory are erased.
In this section, you will view sample code that is provided as a resource with the Studio 5000 Logix Designer to develop an
understanding of how change management is configured.

Rockwell Automation | 2021 263


Before you Begin
This lab does not require that a SD card be installed in the controller. Sample files are provided to show similar files that would
be generated when implementing this logic.

When working with emulator (FactoryTalk Logix Echo), the contents of the emulated SD card can be
accessed from the FactoryTalk Logix Echo Dashboard:
 Start FactoryTalk Logix Echo Dashboard by double-clicking the desktop shortcut or Start menu item

 Right-click the emulated controller in slot 0 – [00] CLX5580_slot00  Select View SD Card

 The contents of the emulated SD card gets opened in file explorer

In this section of the lab, we load the controller project.

1. Double-click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 10 Controller Change Log and double-click the project
named Controller_Log.ACD to open it in Logix Designer.
You can find the project in this directory.

Note: This may take up to a minute to open.

Rockwell Automation | 2021 264


3. Once open, select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the
controller with IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

4. Select Download and acknowledge any other windows to start the download.

5. Put the controller into RUN mode by selecting Yes in the window.

6. Expand the Tasks folder in the Controller Organizer of the project tree to reveal the following
MainProgram and its associated routines.

Rockwell Automation | 2021 265


7. Open the MainRoutine

8. Scroll down to rung 1.

9. Toggle the START bit by right-clicking the XIC and selecting Toggle Bit or select the XIC and press Ctrl-T
on rung 1. This starts the initialization routine preconfigured in the code that configures message
instructions for the proper slot number of the controller. This will ensure that all of the message instructions
will have the correct path.

10. Double-click to open the Counters routine. Each rung has a different Get System Value (GSV) or Set
System Value (SSV) associated with the Controller logging. Each of the GSV instructions works as
described below.

Rockwell Automation | 2021 266


GSV Attribute Description

ControllerLogTotalEntryCount Number of entries added to the log since the last time the value
was reset.

ControllerLogUnsavedEntryCount Number of entries in the controller RAM not yet written to the SD
card.

ControllerLogExecuctionModificationCount Number of entries that are related to modifications to the


behavior of a running controller such as program/task properties
change, online edit, controller timeslice modification, and I/O &
SFC forces (optional).

Rungs 4 and 5 in the Counters routine allow us to programmatically set or reset the Modify execution Count
and Total Entry Count values via Set System Value (SSV) instructions.

11. Turn the controller key switch on the demo box to PROG (Program) mode. Now turn the key switch all the
way to RUN and then to REM (Remote), putting the controller in Remote Run mode. The
ControllerLogTotalEntryCount in Rung 1 is incremented by 2, because the change to Program mode is
logged and then change to Run mode is logged.

12. Leave the controller in Run mode and in the MainRoutine, toggle the START bit in rung 1 again.

Rockwell Automation | 2021 267


13. Double-click to open the Commands routine. It contains a series of message instructions to configure when
and how often the controller writes to the SD card. Additionally, a user may choose to add/remove the
logging of program forces and the ability to create a custom log message. Rung 1, when toggled true, will
write from internal controller memory to the SD card. This is currently done on command by toggling the
Write bit.

Note: You will have to toggle each of the bits in the following steps to enable each Controller Log function.

Note: The WriteLog message will error out if no SD card exists in the controller.

14. Rung 2 is a message that can be used to turn on and off the automatic write to a SD card. Rung 3 is a GSV
that reads that status back. By setting the controller to Automatically Write Entries to the SD card, at 80% of
the controller’s internal memory the log entries will be automatically be copied to the SD card.

Using the MSG instruction to read back the results of a MSG to set a value is good programming practice. It
allows you to see that your configuration message was received.

Rockwell Automation | 2021 268


Rung 4, 5, and 6 are to configure whether you log I/O forces or Sequential Function Chart forces that take place
in the program. Rung 4 is the configuration bit which is messaged to the controller. Rung 5 is the message
instruction that sends that configuration bit to the controller. Rung 6 is a MSG that reads that status information
back.

15. Rungs 7 and 8 are to configure a custom log entry. In addition to the default types of changes that will be
logged automatically, a user is able to configure custom messages to be logged. In this case, Rung 7
triggers the CustomEntryFormatting subroutine which populates a tolerance value into a string. Rung 8 is
used to message the formatted string structure to the controller to be placed into the log file.

16. Custom Entry Logging will allow a user to setup a number of different entries to be triggered in the user
program. Parameter changes, I/O state changes, or custom process related alerts are examples of log
entries that could be useful to a programmer to troubleshoot or track important information for a system. The
log entries are limited to the ideas of the programmer.

17. Toggle the SendCustom bit by right-clicking the XIC and selecting Toggle Bit or select the XIC and press
Ctrl-T on Rung 8.

18. Open the MSG properties by clicking the ellipsis button on rung 8.

Rockwell Automation | 2021 269


19. The message configuration tab comes into view. Under the Service Type drop-down selection, you can
view all the Controller Logging Message types. In this instance, Controller Log Add Entry type, we see
that CustomLog is the source element which is messaged to the controller.

Rockwell Automation | 2021 270


20. Select the communications tab in the CIP message path to the controller. 1 is the default start to any
message instruction to point to the backplane of the rack and 0 is the slot of our L85 controller.

Note: CompactLogix controllers are always in slot 0, so if we were using CompactLogix controller, the path to
a would be always 1,0

All of the message instructions were setup by the program when we set the Start bit in the MainRoutine. If we
want to configure a message to point at a specific controller, then select the browse button and point it to our
controller.

21. Close the Message Configuration dialog.

Rockwell Automation | 2021 271


22. Navigate to the SimpleExample routine.

This example will write to the controller log whenever there is an unsaved entry. With some simple rungs of
code, you can have a log created that saved to the SD card!

Note: The SimpleExample routine is not actually being scanned.

Rockwell Automation | 2021 272


What actions cause new entry in the controller log?
The current list of actions that cause a new entry in the controller log are:
 Project downloaded
 Project loaded from removable media
 Project stored to removable media
 Online edits modified controller program
 Partial import online completed or
Transaction committed
 I/O forces enabled, disabled, removed, or
modified
 SFC forces enabled, disabled, removed, or
modified
 Firmware update
 Constant tag data changed
 Multiple constant tag data changed
 Change to constant tag configuration reset
 Mode change
 Major fault, major fault cleared
 Program properties modified
 Task properties modified
 Controller timeslice modified
 Removable media inserted or removed
 Safety signature created or deleted
 Safety locked or unlocked
 Custom entry: User-defined logic to create a
log entry, with user-defined entry description
and extended information
 Safety signature delete inhibited in Run
mode
 Safety signature delete allowed in Run mode
 The Changes To Detect value has changed
 Log Collected Data Cleared
 Program Connection Modified

Rockwell Automation | 2021 273


23. Minimize Studio 5000 Logix Designer.

24. Right click and open the file ControllerLog_000.txt and/or the ControllerLogSampleExcel.xlsx file
contained in C:\Lab Files\_2_Advanced Logix\Lab 10 Controller Change Log folder.

Important! As mentioned at the beginning of this section, when working with physical controller, you may
not be able to retrieve the SD card from the controller and read it with the lab computer.
The files provided are replicas of what you might find after making the changes performed in the lab.

When working with emulator (FactoryTalk Logix Echo), the contents of the emulated SD card can be
accessed from the FactoryTalk Logix Echo Dashboard, as already explained in the introduction to this Lab.

The folder contains an example of a .TXT file (ControllerLog_000.TXT) and a sample excel file
(ControllerLogSampleExcel.xlsx)..

The top-left corner specifies the type of file, date of file, type of controller, serial number, and firmware revision of the
controller.

In each controller log entry, a sequential record number and time are recorded. An entry description details what
occurred. A windows PC username is associated with the workstation that the changes were made from. If the plant
software is using a FactoryTalk application, then a logged in FactoryTalk user is also tied to the change. Finally, any
extended information like the tolerance values for our custom machine out of tolerance message are shown.

Rockwell Automation | 2021 277


Lab Summary
You should now have a better understanding of how to implement Controller Logging and the features available. Knowing and
understanding changes that were made to a controller aid in troubleshooting field issues in a variety of applications.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 278


Lab 11: Drives Integration into Logix Designer <15 minutes>

Integrated Drive Profiles are designed to save system development time and to make systems easier to maintain.
Testing of skilled engineers configuring drives in a timed, side-by-side comparison, Integrated Drive Profiles in RSLogix 5000
and Studio 5000 Logix Designer software can reduce drive system development time by as much as 70% compared to traditional
configuration.
This is achieved by:
 Providing one software tool to configure the entire controller and drive system.
 Configuring both controller and drive network connections from a single location – eliminating I/O mismatch errors.
 Allowing the dynamic selection of drive parameters transmitted as network I/O – communicating only what is needed
for the application.
 Auto-generating descriptive tag names – eliminating the need to enter individual tag descriptions.
 Auto-generating respective tag data types – eliminating the need to convert from one data type to another.
 Saving all drive configurations in the project file and in the controller – providing a single source of drive configuration
data.
 Providing Copy & Paste capability when creating additional duplicate drives – reduces errors in configuration with
systems containing multiple identical drives.
 Using the same easy-to-use drive configuration Wizards in the Connected Components Workbench, DriveTools SP,
and DriveExplorer software packages.
Systems using the Integrated Drive Profiles in RSLogix 5000 and Studio 5000 Logix Designer software are also easier to
maintain:
 Drive diagnostics, faults, alarms and event information is integral to RSLogix 5000 and Studio 5000 Logix Designer
software.
 Drive Tech Support Wizard can be run from RSLogix 5000 and Studio 5000 Logix Designer software to collect all
pertinent information about a drive, its peripherals, various software components, and PC operating system.
 Drives can be flash updated from RSLogix 5000 and Studio 5000 Logix Designer software.
 Having a single repository of drive configuration data in the controller project file reduces downtime by speeding drive
replacement.
Integrated Drive Profiles are "Add-On Profiles", independent of particular releases of RSLogix 5000 and Studio 5000 Logix
Designer software. Many are backward compatible to work with previous versions of the programming software as well, helping
to prevent obsolescence of the controller when newer drives are available.

Rockwell Automation | 2021 279


Exercise 1: Exploring the Add-On Profile for the PowerFlex 525 Drive

In this section of the lab, we load the controller project.

1. Double-Click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 11 Drives Integration into Logix Controller and
ouble-click the project named PowerFlex_Lab.ACD to open it in Logix Designer.

A pre-configured Studio 5000 Logix Designer software project has already been created for your convenience. The file will
be opened in the Logix Designer software after a few moments.

3. In the Controller Organizer, scroll down to the I/O Configuration section shown in the graphic below.
Open the Module Properties window for the drive by double-clicking
on the “PowerFlex 525-EENET PF525_Drive”.

Rockwell Automation | 2021 280


The Module Properties window will appear. The Add-On Profile for the PowerFlex 525 drive in the Logix Designer software
provides a common look-and-feel to the Connected Components Workbench software. This provides the same ability to
upload, download, view, and compare drive parameters, as well as access the Wizards.

4. Click on the “Device Definition” button.

One additional feature in Logix Designer is for setting up Automatic Device Configuration (ADC) for the drive.

5. Now let’s look at the PowerFlex 755. In the Controller Organizer,


double-click on the “PowerFlex 755-EENET PF755_Drive”.

Rockwell Automation | 2021 281


6. The Module Properties window appears and displays the Overview category of the PowerFlex 755.

The Add-On Profile for the PowerFlex 755 drive in the Logix Designer software provides a common look-and-feel to the
Connected Components Workbench software. This provides the same ability to upload, download, view, and compare drive
parameters, as well as access the Wizards. One additional feature in Logix Designer is for setting up Automatic Device
Configuration (ADC) for the drive.

7. The tools for the PowerFlex 755 are functionally grouped by category as shown below:

8. Click on ‘Device Definition’ underneath the drive description.

Rockwell Automation | 2021 282


9. This will open the drive ‘Identity” window that allows you to view/edit important information such as: voltage
and amp ratings, series, and revision.

Within the Module Definition window, you can perform the following actions:
 Set the Revision of the drive firmware, and set the Electronic Keying
 Select the Drive Rating, Rating Options, and Drive Type
 Create database files from the online drive or download database files from the web
 Configure the input and output datalinks

Rockwell Automation | 2021 283


10. Click on ‘Peripherals’ to view the peripherals installed in the drive.
Expand each port peripheral to review the port, series, revision, and electronic keying.

Your window may be different from pictured image as demo boxes vary.

11. Click on ‘Connection Format’ to view/edit the input and output datalinks configured for the drive.

12. Close the PowerFlex 755 Module Properties window

Rockwell Automation | 2021 284


Exercise 2: Taking Advantage of Having the Drive in the Controller Organizer
When your application requires more than one drive, you can save time with Studio 5000 for configuration. Within the Controller
Organizer, you can duplicate the PowerFlex 525 drive or the PowerFlex 755 drive on the Ethernet network as many times as
needed by using the Copy and Paste features. All of the node information is copied, including the drive parameter settings. All
you need to do is change the IP address, and give the device a unique name. Integrated Drive Profiles are not only easy to use;
they also allow larger systems to be designed faster. Additional devices can be added to the I/O tree by right clicking on the
“Ethernet” and selecting ‘New Module’. There you can search for the device that you are looking to add

13. Create the contextual menu by right-clicking on the device and select “Copy”.

14. Select the Ethernet network and right-click to show the network menu. Select “Paste” from the list.

15. The new drive will appear. It will not have a valid IP address, but the name will be an incremented value of
the original drive.

Where do you think the drive configuration data gets stored? The drive configuration data for each node is
actually stored in your Logix Designer project! It also resides in the controller after the project is downloaded.
This provides a convenient local resource for a node’s configuration settings if the drive needs replaced. Just
connect to the controller, open the drive’s AOP, and download the configuration!

Rockwell Automation | 2021 285


16. In addition to storing the configuration data in the controller, the controller manages the communications to
the drive with convenient tag-based addressing. Double-click on the “Controller Tags” icon under the
“Controller PowerFlex_Lab” folder.

The Monitor Tags window will appear.

17. Find the tag for “PF525_Drive1:I” and expand it by clicking on the [+] next to the name. It may help to
change the width of the “Name” and “Value” columns to view the tag names and values more easily.

Descriptive tag names have been created for the configured drive, based on the module definition. The Drive Status bits
(BOOLs) are clearly defined as well as the “OutputFreq” and “OutputCurrent” (defined as one of the Input Datalinks). Note
that the proper data types are automatically used for every tag.

Rockwell Automation | 2021 286


18. Now expand the “PF525_Drive1:O” tag to view the output tag names.

Descriptive tag names have been created for the drive again. The Logic Command bits (BOOLs) are clearly defined as well
as the “FreqCommand” value for applying a reference to the drive. The proper data types are automatically used for every
tag.

19. Close the Studio 5000 Logix Designer.

20. Click “No” when prompted to save changes to the project.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 287


Lab 12: Extended Data Types and 64 Bit Math Instructions <5 Minutes>

This section will introduce you to features that were introduced in versions 32 and 33 of Studio 5000® Logix Designer.
Goals:
 Highlight new extended data types introduced in version 32 of Studio 5000 Logix Designer. These data types are
o UNSIGNED SHORT INTEGER (USINT)
o UNSIGNED DOUBLE INTEGER (UDINT)
o UNSIGNED INTEGER (UINT)
o UNSIGNED LONG INTEGER (ULINT)
o LONG REAL NUMBER (LREAL)
Note that
o These data types are only supported in the 5580, 5480 and 5380 family of controllers.
o Version 32 have limited 64-bit instruction support  these new data types can only be used with compare,
compute and math instruction in version 32.
 Highlight additional 64-bit instruction support added in version 33; move, logical and advanced math. In both Ladder
and Function Blocks (FBD).
 The 64-bit math capabilities and extended data types enable more precise values in large calculations that no longer
require any user manipulation when dealing with extreme values. Large calculations, precision motion values, etc. are
now easier to define and calculate.
 Highlight the ability to calculate more precise values with higher resolution.
 Demonstrate increased flexibility to comply with open/third-party communications standards (e.g. HART)

Rockwell Automation | 2021 288


12.1 V33 Data Type Enhancements

In this sub section you will learn about new data types and instruction enhancements that were introduced in version 32 and
further developed with version 33.

1. Double-Click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 12 Extended Data Types 64 Bit Math and open the
project named ExtendedDataTypes_64BitMath.ACD.

Note: This may take up to a minute to open.

3. Once open, select COMMUNICATIONSWho Active, expand the AB_ETHIP-1 driver and select the
controller with IP address 192.168.1.20.
Depending on your lab setup, the controller could be either a physical ControlLogix 5580 controller,
or ControlLogix 5580 Emulator (FactoryTalk Logix Echo).

4. Select Download and acknowledge any other windows to start the download.

5. Put the controller into RUN mode by selecting Yes in the window.

Rockwell Automation | 2021 289


6. In the Controller Organizer Double-Click on Controller Tags.

7. Look at and compare the ranges between the NEW data types and the original data types. The ranges are
listed in the Tag descriptions as well as the supported controllers and version introduction.

Rockwell Automation | 2021 290


8. In the Controller Organizer expand the TasksMainTaskMainProgram and double-click on
Ladder_64BitMath to open the ladder routine. These simple rungs help illustrate how you can take
advantage of the new features to calculate more precise values with higher resolution.

9. In the Controller Organizer Double-Click on FunctionBlock_64BitMath to open the FBD routine. These
simple Function Blocks illustrate how you can take advantage of the new features to calculate more precise
values with higher resolution. Note all variables used are LREALs.

Notice the red arrow pointing to the Xf function and MUL instruction. Both blocks behave identically but the
new Xf (multiply) function occupies less physical space in the diagram and uses less controller memory.
This is another new feature introduced in V32 and enhanced in V33. There are several other similar
instructions like the Xf covering the most frequent mathematical operations. For full list of functions and
further details see subsection 1.2 Function Block Diagram (FBD) Enhancements of Lab 1.

Rockwell Automation | 2021 291


10. Go Offline with the controller by selecting COMMUNICATIONSGo Offline.

11. Close Studio 5000 Logix Designer. If prompted to save the file respond with No.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 292


Lab 13: Highly Integrated HART (HIH) <7 Minutes>

This section will introduce some of the features and functionality recently introduced in Studio 5000® Logix Designer related to
Highly Integrated HART (HIH).
New features:
 HIH is available in V32.02 and V33 of Studio 5000 Logix Designer.
 HIH enables a smoother workflow using fewer software tools.
 Ability to add a specific HART device directly to a channel of your 5094 HART module.
 Allows users to directly browse to HART devices in the I/O tree.
 Ability to directly get a HART device connection fault from I/O tree feedback.
 Currently only available when using the 5094 I/O platform.

13.1 Highly Integrated HART

In this section you will be introduced to enhancements that improve the use of HART devices.

1. Double-Click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 13 Highly Integrated HART and open the project
named HighlyIntegrated_HART.ACD.

Note: This may take up to a minute to open.

Rockwell Automation | 2021 293


3. In Controller Organizer expand the I/O Configuration items and notice that there are now specific HART
devices from various manufactures listed directly under the 5094-IF8IH and 5094-OF8IH modules.

4. Right Click on the HART network under the 5094-IF8IH and select New Module….

Rockwell Automation | 2021 294


5. The Select Module Type dialog will appear. Notice the extensive list of HART devices available. The devices
shown come built into Studio 5000 Logix Designer. You can have one HART device per channel on the
5094 HART module. If you have a specific HART device that does not come pre-installed in Studio 5000
you can import the devices EDD file into Studio 5000. An EDD file is very similar to a Rockwell EDS file.

6. Close the Select Module Type dialog.

7. Double Click on the Controller Tags.

Rockwell Automation | 2021 295


8. Expand the tag Honeywell_TWC9000:I. This is a device tag specific to that particular Honeywell HART
device. Observe how much easier your programming would be when using tags with names specific to the
actual functionality.

9. Right Click on the Rosemount_3095C device in the I/O tree and select Properties.

Rockwell Automation | 2021 296


10. On the Module Properties Dialog Select Change… in the Module Definition area.

11. On the Module Definition dialog Select Commands section.

12. Scroll through the Available Commands. These are optional data points that can be configured in Studio
5000 that are specific to the exact HART device chosen. When these are added to the device’s
configuration they will automatically be returned by the HART device and placed in additionally created Input
tags with matching nomenclature. Use of these commands can greatly simplify your programming.

Rockwell Automation | 2021 297


13. Close the Module Definition dialog.

14. Close Studio 5000 Logix Designer. If prompted to save the file respond with No.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 298


Lab 14: Automatic Diagnostics <10 Minutes>

This section will introduce some of the features and functionality recently introduced in Studio 5000® Logix Designer V33 related
to Automatic Hardware Diagnostics. To take advantage of all features you also need Factory Talk View SE V12.
Details:
 Automatically create device diagnostic information between your Logix Designer program and your Factory Talk View
SE project.
 Access of display and diagnostic information without additional programming that can automatically be displayed on
your HMI.
 Diagnostic information automatically created for all devices in the I/O tree.
 Factory Talk View SE will automatically be populated with device diagnostics events.
 Available in the 5580, 5540 and 5530 family of controllers.
 Supported by 1756, 5094, 1794 I/O platforms along with E300 overloads.

14.1 Hardware Diagnostics Workflow Enhancements


In this section you will be introduced to enhancements that improve workflow related to hardware diagnostics and HMI reporting.

1. Double-Click on the Lab Files folder on the desktop.

2. Navigate to C:\Lab Files\_2_Advanced Logix\Lab 14 Automatic Diagnostics and open the video file
named Automatic Diagnostics Demo.mp4.

3. Close the Automatic Diagnostics Demo.mp4 video.

Congratulations!
You have just finished this Lab
Click to Proceed to Contents

Rockwell Automation | 2021 299


Unguided Exercises

This section is not a “Lab” in that the exercises are not step-by-step. For most exercises, a Knowledgebase/Answer ID is
provided to act as the guide. Solution files and/or screenshots are included if needed.

Clock Sync Service


Use the installed Studio 5000 Clock Sync Config Tool to set the controller time to the PC time using CIP Sync/PTP time
synchronization. Refer to section Studio 5000 Clock Sync Service Configuration
in Studio5000 Clock Sync Service Config. Guide_KB641235_3-11-15.doc located
in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\ClockSyncService\References.
Solution screenshots and a final file are available
in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\ClockSyncService\Solution.

Convert Project to Previous Revision


Use the ConvertMe.ACD file located in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\ConvertToPreviousVersion
and convert the project from version 33 to version 32.
See the References folder for a copy of QA1568.mhtml for guidance.

Data Preserve Download


Download to controller project v33_01_NewDownloadOptions.ACD located
in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\DataPreserveDownload and attempt one or more of the noted
workflows from QA45741.mhtml
(located in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\DataPreserveDownload\References).
Attempt any of the noted workflows to learn more about the Data Preserve Download feature.

Rockwell Automation | 2021 300


Socket Communication

Important! This exercise cannot be completed when working with emulated controller (FactoryTalk Logix
Echo), because the emulator does not support Socket Object (yet).

Open the application L85E_Socket_Server.ACD provided


in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\SocketComms. Download the project and then configure the EWEB
Multi Sockets Test application to communicate to the controller. See the application configuration below:

The application file and web application were adapted from QA1492 – 1756-EWEB Open Sockets Server Application sample
(local copy can be found in C:\Lab Files\_2_Advanced Logix\UnguidedExercises\SocketComms\References as
QA1492.mhtml). Once downloaded, toggle Next_Write[0] on Rung 5 (MainTask->MainProgram->RW_Messages)and note
the behavior in the EWEB Sockets Test Application window.
This exercise was primarily for awareness of ethernet socket communication capability of Logix controllers. Ethernet sockets
have many different uses and there are several examples (QA6396 – Example Add On Instructions for Sockets,
QA1185 – Sample Application for Ethernet module Sockets Feature) that can be customized to suit your application needs.

Click to Proceed to Contents

Rockwell Automation | 2021 301


Notes

Rockwell Automation | 2021 302


Rockwell Automation is a trademark of Rockwell Automation, Inc. Trademarks not belonging to Rockwell Automation are property of their respective companies.

Studio 5000 Logix Designer: Advanced Lab Manual — July 2021


Copyright© 2021 Rockwell Automation, Inc. All rights reserved. Printed in USA.

Rockwell Automation | 2021 303

You might also like