1756 Programming
1756 Programming
1756 Programming
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.
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.
Summary of changes
This manual contains new and updated information. The following table contains
the changes made to this revision.
Change Topic
Updated supported controller models Cover
Chapter 1
Chapter 2
Alias tags....................................................................................................................... 47
Display alias information ................................................................................. 49
Assign an alias...................................................................................................... 49
Indirect addresses ....................................................................................................... 50
Expressions........................................................................................................... 51
Array subscript out of range ............................................................................ 52
Tag documentation ................................................................................................... 53
Project documentation ..................................................................................... 53
Chapter 3
Chapter 4
This manual shows how to access I/O and tag data in Logix5000 controllers. This
manual is one of a set of related manuals that show common procedures for
programming and operating Logix5000 controllers.
The term Logix5000 controller refers to any controller that is based on the
Logix5000 operating system.
Studio 5000 environment 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 Logix5000™ controllers for discrete, process, batch, motion, safety, and
drive-based solutions.
Additional resources These documents contain additional information concerning related Rockwell
Automation products.
Resource Description
Logix5000 Controllers Program Parameters Programming Describes how to use program parameters when
Manual, publication 1756-PM021 programming Logix5000 controllers.
Product Certifications website Provides declarations of conformity, certificates, and other
(http://ab.rockwellautomation.com) certification details.
Introduction To communicate with an I/O module in your system, you add the module to the
I/O Configuration folder in the Controller Organizer.
When you add the module, you also define a specific configuration for the module.
While the configuration options vary from module to module, these are some
common options that you typically configure:
Requested packet interval The RPI specifies the period at which data updates over a connection. For example, an input module sends data to a controller at the RPI that you
(RPI) assign to the module.
• Typically, you configure an RPI in milliseconds (ms). The range is 1 ms (1000 microseconds)… 536870.911 ms.
• If a ControlNet network connects the devices, the RPI reserves a slot in the stream of data flowing across the ControlNet network. The timing of
this slot may not coincide with the exact value of the RPI, but the control system guarantees that the data transfers at least as often as the RPI.
In Logix5000 controllers, I/O values update at a period that you configure in the
I/O configuration folder of the project. The values update asynchronous to the
execution of logic. At the specified interval, the controller updates a value
independently from the execution of logic.
ATTENTION: Make sure that data memory contains the appropriate values throughout a task’s execution. You
can duplicate or buffer data at the beginning of the scan to provide reference values for your logic.
• Programs within a task access input and output data directly from
controller-scoped memory.
• Logic within any task can change controller-scoped data.
• Data and I/O values are asynchronous and can change during the course of
a task’s execution.
• An input value referenced at the beginning of a task’s execution can be
different when referenced later.
• To prevent an input value from changing during a scan, copy the value to
another tag and use the data from there (buffer the values).
Tip: Starting with Logix Designer version 24, you can use program parameters to share data between
programs in much the same way as you have used controller-scoped tags. Input and Output program
parameters automatically buffer data, without using another program parameter or tag. For more
information on program parameters, refer to the Logix5000 Controllers Program Parameters
Programming Manual, publication 1756-PM021.
Communication format The communication format that you choose determines the data structure for the
tags that are associated with the module. Many I/O modules support different
formats. Each format uses a different data structure. The communication format
that you choose also determines:
Term Definition
Direct connection A direct connection is a real-time, data transfer link between the controller and an I/O module. The controller
maintains and monitors the connection with the I/O module. Any break in the connection, such as a module fault or
the removal of a module while under power, sets fault bits in the data area associated with the module.
A direct connection is any connection that does not use the Rack Optimization Comm Format.
Rack-optimized connection For digital I/O modules, you can select rack-optimized communication. A rack-optimized connection consolidates
connection usage between the controller and all the digital I/O modules in the chassis (or DIN rail). Rather than having
individual, direct connections for each I/O module, there is one connection for the entire chassis (or DIN rail).
Ownership
In a Logix5000 system, modules multicast data. This means that multiple devices
can receive the same data at the same time from a single device.
Term Definition
Owner controller The controller that creates the primary configuration and communication connection to a module. The owner
controller writes configuration data and can establish a connection to the module.
An owner connection is any connection that does not include Listen-Only in its Comm Format.
Listen-only connection An I/O connection where another controller owns/provides the configuration data for the I/O module. A controller
using a listen-only connection only monitors the module. It does not write configuration data and can only maintain a
connection to the I/O module when the owner controller is actively controlling the I/O module.
Use the following table to choose the type of ownership for a module.
If module is And another controller And you want to Then use this type of connection
Input module Does not own the module ------------------------------------> Owner (not listen-only)
Owns the module Maintain communication with the module if it loses Owner (not listen-only)
communication with the other controller
Use the same configuration as the other owner
controller.
Stop communication with the module if it loses Listen-only
communication with the other controller
Output module Does not own the module ------------------------------------> Owner (such as, not listen-only)
If module is And another controller And you want to Then use this type of connection
Owns the module ------------------------------------> Listen-only
Electronic Keying Electronic Keying is a feature that reduces the possibility that you use the wrong
device in a control system. When the wrong device is used, unexpected system
behavior can occur.
For each device in the project, the user-selected keying option determines if and
how an Electronic Keying check is performed. Three options are available:
• Compatible Module
• Disable Keying
• Exact Match
Carefully consider the benefits and implications of each keying option when
selecting between them. For some device types, fewer options are available.
Important: Changing Electronic Keying parameters online interrupts connections to the device and any devices that are
connected through the device. Connections from other controllers can also be broken.
If an I/O connection to a device is interrupted, the result can be a loss of data.
Attribute Description
Vendor The device manufacturer, for example, Rockwell Automation/Allen-Bradley.
Product Type The general type of the device, for example, communication adapter, AC drive, or digital I/O
module.
Product Code The specific type of device. The Product Code maps to a catalog number.
The Product Code differentiates the product from other products of the same Device Type under
the indicated Vendor.
Major Revision A number that represents the functional capabilities of a device. Typically, a Major Revision is
backwards compatible with a lower Major Revision.
Minor Revision A number that represents behavior changes in the device, for example, anomaly corrections. This
number does not represent the functional capabilities of a device.
Exact Match
Exact Match indicates that all keying attributes of the device that is defined in the
project must match the attributes of the installed device to establish
communication.
If any attribute does not match precisely, communication with the device does not
occur.
Compatible Module
Compatible Module indicates that the device determines whether to accept or
reject communication.
Compatible Module lets the installed device accept the key of the device that is
defined in the project when the installed device can emulate the defined device.
The exact level of emulation that is required is product and revision specific
With Compatible Module, you can typically replace a device of a certain Major
Revision with another device that has the following characteristics:
Disable Keying
Disable Keying indicates the keying attributes are not considered when attempting
to communicate with a device. Other attributes, such as data size and format, are
considered and must be acceptable before I/O communication is established.
With Disable Keying, communication can occur with a device other than the type
specified in the project with unpredictable results. Unpredictable results can
include unwanted and unexpected system behavior.
Be extremely cautious when using Disable Keying; if used incorrectly, this option can lead to personal injury or
death, property damage, or economic loss.
We strongly recommend that you do not use Disable Keying.
If you use Disable Keying, you must take full responsibility for understanding whether the device being used can
fulfill the functional requirements of the application.
More information
For more detailed information on Electronic Keying, see Electronic Keying in
Logix5000 Control Systems Application Technique, publication LOGIX-AT001.
• Each tag uses a structure of data. The structure depends on the specific
features of the I/O module.
• The name of the tag is based on the location of the I/O module in the
system.
• When you add a module to the I/O Configuration folder, the software
automatically creates controller-scoped tags for the module in Controller
Tags.
Where Is
Location Network location
LOCAL = same chassis or DIN rail as the controller
ADAPTER_NAME = identifies remote communication adapter or bridge module
Slot Slot number of I/O module in its chassis or DIN rail
Type Type of data
I = input
O = output
C = configuration
S = status
Member Specific data from the I/O module; depends on what type of data the module can store.
• For a digital module, a Data member usually stores the input or output bit values.
• For an analog module, a Channel member (CH#) usually stores the data for a channel.
Where Is
SubMember Specific data related to a Member.
Bit Specific point on a digital I/O module; depends on the size of the I/O module (0–31 for a
32-point module)
Buffer I/O Buffering is a technique in which logic does not directly reference or manipulate
the tags of real I/O devices. Instead, the logic uses a copy of the I/O data. Buffer
I/O in the following situations:
1. On the rung before the logic for the function, copy or move the data from
the required input tags to their corresponding buffer tags.
3. On the rung after the function, copy the data from the buffer tags to the
corresponding output tags.
The following example copies inputs and outputs to the tags of a structure for a
drill machine.
The main routine of the program executes the following subroutines in this sequence.
The map_inputs routine copies the values of input devices to their corresponding tags that are used in the drill routine.
The drill routine executes the logic for the drill machine.
The map_outputs routine copies the values of output tags in the drill routine to their corresponding output devices.
The following example uses the CPS instruction to copy an array of data that
represent the input devices of a DeviceNet network.
Local:0:I.Data stores the input data for the DeviceNet network that is connected to the 1756-DNB module in slot 0. To synchronize the inputs with the application,
the CPS instruction copies the input data to input_buffer.
− While the CPS instruction copies the data, no I/O updates can change the data.
As the application executes, it uses the input data in input_buffer for its inputs.
Organize tags
Introduction With a Logix5000 controller, you use a tag (alphanumeric name) to address data
(variables).
Term Definition
Tag A text-based name for an area of the controller’s memory where data is stored.
• Tags are the basic mechanism for allocating memory, referencing data from logic, and monitoring
data.
• The minimum memory allocation for a tag is four bytes.
• When you create a tag that stores data that requires less than four bytes, the controller allocates
four bytes, but the data only fills the part it needs.
The controller uses the tag name internally and does not need to cross-reference a
physical address.
Example: Tags
Item Description
Analog I/O Device
Integer Value
Storage Bit
Counter
Timer
Tag type The tag type defines how the tag operates within your project.
If you plan to use produced or consumed tags, you must follow additional
guidelines as you organize your tags.
Data type
Term Definition
Data type The data type defines the type of data that a tag stores, such as a bit, integer, floating-point value,
string, and so forth.
Structure A data type that is a combination of other data types.
• A structure is formatted to create a unique data type that matches a specific need.
• Within a structure, each individual data type is called a member.
• Like tags, members have a name and data type.
• A Logix5000 controller contains a set of predefined structures (data types) for use with specific
instructions such as timers, counters, Function Blocks, and so forth.
• You can create your own structures, called a user-defined data type
The following table outlines the most common data types and when to use each.
For Select
Analog device in floating-point mode REAL
Analog device in integer mode (for very fast sample rates) INT
ASCII characters String
Bit BOOL
Counter COUNTER
Digital I/O point BOOL
Floating-point number REAL
Integer (whole number) DINT
Sequencer CONTROL
Timer TIMER
• Min
• Max
• Engineering Units
• State0
• State1
When these properties are added, their values are made available for use by some
Rockwell Automation HMIs.
Extended properties for a tag are added and modified in the Tag Properties pane.
The minimum memory allocation for a tag is four bytes. When you create a tag
that stores data that requires less than four bytes, the controller allocates four
bytes, but the data only fills the part it needs.
0
-1.17549435E-38-…3.40282347E38 (positive values)
The COUNTER and TIMER data types are examples of commonly used
structures.
Item Description
To expand a structure and display its members, click the + sign.
Members of running_seconds.
COUNTER Structure.
TIMER Structure.
Tag scope When you create a tag, you define it as either a controller tag (global data) or a
local tag for a specific program (local data).
A Logix5000 controller lets you divide your application into multiple programs,
each with its own data. There is no need to manage conflicting local tag names
between programs. This makes it easier to reuse both code and tag names in
multiple programs.
• Routines cannot access data that is at the local scope (local tag) of
another program.
• You can reuse the tag name of a local tag in multiple programs.
• For example, both Program_A and Program_B can have a local tag
named Tag_4.
• You can also use program parameters to share data between programs as
an alternative to controller-scope tags. See Program parameter scope on
page 27.
Avoid using the same name for both a controller tag and a local tag. Within a
program, you cannot reference a controller tag if a local tag of the same name exists
for that program.
• You create program parameters at the program level, and use them to
manage data.
• Program parameters behave like controller-scope tags in that they can pass
data between programs.
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 have to
create separate tags to buffer IO data.
If you want to restrict data to only the local program scope, you can use local tags.
See Tag scope on page 25.
Guidelines for tags Use the following guidelines to create tags for a Logix5000 project.
Guideline Details
Create user-defined data types User-defined data types (structures) let you organize data to match your machine or process. A user-defined data
type provides these advantages:
• One tag contains all the data related to a specific aspect of your system. This keeps related data together and easy
to locate, regardless of its data type.
• Each individual piece of data (member) gets a descriptive name. This automatically creates an initial level of
documentation for your logic.
• You can use the data type to create multiple tags with the same data layout.
For example, use a user-defined data type to store all the parameters for a tank, including temperatures, pressures,
valve positions, and preset values. Then create a tag for each of your tanks based on that data type.
Guideline Details
Use arrays to quickly create a group An array creates multiple instances of a data type under a common tag name.
of similar tags • Arrays let you organize a block of tags that use the same data type and perform a similar function.
• You organize the data in one, two, or three dimensions to match what the data represents.
For example, use a two-dimensional array to organize the data for a tank farm. Each element of the array represents
a single tank. The location of the element within the array represents the geographic location of the tank.
Important: Minimize the use of BOOL arrays. Many array instructions do not operate on BOOL arrays. This makes it
more difficult to initialize and clear an array of BOOL data.
• Typically, use a BOOL array for the bit-level objects of a PanelView screen.
• Otherwise, use the individual bits of a DINT tag or an array of DINTs.
Take advantage of program-scoped tags If you want multiple tags with the same name, define each tag at the program scope (local tags) for a different
program. This lets you reuse both logic and tag names in multiple programs.
Avoid using the same name for both a controller tag and a local tag. Within a program, you cannot reference a
controller tag if a tag of the same name exists as a local tag for that program.
Certain tags must be controller scope (controller tag).
If you want the tag Then assign this scope
In more than one program in the project Controller scope (controller tags)
In a Message (MSG) instruction
To produce or consume data
In any of the seven AXIS data types
To communicate with a PanelView terminal
None of the above Program scope (local tags)
For integers, use the DINT data type To increase the efficiency of your logic, minimize the use of SINT or INT data types. Whenever possible, use the DINT
data type for integers.
• A Logix5000 controller typically compares or manipulates values as 32-bit values (DINTs or REALs).
• The controller typically converts a SINT or INT value to a DINT or REAL value before it uses the value.
• If the destination is a SINT or INT tag, the controller typically converts the value back to a SINT or INT value.
• The conversion to or from SINTs or INTs occurs automatically with no extra programming. But it takes extra
execution time and memory.
Use most restrictive external access External access limits the exposure of controller tags by defining a user’s ability to edit tags to Read/Write, Read Only
and None. This helps:
• Reduce the risk of inadvertently changing tags.
• Reduce the number of tags to browse when configuring HMI.
See External access on page 63.
Enable constant attribute for tags that should not be You can assign a constant value to a tag to prevent the table-backed data from being changed programmatically.
changed by logic This helps reduce the risk of inadvertently changing tags.
See Constant value tags on page 76.
Limit a tag name to 40 characters Here are the rules for a tag name:
• Only alphabetic characters (A–Z or a–z), numeric characters (0–9),
and underscores (_)
• Must start with an alphabetic character or an underscore
• No more than 40 characters
• No consecutive or trailing underscore characters (_)
• Not case sensitive
Use mixed case Although tags are not case sensitive (upper case A is the same as lower case a), mixed case is easier to read.
Guideline Details
These tags are easier to read Than these tags
Tank_1 TANK_1
Tank1 TANK1
tank_1
tank1
Consider the alphabetical order of tags Logix Designer application displays tags of the same scope in alphabetical order. To make it easier to monitor related
tags, use similar starting characters for tags that you want to keep together.
Starting each tag for a tank with ‘Tank’ keeps the tags Otherwise, the tags may end up separated
together. from each other.
Using extended properties in logic You can access limit extended properties defined on tags using the .@Min and .@Max syntax. However, you cannot
write to extended properties values in logic.
For example, in the Ladder Editor, you can use limit extended properties on an instruction’s source operand.
Guideline Details
Using extended properties in logic (continued) In the Function Block Editor, you can access extended properties in logic by wiring an Input Reference to a block’s
input pins.
In the Structured Text Editor, you can access limit extended properties in logic on the right hand side of an
assignment operation or in a comparison statement. You can also access limit extended properties in logic when you
embed structured text in the Sequential Function Chart Editor.
You need to know which tags have limit extended properties associated with them as there is no indication in the
Tag Browser that extended properties are defined for a tag. However, if you try to use extended properties that have
not been defined for a tag, the editors show a visual indication (that is: a rung error in Ladder Logic, a verification
error X in Function Block Diagrams, and the error underlined in Structured Text) and the routine does not verify.
• The following restrictions apply when you use extended properties in logic.
− You must use extended properties as an input operand.
You can use extended properties on an instruction as long as the input (source) operand is a non-boolean
atomic data type. That is, if an instruction has operands whose data type is non-atomic or BOOL, limit
extended properties cannot be used. For example, the ALMD instruction in Ladder Logic does not support
extended properties because its configurable operands are of type BOOL.
In the Ladder Editor, when limit extended properties is used in logic, the value field associated with the source
operand is unavailable. You can change the tag's extended properties only in the Tag Editor Properties Pane.
Guideline Details
Using extended properties in logic (continued) • Array Tags are constrained
A constraint on array tags applies if the array tag uses indirect addressing to access limit extended properties. If
an array tag is using indirect addressing to access limit extended properties in logic, the following conditions
apply.
− If the Array Tag has limit extended properties configured, the extended properties are applied to any array
element that does not explicitly have that particular extended property configured. For example, if the
MyArray has Max configured to 100, then any element of the array that does not have Max configured inherits
the value of 100 when being used in logic. However, it is not visible to you that the value inherited from
MyArray is configured in the tag properties.
− At least one array element must have specific limit extended property configured for indirectly referenced
array logic to verify. For example, if MyArray[x].@Max is being used in logic, at least one array element of
MyArray[] must have Max extended property configured if Max is not configured by MyArray. If this is not
done, if you attempt to access Max in logic on MyArray in logic, the routine does not verify.
− Under the following circumstances the software uses a data type default value:
− Array is accessed programmatically with indirect reference.
− Array tag does not have the extended property configured.
− Member of array does not have the extended property configured. For example for Array of SINT type,
when max limit is called in logic for a member, the value 127 is used.
• Removing Extended Properties
You cannot remove extended properties that are accessed in logic when the project is online with the controller.
The Max and Min check boxes in the Extended Properties box in the Tag Properties pane are unavailable.
You have to go offline to remove the extended properties.
Removing extended properties in logic on structure tags is unavailable at the tag level. For example, if MyUDTTag
has 2 members, Mem1 being a DINT and the Mem2 being a SINT, if you define limit extended properties in Logic
on both members, but are only accessing Max extended properties on Mem1, the Max check box is unavailable in
Extended Properties for both members. You are not able to remove the Max extended properties for
MyUDTTag .Mem2 online.
The same applies for Array tags. If you define limit extended properties on an array element and that element is
accessed in logic, then you cannot remove the limit extended properties from any of the array elements.
Create a tag The Tag Editor lets you create and edit tags by using a spreadsheet-style view of
the tags.
Important: The Logix Designer application also automatically creates tags when you:
− Add an element to a sequential function chart (SFC).
− Add a function block instruction to a function block diagram.
Follow these steps to create a tag by using the Logix Designer application.
2. In the Tag Editor, from the Scope box, choose a scope for the tag using the
following table as a guide.
As a producer or consumer
In any of the seven AXIS data types
In a message
In only one program within the project Program that uses the tag
This also limits the tag display to only tags with the same scope.
You can also click the Browse button and then in the Select Data Type
dialog box, choose a data type for the tag.
6. (optional) Select the Constant check box if you want the tag to have a
constant value.
7. In the External Access list, choose the external access for the tag.
See Data access control on page 63 for information on the External Access
and Constant attributes.
The entries in the list depend on the tag’s data type. You can select more
than one property.
For data type You can add the following extended property
Array and string Engineering Unit
Bool State0
State1
Engineering Unit
DINT, INT, LINT, SINT, and REAL and corresponding Min
array member Max
Engineering Unit
The added properties are displayed in the Tag Editor Properties pane
under Data.
Clear the check box to remove the property from the tag. This also removes
the properties from the Data properties category. Note that once the
property is removed, any value associated to the property is removed from
the system.
The list is not available for other types of tags. The following table lists the
minimum and maximum values for DINT, INT, LINT, SINT, and REAL
Data Types
Create an array Logix5000 controllers also let you use arrays to organize data.
Term Definition
Array A tag that contains a block of multiple pieces of data.
The subscript identifies each individual element within the array. A subscript
starts at 0 and extends to the number of elements minus 1 (zero based).
Item Description
To expand a structure and display its members, click the + sign.
This one-dimensional array contains six elements of the DINT data type. In this example, a single timer
instruction times the duration of several steps. Each step requires a different preset value. Because all the
values are the same data type (DINTs), use an array.
This is a tag that uses the Timer structure (data type). This is a tag that uses an array of the Timer data type.
In the Tag Editor, the elements are in the order in the following graphic.
Item Description
The rightmost dimension increments to its maximum value then starts over.
When the rightmost dimension starts over, the dimension to the left increments by one.
This array contains a two-dimensional grid of elements, six elements by six elements.
Configure an array
To create an array, you create a tag and assign dimensions to the data type.
2. In the Tag Editor, from the Scope box, choose a scope for the tag using the
following table as a guide.
This also limits the tag display to only tags with the same scope.
4. In the Data Type box, enter the data type the array dimensions. In the
following table, Data_type represents the actual data type you enter.
You can also click the Browse button and then in the Select Data Type
dialog box, choose a data type and the array dimensions for the array.
User-defined data types (structures) let you organize your data to match your
User-defined data types
machine or process.
An array that is based on this data type looks like this example.
Item Description
Array of recipes
First recipe
Example: User-defined data type that stores the data that is required to run a machine.
Because several drill stations require the following mix of data, use a user-defined data type.
An array that is based on this data type would look like this example.
Item Description
Array of drills
First drill
• If you include members that represent I/O devices, you must use logic to
copy the data between the members in the structure and the corresponding
I/O tags. Refer to Address I/O data on page 18.
• If you include an array as a member, limit the array to a single dimension.
Multi-dimension arrays are not permitted in a user-defined data type.
• When you use the BOOL, SINT, or INT data types, place members that
use the same data type in sequence.
More Efficient Less Efficient
BOOL BOOL
BOOL DINT
BOOL BOOL
DINT DINT
DINT BOOL
2. In the Data Type Editor, in the Name box, type a name for the user-
defined data type.
5. In the member Name box, type a name for the data type member.
6. In the member Data Type box, enter the data type for the member.
You can also click the Browse button and then in the Select Data Type
dialog box, choose a data type for the tag.
Limit any arrays to a single dimension. See Configure an array on page 37.
7. (optional) In the member Description box, type a description for the data
type member.
Tip: You may have to click in the data type member again to display the properties for the member instead
of the properties for the data type.
1. In the Properties pane, click the box next to External Access, and
select an attribute.
2. To display the value of the member in a different style (radix), click the
box next to Style, and select the style.
9. Click Apply.
You can add and change these extended properties in the Data Type Editor
Properties pane.
• Click in the data type Name box to choose the data type.
• Click in the data type member Name box to choose the data type
member.
5. Select one or more properties that you want to add. The properties in the
list depend on the selected data type or member’s data type.
For data type You can add the following extended property
Array and string Engineering Unit
Bool State 0
State 1
Engineering Unit
DINT, INT, LINT, SINT, and REAL Min
Max
Engineering Units
Important: The list is unavailable for other types of data type members.
The following table shows the minimum and maximum values for DINT, INT,
LINT, SINT, and REAL Data Types.
In version 13 or later, the Logix Designer application lets you automatically build
Describe a user-defined descriptions out of the descriptions in your user-defined data types. This greatly
data type reduces the amount of time you have to spend documenting your project.
As you organize your user-defined data types, keep in mind the following features
of the Logix Designer application.
Item Description
Pass through of descriptions—When possible, the Logix Designer application looks for an available
description for a tag, element, or member.
− Descriptions in user-defined data types ripple through to the tags that use that data type.
− Description of an array tag ripples through to the elements and members of the array.
Append description to base tag—the Logix Designer application automatically builds a description for
each member of a tag that uses a user-defined data type. It starts with the description of the tag and then
adds the description of the member from the data type.
Paste pass-through description—Use the data type and array description as a basis for more specific
descriptions.
In this example, Tank became West Tank.
1. In the Controller Organizer, right-click the controller at the top and then
click Properties.
4. Click OK.
Follow these steps to use a pass-through description as the starting point for a
more specific description.
1. In the Controller Tags Editor, right-click the Description box, and then
click Paste Pass-Through.
Where Is
Name Name that identifies this specific tag.
Element Subscript or subscripts that point to a specific element within an array.
• Use the element identifier only if the tag or member is an array.
• Use one subscript for each dimension of the array. For example: [5], [2,8], [3,2,7].
To indirectly (dynamically) reference an element, use a tag or numeric expression that provides the element number.
• A numeric expression uses a combination of tags, constants, operators, and functions to calculate a value. For example, Tag_1-Tag_2,
Tag_3+4, ABS (Tag_4).
• Keep the value of the tag or numeric expression within the dimensions of the array. For example, if a dimension of an array contains 10
elements, then the value of the tag or numeric expression must be
0…9 (10 elements).
Member Specific member of a structure.
• Use the member identifier only if the tag is a structure.
• If the structure contains another structure as one of its members, use additional levels of the.Member format to identify the required
member.
Bit Specific bit of an integer data type (SINT, INT, or DINT).
Index To indirectly (dynamically) reference a bit of an integer, use a tag or numeric expression that provides the bit number.
• A numeric expression uses a combination of tags, constants, operators, and functions to calculate a value. For example, Tag_1-Tag_2,
Tag_3+4, ABS(Tag_4).
• Keep the value of the tag or numeric expression within the range of bits of the integer tag. For example, if the integer tag is a Dint (32-bits),
then the value of the index must be 0…31 (32-bits).
Alias tags An alias tag lets you create one tag that represents another tag.
Item Description
drill_1_depth_limit is an alias for Local:2:I.Data.3 (a digital input point). When the input turns on, the alias
tag also turns on.
drill_1_on is an alias for Local:0:O.Data.2 (a digital output point). When the alias tag turns on, the output
tag also turns on.
north_tank is an alias for tanks[0,1].
A common use of alias tags is to program logic before wiring diagrams are available.
1. For each I/O device, create a tag with a name that describes the device, such
as conveyor for the conveyor motor.
You can even test your logic without connecting to the I/O.
3. Later, when wiring diagrams are available, add the I/O modules to the I/O
configuration of the controller.
4. Finally, convert the descriptive tags to aliases for their respective I/O points
or channels.
The following logic was initially programmed by using descriptive tag names, such
as stop and conveyor_on. Later, the tags were converted to aliases for the
corresponding I/O devices.
2. In the Workstation Options dialog box, expand Ladder Editor and then
click Display.
4. Click OK.
Assign an alias
Follow these steps to assign a tag as an alias tag for another tag.
2. In the Tag Editor window, to the right of the tag name, click the Alias For
cell.
To Do This
Select a tag Double-click the tag name.
Select a bit number 1. Click the tag name.
2. To the right of the tag name, click +.
3. Click the required bit.
Indirect addresses If you want an instruction to access different elements in an array, use a tag in the
subscript of the array (an indirect address). By changing the value of the tag, you
change the element of the array that your logic references.
The following table outlines some common uses for an indirect address.
The following example loads a series of preset values into a timer, one value (array
element) at a time.
The timer_presets array stores a series of preset values for the timer in the next rung. The north_tank.step tag points to which element of the array to use. For
example, when north_tank.step equals 0, the instruction loads timer_presets[0] into the timer (60,000 ms).
When north_tank.step_time is done, the rung increments north_tank.step to the next number and that
element of the timer_presets array loads into the timer.
When north_tank.step exceeds the size of the array, the rung resets the tag to start at the first element in the
array. (The array contains elements 0–3.)
Expressions
You can also use an expression to specify the subscript of an array.
Example:
Tag documentation The table outlines the four types of tags that you can create and the descriptions
that you can document for each one.
Important: The Logix Designer application automatically assigns what are called pass-through descriptions of the tags
you create. You may or may not want to use these descriptions.
Tag Description
Base When you create a tag without specifying a tag type, the Logix Designer application automatically
assigns your tag a default type of Base. Since base tags enable you to create your own internal data
storage, you can document in your tag description the nature of the data being stored.
Alias By creating an alias tag, you can assign your own name to an existing tag, structure tag member, or
bit. In the description of your alias tag, you can describe the tag that your alias tag references.
Produced A produced tag refers to a tag that is consumed by another controller. In the description of your
produced tag, you can describe the remote controllers that you want to make your produced tag
available through controller-to-controller messaging.
Consumed A consumed tag refers to a tag that is produced by another controller and whose data you want to use
in your controller. In the description of your consumed tag, you can describe how you want to use a
produced tag’s data or the data-producing controller.
Project documentation
With version 17 and later of the Logix Designer application, you have the option
to display project documentation variables for any supported localized language,
such as:
You can store project documentation for multiple languages in a single project file
rather than in language-specific project files. You define all the localized languages
that the project supports and set the current, default, and optional custom
localized language. The application uses the default language if the current
language's content is blank for a particular component of the project. However,
you can use a custom language to tailor documentation to a specific type of project
file user.
Enter the localized descriptions in your Logix Designer project, either when
programming in that language or by using the import/export utility to translate
the documentation off-line and then import it back into the project. Once you
enable documentation languages in the Logix Designer application, you can
dynamically switch between languages as you use the application.
Force I/O
Introduction Use a force to override data that your logic either uses or produces. For example,
use forces to:
Use forces only as a temporary measure. They are not intended to be a permanent
part of your application.
ATTENTION: Forcing can cause unexpected machine motion that could injure personnel. Before you use a force,
determine how the force affects your machine or process and keep personnel away from the machine area.
− Enabling I/O forces causes input, output, produced, or consumed values to change.
− Enabling SFC forces causes your machine or process to go to a different state or phase.
− Removing forces may still leave forces in the enabled state.
− If forces are enabled and you install a force, the new force immediately takes effect.
Enable forces
You must enable forces for a force to take effect. You can only enable and disable
forces at the controller level.
• You can enable I/O forces and SFC forces separately or at the same time.
• You cannot enable or disable forces for a specific module, tag collection, or
tag element.
Important: If you download a project that has forces enabled, the application prompts you to enable or disable forces
after the download completes.
When forces are in effect (enabled), a appears next to the forced element.
• You can disable or remove I/O and SFC forces at the same time or
separately.
• Removing a force on an alias tag also removes the force on the base tag.
ATTENTION: Changes to forces can cause unexpected machine motion that could injure personnel. Before you
disable or remove forces, determine how the change affects your machine or process and keep personnel away
from the machine area.
Check force status Before you use a force, determine the status of forces for the controller. You can
check force status.
The Online toolbar shows the status of forces. It shows the status of I/O forces
and SFC forces separately.
This Means
Enabled • If the project contains any forces of this type, they are overriding your logic.
• If you add a force of this type, the new force immediately takes effect
Disabled Forces of this type are inactive. If the project contains any forces of this type, they
are not overriding your logic.
Installed At least one force of this type exists in the project.
None Installed No forces of this type exist in the project.
Important: The FORCE Status Indicator shows only the status of I/O forces. It does not s(how that status of SFC forces.
GSV instruction
Important: The ForceStatus attribute shows only the status of I/O forces. It does not show the status of SFC forces.
This ladder rung shows how to use a GSV instruction to get the status of forces.
• You can force all I/O data, except for configuration data.
• If the tag is an array or structure, such as an I/O tag, you can force a BOOL,
SINT, INT, DINT, or REAL element or member.
• If the data value is a SINT, INT, or DINT, you can force the entire value or
you can force individual bits within the value. Individual bits can have a
force status of:
• No force
• Force on
• Force off
• You can also force an alias to an I/O structure member, produced tag, or
consumed tag.
• An alias tag shares the same data value as its base tag, so forcing an alias
tag also forces the associated base tag.
• Removing a force from an alias tag removes the force from the
associated base tag.
• If a produced tag is also Constant, you cannot use forces.
• If a produced tag is forced, you cannot make it Constant.
Add an I/O force To override an input value, output value, produced tag, or consumed tag, use an
I/O force.
ATTENTION: Forcing can cause unexpected machine motion that could injure personnel. Before you use a force,
determine how the force affects your machine or process and keep personnel away from the machine area.
− Enabling I/O forces causes input, output, produced, or consumed values to change.
− If forces are enabled and you install a force, the new force immediately takes effect.
If Then note
Off No I/O forces currently exist.
Flashing No I/O forces are active. But at least one force already exists in your project. When you enable I/O
forces, all existing I/O forces also take effect.
Solid I/O forces are enabled (active). When you install (add) a force, it immediately takes effect.
2. Open the routine that contains the tag that you want to force.
If necessary, expand the tag to show the value that you want to force (that is,
BOOL value of a DINT tag).
To force a Do this
BOOL value Right-click tag and then click Force On or Force Off.
Non-BOOL value In the Force Mask column for the tag, type the value that you want to force the tag.
Press Enter.
5. Verify that I/O forces are enabled (see step 1). If they are not, on the Menu
bar, click Logic > I/O Forcing > Enable All I/O Forces, and then click
Yes to confirm.
1. Open the routine that contains the force that you want to remove.
If Then
SFC Go to step 4.
Ladder logic Go to step 4.
Function block Go to step 3.
Structured text Go to step 3.
3. Right-click a tag that has the force and then click Monitor.
If necessary, expand the tag to show the value that is forced, for example,
BOOL value of a DINT tag.
4. Right-click a tag or element that has the force and then click Remove
Force.
Introduction In version 18 or later of the Logix Designer application, there are two tag
attributes that allow you to control access to tag data. These attributes are:
• External Access
• Constant
The External Access attribute controls how external applications, such as HMIs,
can access tags. It has possible values of Read/Write, Read Only, and None. See
Configure external access on page 64.
The Constant attribute value determines if controller logic can change a tag. Also,
by using FactoryTalk Security software, it is possible to control which users can
change tags designated as constants in the Logix Designer application. See
Constant value tags on page 76 for more information on the Constant attribute.
By using these two attributes, you can help safeguard tag data by preventing
unwanted changes to tag values. Also, by reducing the number of tags exposed to
external applications, you can reduce the time required to develop
HMI screens.
External access You can control how external applications and devices can access tags by using the
External Access attribute.
Using external access reduces the number of tags for an application that appear
when you reference them in applications or devices. It can also improve system
performance by reducing the number of tags RSLinx has to maintain, scan, and
cache. Reducing the number of externally accessible tags can improve the
performance of the RSLinx data server and other related applications.
Configure external access You configure external access from a menu when you create a new tag or data type.
You can also change that value just like other tag attributes. You can make these
changes throughout the application. For example, you can make the changes in the
User-defined Data Type Editor, New Tag dialog box, and the Tag Properties
dialog box.
Important: • The Logix Designer application has full access to all tags, regardless of their external access settings.
External access applies to all program, controller, and Add-On Instruction scoped tags.
• If the controller is in safety locked mode, only the safety tags are disabled from being accessed. The
standard tags have the same behavior as in the unlocked mode.
• New Tag (See Configure external access in the New Tag dialog box on page
65)
• Tag Properties (See Set up external access in the Tag Properties dialog box
on page 67)
The default value in the External Access list depends on the usage and type of the
tag. The following table describes the values.
Important: For alias type tags, the External Access list is unavailable. You are not allowed to change the external
access of an alias tag. However, the External Access list updates its value to be the same as the external
access of the base target.
See Find a base tag with Go To on page 69 for procedures to locate the base tag for an alias.
See External access availability on page 70 for additional tag considerations.
• Base
• Alias
• Produced
• Consumed
The parameters on the dialog box depend on the type of tag you are creating. For
tag descriptions, see Tag type on page 22.
You choose the external access attribute for a new tag in the External Access list
on the New Tag dialog box. Follow these steps.
2. In the New Tag dialog box, in the Type list, choose a tag type.
4. Click OK.
As shown in the following example, the External Access list is unavailable for an
alias tag.
There may be many alias tags in a program. To locate an associated base tag to
assign an external access, use the Go To feature. See Find a base tag with Go To on
page 69 for details.
For other tag considerations, see External access availability on page 70.
The Connection button (next to the Type box) becomes active when you select
either a produced or consumed tag type. The button displays a dialog box to set up
produced and consumed tag connections. See the Logix5000 Controllers
Produced and Consumed Tags Programming Manual, publication 1756-PM011.
Follow these steps to choose an external access option for an existing tag.
1. In the Tag Editor, right-click a tag and then click Edit (tag name)
Properties.
2. In the Tag Properties dialog box, in the Type list, choose a tag type.
The External Access list is unavailable for an alias tag. If a tag is a module
tag, the only external access option is Read/Write.
See External access availability on page 70 for other considerations.
4. Click OK.
Follow these steps to select multiple rows and set the external access at one time on
the Tag Editor.
1. To select multiple individual rows, hold down the Ctrl key and click the
desired rows.
2. Right-click a selected tag, and then click Set External Access for (tag
name) to select an external access option.
This updates the external access for all highlighted rows that are enabled for
changing external access.
See External access availability on page 70 for considerations when the External
Access column is unavailable.
1. In the Tag Editor select the alias tag, and then on the Logix Designer
application Menu bar, click Search > Go To.
You can also right-click the alias tag and then click Go To.
The Go To box displays the target of the alias tag. If there is an alias chain,
all alias tags in this chain appear in the Go to list.
4. Click Go To.
External access availability The following table describes the conditions in which the External Access list is
unavailable.
Important: The External Access list is always unavailable for any tag whose data type is Alarm Analog or Alarm
Digital. The external access status is always Read/Write for these data types.
You select the external access options for a tag—Read/Write (default), Read
User-defined type Only, or None—from the Data Type Editor Properties pane.
considerations
1. In the Controller Organizer, right-click the data type and then click
Properties.
2. In the Data Type editor, click the Properties tab to display the Properties
pane. Click the pushpin icon to keep the Properties pane open.
Three external access rules apply for members of User-defined data types.
• You can only set external access for the top members of that User-defined
data type. External Access lists for the child-members are unavailable on
the User-defined Data Type Editor.
• If the member’s data type is Predefined structural, Module-defined, or
String, you cannot set external access of child-members. The external access
level of the parent member applies to its child-members.
The following table describes the conditions in which the External Access
column is unavailable.
To pick Considerations
Change existing The External Access column is unavailable if:
data type • You do not have permission to change the external access settings(2).
• The redundancy controller is in any state that does not allow changes.
• The data type is applied to tags and the controller is online.
Tip: Data type size is not affected by the external access attribute.
Predefined, module-defined, The External Access column is always visible but unavailable. The Set External Access
Strings type entry is added to the bottom of the row header context menu, but it is always unavailable.
(2) If you have User-defined Data Type Modify permission, you also can modify external access of a User-defined data type.
Add-on instructions You can use external access settings with parameters and local tags of Add-On
Instructions. For example, if you define an input parameter with external access of
external access read only, the member that represents that parameter in the Add-On Instruction
considerations data type cannot be written.
The following table describes the external access options for various Add-On
Instruction parameters and tags.
EnableOut parameter
InOut parameter Not Applicable
You can choose the external access for an Add-On Instruction tag from the list on
the New Add-On Instruction Parameter or Local Tag dialog box or from the
External Access column on the Tag Editor.
You can configure the external access of an Add-On Instruction’s parameters and
local tags in the Add-On Instruction Definition dialog box and on the Add-On
Instruction Parameters and Local Tags dialog boxes.
For alias parameters, the external access type is equal to the type configured for the
base local tag.
Parameters/Local Tag No change is applied to the External Access list if you switch the usage among Input parameter, Output parameter or Local Tag, except when
Properties the usage is Local Tag, then the box is unavailable.
If you change the usage from InOut parameter to:
• Input or output parameter, then the External Access list is available and your last selection for creating an equipment phase/Add-On
Instruction input parameter or an equipment phase/Add-On Instruction output parameter is displayed accordingly.
• Local tag, then the external access is updated to None and the box is unavailable.
The External Access list also is unavailable if:
• You do not have permission to change external access settings.
• The controller is online.
• The tag is an alias tag.
• The Add-On Instruction is in Source Protection mode.
Only tags with external access settings of Read/Write or Read Only can be
Tag mapping mapped to a PLC-2 controller and PLC-5/SLC controllers.
considerations
1. In the PLC-2 or PLC-5/SLC Mapping dialog box, type a file number.
2. Choose a tag from the Name list. Only eligible tags that are set to either
Read/Write or Read Only appear in the menu.
If you manually type the name of a tag whose external access is set to None,
an error message appears.
3. Click OK.
Imported tag behavior The Logix Designer application preforms a check to verify an imported program
file has a valid external access value. A default value is assigned to unspecified tags
that are imported from programs created in the Logix Designer application earlier
than version 18.
An error message appears in the Logix Designer application for imported files that
contain tags with any value other than Read/Write, Read Only, and None.
Constant value tags In version 18 and later of the Logix Designer application, you can designate tags as
constants to protect them from being changed programmatically by:
The tags that you cannot designate as constants are User-defined type members,
Add-On Instruction input and output parameters, and local tags. You make a tag a
constant value tag by selecting the Constant check box on tag creation dialog
boxes and tag editor/monitor windows.
For an alias tag, the default constant setting of this tag is the same as its target tag.
For all other conditions, the default value is unchecked, indicating the tag is not a
constant value tag.
Tip: You cannot pass a constant value tag as an argument to an Output parameter of an Add-On Instruction. You cannot
pass a constant tag to an InOut parameter that is not also designated as a constant value.
Configure constant tags This section describes the various ways you can configure a constant attribute for a
tag.
2. In the New Tag dialog box, in the Type list, choose a tag type.
4. Click Create.
1. On the Tag Editor, right-click a tag and then click Edit (tag name)
Properties.
3. Click OK.
An error message appears if you try to change the data type of a constant tag to a
data type that cannot be constant.
In the Tag Editor, select the check box in the Constant column.
Important: In the Tag Monitor, the Constant setting for the tag appears in the same Constant column as shown
in the previous illustration. However, you cannot change the value.
The Constant column also is available on the Equipment Phase Tag Editor and Equipment Phase Tag
Monitor.
Tag Editor
Tag Values permission. You cannot change a constant value in any of the language editors or any other tag browser. The icon in the Value
column indicates that you are changing a constant value tag’s value. Any change to the values of a constant tag is recorded in the Controller Log for
future reference.
For controller logging, see the Logix5000 Controllers Information and Status Programming Manual, publication 1756-PM015.
(4) If the controller is in safety-locked mode, only the safety tags are unavailable, and the standard tags will have the same behavior as
in the unlocked mode. The Constant check box is unavailable in the Tag Properties dialog box only if the tag is a safety tag.
Add-on instructions The Constant attribute applies only to InOut parameters. The default setting of
the property is not a Constant Value.
constant value
considerations The Constant attribute does not apply to Input, Output, EnableIn and
EnableOut Add-On Instruction parameters. It does not apply to Add-On
Instruction Local tags.
listen-only 14
A overview 12
access considerations
external 63 Add-On Instructions
add extended properties to a tag 32 constant value 81
add extended properties to user-defined data type 42 external access 73
Add-On Instruction external access 70, 71
constant value considerations 81 user-defined data type external access 71
external access variables 73 constant
address value
assign indirect 50 availability 80
tag 47 dialog box 77
tag I/O module 18 tag editor 79
alias tag properties 78
create 49 value configuration 77
show/hide 49 value tags 76
use of 47 controller
array tags 25
calculate subscript 51 use of 25
create 37 create
index through 50 alias 49
organize 27 tag 31
overview 34 user-defined data type 40
availability
constant value 80 D
external access 70, 71
data
block
B See array (create) 34
base tag, find, 69 I/O 18
buffer table
I/O data 19 See tag (organize) 55
type
choose 23
C overview 23
communication structure 23
format 12 description
ownership 14 tag 44
I/O module 12 user-defined data type 44
module I/O configuration 55 direct connection 12
compatible disable
keying 15, 16 electronic keying 16, 17
configure electronic keying 17
external access 64 force 56
connection document
tag I
description 44
user-defined data type 44 I/O module
buffer data 19
configuration 55
E document
electronic keying See alias 47
electronic keying 17 electronic keying 15
enable ownership 14
force 55 synchronize with logic 19
exact match tag address 18
electronic keying 16 update period 12
keying 15 index
expression See indirect address 50
calculate array subscript 51 indirect address 50
extended properties 23 format 47
adding extended properties to a use of expression 51
tag 32
user-defined data type 42 K
external
access 63 keying
Add-On Instruction 73 See electronic keying 15
availability 70, 71
configure 64 L
configure tag dialog 65
ladder logic
configure tag properties 67
force a value 55
options 64
override a value 55
user-defined data type considerations 71
local data
view tag editor 69
See scope 25
F M
file
memory
See array 34
allocation for tags 23
force
Min and Max for DINT, INT, LINT, SINT, and REAL data types 32, 42
disable 56
module
enable 55
I/O configuration 55
remove 56
function block diagram
force a value 55 N
name
G guidelines for tag 27
reuse of tag name 25
Go To, 69
global data
See scope 25
O configuration 77
create 31
ownership create alias 49
I/O module 14 data
type 23
P dialog
external access 65
pass-through description 44
editor
program
view external access 69
parameters 12, 19, 25, 27
guidelines 27
tags 25
I/O 18
program parameters 12, 19, 25, 27
mapping
project documentation 53
considerations 76
memory allocation 23
R name 25
organize 27
rack-optimized connection 12
overview 55
remove
properties
force 56
requested packet interval (RPI) 12 external access 67
reuse of name 25
scope 25
S type 22
scope
guidelines 27 U
parameters 12, 19, 25, 27
user-defined data type
tag 25
create 40
sequential function chart
external access variables 71
force element 55
guidelines 40
structure
overview 40
create 40
organize 27
overview 23 V
user-defined 40
variables
structured text
constant value 80
force a value 55
external access 70, 71
symbol
user-defined data type
See alias. 47
external access 71
T
tag
address 47
alias 47
array 34
assign dimensions 37
constant value 76
Rock well Automati on Publication 1756- PM004F -EN-P - June 2016 85
Rockwell Automation support
Rockwell Automation provides technical information on the web to assist you in using its products. At
http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to
software service packs. You can also visit our Support Center at https://rockwellautomation.custhelp.com for software
updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.
In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more
information, contact your local distributor or Rockwell Automation representative, or visit
http://www.rockwellautomation.com/services/online-phone.
Installation assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this
manual. You can contact Customer Support for initial help in getting your product up and running.
United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to
your distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Documentation feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete the feedback form, publication RA-DU002.
Supersedes Publication 1756-PM004E-EN-P - October 2014 Copyright © 2016 Rockwell Automation, Inc. Allrights reserved.Printed in the U.S.A.