Substitution tab

A substitution is a user-defined rule that, during instantiation, replaces a text string in the name, description, instantiation location, or other attribute of a library object element with a parameter value, calculation result, or referenced value. Substitutions can be set to search all text in the library object, or restricted to text in operands, which are the instructions in routines.
Keep these considerations in mind when using substitutions.
  • Substitutions applied at one level of the library object hierarchy extend to all Objects at lower levels of the hierarchy, and to all elements that are contained within the library objects. For example, a substitution applied to a Project library object extends to the Controller library object and all Logix Object library objects in the same ACD file, as well as to all elements within all of these library objects.
  • Substitutions applied to a library object extend to all elements within the library object. Substitutions applied at a higher level in the hierarchy take precedence over substitutions applied directly to the library object.
  • Substitutions that are inherited by an element from the containing library object, or from a library object higher in the library object hierarchy (base library), can be overridden at the element level using the
    Substitution Builder
    .
  • Substitutions can be copied and pasted from one library object to another and can be copied and pasted between library objects of different scope.
  • Substitutions are not grouped.
    IMPORTANT:
    Substitutions are applied globally based on a simple search-and-replace logic. Care should be taken in both the naming conventions and standards used when elements are created in
    Logix Designer
    , and in the text strings selected for substitution in the
    Library Object Manager
    application.
    Substitutions that affect text strings in unexpected locations can make the library object function in unexpected ways or fail to validate.
This table describes the commands available on the
Substitions
tab.
Command
Description
Add New icon
The
Add New
button opens the
Substitution Builder
window.
Move Up icon Move Down icon
The
Move Up/Move Down
buttons change the position of a selected Substitution item in the tab listing. Substitutions are listed in alphabetical order by default.
Find partial
This dropdown menu can initiate a search for functions that match a text string entered in the adjacent field. There are two different types of finds that can be performed, use the dropdown menu to select the one to use:
  • FindPartial
    : Searches for the text string in any part of an entry.
  • FindPrefix
    : Searches for the text string at the beginning of an entry.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal