Extended properties

The extended properties is a Logix controller capability that lets you define additional information, such as engineering units, state identifiers, for components within your controller project in
Studio 5000 Logix Designer
version 21.00.00 or later. Once configured, the values of extended properties can be distributed to local and distributed clients, such as
FactoryTalk View
version 9.00.00.
TIP:
Extended tag properties are not supported by
FactoryTalk Design Studio
version 2.01.00 or earlier, so many of the extended tag properties retrieved from the controllers are not available in controllers loaded by
FactoryTalk Design Studio
. However, some extended properties generated by
FactoryTalk Linx
are available for controllers loaded by both
Studio 5000 Logix Designer
and
FactoryTalk Design Studio
.
The extended properties are only available to
FactoryTalk
Software and the
PanelView Plus
.
You can use extended properties to define additional information about a tag, or structure of tags. You can also use extended properties for user defined data types, arrays, or other complex data structures. Currently the extended properties are supported for
ControlLogix
controllers with firmware version 21 or later.
While FactoryTalk Linx can read extended tag properties, these attributes do not support write operations. Because of FactoryTalk Live Data client can receive the values but will not be able to change them.
Logix controllers extended tag properties
Property Name
Description
Pass-through supported (Version)
Logix controllers (Version)
PlantPAX controllers (version)
.@Description
A text string from 0 to 512 characters that contains the descriptive texts as defined in Studio 5000 Logix Designer.
FactoryTalk Linx
V6.00
V30 and later
V33 and later
.@EngineeringUnit
A text string from 0 to 80 characters that represents the units of measurement associated with a tag or tag structure or array member.
FactoryTalk Linx
V6.20
V30 and later
V33 and later
.@Min
The minimum (low) value of a tag or tag structure or array member. This property is used with the .@Max property to create a high and low limit for a DINT, INT, LINT, SINT, and REAL tag. This value takes on the same type as the tag which it is associated with.
No
V30 and later
V33 and later
.@Max
The maximum (high) value of a tag or tag structure or array member. This property is used with the .@Min property to create a high and low limit for a DINT, INT, LINT, SINT, and REAL tag. This value takes on the same type as the tag which it is associated with.
No
V30 and later
V33 and later
.@State0
The State 0 identifier associated with the tag or tag structure or array member. It is used with .@State1 property to describe two states of a BOOL tag. The identifier is limited to 80 characters.
FactoryTalk Linx
V6.20
V30 and later
V33 and later
.@State1
The State 1 identifier associated with the tag or tag structure or array member. It is used with .@State0 property to describe two states of a BOOL tag. The identifier is limited to 80 characters.
FactoryTalk Linx
V6.20
V30 and later
V33 and later
TIP:
Logix controller extended tag properties are only available for controllers loaded by
Studio 5000 Logix Designer
.
PlantPAX controller process instruction extended tag properties
Property Name
Description
Tag category
Pass-through supported (Version)
PlantPAX controllers (version)
.@Library
Associates instructions with a display library for faceplate call-up.
Type
FactoryTalk Linx
V6.20
V33 and later
.@Instruction
Associates the instruction name for faceplate call-up.
Type
FactoryTalk Linx
V6.20
V33 and later
.@Label
A label that appears on the graphic HMI symbol.
Type and element
FactoryTalk Linx
V6.20
V33 and later
.@Area
The area name for area-based security in the HMI.
Type
FactoryTalk Linx
V6.20
V33 and later
.@URL
The Uniform Resource Locator (URL) for accessing the help content from HMI.
Type
FactoryTalk Linx
V6.20
V33 and later
.@Navigation
A path to another source of information. For example, a document link or website.
Element
FactoryTalk Linx
V6.20
V33 and later
TIP:
PlantPAx
controller process instruction extended tag properties are only available for controllers loaded by
Studio 5000 Logix Designer
.
FactoryTalk Linx extended tag properties
Property Name
Description
Pass-through supported (Version)
.@Name
A text string ranging from 0 through 512 characters that defines the tag name in client application.
FactoryTalk Linx
version 6.20.00
.@Quality
A value that represents the communication status for the base tag. Refer to Attribute for quality codes and their meanings.
FactoryTalk Linx
version 6.20.00
.@Timestamp
The date/time when the base tag was last received. A string that follows the format of Year/Month/Day/Hour/Minute/Second to define the time when
FactoryTalk Linx
data server polls the data to the client.
FactoryTalk Linx
version 6.20.00
.@Scope
A string that defines a tag's controller and program scope.
FactoryTalk Linx
version 6.20.00
.@Description
A custom text string ranging from 0 through 512 characters defined in
Studio 5000 Logix Designer
to provide descriptive information about a tag. This may contain a description assigned to the tag element directly, or an automatically generated description using other description information using the
Studio 5000 Logix Designer
pass-through description mechanism.
FactoryTalk Linx
version 6.60.00
.@Shortcut
A string that defines the shortcut reference. This can include FactoryTalk Application area/sub-areas and the
FactoryTalk Linx
server name. (For example, /Area/subarea:FactoryTalk Linx:[ShortcutName])
FactoryTalk Linx
version 6.60.00
TIP:
FactoryTalk Linx
extended tag properties are available for controllers loaded by both
Studio 5000 Logix Designer
and
FactoryTalk Design Studio
.
For more definition about extended properties, refer to
Studio 5000 Logix Designer
Online Help
.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal