Library object properties

Library object elements support different decorative properties. The decorator panel is divided into two sections:
  • Attributes section. Displays the configurable attributes for a library object element.
  • Parameters section. Displays the customizable properties (decorations) available for a library object element and any of its extended parameters.
Use the configurable items in the decorator panel to turn static instances of controller tags, local tags, and tag members into parameters or external references. Adding a tag as a parameter opens the tag to values set by the user, or by calculations or references set after the library object has been added to an
Application Code Manager
project. Adding a tag as an external reference makes the value of the tag available to other library objects after the library object has been added to an
Application Code Manager
Project.
This table describes the decorative attribute items available for the different library object elements.
Name
Field Type
Supported item
Description
Name
Text entry
Tag
Task
Program
Routine
Directive
Function Block sheet
Sequential function chart
Structured text chart
Structured text chart line
Motion group
Motion group axis
Add-On Instruction
Data type
Module
The name applied to the item when the library object is instantiated. If substitutions appear in the original item name, these are applied by default.
This field cannot be edited for Function Block sheet or data type items.
Description
Text entry
Tag
Task
Program
Routine
Function Block sheet
Sequential function chart
Structured text chart
Structured text chart line
Motion group
Motion group axis
Add-On Instruction
Data type
The description applied to the item when the library object is instantiated. If substitutions appear in the original item description, these are applied by default.
This field cannot be edited for data type items.
Description Language
Dropdown menu
Tag
Task
Program
Routine
Function Block sheet
Sequential function chart
Structured text chart
Motion group
Add-On Instruction
Data type
The language used for the description. The default is English.
This field cannot be edited for data type items.
Library Object
Read-only
Tag
Task
Program
Routine
Function Block sheet
Sequential function chart
Structured text chart
Motion group
Add-On Instruction
Data type
Module
The library object that contains the item.
Logix Path
Read-only link
Tag
Task
Program
Routine
Function Block sheet
Sequential function chart
Structured text chart
Motion group
Add-On Instruction
Data type
A link to the applicable item for the element in
Studio 5000 Logix Designer
. Click the link to open the screen. Close
Library Designer
to access
Studio 5000 Logix Designer
.
Configure Instantiation Rules: Condition
Text entry
Tag
Task
Program
Routine
Rung
Function Block sheet
Function Block diagram
Sequential function chart
Sequential function chart element
Structured text chart
Structured text chart line
Motion group
Motion group axis
Add-On Instruction
Data type
Sets the condition under which the current item is instantiated. The default is
Always
. A condition can be entered manually or generated by an expression.
Configure Instantiation Rules: Usage
Dropdown menu
Tag
Task
Program
Routine
Rung
Function Block sheet
Function Block diagram
Sequential function chart
Sequential function chart element
Structured text chart
Structured text chart line
Motion group
Motion group axis
The number of times the item is instantiated.
Default options are:
  • One per Object
  • Include Once
If the containing library object has subobjects, there will also be an option "Once per sub object [SubObject name]" for each subobject. The default value is "One per Object".
Exclude Base Library Substitutions
Checkbox
Tag
Task
Program
Routine
Rung
Function Block sheet
Function Block diagram
Sequential function chart
Sequential function chart element
Structured text chart
Structured text chart line
Motion group
Motion group axis
Add-On Instruction
Data type
If selected, allows substitutions added to the base library object for the current library object to be overridden.
Exclude Library Substitutions
Checkbox
Tag
Task
Program
Routine
Rung
Function Block sheet
Function Block diagram
Sequential function chart
Sequential function chart element
Structured text chart
Structured text chart line
Motion group
Motion group axis
Add-On Instruction
Data type
If selected, allows substitutions added to the current library object to be overridden.
Container Mode
Checkbox
Task
Program
Routine
Rung
When this command is active, all program tags and routines are added to the library object automatically. If it is inactive, the user must manually add the content to the library object.
Catalog No
Read-only
Module
The catalog number of the item.
Major Version
Read-only
Module
The major version for the item.
Minor Version
Read-only
Module
The minor version for the item.
ParentModule
Text entry
Module
The name that is applied to the module when the library object is instantiated. A predefined parameter is assigned by default.
This table describes the actions available from the parameters section of the decoration pane. Actions that are not supported by the current element appear will be unavailable. To see the available actions, right-click the element.
Action
Description
Substitutions
Opens the Substitution Builder.
Select By > Included in Library
Selects all elements that are included in a library.
Select By > Excluded from Library
Selects all elements that are excluded from libraries.
Select By > Usage > One per Object
Selects all elements where the Usage field has been set to "Include Once per Object".
Select By > Usage > One per SubObject
Selects all elements where the Usage field has been set to "Include Once per SubObject".
Select By > Usage > Include Once
Selects all elements where the Usage field has been set to "Include Once".
Select By > Include Condition
Selects all elements where the Condition field matches the option selected in the submenu. The submenu displays all conditional inclusions rules for the current diagram.
Select Same > Usage
Selects additional elements that match the Usage field for the currently selected element.
Select Same > Include Condition
Selects additional elements that match the Condition field for the currently selected element.
Select Same > Both of the Above
Selects additional elements that match both the Usage field and the Condition field for the currently selected element.
Select Same > Tag
Selects additional elements that reference the same Tag as the currently selected element.
Select All
Selects all elements.
Remove
Deactivates the selected elements.
Add
Not Available.
Undo
Undoes the last action.
Redo
Redoes the last action.
Extended Properties
Displays any extended properties set in
Studio 5000 Logix Designer
that can be modified. Select the ellipsis button
(...)
to open the
Expression Builder
.
Some elements, such as Add-On Instructions and Data Types, do not have configurable parameters in the bottom half of the decorator panel.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal