Rockwell Automation Allen-Bradley Logix 5000 Series Owner's manual

Programming Manual
Logix 5000 Controllers Program Parameters
1756 ControlLogix, 1756 GuardLogix, 1769 CompactLogix, 1769 Compact GuardLogix,
1789 SoftLogix, 5069 CompactLogix, 5069 Compact GuardLogix, Studio 5000 Logix Emulate

Important user information
Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this equipment
before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and wiring instructions
in addition to requirements of all applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by
suitably trained personnel in accordance with applicable code of practice. If this equipment is used in a manner not specified by the manufacturer,
the protection provided by the equipment may be impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to
personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic
loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence
Important: Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be
present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc
Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work
practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.

Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 3
Summary of changes
This manual includes new and updated information. Use these reference tables to
locate changed information.
Grammatical and editorial style changes are not included in this summary.
Global changes
This table identifies changes that apply to all information about a subject in the
manual and the reason for the change. For example, the addition of new supported
hardware, a software design change, or additional reference material would result
in changes to all of the topics that deal with that subject.
Subject Reason
Updated screen shots throughout. The Studio 5000 Logix Designer® interface has been modified in
versions 31 and later.
New or enhanced features
This table contains a list of topics changed in this version, the reason for the
change, and a link to the topic that contains the changed information.
Topic Name Reason
Cover Added 5069 CompactGuardLogix to the list of supported controllers.

Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 5
Table of contents
Studio 5000 environment....................................................................................................7
Additional resources.............................................................................................................8
Important terminology ........................................................................................................8
Legal notices ...........................................................................................................................9
Chapter 1
Introduction........................................................................................................................ 13
Program parameters........................................................................................................... 13
Program parameter connection methods.............................................................. 14
Program parameter connection syntax .................................................................. 17
User-defined type sub-element connection considerations............................... 18
Input parameters ................................................................................................................ 18
Input parameter connection types and uses.......................................................... 18
General rules for using Input parameters .............................................................. 18
Connect an Input parameter to a controller scope tag....................................... 19
Output parameters............................................................................................................. 21
Output parameter connection types and uses ...................................................... 22
General rules for using Output parameters........................................................... 22
Connect an Output parameter to a controller scope tag.................................... 23
Connect an Output parameter to another program........................................... 24
InOut parameters............................................................................................................... 26
InOut parameter connection types and uses ........................................................ 26
General rules for using InOut parameters............................................................. 27
Connect an InOut parameter to a controller scope tag...................................... 27
Public parameters............................................................................................................... 29
Public parameter connection types and uses......................................................... 29
General rules for using Public parameters............................................................. 29
Connect a Public parameter to another program................................................ 30
Safety program parameters............................................................................................... 32
General rules for connecting parameters for safety programs ........................... 32
Program parameter connection rules ............................................................................. 33
Standard program to standard program connection rules ................................. 33
Safety program to safety program connection rules ............................................ 34
Safety program to standard program connection rules....................................... 35
Preface
Connecting program
parameters

Table of contents
6Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
Chapter 2
Introduction........................................................................................................................ 37
Direct access ........................................................................................................................ 37
Behavior of direct access in logic ............................................................................. 37
Access program parameters when editing ladder logic........................................ 38
Directly accessing program
parameters
Index

Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 7
Preface
This manual shows how to create and configure program parameters. This manual
is one of a set of related manuals that show common procedures for programming
and operating Logix 5000™ controllers.
For a complete list of common procedures manuals, refer to the Logix 5000
Controllers Common Procedures Programming Manual, publication 1756-
PM001.
The term Logix 5000 controller refers to any controller that is based on the Logix
5000 operating system.
The Studio 5000 Automation Engineering & Design Environment® combines
engineering and design elements into a common environment. The first element is
the Studio 5000 Logix Designer® application. The Logix Designer application is
the rebranding of RSLogix 5000® software and will continue to be the product to
program Logix 5000™ controllers for discrete, process, batch, motion, safety, and
drive-based solutions.
The Studio 5000® environment is the foundation for the future of
Rockwell Automation® engineering design tools and capabilities. The Studio 5000
environment is the one place for design engineers to develop all elements of their
control system.
Studio 5000 environment

Preface
8Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
These documents contain additional information concerning related Rockwell
Automation products.
Resource Description
Industrial Automation Wiring and Grounding Guidelines,
publication 1770-4.1
Provides general guidelines for installing a Rockwell
Automation industrial system.
Product Certifications webpage, available at
http://ab.rockwellautomation.com
Provides declarations of conformity, certificates, and other
certification details.
You can view or download publications at
http://www.rockwellautomation.com/literature. To order paper copies of
technical documentation, contact your local Rockwell Automation distributor or
sales representative.
This table defines the terms that are important to understanding the concepts
described in this manual.
Term Definition
Argument An argument is assigned to a parameter and contains the
specification of the data used by an instruction in a user
program. An argument can contain the following:
•A simple tag (for example, L101)
•A literal value (for example, 5)
•A tag structure reference (for example,
Recipe.Temperature)
•A direct array reference (for example, Buffer[1])
•An indirect array reference (for example, Buffer[Index+1])
•A combination (for example, Buffer[Index+1].Delay)
InOut parameter An InOut parameter is a special usage program parameter that
represents a reference to data that can be used both as input
and output during the execution of a program. Because InOut
parameters pass by reference rather than by value, 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.
Input parameter An Input parameter is a parameter that defines the data that is
passed by value into an executing program. Since Input
parameters are passed by value, their values cannot change
from external sources during the execution of the program. An
Input parameter supports a maximum of one sourcing
connection.
Additional resources
Important terminology

Preface
Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 9
Output parameter
An Output parameter is a parameter that
defines the data that is produced as a
direct result of executing a program. Since
Output parameters are always passed by
value, their values only change at the end
of the scan of a program when the copy of
the parameters has executed.
Tip: If using direct access another program can be a
source for an Output parameter.
Passed by reference When an argument is passed to a parameter by reference, the
logic directly reads or writes the value that the tag uses in
controller memory. External code or HMI interaction that
changes the argument’s value can change the value during
execution of a program.
Passed by value When an argument is passed to a parameter by value, the
value is copied in or out of the parameter during execution of a
program. The value of the argument does not change from
external code or HMI interaction.
Public parameter A Public parameter is an encapsulated version of a controller
scope tag, and typically it is used for large data structures that
need to be shared among programs.
Copyright notice
Copyright © 2018 Rockwell Automation Technologies, Inc. All Rights Reserved.
Printed in USA.
This document and any accompanying Rockwell Software products are
copyrighted by Rockwell Automation Technologies, Inc. Any reproduction
and/or distribution without prior written consent from Rockwell Automation
Technologies, Inc. is strictly prohibited. Please refer to the license agreement for
details.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Other Licenses
The software included in this product contains copyrighted software that is
licensed under one or more open source licenses. Copies of those licenses are
included with the software. Corresponding Source code for open source packages
included in this product can be located at their respective web site(s).
Legal notices

Preface
10 Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
You may alternately obtain complete Corresponding Source code by contacting
Rockwell Automation via our Contact form on the Rockwell Automation
website: http://www.rockwellautomation.com/global/about-
us/contact/contact.page.
Please include "Open Source" as part of the request text.
The following open source software is used in this product:
Software Copyright License Name License Text
AngularJS Copyright 2010-2017 Google, Inc. MIT License AngularJS 1.5.9 License
Bootstrap Copyright 2011-2017 Twitter, Inc.
Copyright 2011-2017 The Bootstrap Authors
MIT License Bootstrap 3.3.7 License
jQuery Copyright 2005, 2014 JS Foundation and other contributors MIT License jQuery 2.1.1 License
OpenSans Copyright 2017 Google, Inc. Apache License, Version 2.0 OpenSans License
Trademark Notices
Allen-Bradley, ControlBus, ControlFLASH, Compact GuardLogix, Compact
I/O, ControlLogix, CompactLogix, DCM, DH+, Data Highway Plus,
DriveLogix, DPI, DriveTools, Explorer, FactoryTalk, FactoryTalk Administration
Console, FactoryTalk Alarms and Events, FactoryTalk Batch, FactoryTalk
Directory, FactoryTalk Security, FactoryTalk Services Platform, FactoryTalk
View, FactoryTalk View SE, FLEX Ex, FlexLogix, FLEX I/O, Guard I/O, High
Performance Drive, Integrated Architecture, Kinetix, Logix5000, Logix 5000,
Logix5550, MicroLogix, DeviceNet, EtherNet/IP, PLC-2, PLC-3, PLC-5,
PanelBuilder, PowerFlex, PhaseManager, POINT I/O, PowerFlex, Rockwell
Automation, RSBizWare, Rockwell Software, RSEmulate, Historian,
RSFieldbus, RSLinx, RSLogix, RSNetWorx for DeviceNet, RSNetWorx for
EtherNet/IP, RSMACC, RSView, RSView32, Rockwell Software Studio 5000
Automation Engineering & Design Environment, Studio 5000 View Designer,
SCANport, SLC, SoftLogix, SMC Flex, Studio 5000, Ultra 100, Ultra 200,
VersaView, WINtelligent, XM, SequenceManager are trademarks of Rockwell
Automation, Inc.
Any Rockwell Automation logo, software or hardware product not mentioned
herein is also a trademark, registered or otherwise, of Rockwell Automation, Inc.
Other Trademarks
CmFAS Assistant, CmDongle, CodeMeter, CodeMeter Control Center, and
WIBU are trademarks of WIBU-SYSTEMS AG in the United States and/or
other countries. Microsoft is a registered trademark of Microsoft Corporation in
the United States and/or other countries. ControlNet is a trademark of
ControlNet International. DeviceNet is a trademark of the Open DeviceNet
Vendors Association (ODVA). Ethernet/IP is a trademark of ControlNet
International under license by ODVA.

Preface
Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 11
All other trademarks are the property of their respective holders and are hereby
acknowledged.
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
Rockwell Automation maintains current product environmental information on
its website at http://www.rockwellautomation.com/rockwellautomation/about-
us/sustainability-ethics/product-environmental-compliance.page
Contact Rockwell Automation
Customer Support Telephone — 1.440.646.3434
Online Support — http://www.rockwellautomation.com/support/

Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 13
Chapter 1
Connecting program parameters
This chapter provides an overview of program parameters and then further defines
each type of program parameter. Explanations are provided on when to use each
type of program parameter and the general rules to follow, and example procedures
are provided for connecting each type of program parameter.
A program parameter is an argument that is exposed for external access by a
program. Unlike local tags, all program parameters are publicly accessible outside
of the program. Additionally, HMI external access can be specified for each
parameter. Data sharing between programs can be achieved either through pre-
defined connections between parameters or directly accessed through a special
notation.
There are four types of program parameters.
•Input
•Output
•InOut
•Public
Among other benefits, program parameters allow you to clearly define the inputs
to the routines in a program, and the outputs from those routines. Input and
Output parameters also automatically buffer data, so that you do not need to
create separate tags to buffer IO data (although if desired, you can still buffer data
using the Synchronous Copy File [CPS] instruction).
Introduction
Program parameters

Chapter 1
Connecting program parameters
14 Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
You can use any of the following methods to connect program parameters in the
Logix Designer application.
•Connections column on the Program Parameters and Local Tags dialog
box
Tip: To show the Connections column click View > Toggle Columns >
Connections.
Program parameter connection
methods

Connecting program parameters
Chapter 1
Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 15
•Ellipses button (...) in the Connections cell on the Program Parameters
and Local Tags dialog box

Chapter 1
Connecting program parameters
16 Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
•Properties pane on the Program Parameters and Local Tags dialog box
•Parameters tab on the Program Properties dialog box

Connecting program parameters
Chapter 1
Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 17
•New Parameter or Tag dialog box
The syntax {x:y} is used to connect program parameters where:
x = the number of full connections, meaning connections at the word or
user-defined type level
y = the number of partial connections, meaning connections at the bit or
member level
Program parameter connection
syntax

Chapter 1
Connecting program parameters
18 Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
User-defined types (UDTs) used as parameters can contain member-specific
connections. To ensure proper data flow, the base Usage can only be specified at
the base of the UDT, and not at the member level, as the following example
shows.
An Input parameter is a parameter that defines the data that is passed by value
into an executing program. Since Input parameters are passed by value, their
values cannot change from external sources during the execution of the program.
An Input parameter supports a maximum of one sourcing connection.
Input parameters can be connected to Output parameters, Public parameters,
InOut parameters, and controller scope tags. 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.
The following are general rules when using Input parameters.
•Input parameters (including members) can only support one sourcing
connection. This means that only one source can be delivering the value to
the input parameter.
•Input parameter values are refreshed before each scan of a program. The
values do not change during the logic execution, so you do not need to write
code to buffer inputs.
•A program can write to its own Input parameters.
•Data values for Output parameters that are connected to controller scope
tags or Public parameters are copied after the scan of a program. In a project
with multiple tasks, the data copy for a parameter that is of type BOOL,
SINT, INT, DINT, LINT, or REAL will not be interrupted. The data copy
from an Output parameter to a controller scope tag or Public parameter or
any other predefined or user-defined data type may be interrupted by a task
switch.
For more information on the Input parameter connections that can be made, see
Program parameter connection rules on page 33.
User-defined type sub-element
connection considerations
Input parameters
Input parameter connection
types and uses
General rules for using Input
parameters

Connecting program parameters
Chapter 1
Rockwell Automation Publication 1756-PM021C-EN-P - February 2018 19
A parameter can be connected to another parameter or controller scope tag. As an
example, connecting an Input parameter to an Output parameter ensures that
data is copied to the Input parameter from the Output parameter on every scan.
The following procedure explains how to connect an Input parameter to a
controller scope tag.
Tip: This procedure demonstrates the use of the Properties pane on the Program
Parameters and Local Tags dialog box. You can alternatively connect
parameters using any of the other methods shown in Program parameter
connection methods on page 14.
1. In the Controller Organizer, expand the folder for the program for which
you are connecting an Input parameter, and double-click Parameters and
Local Tags.
2. On the Program Parameters and Local Tags dialog box, choose the Input
parameter that you want to connect.
Connect an Input parameter to
a controller scope tag

Chapter 1
Connecting program parameters
20 Rockwell Automation Publication 1756-PM021C-EN-P - February 2018
3. On the right, in the Properties pane, expand Parameter Connections.
4. Click New Connection.
5. Click the Browse (...) button.
6. In the Tag box, choose the drop-down arrow.