Home

Library Designer and Library Object Manager User Manual

Contents

1. 100 Rockwell Automation Publication LOGIX UM006A EN P October 2015 121 Chapter 7 122 The Library Designer Plug in Decorating Library Object Elements Refer to Applying Decoration to the Elements in a Ladder Logic Diagram on page 123 for the decoration available to a Ladder Logic Diagram Refer to Applying Decoration to the Elements in a Function Block Diagram on page 128 for the decoration available to a Function Block Diagram Refer to Applying Decoration to a Sequential Function Chart on page 134 for the decoration available to a Sequential Function Chart Refer to Applying Decoration to a Structured Text Chart on page 141 for the decoration available to a Structured Text Chart The following table describes the fields in the top half of the Decorator Panel when a Routine is selected Name Field Type Description Name Text entry The name that will be applied to the Routine when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Routine name these are applied by default Refer to Changing the Routine Name or Description on page 123 Description Text entry The description that will be applied to the Routine when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Routine description these are applied by default Refer
2. Name Data Description Global ControllerDescription String The description of the Controller for the current Project ControllerName String The name of the Controller for the current Project ParentName String The name of the Object or element that contains the current element Processorlype String The processor type of the Controller for the current Project ProjectDescription String The description of the current Project ProjectName String The name of the current Project SoftwareRevision String The software revision number of the Controller for the current Project Local ObjectDescription String The description of the current Library Object ObjectName String The name of the current Library Object ProgramDescription String The description of the Program that contains the current element ProgramName String The name of the Program that contains the current element SubObject Description String The description of the SubObject that contains the current element SubObjectName String The name of the SubObject that contains the current element TaskDescription String The description of the Task that contains the current element TaskName String The name of the Task that contains the current element Modules ParentChassisName String For Module Library Objects only The chassis name of the current Library Object ParentChassisSize Integer For Module Library Objects only The chassis size of
3. RA LIB P DOut Graphics Library Template_ProcessLib Display RA BAS DOut Graphics Library ggfx Version 3 1 01 Release Copyright Rockwell B Digital 2 State Device Display Elements for use on overview and detail displays To use these Display Elements on your display NOTE These display elements us 1 Copy the abject and nacta it tn wnur dienlaw name and Inf Lib library name te 2 Right click or Edit Values should be displayed Ifthe facepla 3 Populate the Torreele please verify that these tags are se Simple Digital Code Activex Events ssssssssss Methods Object Keys Arrange Ll Global Object Parameter Values Animation Convert to Wallpaper ed AreaPath Lees Tag Substitution Property Panel Object Explorer Copy Paste Paste without localized strings Delete Duplicate Copy Animation Paste Animation Global Object Defaults 3 Enter the following value in the Object Tag Parameter AreaPath ObjectName IMPORTANT Thevalue entered must include the second pair of curly brackets enclosing the AreaPath and ObjectName tokens Note that the the Path Parameter is also a part of the Object Tag Parameter 4 Enter the following value in the Path Parameter AreaPath IMPORTANT Thevalue entered must include the second pair of curly brackets enclosing the AreaPath token 5 Export the Sy
4. The following table describes the fields the Decorator Panel that are active when a Sequential Function Chart element is selected Name Field Type Description Description Text entry The description that will be applied to the element when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Sequential Function Chart description these are applied by default Refer to Changing the Sequential Function Chart Element Description on page 139 Configure Instantiation Text entry Sets the condition under which the current element is instantiated Rules Default is Always A condition can be entered manually or generated Condition by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 136 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 137 The Library Designer Plug in Decorating Library Object Elements Name Field Type Description Configure Instantiation Pull down The number of times the element will be instantiated Default is Once Rules menu per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substi
5. Field Type The Library Designer Plug in Decorating Library Objects Chapter 5 Description This field appears if Integer is selected in the Data Type field and the Parameter is being added to a SubObject Autolncrement TRUE FALSE pull down menu When TRUE is selected the Parameter will be populated automatically and the value incremented every time a new SubObject is added to an ACM Project For example multiple channel SubObjects will be numbered sequentially as they are added 04 Userlnterface Group Text entry The group in the Parameters Tab where the Parameter will appear If the value entered matches an existing group name the Parameter will appear in this group If the value entered does not match an existing group name a new group will be created Filter Text entry When Reference has been selected as the Reference Type for the new Parameter this field allows you to create a filter expression to limit which External References the Parameter can reference For example an input Parameter for a valve can be limited to an input channel that is a SubObject of a Module The filter expression can be entered manually or generated by the Filter Builder To create a filter expression click Ellipsis to the right of the field to open the Filter Builder window Visible Text entry Allows you to create a condition to control whether the user sees the Parameter when the Library Object is adde
6. b Click Delete in the Library Object Button Bar The Warning window displays Warning X Are you sure you want to delete library AnalogInput Yes No 3 Select Yes to delete the selected items or No to cancel the deletion 58 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives The Decorator Panel Chapter 5 The Library Designer Plug in Decorating Library Objects This chapter provides information on the following topics e The Decorator Panel e Adding Decoration to a Library Object e Parameters e Functions e Substitutions e Predefined Parameters e External References The Decorator Panel becomes active when an element within a Library Object that accepts decoration Custom Properties is selected The Decorator Panel displays the fields and functions available to add modify or delete decoration for the selected item The display changes based on the decoration available for the selected element Fields that can be edited display with white backgrounds Fields that are locked for editing appear dimmed Fields that can accept calculated values show the Ellipsis button to the right The Decorator Panel becomes inactive when organizational folders in a Library Object or items in the Selected Objects column are selected Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 59 Chapter5 Library Designer Plug in Decorating Libr
7. Setting a Rule for Instantiation Applying Decoration to the Elements in a Ladder Logic Diagram Applying Decoration to Rung i eee oink era Ped Ree ee Setting a Rule for Instantiatloh Excluding Inherited Substitutiohisu enero nics soe Applying a Substitution to a 8 Activating and Deactivating Applying Decoration to a Directive Applying a Substitution to a Rockwell Automation Publication LOGIX UM006A EN P October 2015 Table of Contents Applying Decoration to the Elements in a Function Block Diagram 128 Applying Decoration to a Sheet 128 Changing the Sheet Descriptlons 129 Setting a Rule for 129 Excluding Inherited Substitutions 888 130 Applying Decoration to a Function Block Diagram Elect ec ere epe e E e e apes 130 Setting a Rule for istantiatioD dian h erret 132 Excluding Inherited Substituti ns 1 5 220 00 ce et etae e 132 Applying a Substitution to a Function Block Diagram cid 133 Activating a New Function Block Diagram Element 133 Activating and Deactivating Function Block Diagram Elements PERS VERON RE RARE Gu 133 Applying
8. Group Cfg TransitStalT Lab V v Parameter Help Lab Valve 03 IO Configurati Extended Group TIP Columns can be resized horizontally by mousing over the right side of the column until the pointer changes to a double arrow then by dicking and dragging Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 65 Chapter5 Library Designer Plug in Decorating Library Objects The Parameters Tab Button Bar The Parameters Tab Button Bar is shown below f FindPartial The following table describes each Parameters Tab Button Bar command The Add New button opens the Add New Parameter window A The Move Up Move Down buttons change the position of a selected Parameter E w item in the tab listing Parameters are listed in alphabetical order by default Parameters may be moved up or down within their group but cannot be moved between groups using these buttons The Find pull down menu initiates a search for Parameters that match a text string FindPartial you enter in the field Using the Find Feature The Find feature limits the display in the Parameters Tab to Parameters that match the text string entered in the field All columns currently being displayed are searched The following table describes the two options in the Find pull down menu FindPartial Searches for the text string in any part of an entry FindPrefix Searches for the text string at the beginning of an entry Follow these step
9. 174 Editing an ACD Repository in the Studio 5000 Logix Designer Application 174 Editing an ACD Repository in the Library Designer Plug in of t v eR ET tpe etes 175 Exporting ACD Repository to L5X 176 Removing an ACD Repository from the Library Object Manager 176 Adding Folder Repository vei ose eek Vendre eR Reihe 177 Removing a Folder Repository from the Library Object Manager Application ceo eret re 178 Adding the ACM Database as a 179 Removing the ACM Database from the Library Object Manager 182 Creating New Library Object cies oco rere er mehr stets 182 Copying a Library Object from the ACD Repository to a Folder Repository or the ACM Database 184 Copying Multiple Library Objects from the ACD Repository to a Folder Repository or the ACM Database 186 Copying Library Objects Between Folder Repositories and the 187 10 Chapter Objectivesias eR RE RE UDHENT Y Ex 189 OVERVIEW veter adu rata ATE Vote ass 189 Viewing the Decoration Settings of a Library Object 190 Viewing the Logix Code of a Library 191 Adding FactoryTalk View SE ME Content to a Library Object 191 Addinga Symbol to a L
10. Configuration aa_Interlocks Add Children aa_Permissives a Parameters and Local Tag 2 2 89 xv100 psXV100 lOFault AND Add Dependencies 4 Sheeti psXV100 lOFault NOT Allow Shared Ownership Ownership 53 Motion Groups Add On Instructions Data Types Inclusions 28 1 0 Configuration v Add Children Add Dependencies Allow Shared Ownership Inclusions ff MainRoutine B aa_Interlocks B aa_Permissives Xv100 Sheet Motion Groups Add On Instructions A P_Aln fig P Alarm fi P Din AJ P Gate fj P Intlk i3 P Mode AI P Perm fij P_ValveSO 9 08 Data Types G Configuration Children Add Dependencies Allow Shared Ownership The Allow Shared Ownership command determines whether an item in the Project hierarchy can be associated with multiple Library Objects or restricted to a single Library Object The default is Shared Ownership which allows for multiple associations The setting for this command affects all associations made until it is changed When the Allow Shared Ownership command is activated items which were previously limited to a single Library Object may be added to other Library Objects When the Allow Shared Ownership command is deactivated selected items may be added to one Library Object Ifany of these items is selected and added to another Library Object the Library Designer plug in does not allow the association
11. Pre ene eee eee The Buttott BAI eee dea eben e ee ND Ma etu Creating an Expression EA EE prre dus Setting the Result Type of an Validating and Testing an Saving an Expression sses eaa oett et ee Applying Expression Gier hee re eR Rs aas Chapter 7 Chapter Objectives cud seh vetu i A ari The Decorator Panel id ctu re e eal Adding Tags as Parameters or External References The Substitution Builder eed oat eo The Element Substitutions in order Window The Create New Substitution Creating a New Substitution iude er rer eret d Applying Decoration to a Tag nn qo Changing the Tag Name or Setting a Rule for Instantiation Adding a Tag as Adding a Tag as an External Applying Decoration to Tag Applying Decoration to a Task or Changing the Task or Program Name or Description Setting a Rule for Instantiation Applying Decoration to a Changing the Routine Name or
12. 5 6 Custom Properties 52 69 Libraries Lab Coi Edit em Delete Lab Va Lab Mo Lab Dig Lab Did Lab Wa Paste The Library Object contextual menu has the following commands Edit Not applicable in this context Delete Deletes the selected item Copy Not applicable in this context Paste Works with the Copy command in the Selected Objects column Pastes the copied item s from the Selected Objects column into the selected Library Object View in Studio 5000 Highlights the selected item in the Studio 5000 Logix Designer tree view Move Up Not applicable in this context Move Down Not applicable in this context Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 57 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object Deleting a Libra ry Object The Delete command can be applied to any item or items in the Library Objects column Follow these steps to use the Delete command 1 Select the items you want to delete 2 Do one of the following a Right click one of the selected items The Library Object contextual menu opens Select Delete 3x Libr Library Objects Custom Properties Libraries EH Edit Delete Lab Mo Lab Paste View in Studio5000 E Ge 5 3 Ea E Eo 1
13. Condition Always x Usage One per object M Catalog No 1756 IF16 Major Version 1 Minor Version 1 ParentModule ParentName ojo Slot Slot Address N A o RPE Fn RP Unicast N A Name Data Type Value Value Expres ObjectName AB 1756 IF1 ModuleFilter SINT 2 RealTimeSample INT 100 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Main Graphic User Interface Chapter 3 Main Button Bar The Main Button Bar is shown below OK Cancel Apply The following table describes the Main Button Bar commands The OK button closes the Library Designer plug in and saves all changes that have OK been made since the program was opened The Cancel button closes the Library Designer plug in without saving the changes Cancel The Apply button updates all Library Objects in the Selected Libraries columns with Apply the most recent changes applied in the Decorator Panel It does not close the program Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 39 Chapter3 Library Designer Plug in Main Graphic User Interface Notes 40 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives Adding a Selected Object The Inclusions Pull down Menu Chapter 4 The Library Designer Plug in Adding a Selected Object to a Library Object This chapter provides information on t
14. Historian Tags FE EE EE 01 General Name Parameter Help Data Type 02 Reference Reference Type Default Value Append 4 04 Userinterface Group trol Type V le Disabled ReadOnly Enter the parameter name must be unique within its scope Unit Library Object Designer Parameter Unit Reference String Immediate Tank1 01 Programming and Execution TextBox True False Apply Help 162 The following table describes the regions and controls on the Main Graphic User Interface Settings Command Refer to Setting the Default Options for Library Object Classification on page 164 Library Repositories Tree View Refer to The Library Repositories Tree View on page 165 for more information Library Content Tree View Refer to The Library Content Tree View on page 166 for more information Properties Panel Refer to The Properties Panel on page 167 for more information Main Button Bar Refer to Main Button Bar on page 169 for more information The Library Object Manager Main Graphic User Interface is divided into three columns The Library Repositories column displays collections of Library Objects repositories There are three kinds of repositories that can be added to the display ACD An ACD base controller code file that includes Library Objects created in the Library Designer plug in These Library Objects are still
15. Name Conditional Calculation Bool Result Type Object hd Function Scope Object Statement Definition If this expression is true Return this value Expression Cid Cancel Help The following table describes the fields and buttons in the Function Builder window Name Field Type Description Name Text entry The name of the Function This is a required field Type Pull down menu Determines whether the Function generates a single value or uses IF ELSE logic to generate one of multiple possible values Conditional Function uses IF ELSE logic to generate one of multiple possible values Calculated Function generates a single value based on a single Statement Result Type Pull down menu The data type ofthe Function Options are Boolean String Numeric Function Scope Pull down menu The Library Object that contains the Function Default value is the current Library Object This field appears if Calculated is selected in the Type field Expression Pull down menu A single statement that determines the value generated by the function The value can be entered manually or generated by an Expression To create an Expression dick Ellipsis to the right of the field to open the Expression Builder This is a required field when Calculated has been selected in the Type field 82 Rockwell Automation Publication LOGIX UMO
16. The Library Objects Tree View e The Decorator Panel e Main Button Bar Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 29 Chapter3 Library Designer Plug in Main Graphic User Interface The Main Graphic User Interface This chapter describes the Main Graphic User Interface Main GUI Library Object Designer Selected Objects EH Controller Lab WM ProcessObjects 5 69 Tasks 08 MainTask 89 PO_DeviceControl amp Analoginputs 5 Gg Digitallnputs amp DigitalOutputs amp Motors Motion Groups 8 08 Add On Instructions Data Types Trends 4G 1 0 Configuration Library Objects 5 69 Custom Properties 5 8 Libraries Lab Project Lab Controller Lab Analoglnput Lab Motor Lab DigitalOutput Lab Digitallnput Lab WashMachine Library Attributes Catalog Number Lab Valve Library Description Solenoid Operated Valve Type Module Base Library Lab Controller Instantiation Default Name XV100 Default Description Substitutions Name XV100 ObjectName Description Inlet Valve ObjectDescription FindPartial Parameters Functions Substitutions Predefined External References Name Scope Default Value Lab_Valve 01 Programming and Execution Unit Lab_Valve Tank1 Lah Mala IND Darden Caaf muent an 4 nt 30 The following tab
17. Default The value can be entered manually or generated by an Expression To Description create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 49 Chapter 4 Name Substitutions Name The Library Designer Plug in Adding a Selected Object to a Library Object Field Type Description Text entry Sets the default substitution for a text string in the Library Object name when the Library Object is instantiated This string can be the complete name ora substring within the name The substitution extends to the names of all elements within the Library Object By default the Library Object Manager application assigns the Predefined Parameter ObjectName as the Substitution for the entered string Substitutions Description 10 50 Text entry Sets the default substitution for a text string in the Library Object description when the Library Object is instantiated This string can be the complete description or a substring within the description The substitution extends to the descriptions of all elements within the Library Object By default the Library Object Manager application assigns the Predefined Parameter ObjectDescription as the Substitution for the entered string Enter the Catalog Number name and Description of the Lib
18. Logix Path Read only link A link to the Edit screen for the Sequential Function Chart in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Text entry Sets the condition under which the current Sequential Function Chart is Instantiation Rules instantiated Default is Always A condition can be entered manually or Condition generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 136 Configure Pull down The number of times the Sequential Function Chart will be instantiated Instantiation Rules menu Default is Once per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for the Substitutions current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 136 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to be Substitutions overridden Refer to Excluding Inherited Substitutions on page 136 Changing the Sequential Function Chart Name or Description Ina typical application S
19. PrgiectName Global string PrgiectDescription Global string ProkessorType Global string Local ProgramName Local string ProgramDescription Local string The Predefined Tab display reacts dynamically to the text string entered returning a shorter list of matching Predefined Parameters as the text string grows TIP You must delete the text in the entry field to return the display to all Predefined Parameters Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 97 Chapter5 Library Designer Plug in Decorating Library Objects External References 98 An External Reference makes the value of a Local Tag Controller Tag or Tag Member within a Library Object accessible to Parameters in other Library Objects Used in conjunction with Parameters that have been assigned to accept values by reference External References provide the points of contact between Library Objects in ACM Project Inan ACM Project a user can link an External Reference to a Reference type Parameter The Parameter references the value of the External Reference when the Project is in operation Reference type Parameters can be defined so that the External References that are accessible to them are limited to those that meet certain criteria filters Any Tag or Tag Member can be added as an External Reference An External Reference can be copied to other Library Objects and to Library Objects of different scope IMPORTANT Ch
20. FC_HeatingCoilAvailable Cancel Help The following table describes the fields in the References window Name Description Library The Library Object for the element that references the Function Used in The element that references the Function The value is displayed in this format SubObject Type SubObject Name Details The specific reference point within the element Examples a field in the Edit Parameter window a conditional inclusion the Value Expression for a Controller or Local Tag Navigate Jump button that opens the Decorator Panel for the element where the reference is located 86 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Follow these steps to view a Function reference 1 Click Navigate for the reference listing The Decorator Panel opens for that element 2 Click OK to close the References window TIP You must close the References window before you can access the fields in the Decorator Panel Deleting a Function Follow these steps to delete a Function 1 Right click the Function Select Delete TIP Use the Show References command to list references to the Function before using the Delete command The Delete Objects window opens Delete Objects 5 Object s have been selected to be permanently deleted Continue 2 To finish the deletion click Yes To cancel the dele
21. ModelType Delux Name Value ModelType Stand String Variable Substitution Standard Delux Test Result SSS Help TIP The Expression must pass validation before it can be tested Saving an Expression To save an Expression click Save The Expression is added to the Saved Expressions Tab and becomes available to any Project opened in the Library Designer plug in TIP Clicking Save does not apply the Expression to the current field You must click OK in the Expression Builder Button Bar to apply the Expression Applying an Expression To apply an Expression to the current field click OK or click Cancel to delete the Expression without applying Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives The Decorator Panel Chapter 7 The Library Designer Plug in Decorating Library Object Elements This chapter provides information on the following topics e The Decorator Panel e Adding Tags as Parameters or External References e The Substitution Builder e Applying Decoration to a Tag e Applying Decoration to a Task or Program e Applying Decoration to a Routine e Applying Decoration to the Elements in a Ladder Logic Diagram e Applying Decoration to the Elements in a Function Block Diagram e Applying Decoration to a Sequential Function Chart e Applying Decoration to a Structured Text Chart e Applying Decoration to a Motion
22. ProcessObjects 1756 L75 27 11 File Edit View Search Logic Communications Tools Window amp Add Offline amp Cut Ctrl X No Forces Ctrl C No Edits Paste Ctrl V Delete Del Controller Organizer iControllerLab Verify 8 Controller T Cross Reference Ctrl E 3 Controller Power Up Browse Logic Ctrl L zr amp xTasks Online Edits 48 MainTask WashMac Print 5 PO DeviceCi 44 Analogin Export Program 5 6 Digitallng _ 3 68 DigitalOu Properties Alt Enter 1 68 Motors F E i pen Library Designer TIP You can select most items object or element at any level of the Controller Organizer tree The selected object plus all elements within the tree that reference the object or are referenced by it are brought into the Library Designer plug in For example a valve Object opens together with the Controller Tags Add On Instructions and Data Types that it references The following items are supported Controllers Tags Modules Tasks Programs and Routines Elements contained in Function Block Diagrams Sequential Function Charts Ladder Logic Diagrams and Structured Text Charts Data Types Add On Instructions 24 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Opening the Library Designer Plug in Chapter 2 3 The selected item and all referenced items open in the Selected Objects column at the left of t
23. a Click Add New b Right click a group name to open the contextual menu Select Add new Parameter 4 FindPartial Parameters Functions Substitutions Predefined Scope Add new Parameter Unit Dacta D RE Paste Parameter s Lab Valve 02 4 E Add new SubObject Cfg HasOpenLS LT Cfg HasClosedLS Cfg HasPermObj Collapse Library Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 The Add new Parameter window opens 02 Add new Parameter a x 4 01 General EER Cig_HasOpents Parameter Help Scope Lab_Valve Data Type String 02 Reference Reference Type Immediate 4 03 Data Default Value Append 04 Userinterface Group 01 Programming and Execution Control Type TextBox Filter Visible True Disabled ReadOnly False Name Enter the parameter name must be unique within its scope OK Cancel The entry fields in the window are functionally grouped Some fields appear conditionally based on selections made in other fields The following table describes the fields in the Add new Parameter window Name Field Type Description 01 General Name Text entry The name of the Parameter This is a required field Parameter Help Text entry Help text to explain the function of the Parameter and the result when specific values are entered Appears at the bottom of the
24. 1 H Analog 1 Motor 1 3 H E Valve 1 DesignPattern 1 v0 0 Global 2 E 03 88 89 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 189 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Viewing the Decoration Settings of a Library Object The Library Content column displays all Parameters Functions and External References added to a Library Object in the Library Designer plug in All settings for decorative elements can be reviewed but not edited in the Library Object Manager application although new Functions can be added Refer to Editing an ACD Repository in the Library Designer Plug in on page 175 for information on moving between the Library Object Manager application and the Library Designer plug in Follow these steps to review the decoration for a Library Object 1 Select a Library Object in a Folder or Database Repository The Library Content column and Properties panel activate m 7 Library Object Manager fog Settings Library Repositories Library Content Properties Repositories 5 15 Lab Motor 1 3 5 9 Lab WM ProcessObjects ACD Library Icon 7 8 04 Library Objects 9 8 Revision History 01 General Data Container Definition Data Name Unit Library Object Designer Parameter 3i Libraries Parameters Parameter Help Unit Reference 5 Instance Data Ob
25. Click the Library Object in the Library Content column to select it Right click to open the contextual menu Library Content J Lab Motor 1 0 Library Icq Add Section 9 FT View i FAE c Definition Collapse amp FT Historian 2 Select Add Section gt FTAE An FTAE folder with subfolders for Digital Alarms Messages and Tag Update Rates is added to the Library Object Library Content 5 15 Lab Motor 1 3 Library Icon H Revision History Help Document H E Definition Data gr Logix FTAE Digital Alarms Messages Tag Update Rates Adding a Digital Alarm to a Library Object Follow these steps to add a Digital Alarm 1 Click the Digital Alarms subfolder to select it Right click to open the contextual menu Library Content 5 15 Lab Motor 1 3 Library Icon H Revision History Help Document Definition Data tor Logix 5 9 FTAE f m Add essages Tag Updat Delete Expand All Collapse Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter 10 2 Select Add The Tag Browser window opens 7 5 Tag Browser bosa Select the Alarm Trigger Tag Selectable Type Bool Enter Name Filter Show All Tags M Name Data Type T Hf Sts_BypActive BOOL Hf Sts Disabled BOOL Hf Sts
26. ControllerName Program Pro FTLD Interface No FTLDInterfaceNo Point Type String Typical Value 168 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Chapter 8 Main Button Bar The Main Button Bar is shown below Apply Help The following table describes the Main Button Bar commands applied in the Properties panel It does not close the program The Apply button updates the selected Library Object with the most recent changes The Help button opens the help screens for the Library Object Manager application Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 169 Chapter8 The Library Object Manager Application Notes 170 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives The Library Object Manager Application Functions Chapter 9 The Library Object Manager Application Adding Repositories and Copying Library Objects This chapter provides information on the following topics The Library Object Manager Application Functions Adding and Mounting an ACD Repository Adding a Folder Repository Adding the ACM Database as a Repository Creating a New Library Object Copying a Library Object from the ACD Repository to a Folder Repository or the ACM Database Copying Multiple Library Objects from the ACD Repository to a Folder Repository or the ACM Database Copying Libra
27. Hf Sts_BypActive BOOL Hf Sts Disabled BOOL H Sts NotRdy BOOL B Sts MaintByp BOOL Hf Sts_Alminh BOOL c ns Tm gt Selected Tag ObjectName Sts Running 3 Scroll to select the Tag that the Historian Tag will reference Click OK The Tag is added Library Content 5 5 Lab Motor 1 0 Library Icon 8 8 Revision History Help Document HE Definition Data 48 Logix FT Historian Ej Historian Tags bul ControllerName ObjectName Sts_Running 208 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter 10 Configuring a Historian Tag Follow these steps to configure a Historian Tag 1 Click the Historian Tag to select it When a Historian Tag is selected the Properties panel displays these fields Properties Tag Name ControllerName ObjectName Sts_Running Include Condition Always Scan Class SC_Sts_Running Descriptor Engineering Units Instrument Tag HistorianPath ObjectName Sts_Running FTLD Interface No FTLDInterfaceNo Point Type Digital Typical Value 0 2 0 100 A number of the fields in the Properties panel are populated with default values In a typical application it is not necessary to change these values The following table describes th
28. Kar Plaza Is Merkezi E Blok Kat 6 34752 erenk y stanbul Tel 90 216 5698400 www rockwellautomation com Power Control and Information Solutions Headquarters Americas Rockwell Automation 1201 South Second Street Milwaukee WI 53204 2496 USA Tel 1 414 382 2000 Fax 1 414 382 4444 Europe Middle East Africa Rockwell Automation NV Pegasus Park De Kleetlaan 12a 1831 Diegem Belgium Tel 32 2 663 0600 Fax 32 2 663 0640 Asia Pacific Rockwell Automation Level 14 Core F Cyberport 3 100 Cyberport Road Hong Kong Tel 852 2887 4788 Fax 852 2508 1846 Publication LOGIX UMOOGA EN P October 2015 Copyright 2015 Rockwell Automation Inc All rights reserved Printed in the U S A
29. Project 1 0 Create Controller 1 0 Create 1 0 Create 1 0 Create 1 0 Create 1 0 Create 3 S S S S 2 4 01 Revision History Revision Description 9 02 Library Details CatalogNumber Description Family 9 Solution 9 Library Type Category Owner PFPember Major Revision 1 Minor Revision 0 03 Library Usage Rules Upstream Keys Downstream Keys Lab Project Lab Project Project Revision Description Description of any changes made to the library since the last revision Cancel Help Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects Chapter 9 IMPORTANT Ifyou copying the Library Objects into the ACM Database the new Library Objects will be compared to all Library Objects with the same CatalogNumber that are currently stored in the database and many of the fields in the Library Import Configuration window will be filled in by the database You will not be able to edit these fields All of the selected Library Objects are listed under the New Libraries heading You can select each item on the list to display its fields enter the information for the Library Object then click Apply once when all items have been entered to add all of the Library Objects at the same time IMPORTANT Library Object in the list that has required fields that have not been filled in displays with the red
30. Properties panel with Digital Alarm selected 202 Properties panel with Historian Tag selected 209 Properties panel with Symbol selected 193 removing the ACM Database 182 resizing the columns 165 resizing the main GUI 164 Tag Browser window 201 viewing the decoration settings 190 viewing the Logix Code 191 Library Object Manager LOM 13 15 19 23 26 77 161 189 Library Object Repository 15 Library Repositories tree view 27 Logix Object 13 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 157 158 159 Downstream Keys 183 186 Upstream Keys 183 186 Module Wizard 17 53 Motion Group 146 149 151 152 non Logix content 189 0 operand 115 ownership 43 Allow Shared Ownership 43 child Object 43 parent Object 43 P Parameter 16 17 20 98 105 111 151 158 description 18 instantiation 18 62 naming 63 reference type 98 uses 18 62 Predefined Parameter data type 96 definition 96 description 20 95 instantiation 95 Program 119 Project Engineer 14 Routine 121 Rung 123 126 Index Sequential Function Chart 134 137 139 Sheet 128 129 Software 17 Structured Text Chart 141 142 Studio 5000 Logix Designer 13 23 31 52 Logical Organizer view 31 SubObject 16 18 63 64 68 naming conventions 64 Substitution 16 17 51 52 111 description 19 88 inheritance 88 111 instantiation 19 88 overriding inheritance 16 51 52 111 112 Substitutio
31. Select the Function TIP You can select multiple Functions using the SHIFT or CONTROL keys 2 Right click the Function to open the contextual menu Select Copy 3 Open the Library Object where you wish to add the Function 4 Right click anywhere in the Functions Tab for the new Library Object to open the contextual menu Select Paste Function s The Function is added to Library Object IMPORTANT If the Library Object does not contain all of the decorative elements referenced by the Function the Function Builder window opens with any statements that contain missing elements outlined in red Function Builder Name FC_HeatingCoilError Type Conditional x Result Type String E Function Scope Object gt Condition 7 Statement Definition If this expression is true ModelType Delux Return this value HeatingCoil Sts_Err Import The Function will be pasted into the Library Object even if the missing elements are not resolved Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Follow these steps to use a Function as the template for a new Function in the same Library Object 1 Select the Function TIP You can select multiple Functions using the SHIFT or CONTROL keys 2 Right click the Function to open the contextual menu Select Cop
32. e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Applying Decoration to Module The Library Designer Plug in Decorating Library Object Elements Chapter 7 Module Library Objects include a node for input output configuration including fields that are not found in other Library Object elements When a Module is selected the Decorator Panel display has two functional areas The bottom half of the panel displays the Configuration Tags and Tag Members for the Module Name ObjectName Library Object 1756 OB32 Logix Path Configure instantiation Rules Condition Always Lab_WM_ProcessObjects Modules Local_03 Usage One per object Catalog No 1756 OB32 Major Version 3 Minor Version 1 ParentModule ParentName Slot Slot m Address N A RPI Fn mu Unicast N A Name Data Type Value Value Expri ObjectName ProgToFaultEn 0 2540000 000 FaultValue 2350000 000 ProgMode T 250000 000 ProgValue T 2 0000_000 lt LU The following table describes the fields in the top half of the Decorator Panel when a Module is selected Name Field Type Description Name Text entry The na
33. 1 02 Cfg Tag S 0 102 Cfg Desc exposeToVba notExposed isReferenceObject true linkSize true linkConnections true linkAnimations linkWithExpression linkBaseObject RA BAS P DOut Graphics Library GO P DOut linkToolTipText true gt ControllerNameHObjectName DOut AlarmPolygon height 41 width 146 154 dth fLeftindex 5 4 oes visible true toolTipText expaseToVba notExposed isReferenceObject true linkSizes true linkConnections true linkAnimationss linkWithExpression linkBaseObject RA BAS P DOut Graphics 6 Check that the left and top offsets are consistent with other Symbols in the Library Object Modify if necessary TIP Asmall offset value of 5 10 provides the most efficient use of screen space and the most predictable configuration of multiple Symbols in a display Deleting a Symbol from a Library Object Follow these steps to delete a Symbol from a Library Object 1 Click the Symbol to highlight it Right click to open the contextual menu 2 Select Delete Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 199 200 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Adding FactoryTalk Alarms IMPORTANT _ Refer to Publication FTAE RMO01H EN E for more information on the screens and Events FTAE Content to a Library Object and fields associated with FTAE content Follow these steps to add FTAE content 1
34. 8 Revision History 8 8 Revision History Definition Data Definition Data E Parameters E Parameters B Object ER Object o geo Programming and Execution geo Programming and Execution H 02 Device Configuration 9 1 02 Device Configuration 03 10 Configuration 4 03 10 Configuration H 04 Alarm Configuration cH 04 Alarm Configuration 5 Historian Configuration Historian Configuration amp SC_Sts_Intik 1 amp SC Sts Intlk 1 amp SC Sts Intlk2 amp SC Sts Intlk2 SC Sts Intlk 3 H SubObjects H SubObjects Delete Functions Functions Move Up External References E e External References Doan Logix Logix FT Historian S FT Historian Expand All Historian Tags Historian Tags Collapse ControllerName ObjectName Interlock Sts Intlk 1 ControllerName Intl 1 ControlleiName ObjectName Interlock Sts Intlk 2 ControllerName ObjectName Interlock Sts Intlk 2 bd ControllerName ObjectName _Interlock Sts Intlk 3 Delete Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Expand All Collapse 211 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Notes 212 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 ACD file 13 14 17 23 54 162 ACM Database 15 17 163 184 ACM Project 20 63 98 112 Add On Instruction 14 2
35. A new group is created and the Parameter is included in the new group Deleting a Group from the Parameters Tab To delete a group from the Parameters Tab edit all of the Parameters in the group and assign them to other groups TIP You must type the group name exactly as it appears in the Parameter Tab Otherwise you will create a new group and assign the Parameter to it default group cannot be deleted Renaming a Group To rename a group you must first create a new group with a new name then reassign all the grouped Parameters to the new group Edit one of the Parameters in the group and assign it to a group with a new name Then edit the other Parameters in the group and assign them to the new group TIP e You must type the new group name exactly as it appears in the Parameter Tab Otherwise you will create another new group and assign the Parameter to it default group can be renamed When the first Parameter is added to the Library Object any text entered in the Group field will be added to the default group name Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 67 Chapter5 Library Designer Plug in Decorating Library Objects Adding a SubObject to the Parameters Tab Follow these steps to add a SubObject to the Parameters tab 1 Right click any group name to open the contextual menu Select Add new SubObject amp FindPartial Parameters Functions S
36. AreaPath ObjectName Err Alarm mm Condition Input lt gt 0 Latched Severity 500 1 Acknowledge required Minimum duration 0 Seconds Message ID not assigned New Browse Associated Tags Tagl mm Tag2 mm Tag3 Tag4 Alarm Class FactoryTalk View Command Apply Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content to a Library Object Chapter 10 The following table describes the fields in the Digital tab of the Properties panel when a Digital Alarm is selected Name Field Type Description Name Text entry The name that will be applied to the Digital Alarm when the Library Object is instantiated This name will appear in Application Code Manager screens The field is populated with a default name based on the Tag name and Library Object for the selected Tag Include Condition Text entry Sets the condition under which the current Digital Alarm is instantiated The default is Always A condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Refer to Setting a Rule for Instantiation on page 204 Input Tag Text entry The ItemID that will be appli
37. Button Pull name is displayed ACM The list includes all databases on the currently down menu selected server Attach adatabase Radio Allows you to use a different data file Click Browse to open a navigation file Button Text window to select the file entry Logical Name Text entry Becomes active when Attach a database file is selected Allows you to enter a name for the database file Advanced Button Click to open the Advanced Properties window Test Connection Button Click to test the connection to the currently selected database without opening it OK Button Click to open the selected database in the Library Object Manager application Cancel Button Click to cancel 3 You can select the default ACM Database or use a different data file a To select the default ACM Database click OK b To select a different data server select from the pull down menu in the Server name field or enter a different server name and SQL server instance Then click Refresh When the refresh is complete click OK c To select a different database from the current server select from the Select or enter a database name pull down menu Then click OK d To select a data file from outside the server select Attach a database file and click Browse Navigate to the data file Click OK to load it then enter a name in the Logical name field Click OK 4 To test the database connection click Test Connection The Test results
38. Decoration to a Sequential Function Chart 134 Changing the Sequential Function Chart Name or DescHptfonas d usd edi QI e CHEN 135 Setting a Rule for 136 Excluding Inherited Substitutions 0 00 cee eee ee 136 Applying Decoration to a Sequential Function Chart 2 4 cushy RE CR ten S qeu E RU uM 137 Changing the Sequential Function Chart Element Description geek dope weer oreet ER rU Repas 139 Setting a Rule for 139 Excluding Inherited Substitutions iere eae tetur eres 139 Applying a Substitution to a Sequential Function Chart Blementic before oy eis Mies 140 Activating a New Sequential Function Chart Element 140 Activating and Deactivating Sequential Function Chart Elements c osea ro CE role E deed 140 Applying Decoration to a Structured Text 141 Changing the Structured Text Chart Name or Description 142 Setting a Role tor 143 Excluding Inherited Substitutions 4 reete 143 Applying Decoration to a Structured Text Chart Line 144 Changing the Structured Text Chart Line Description 145 Setting a Rule for 145 Excluding Inherited Substitutions 0 0 0 ee eee 145 Applying a Substitution to a Structured Text Char
39. Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for the Substitutions current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 154 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 154 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 153 Chapter 7 154 The Library Designer Plug in Decorating Library Object Elements Changing the Add On Instruction Description Ina typical application Add On Instruction descriptions have a user accessible Parameter applied as a Substitution to the original text string This allows the user to assign instance specific identification to the Add On Instruction when it is added to an ACM Project Substitutions can also be inherited from the Library Object the Project Library Object or the Controller Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Definition field of an Add On Instruction Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements ar
40. Graphic User Interface HMI Human Machine Interface 1 0 Input Output LOM Library Object Manager ME Machine Edition SE Site Edition XML Extensible Markup Language Export format XML file extension Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 11 Preface Notes 12 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives Design Process Chapter 1 The Library Designer Plug in and the Library Object Manager Application Overview This chapter provides information on the following topics e Design Process e Features of the Library Designer Plug in e Library Objects Types of Decoration e Applying Decoration to Library Object Elements e Design Automation Concept The Studio 5000 Application Code Manager ACM design process introduces a modular Object based approach to the creation of ACD controller code Factorylalk View SE ME display content FactoryTalk Historian Tag and FactoryTalk Alarms and Events FTAE import configuration The Studio 5000 ACM design process separates function and configuration into two separate layers of data and divides the design process into two distinct workflows Library Management and Project Execution The design process involves a suite of applications and plug ins e The Studio 5000 Logix Designer application e The Library Designer plug in The Library Object Manager LOM application The Application Code Ma
41. Mode Pull down menu Determines whether the Substitution search feature is searching for a text string or numeric value Text searches for a text string in all locations Operand limits the search to text strings within the name or description of an instruction that is part of a Routine 2 Enter the values for the new Substitution 3 Click OK to add the new Substitution or Cancel to cancel The Member Selector To open the Member Selector window click Ellipsis to the right of the Replacement field in the Add new Substitution window The Member Selector window opens The Member Selector window gives quick access to all decorative elements available as replacements All Parameters and Functions added to the current Library Object as well as Parameters and Functions added to Library Objects higher in the Library Object hierarchy are displayed in the window Saved Functions and Predefined Parameters are also displayed Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 93 Chapter 5 94 The Library Designer Plug in Decorating Library Objects The decorative elements are organized in tabs with the same features as the tabs in the Decorator Panel Refer to The Parameters Tab on page 63 The Functions Tab on page 77 and The Predefined Tab on page 96 Member Selector amp FindPartial Parameters Functions Saved Functions Predefined Name Scope Default Value Min M Lab Controller Lab Digita
42. Module A Module registers as Hardware rather than Software in the Application Code Manager application Base Library Checkbox Allows you to select an existing Library Object in the Library Object hierarchy as a Base Library When a Base Library is selected the current Library Object inherits Substitutions from the Base Library and the Expression Builder accesses all Custom Properties of the Base Library when used in the current Library Object When NONE is selected the current Library Object does not inherit Custom Properties Instantiation Text entry Sets the default name for each instantiation of the Library Object The Default Name value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Instantiation Text entry Sets the default description for each instantiation of the Library Object Default The value can be entered manually or generated by an Expression To Description create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 55 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object Description Sets the default substitution for a text
43. Publication LOGIX UMOOGA EN P October 2015 41 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object Inclusions 42 Mouse over a menu item to make it active Mouse over a second time to make it inactive The pull down menu must be reopened after each selection a Library Object Designer 5 Inclusions Selecte Add Children 9 08 Add Dependencies v Allow Shared Ownership Ex The following table describes each Inclusions pull down menu command Add Children When this command is active all elements contained within the selected item in the Selected Object Tree View will be included when it is added to a Library Object Add Dependencies When this command is active all elements referenced by the selected item in the Selected Object Tree View will be included when it is added to a Library Object Allow Shared Ownership When this command is active the selected item in the Selected Object Tree View may be added to more than one Library Object When it is inactive the selected item may only be added to one Library Object This example shows the elements included when a Two State Valve Object Program is added to a Library Object under the following conditions e Add Children and Add Dependencies deactivated e Add Children activated e Add Children and Add Dependencies both activated With Add Children and Add Dependencies deactivated the valve Prog
44. Reference 1 Click the Tag name to highlight it 2 Right click the highlighted name to open the contextual menu Select Add External Reference The Reference Builder window opens TIP All fields other than the Description field are filled in by default In a typical application the default values should not be changed Refer to Adding a New External Reference on page 100 3 Click OK to add the External Reference The new External Reference is added to the External References tab for the Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 151 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying Decoration to Motion Group Tag Values Follow these steps to apply decoration to a Tag value 1 2 Click within the Value Expression column for the Tag listing Right click to open the contextual menu Select Add Edit Expression The Expression Builder window opens Edit the Expression Refer to The Library Designer Plug in The Expression Builder on page 103 Click OK to add the Expression The Expression token appears in the Value Expression column for the Tag indicating that the Tag will now use the Expression to generate values Decoration tokens appear as blue Follow these steps to edit the decoration applied to a Tag 4 Click within the Value Expression column for the Tag listing Right click to open the contextual menu Select Add Edit Ex
45. Rung will extend to Directives contained by the Rung Follow these steps to apply a Substitution to a Rung 1 Select Substitution TIP The Substitution command does not respond if more than one Rung is selected 2 Refer to The Substitution Builder on page 112 Activating and Deactivating Rungs Follow these steps to deactivate one or more Rungs 1 Use the menu commands to select the Rungs to deactivate You can also select multiple Rungs by holding down the CONTROL key 2 Right click again on one of the selected Rung names to open the contextual menu 3 Select Remove or click Remove at the top of the Decorator Panel The Clear Directives window opens Clear Directives A Clear directives from all selected objects E 4 Click OK to deactivate the Rungs or Cancel to cancel The selected Rungs appear dimmed Follow these steps to reactivate one or more deactivated Rungs 1 Select the Rung name Right click to open the contextual menu 2 Ifnecessary use the menu commands to select additional Rungs 3 Select Undo Follow these steps to reapply a deactivation to one or more Rungs 1 Select the Rung name Right click to open the contextual menu 2 Ifnecessary use the menu commands to select additional Rungs 3 Select Redo 126 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying Decoration to a Dir
46. Slot Address RPI or Adding a Module Tagas a Adding a Module Tag as an External Reference Applying Decoration to Module Tag Values Chapter 8 Chapter Objectives nesei ere ina e teu et Beh Rust uta eure eae s Features of the Library Object Manager Application Opening the Library Object Manager Application The Main Graphic User Interface 5 eo ded etude inst asa d Setting the Default Options for Library Object Classification Resizing the Main Graphic User Interface Resizing the Columns in the The Library Repositories Tree View The Library Content Tree View ie oisi se E X ee tees The Properties Panel ucro mean dere dread ce esee ovra cade bene ENT Rockwell Automation Publication LOGIX UMO06A EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects The Library Object Manager Application Adding Library Content toa Library Object Table of Contents Chapter 9 Chapter OB jectives 2 c some CREATE 171 The Library Object Manager Application Functions 171 Adding and Mounting an ACD Repository 172 Unmounting an ACD Repository
47. SubObjectCount True False Or And Not lt gt amp gt gt lt lt amp The following table describes the functions and operators in the Expression Builder Name Description Functions Elements are inserted into these functions to replace the lt value gt token Format Inserts Format lt value gt lt style gt lt valueDatalype gt Returns the value entered in lt value gt using the numeric format entered in lt style gt Style options are Decimal Hexadecimal Currency Scientific Fixed point General Number Percent Data type options are Int Real DateTime Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in The Expression Builder Chapter 6 Name Description Modulus Inserts Modulus lt value1 gt lt value2 gt Returns the remainder after the value of the decorative element inserted as lt value1 gt is divided by the value of the decorative element inserted as lt value2 gt Round Inserts Round lt value gt Returns the rounded value of the decorative element inserted as lt value gt Abs Inserts Abs lt value gt Returns the absolute value of the decorative element inserted as lt value gt Length Inserts Length lt value gt Returns the text string length of the decorative element inserted as lt value gt GetParameterMax Inserts GetParameterMax ObjectName SubObj
48. Tag When a Controller or Local Tag is selected the Decorator Panel display has two functional areas The bottom half of the panel displays the Tag and its members Name ObjectName Description ObjectDescription Description Language en US Library Object Lab Valve Logix Path Lab WM ProcessObjects Tags XV100 Configure Instantiation Rules Condition Always Usage One per object Exclude Base Library Substitutions Exclude Library Substitutions Name Data Type Value xv100 EnableIn EnableOut Inp OpenLS Inp ClosedLS Inp PermOK Inp NBPermOK Inp IntlkOK Inn NBIntlkOK eer OOO The following table describes the fields in the top half of the Decorator Panel when a Tag is selected Name Field Type Description Name Text entry The name that will be applied to the Tag when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Tag name these are applied by default Refer to Changing the Tag Name or Description on page 117 Description Text entry The description that will be applied to the Tag when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Tag description these are applied by default Refer to Changing the Tag Name or Description on page 117 Description Language Pull down The language used for the descripti
49. a listing of all existing messages when the Messages subfolder is selected Select a message listing to highlight it 3 Right click the listing to open the contextual menu Select Delete 206 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content to a Library Object Chapter 10 Changing the Tag Update Rate for a Digital Alarm Follow these steps to change the Tag update rate 1 Click the Tag Update subfolder to select it 2 The Properties panel displays a listing of the default tag update rate for all existing Digital Alarms Select a Digital Alarm listing to highlight it 3 Right click to open the contextual menu Mouse over Change Update Rate to display the pull down list of update values Select a new value Properties Update Rate Tag Name 2 Change Update Um gt 0 10 0 25 0 50 1 2 5 10 20 30 60 120 Deleting a Digital Alarm from a Library Object Follow these steps to delete a Digital Alarm 1 Click the Digital Alarm to highlight it Right click to open the contextual menu 2 Select Delete Adding FactoryTalk Historian Follow these steps to add FactoryTalk Historian content Content to a Library Object IMPORTANT _ Refer to the documentation on FactoryTalk Historian for more information on the screens and fields associated with FactoryTalk Historian content 1 Click the Library Object
50. an option Once per sub object SubObject name for each SubObject Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 132 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 132 The following table describes the commands in the contextual menu Substitutions Opens the Substitution Builder Select By Selects all elements in the diagram Has Directives Select By Deselects all elements in the diagram No Directives Select By Selects all elements where the Usage field has been set to Include Once per Object Repeat per Object Select By Selects all elements where the Usage field has been set to Include Once per SubObject Repeat per SubObject Select By Selects all elements where the Usage field has been set to Include Once Repeat per Include Once Select By Selects all elements where the Condition field matches the option selected in the Conditional Inclusion submenu Submenu displays all conditional inclusions rules for the current diagram Select Same Selects additional elements that match the Usage field for the currently selected element Repeat Per Select Same Selects additional elem
51. appears dimmed Follow these steps to reactivate a line 1 Select the line Hold down the SHIFT or CONTROL key to select multiple lines 2 Click Add at the top of the Decorator Panel When Motion Group is selected the Decorator Panel display has one functional area Name ObjectName Description Description Language Library Object motion Logix Path MotionSFC Tags group1 Configure instantiation Rules Condition Always Usage One per object nA Exclude Base Library Substitutions Exclude Library Substitutions Name Data Type Value Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 The following table describes the fields in the top half of the Decorator Panel when a Motion Group is selected Name Field Type Description Name Text entry The name that will be applied to the Motion Group when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Motion Group name these are applied by default Refer to Changing the Motion Group Name or Description on page 147 Description Text entry The description that will be applied to the Motion Group when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Motion Group description these are appl
52. contains Child Objects all of the Child Objects are listed as well in the Library Ownership window The Library Ownership window displays the selected item together with any Child Objects The listing includes the Object type and the Library Object or Objects the item is associated with Owner Library Items with multiple Library Object associations show multiple listings Library Ownership koa Name Type Owner Library Navigate Gg Val lves TwoState Program Lab Valve B psXV100 lOFault AND Tag Lab Valve IE psXV100 lOFault NOT Lab Valve MainRoutine Routine Lab_Valve aa_Interlocks Routine Lab_Valve aa Permissives Routine Lab Valve B5 Bi Xv100 Routine Lab Valve B f Sheet 1 Sheet Lab Valve IE _ J jJ 3 Click Navigate for a listing to open the Owner Library and display the Decorator Panel for the selected item This allows you to see the specific association for the listed item where it is located in the Library Object structure and the context of its inclusion in the Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 45 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object Adding a Selected Object Use one of the following procedures to add an item in the Selected Objects Tree Libra ry Object View to a Library Object Adding a Selected Object to a Library Object by Clicking the Add S
53. contextual menu also allows you to create a new blank Project or Controller Library Object e Project and Controller Library Objects are placed higher in the Library Object hierarchy for the ACD file Project Library Objects include default Parameters and Substitutions Substitutions added to these Library Objects extend to other Library Objects e Only Project and Controller Library Object can exist within an ACD file If the ACD file already contains a Project or Controller Library Object these commands will appear dimmed in the menu Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Adding a Selected Object to a Library Object The New Library window opens Chapter 4 New Library Library Attributes Catalog Number Library Description Type Module Base Library Lab_Controller X Instantiation Default Name Motors Default Description Substitutions Name Motors gt Description ObjectName ObjectDescription OK Cancel The New Library window has the following fields Name Field Type Description Catalog Number Text entry The Library Object name which appears when the Library Object is registered in the Application Code Manager application Library Object Text entry The description of the Library Object Description Type Module Checkbox This checkbox identifies the Library Object as a
54. delete an External Reference 1 Right click the External Reference Select Delete The Warning window opens Warning Delete selected references 2 To finish the deletion click Yes To cancel the deletion click No Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter 6 The Library Designer Plug in The Expression Builder Cha pter Objectives This chapter provides information on the following topics The Expression Builder The Expression Builder Window e The Decorative Elements Tabs The Predefined Functions and Operators The Expression Box e The Button Bar e Creating an Expression The Expression Builder An Expression is a one line statement that generates a single calculated result Expressions can return a string numeric or Boolean value and generate values automatically during instantiation Expressions can incorporate any decorative element that is available to the current Library Object element as well as a set of logical and mathematical operators text strings and numeric characters Decorative elements and functions display as tokens with the following format Element Name Expressions can be used in any field in the Library Designer plug in that accepts a calculated result These fields display an Ellipsis button to the right The Expression Builder opens when the Ellipsis button is clicked Library Attributes Catalog Number Lab_M
55. for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e If no Substitutions have been added to the Library Object the field reverts to the original value for the element Adding a Motion Group Tag as a Parameter Adding a Tag or Tag Member as a Parameter makes the Tag value accessible to the Application Code Manager ACM application 1 Click the Tag name to highlight it 2 Right click the highlighted name to open the contextual menu Select Add as Parameter The Add new Parameter window opens 3 Edit the Parameter Some fields will be filled with default values based on the Tag settings Refer to Adding a New Parameter on page 70 for fields and settings available in the window 4 Click to add the Parameter The new Parameter is added to the Parameters tab for the Library Object The token for the new Parameter appears in the Value Expression column for the Tag indicating that the Tag will now accept values from the Parameter Decoration tokens appear as blue Adding a Motion Group Tag as an External Reference Adding a Tag or Tag Member as an External Reference makes the Tag value accessible to reference type Parameters in ACM Follow these steps to add a Tag as an External
56. in the Library Content column to select it Right click to open the contextual menu Library Content EB Lab Motor 1 mu Library Icd Add Section 53 FT View EH Revision FTAE Help Doc Expand All Definition Collapse amp FT Historian pon ome e 2 Select Add Section FT Historian An FT Historian folder with a subfolder for Historian Tags is added to the Library Object Library Content 5 15 Lab Motor 1 0 Library Icon Revision History Help Document Definition Data Agr Logix 1 53 FT Historian Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 207 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Adding a Historian Tag to a Library Object Follow these steps to add a Historian Tag 1 Click the Historian Tags subfolder to select it Right click to open the contextual menu Library Content 5 15 Lab Motor 1 0 Library Icon 8 8 Revision History El Help Document H E Definition Data 48 Logix 5 80 FT Historian gt Delete Expand All Collapse 4 Tag Browser ES Ec c Select the Alarm Trigger Tag Selectable Type Bool Enter Name Filter Show All Tags Data 2 EH f val Owner DINT EH fl Notify SINT Hf Sts Stopped BOOL fl Sts Starting BOOL Hf 515 Stopping BOOL f Sts Available BOOL E Hf Sts_Bypass BOOL
57. is an argument that is not exposed to external access The value of a Function is generated by user defined logic created in the Library Designer plug in and by conditions that apply during instantiation Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in and the Library Object Manager Application Overview Chapter 1 A Function can be either Conditional or Calculated e Conditional Function returns one of multiple possible results generated by Expressions and based on IF ELSE ELSEIF logic A Conditional Function allows for multiple branches and nesting e A Calculated Function generates a single value based on a single Expression Both types of Function are created using the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Functions can be copied between Library Objects and between Library Objects of different scope as long as the decorative elements used in the Expressions are common to both Library Objects Functions can be saved within the Library Object Manager application Saved Functions are available to all Projects opened in the Library Designer plug in Substitutions Substitution is a user defined rule which during instantiation replaces a text string in the name description instantiation location or other attribute ofa Library Object element with a Parameter value calculation result or referenced value IMPORTANT Substit
58. manually This is a required field 02 Library Details CatalogNumber Text entry The Library Object name which appears together with the revision number in the Library Object listing when the Library Object is registered in ACM This is entered manually This is a required field Library Object Text entry The description of the Library Object Description This is a required field Family Pull down menu The Family for the Library Object This is a required field Solution Pull down menu The Solution for the Library Object Refer to The Library Management Workflow on page 13 for more information on the naming conventions for Library Objects This is a required field Library Type Pull down menu The Library Type for the Library Object Refer to The Library Management Workflow on page 13 for more information on the naming conventions for Library Objects This is a required field Category Pull down menu The Category for the Library Object Refer to The Library Management Workflow on page 13 for more information on the naming conventions for Library Objects This is a required field Owner Text entry The user or entity that originally published the Library Object This is a required field Major Revision Text entry integer The major revision number for the Library Object For a new Library Object this defaults to 1 Minor Revision Text entry integer The minor revision number for the Library Object For a new Library Object thi
59. open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition ficld Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 117 Chapter7 Library Designer Plug in Decorating Library Object Elements Adding a Tag as a Parameter Adding a Tag or Tag Member as a Parameter makes the Tag value accessible to the Application Code Manager ACM application Follow these steps to add a Tag as a Parameter 1 2 Click the Tag name to highlight it Right click the highlighted name to open the contextual menu Select Add as Parameter The Add new Parameter window opens Edit the Parameter Some fields will be filled with default values based on the Tag settings Refer to Adding a New Parameter on page 70 for fields and settings available in the window Click OK to add the Parameter The new Parameter is added to the Parameters tab for the Library Object The token for the new Parameter appears in the Value Expression column for the Tag indicating that the Tag will now accept values from the Parameter Decoration tokens appear as blue Adding a Tag as an External Reference Adding a Tag or Tag Member as an External Reference makes the Tag value acces
60. original text string This allows the user to assign instance specific identification to the Motion Group Axis when it is added to an ACM Project Substitutions can also be inherited from the Library Object the Project Library Object or the Controller Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Name or Definition field of a Motion Group Axis Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value
61. page 103 Auto Populate Checkbox When checked automatically creates multiple instances of the SubObject during instantiation The following steps must be followed for Auto Populate to take place There must be a Parameter contained in the SubObject with the Data Type field set to INT This field generates sequential identity numbers for each instance of the SubObject A value must be entered in the Min and Max fields for the Parameter The AutoIncrement field must be set to TRUE 2 Enter the values for the new SubObject 3 Click OK to add the new SubObject or Cancel to cancel 68 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Moving a Parameter within a Group Follow these steps to move a Parameter within a group 1 Select the Parameter 2 Doone of the following a Click Move Up or Move Down b Right click the Parameter to display the contextual menu Select Move Up or Move Down TIP You cannot move a Parameter outside of its group Copying a Parameter A Parameter can be copied to a different Library Object or can be used as a template for a new Parameter Follow these steps to copy a Parameter to a different Library Object 1 Select the Parameter TIP You can select multiple Parameters using the SHIFT or CONTROL keys 2 Right click the Parameter to open the contextual menu Select Copy 3 Open the Libra
62. positioning guarantees that the overall configuration of the Symbols in a display will match the original configuration created in FactoryTalk View Studio Follow these steps to apply absolute positioning to a Symbol 1 Click the SE Symbols or ME Symbols folder to select it Right click to open the contextual menu 2 Select Add The Symbol Builder window opens 3 Locate the Symbol you wish to add Uncheck all of the Position options in the Apply Substitutions area Leave the Name Prefix option checked 1 Symbol Builder fog Select Display Export File EATech Support StuffiSample Displays ov_Motors xml Select Root Node s of Symbol Name Type a F Group2 group HH GO P Motor _ group 3 HH GO P Motor Fan D group E GO_P_Motor_RPump_U group GO_P_Motor_Pump_U group HHGO Motor Pump L group GO Pump_R Motor AlarmPolygon13 rectangle Motor Touchpoint13 rectangle Motor QuickTouchpoint13 rectangle a Damm eniin EPA 4 Apply Substitutioi ame Prefix Left Position Line Position Arc Position 4 After the Symbol has been added review the XML code 5 Locate the Left and Top Parameters in the code The values for both are numeric Check that they match the desired display position for the Symbol or modify if necessary Relative positioning adds Symbols to a display starting at the top left corner moving left to r
63. pull down menu initiates a search for Functions that match text string FindPartial you enter in the field Using the Find Feature The Find feature limits the display in the Functions Tab to Functions that match the text string entered in the field columns currently being displayed are searched The following table describes the options in the Find pull down menu FindPartial Searches for the text string in any part of an entry FindPrefix Searches for the text string at the beginning of an entry Follow these steps to limit the display based on a text string 1 Select the Search option in the Find pull down menu 2 Type the text string to search for in the entry field to the right in 4 FindPartial Parameters Functions Substitutions Predefir Name Lab_WashMachine FC_HeatingCoifAvpilable The Functions Tab display reacts dynamically to the text string entered returning a shorter list of matching Functions as the text string grows TIP You must delete the text in the entry field to return the display to all Functions Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 79 Chapter 5 80 The Library Designer Plug in Decorating Library Objects Copying a Function A Function can be copied to a different Library Object or can be used as a template for a new Function Follow these steps to copy a Function to a different Library Object 1
64. string in the Library Object name when the Library Object is instantiated This string can be the complete name ora substring within the name The substitution extends to the names of all elements within the Library Object By default the Library Object Manager application assigns the Predefined Parameter ObjectName as the Substitution for the entered string Name Field Type Substitutions Text entry Name Substitutions Text entry Description Sets the default substitution for a text string in the Library Object description when the Library Object is instantiated This string can be the complete description or a substring within the description The substitution extends to the descriptions of all elements within the Library Object By default the Library Object Manager application assigns the Predefined Parameter ObjectDescription as the Substitution for the entered string 2 Enter the Catalog Number name and Description of the Library Object in the respective fields IMPORTANT The Catalog Number is the only required field and must be unique within the ACD file 3 Ifthe Library Object defines a Hardware component rather than a Software component check the Module checkbox Modules are identified as Hardware when the Library Object is added to an ACM Project Select a Base Library from the Base Library pull down menu if you want the new Library Object to inherit substitutions from an existing Library Object Se
65. the current Library Object ParentChassisSlot Integer For Module Library Objects only The chassis slot of the current Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 The Predefined Tab Button Bar The Predefined Tab Button Bar is shown below f FindPartial The following table describes each Predefined Tab Button Bar command The Add New button is deactivated for this tab The Move Up Move Down buttons are deactivated for this tab The Find pull down menu initiates a search for Substitutions that match a text FindPartial string you enter in the field Using the Find Feature The Find feature limits the display in the Predefined Tab to Predefined Parameters that match the text string entered in the field All columns currently being displayed are searched The following table describes the options in the Find pull down menu FindPartial Searches for the text string in any part of an entry FindPrefix Searches for the text string at the beginning of an entry Follow these steps to limit the display based on a text string 1 Select the Search option in the Find pull down menu 2 Type the text string to search for in the entry field to the right FindPartial Pro Parameters Functions Substitutions Predefined External Refi Name Scope Data Type Global
66. to Changing the Routine Name or Description on page 123 Description Language Pull down The language used for the description The default is English menu Library Object Read only The Library Object that contains the Routine Logix Path Read only link A link to the Edit screen for the Routine in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Instantiation Text entry Sets the condition under which the current Routine is instantiated Rules Default is Always A condition can be entered manually or generated Condition by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 123 Configure Instantiation Pull down The number of times the Routine will be instantiated Default is Once Rules menu per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Changing the Routine Name or Description on page 123 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Sub
67. when the Library Object is instantiated Include Condition Text entry Sets the condition under which the current Symbol is instantiated The default is Always A condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 193 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Name Field Type Description Source Text Text entry The editable XML code of the Symbol The XML code includes all Substitutions applied by the Apply Substitutions checkboxes when the Symbol was imported Apply Substitutions Text entry A text string to replace with a Substitution Find Apply Substitutions Text entry The text that will replace the text string in the Find field Replace Apply Substitution Button Applies the Substitution IMPORTANT Default Substitutions in the XML code include the Name attribute and the Left and Top attributes Changing the Symbol Name In a typical application the default name should be used Alternatively a name can be entered manually in the Name field Setting a Rule for Instantiation By default Symbols are set to instantiate under all conditions and to instantiate once every time the Library Object is ad
68. when the Parent and Child Objects are associated with different Library Objects When selected the Child Object is reassigned to the same Library Object as its Parent Object When you select Delete decoration the Object is removed from all existing Library associations The Object displays in the Selected Object column as black indicating it is no longer decorated The Object can be added to a different Library Object or used to create a new Library Object When you select Re assign decoration the Object is reassigned to the same Library Object that its Parent Object is associated with All existing decoration is removed or replaced by decoration inherited from the Parent Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Adding a Selected Object to Library Object Chapter 4 Listing Ownership for a Selected Object The Library Ownership window displays all Library Object associations for items in the Selected Objects column Follow these steps to see the Library Ownership for an item 1 Select the item in the Selected Objects column 2 Right click to open the contextual menu Select Library Ownership The Library Ownership window opens Selected Objects Controller Lab WM ProcessObiects 5 63 Tasks a fia MainTask 69 PO DeviceControl 9 08 Analoginputs H Digitalinputs CB DigitalOutputs E Library Ownership TIP When an Object is selected that
69. which the current Motion Group Axis is Instantiation Rules instantiated Default is Always A condition can be entered manually or Condition generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 150 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 149 Chapter 7 150 The Library Designer Plug in Decorating Library Object Elements Name Field Type Description Configure Pull down The number of times the Motion Group Axis will be instantiated Default Instantiation Rules menu is Once per Object Default options are Usage One per Object e Include Once If the containing Library Object has SubObjects there will also be an option Once per sub object SubObject name for each SubObject Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for the Substitutions current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 151 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to be Substitutions overridden Refer to Excluding Inherited Substitutions on page 151 Changing the Motion Group Axis Name or Description In a typical application Motion Group Axis names and descriptions have a user accessible Parameter applied as a Substitution to the
70. 10 Viewing the Logix Code of a Library Object Follow these steps to view the Logix code for a Library Object 1 Select a Library Object in a Folder or Database Repository The Library Content column and Properties panel activate 2 Click the Logix listing in the Library Content column The complete line by line code for the Library Object displays in the Properties panel Library Object Manager Library Repositories Data Container 54 Libraries Instance Data 5 89 Desktop New_Lab 2 54 Libraries H a ProObj 2 9 08 localhoshSQLACM Libraries E ProObj 8 B Project 1 EC All Industries 1 Lab Project 1 0 Controller 1 6E Controller 1 Lab_Controller 1 2 Module 1 1 2 ControlModule 4 Digital 1 amp 2 Analog 1 2 04 Motor 1 13 H E Valve 1 8 2 DesignPattern 1 W Speciality 1 5E v0 0 Global 2 F a Module 2 6 Digital 2 Ld 1756 0B32 1 1 4 rm 2 Library Content Properties 51 15 Lab Motor 1 3 lt gt Library Icon E lt AddOnInstructionDefinitions UId D652CZF ParentUId BSFFSBO4 gt Revision History AddOnInstructionDefinition Name P Motor UId 88549881 ParentUId D652C2FA Bl Help Document lt CustomProperties gt a ose Definition Data B Provider ID ACH gt Wc B DecoratedData xmlns xsi http www w3 org 2001 XMLS
71. 4 Application Code Manager ACM 13 16 162 B Base Library 50 88 C conditional inclusion 16 Controller 13 Controller Organizer tree 24 D Data Type 155 data type 14 18 24 Boolean 18 integer 18 real 18 string 18 decoration 14 16 17 18 59 111 applying 21 decorative element 16 20 103 decorative element token 20 63 103 design process 13 Directive 127 128 E Expression 16 17 103 111 description 20 entering manually 104 instantiation 20 naming conventions 103 Expression Builder 17 19 21 34 50 56 77 95 103 104 111 applying an Expression 110 button bar 108 creating an Expression 108 decorative elements tabs 105 Expression box 108 Index Expression box fields and buttons 108 Expressions tab 106 functions and operators 106 Predefined Functions and Operators tab 106 saved Expressions 106 saving an Expression 110 setting the result type 109 tooltip 107 validating and testing 109 Expression Builder fields 105 External Reference 16 17 112 151 158 190 description 20 98 F FactoryTalk Alarms and Events FTAE 161 163 189 200 FactoryTalk documentation 189 FactoryTalk Historian SE 15 161 163 189 207 FactoryTalk View ME 15 161 163 189 191 FactoryTalk View SE 15 161 163 189 191 FactoryTalk View Studio Global Object Parameter Values window 195 Function 16 17 105 111 190 calculated 19 77 conditional 19 77 adding branches to a statement 85 deleting a branch from
72. Automation Publication LOGIX UMO06A EN P October 2015 111 Chapter7 Library Designer Plug in Decorating Library Object Elements Adding Ta gs as Parameters or The Decorator Panel also allows you to quickly and accurately turn static External References The Substitution Builder 112 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 ACM 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 ACM Project Regardless of which element has been selected the top two fields displayed by the Decorator Panel are the Name and Description fields for the element If Substitutions have been added to the containing Library Object or to Library Objects that are higher in the Project hierarchy they are applied by default To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the L
73. Builder Chapter 6 Setting the Result Type of an Expression To set the result type of an Expression click the String Boolean or Numeric radio button in the Result Type field IMPORTANT If the current field where the Expression will be applied has a predefined data type the Result Type field will be set to match this data type and will appear dimmed Validating and Testing an Expression The Validate and Test buttons allow you to validate an Expression for internal syntax and data type and to test an Expression for the result returned To validate an Expression click Validate The validation bar displays the result of the validation Ifthe validation passes the validation bar displays with a green background Expression Result Type Validat ModelType Delux String Boolean Test Numeric Save e Ifthe validation fails the validation bar displays an error message with a red background Expression E Abs Cfg_TransitStallT gt 10 Sane Boolean Test Numeric Save Unknown variable Cfg TransitStallT at position 17 Ensure all string parameters and string literals are enclosed Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 109 Chapter 6 110 The Library Designer Plug in The Expression Builder To test the Expression click Test The Expression Test window opens and displays the current result of the Expression Original Expression
74. Copy Right click the Library Object folder to open the contextual menu Select Paste The selection is added at the appropriate locations within the existing Library Objects structure The new elements inherit all applicable Substitutions from the Library Object IMPORTANT Default Substitutions are inherited automatically Overrides to the default Substitution and all other decoration must be applied manually to new elements of an existing Library Object Alternatively a new Library Object can be created that includes the modified elements since any Logix Object can be used to create multiple Library Objects The two Library Objects will be saved with different Version Numbers when they are added to a Repository in the Library Object Manager application Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Adding a Module to a Library Object The Library Designer Plug in Adding a Selected Object to a Library Object Chapter 4 Module Objects are listed in the Selected Object View Tree under the I O Configuration node These Objects may be added to a Library Object using any of the three procedures The Library Designer plug in recognizes the selected Object as a Module and opens the Module Wizard The Module Wizard generates default Parameters and SubObjects for the Library Object based on the controller code for the Module This decoration conforms to standards of the Studio 5000 Logix Designer design process You can a
75. Filter Visible True Disabled ReadOnly False Name Enter the parameter name must be unique within its scope Amy Hep Editable fields display within an active editing widget such as a text box of a pull down menu Fields which are locked for editing display with a white background Fields which can accept calculated values show the Ellipsis button to the right Clicking this button opens the Expression Builder or the Tag Browser Refer to The Library Designer Plug in The Expression Builder on page 103 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 167 Chapter8 The Library Object Manager Application Properties Panel with a Parameter selected Fields are read only Properties 4 01 General Name Cfg_HasPermObj Library Designer Parameter Parameter Help 1 Has Permissive Object Data Type Bool 4 02 Reference Reference Type Immediate 4 03 Data Default Value 1 Append 4 04 Userinterface Group 02 Device Configuration Filter Visible True Disabled ReadOnly False Parameter Help Enter the parameter description Properties Panel with a Historian Tag selected Fields are editable Properties Tag Name ControllerName Program ProgramName ps Include Condition noi SC ps ObjectName lOFautt ANDY Scan Class SC ps ObjectName lOFault Descriptor Engineering Units Instrument Tag HistorianPath
76. GIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects 9 3 Select Open ACD The file opens in the Logix Designer application Library Repositories Library amp Repositories Lab_WM_ProcessObje Unmount Open ACD Launch Library Designer Export to L5X Remove Refresh Expand All Collapse 4 When you have completed modifications to the file close it in the Logix Designer application You will then be able to mount it in the Library Object Manager application IMPORTANT Modifications to the ACD file are saved to the file but are not saved to Library Objects that have already been published to Folders or the ACM Database You will need to generate new versions of the Library Object to incorporate the most recent modifications Editing an ACD Repository in the Library Designer Plug in You can move directly between the Library Object Manager application the Library Designer plug in and the Logix Designer application when working with a file Follow these steps to move from the Library Object Manager application to the Library Designer plug in 1 Click the repository to make it active If necessary mount the repository 2 Right click to open the contextual menu Select Launch Library Designer 3 The file opens in the Library Designer plug in When you have completed modifications to the file close the Library De
77. Global 2 Egg E Es ERE TIP The pointer changes to the unavailable o icon until you drag on top of a Repository icon The Library Import Configuration window opens IMPORTANT Ifyou copying the Library Object into the ACM Database the new Library Object will be compared to all Library Objects with the same CatalogNumber that are currently stored in the database and many of the fields in the Library Import Configuration window will be filled in by the database You will not be able to edit these fields Q Library Import Configuration Jc m Import Catalog Number Operation Family Solution Library Type Category Revision New Revision Existing Libraries Lab Valve Update Logix ProObj ControlModule Valve 1 2 1 3 4 01 Revision History Revision Description 4 02 Library Details CatalogNumber Lab_Valve Description Solenoid Operated Valve Family Logix Solution ProObj Library Type ControlModule Category Valve Owner PFPember Major Revision 1 Minor Revision 3 03 Library Usage Rules Upstream Keys Downstream Keys Revision Description Description of any changes made to the library since the last revision Cancel Help 184 Rockwell Automation Publication LOGIX UM006A EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects Chapter 9 The Library Import Configuration window has the following fields 01 Revision Hist
78. Group e Applying Decoration to an Add On Instruction e Applying Decoration to a Data Type e Applying Decoration to a Module Any element within a Library Object that accepts decoration opens the Decorator Panel when it is selected in the Library Objects column The Decorator Panel displays the fields for the element where decoration can be applied The display changes based on the decoration available for the selected element Fields in the Decorator Panel that can be edited display with white backgrounds Fields that are locked for editing appear dimmed Fields that can accept calculated values show the Ellipsis button to the right Clicking the button opens one of the Expression Builder windows Ina typical application Substitutions added to the Library Object extend to names and descriptions for all elements contained within the Library Object This allows for consistent identification of all elements within each instance of the Library Object that is added to an ACM Project Parameters Functions and Expressions can be applied as conditions for instantiation to populate Tags and to configure Programs Substitutions added to the Library Object as well as Substitutions added to Library Objects higher in the Library Object hierarchy are applied automatically Substitutions can be overridden through the Substitutions Builder All other decorative elements are accessed through the Expression Builder Rockwell
79. Library 208 Configuring a Historian 48 5 032 do eres neta t 209 Deleting a Historian Tag from a Library Object 211 uum eA Bars a MITIS M EUM MEE E LL ME UL 213 Rockwell Automation Publication LOGIX UMO06A EN P October 2015 Preface Objectives Purpose of This Manual Additional Resources Abbreviations Preface This preface covers the following topics Purpose of This Manual e Additional Resources e Abbreviations This manual is a user guide for the Library Designer plug in and the Library Object Manager application It provides procedures for the following e Creating Library Objects e Decorating Library Objects e Saving Library Objects and creating Library Object Repositories These documents contain additional information concerning related products from Rockwell Automation Resource Description Application Code Manager User Manual publication LOGIX UM003A EN P User manual for the Application Code Manager ACM application You can view or download publications at_ http www rockwellautomation com literature To order paper copies of technical documentation contact your local Allen Bradley distributor or Rockwell Automation sales representative The following abbreviations are used in this publication Abbr Meaning ACM Application Code Manager FT FactoryTalk FTAE FactoryTalk Alarms and Events GUI
80. OGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Name Field Type Description These fields appear if Conditional is selected in the Type field Statement Definition Condition Menu This field provides a visual representation of the Conditional Statement in menu form Click a menu item to make its statement field active The Function Builder window can display at most one If this expression is true and one Return this value field at a time You must select each line in the Conditional Statement menu to access the statement fields for that line Click the Plus Icon to the left of a menu item to expand the listing This icon appears when there are nested statements within the item Click the Minus Icon to the left of a menu item to collapse the listing This icon appears when there are nested statements within the item Use the scroll bar to access additional menu items if the Conditional Statement menu has grown too large to fit in the window Ifthis expressionis Text entry The condition being tested The value can be entered manually or true generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder This is a required field when Conditional has been selected in the Type field Return this value Text entry The value used if the condition returns TRUE The value can be entered manually or generated by an Expres
81. Once Exclude Base Library Substitutions Exclude Library Substitutions ump To Subroutine Routine Name ObjectName 100 J 36 Rockwell Automation Publication LOGIX UM006A EN P October 2015 The Library Designer Plug in Main Graphic User Interface Chapter 3 Decorator Panel Function Block Sheet Selected Refer to Applying Decoration to a Sheet on page 128 Add Remove Name Sheet 1 Description ObjectName ObjectDescription Description Language Library Object Valve Logix Path ProcessObjects Task D 500ms Valve XV003 Sheet Configure instantiation Rules Condition Always x Usage One per object hd Exclude Base Library Substitutions Exclude Library Substitutions En ClosedLS n um ObjectName Perm P Perm Inp Perm00 Sts PermOK Inp_Perm01 515 NBPermOK 00 7 Inp Perm02 Sts Perm Inp Perm03 Inp Perm04 4 100 0 Decorator Panel Add On Instruction Selected Refer to Applying Decoration to an Add On Instruction on page 153 Name P_Alarm Description Alarm Description Language Library Object Valve Logix Path ProcessObjects AddOnInstructionDefinitions P_Alarm Configure Instantiation Rules Condition Always Exclude Base Library Substitutions _ Exclude Library Substitutions Name Us
82. P When you mouse over a predefined function or operator a tooltip appears displaying input options for that function or operator Predefined Functions and Operators Format Modulus Round Abs Length GetParameterMax CalcBitNumber SubObjectCc Tni Returns lt value gt formatted according to the lt style gt expression pre s INT REAL and DateTime formatting Type Strin REAL result 12 34 esult 03 45 Boolean 3 Numeric 2015 MMMM dad yyyy DateTime gt result June 24 2015 using standard microsoft styles D Decima 12345 X Hexadecimal FFFFCFC7 rM a seat cape Cancel C Currency pe unnm E Scientific F Fixed point General default Number 2 P Percent Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 107 Chapter6 Library Designer Plug in The Expression Builder The Expression Box The Button Bar Creating an Expression 108 The Expression Box displays the Expression statement as it is created Elements of the statement can be entered manually or by clicking items in the Decorative Elements Tab or the Functions and Operators area Expression WMO01 Result Type Validate String See Boolean __ Tet Numeric Save The Expression Box has the following fields and buttons Name Description Expression The Expression appears here as elements are added to it Window Resu
83. Parameter window when the Parameter is selected in the Application Code Manager application Scope Pull down menu The Library Object that contains the Parameter The list includes all Library Objects in the Library Object tree Default value is the current Library Object Parameters can be moved to a different Library Object by changing the selection here Data Type Pull down menu The data type of the Parameter Options are Boolean String This option is only available if Reference or Calculated is selected in the Reference Type field Integer Real Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 71 Chapter 5 72 The Library Designer Plug in Decorating Library Objects Name 02 Reference Field Type Description Reference Type Pull down menu Determines whether the Parameter is accessible to user input as an entry field is populated automatically by a calculation or references other Parameters The options are Immediate Parameter is accessible to user input as an entry field Calculated Parameter is not accessible to user input Value is set to the name or description of the selected Parameter The Use Custom field allows you to set a condition which if true at instantiation makes the Parameter accessible to user input Reference Parameter references an External Reference The Parameter and the External Reference function as a Consumed and a Produced T
84. PermOK Sts Opening oo Inp NBPermOK Sts_Opened E Inp IntlkOK Sts Closina 4 rm 10096 0 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 The following table describes the fields in the top half of the Decorator Panel when a Sheet is selected Name Field Type Description Name Text entry This field is not available for editing Description Text entry The description that will be applied to the Sheet when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Sheet description these are applied by default Refer to Changing the Sheet Description on page 129 Description Language Pull down The language used for the description The default is English menu Library Object Read only The Library Object that contains the Sheet Logix Path Read only link A link to the Edit screen for the Sheet the Logix Designer application Click the link to open the screen You will need to dose the Library Designer plug in to access the Logix Designer application Configure Instantiation Text entry Sets the condition under which the current Sheet is instantiated Rules Default is Always A condition can be entered manually or generated Condition by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Buil
85. Projects or share Library Objects with other Project Engineers Completed Projects can in turn be used to create new Library Objects The Library Designer plug in allows a Librarian to perform these tasks e Creating Library Objects e Specifying the Logix content that is included in the Library Object e Decorating the Library Object with Parameters SubObjects Substitutions Functions and External References e Creating Substitutions for text strings that extend to all elements of a Library Object during instantiation e Creating Substitution overrides for specific elements e Creating mathematical and logical Expressions using decorative elements e Assigning Parameters to be populated by user input calculated values Functions and Expressions or references to other elements e Setting conditions for inclusion of any element of a Library Object during instantiation e Making Tags and Tag members accessible to the ACM application by adding them as Parameters or External References e Populating Tags based on Parameters Functions and Expressions Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Library Objects Libray Designer Plug in Studio 5000 Logix Designer Excel The Library Designer Plug in and the Library Object Manager Application Overview Chapter 1 A Library Object Library is the class definition ofan Object A Library Object is instantiated Individual Library Object files HSL4 a
86. Refer to Changing the Structured Text Chart Name or Description on page 142 Description Language Pull down The language used for the description The default is English menu Library Object Read only The Library Object that contains the Structured Text Chart Logix Path Read only link A link to the Edit screen for the Structured Text Chart in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Text entry Sets the condition under which the current Structured Text Chart is Instantiation Rules instantiated Default is Always A condition can be entered manually or Condition generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 143 Configure Pull down The number of times the Structured Text Chart will be instantiated Instantiation Rules menu Default is Once per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for the Substitutions current Library Object to be overridden Refer to Setting a Rule for Instantiation on page 143 Exclude Library Check
87. Tab 94 Editing a Substitution in the Edit Substitutions Window 95 Deleting a Substitution ee ten eee e eren 95 Predefined Parameters ire retra hr t ya xr RR ra RA 95 The Predefined Tab veul a diate bode dee E ue ees 96 The Predefined Tab Button 97 Using the Find 97 External Referetices oria era o Boa etree Ex a ada E ER aot 98 The External References 98 Changing the Columns Displayed in the External References Tab 5 oe e YR ROS 99 The External References Tab Button 99 Using the Find Feature ve Ee Ce ee RE 100 Adding New External Reference e o ets 100 Editing an External Reference ois eer ether er ER d 102 Deleting an External Reference is oseosder seg eer ern ines 102 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 5 Table of Contents The Library Designer Plug in The Expression Builder The Library Designer Plug in Decorating Library Object Elements Chapter 6 Chapter Ses ue uibs iene The Expression bee eu ETE E QUAE The Expression Builder Window 25534149 The Decorative Elements Tie Expressions elt eons The Predefined Functions and The Erpression
88. The following table describes the fields in the References window Name Library Description The Library Object for the element that references the Parameter Used in The element that references the Parameter The value is displayed in this format Element Type SubObject Name Details The specific reference point within the element Examples a field in the Edit Parameter window a conditional inclusion or the Value Expression for a Controller or Local Tag Navigate Jump button that opens the Decorator Panel for the element where the reference is located Follow these steps to view a Parameter reference 1 Click Navigate for the reference listing The Decorator Panel opens for that element 2 Click OK to close the References window TIP You must dose the References window before you can access the fields in the Decorator Panel Deleting a Parameter Follow these steps to delete a Parameter 1 Right click the Parameter Select Delete TIP Use the Show References command to list references to the Parameter before using the Delete command The Delete Objects window opens Delete Objects Object s have been selected to be permanently deleted Continue 2 To finish the deletion click Yes To cancel the deletion click No TIP You will not be able to delete the Parameter if it is referenced A warning displays Warning Cannot delete Cfg HasClosedLS as it is part of th
89. These fields appear if In teger or Real is selected in the Data Type field Min Text entry The minimum value for the Parameter The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 This is a required field Max Text entry The maximum value for the Parameter The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 This is a required field Engineering Unit Text entry A unit of measure added to the value of the parameter to provide additional context Invalid Text entry An additional condition for validation of Parameter values The condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 This field appears if Integer is selected in the Data Type field Padding TRUE FALSE pull down menu When TRUE is selected single digit integer values will be padded with zeros Rockwell Automation Publication LOGIX UMOOGA EN P October 2015
90. User Manual Allen Bradley Library Designer and Library Object Manager 2 mu a at M i mi LI Allen Bradley Rockwell Software Automation 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 u
91. _NotRdy BOOL f Sts MaintByp BOOL H 515 Alminh BOOL H Sts_Err BOOL Hf Timer BOOL E f Sim BOOL E HA Sts Hand BOOL 1 8 Sts Maint BOOL Hf Sts_Ovrd BOOL f Sts_Prog BOOL 7 Selected ObjectName Err_Alarm 3 Scroll to select the Tag that the Digital Alarm will reference Click The Tag is added Library Content 5 9 Lab Motor 1 3 Library Icon 8 8 Revision History El Help Document 4 Definition Data Logix Eig FTAE E3 Digital Alarms i ControllerName ObjectName Messages Tag Update Rates Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 201 Chapter 10 202 The Library Object Manager Application Adding Library Content to a Library Object Configuring a Digital Alarm When a Digital Alarm is selected the Properties panel displays three tabbed screens The Status Tags and Control Tags tabs match tabs in the Factory Talk Alarms and Events application Refer to the FactoryTalk Alarms and Events documentation for more information on these screens Click Apply to apply changes made in these screens The Digital tab has some fields that are exclusive to the Library Object Manager application These will be described here Properties Digital Status Tags Control Tags Name ControllerName ObjectName Err_Alarm Include Condition Always Input
92. a Child Object or Dependency to an Existing Library Object 52 When an Object which has been added to a Library Object in the Library Designer plug in is later modified in the Logix Designer application the modifications must also be added to the Library Object in the Library Designer plug in if you want the Library Object to include the new functionality For example if a valve Object has new rungs added to a contained Ladder Logic Diagram in the Logix Designer application the new rungs must also be added to the valve Library Object in the Library Designer plug in IMPORTANT Items in the Selected Objects column are color coded to indicate whether they are fully associated partially associated or not associated in the Library Designer plug in Items which have been newly created in the Logix Designer application display as black Items which have newly added associations in the Logix Designer application which have not been replicated in the Library Designer plug in display as blue Items which are fully associated display as green Follow these steps to add new Children or Dependencies to an existing Library Object 1 Select the items you want to add in the Selected Objects column TIP Hold down the SHIFT or CONTROL keys to select multiple items 2 Doone of the following a Drag the selection on top of an existing Library Object in the Library Objects column b Right click the selection to open the contextual menu Select
93. a statement 85 ELSEIF statement 85 IF statement 85 description 18 77 instantiation 18 77 naming conventions 77 references to 86 Function Block Diagram 128 130 133 146 Hardware 17 1 0 Configurations 14 inheritance 17 overriding 17 instantiation 14 16 194 204 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 213 Index 214 L Ladder Logic Diagram 123 Librarian 13 14 15 Library Designer 13 14 162 190 accessing the program 23 activating a new Function Block element 133 activating a new Sequential Function Chart element 140 adding a Child Object or Dependency to an existing Library Object 52 adding a Module Object to a Library Object 53 adding Tag as a Parameter 112 118 148 150 158 adding a Tag as an External Reference 112 applying a Substitution to a Directive 128 applying a Substitution to a Function Block element 133 applying a Substitution to a Rung 126 applying a Substitution to a Sequential Function Chart element 140 applying decoration to a Directive 127 applying decoration to a Function Block element 130 137 146 applying decoration to a Module 134 141 applying decoration to a Program 119 applying decoration to a Routine 121 applying decoration to a Rung 123 applying decoration to a Sheet 128 applying decoration to a Task 119 applying decoration to an element 144 changing element name or description 117 120 123 129 135 142 147 150 154 158
94. ag User links the Parameter to the External Reference following instantiation The Filter field can be used to set criteria for the External Reference that can be referenced Refer to External References on page 98 These fields appear if Calculated is selected in the Reference Type field Reference Linked Parameter Pull down menu Returns a list of Parameters within the Library Object where the Reference Type field has been set to Reference This is a required field Reference Field Pull down menu Returns a list of fields The options are the Name and Description field This is a required field Use Custom Text entry Allows you to set a condition which if true at instantiation overrides the default and opens the field to user input The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 03 Data Default Value Text entry The default value for the Parameter The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Append Text entry A text string that will be added to the end of the value of the Parameter
95. age Data Type Alias For Default Style Req Vis External P Alarm P Alarm False False i EnableIn Input BOOL Decimal False False Read Only E H EnableOut Output BOOL Decimal False False Read Only H Inp Input BOOL i Decimal False True Read Write H Inp Reset Input BOOL 0 Decimal False True Read Write Cfg_Exists Input BOOL T Decimal False False Read Write Cfg ResetReqd Input BOOL 0 Decimal False False Read Write H Cfg_AckReqd Input BOOL il Decimal False False Read Write H Cfg AllowShelve Input BOOL 1 Decimal False False Read Write Cfg AllowDisable Input BOOL E Decimal False False Read Write Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 37 Chapter 3 38 The Library Designer Plug in Main Graphic User Interface Decorator Panel Data Type Selected Refer to Applying Decoration to a Data Type on page 155 Name STRING_12 Description Description Language Library Object Valve Logix Path ProcessObjects DataTypes STRING 12 Configure Instantiation Rules Condition Always x Exclude Base Library Substitutions Exclude Library Substitutions Name Data Type DefaultValue Description STRING_12 STRING_12 H LEN DINT 196 DATA SINT Decorator Panel Module Selected Refer to Applying Decoration to a Module on page 157 Name ObjectName mm Library Object 1756 IF16 Logix Path Lab WM ProcessObjects Modules Vocal 01 Configure Instantiation Rules
96. al c Ifyou have selected a corner the window will resize in all directions 164 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Chapter 8 Resizing the Columns in the Interface Follow these steps to resize individual columns 1 Click and hold on the blue bar that separates the columns 2 Dragto resize TIP The overall window size remains the same so all columns will resize to accommodate the change The Library Repositories Tree The Library Repositories Tree View is displays the open Repositories View Settings Library Repositories E se Repositories Lab WM ProcessObjects ACD a Library Objects 5 9 Data Container 5 Libraries 5b Instance Data jm New LOM New folder E Libraries 9 2 ProObj 2 H E MS 1 1 08 localhost SQLACM ACM 5 94 Libraries B L ProObj 8 Ba Project 1 4 Controller 1 22 Module 1 LI Controller 1 ControlModule 4 2 Digital 1 Analog 1 Lj Motor 1 Ap 4j Valve 1 8 a DesignPattern 1 9 2 v0 0 Global 2 0 E3 E W 8 m Click the icon to the left of an item in the tree to display elements that are contained within it Click the icon to collapse the element display Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 165 Chapter8 The Library Object Manager Application The Library Content Tree The Library Content Tree View displays the conte
97. alve In RefTag Lab Valve In Lab Valve Permissive Index Lab Valve P RefTag Lab Valve P Default Value 0 0 Min Max Data Type Ref Type Group Parameter Help 0 15 Int Immediate String Reference 0 15 Int Immediate String Reference 64 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Changing the Columns Displayed in the Parameters Tab The Parameters Tab can display the following columns Name e Scope Default Value e Min e Max e Data Type Ref Type e Group Parameter Help e Extended Group Refer to Adding a New Parameter on page 70 for a full description of these fields Follow these steps to change the columns displayed 1 Right click the column heading The contextual menu appears 2 Select Columns to display the submenu listing all columns 3 Mouse over an inactive column to add it to the display Mouse over an active column to remove it from the display f FindPartial Parameters Functions Substitutions Predefined External References Name eee Wahin Min Columns Name Lab Valve DN Scope v Default Value E Lab Valve 02 Device Configur Min Cfg HasOpenLS Lab M E Max Cfg HasClosedLS Lab V Cfg HasPermobj Lab VL Data Type Cfg HasIntlkObj Lab Ref Type Cfg FulStalT Lab
98. an ACM Project Inan ACM Project a user can link an External Reference to a Reference type Parameter The Parameter references the value of External Reference when the Project is in operation Reference type Parameters can be defined so that the External References that are accessible to them are limited to those that meet certain criteria filters Any Tag or Tag Member can be added as an External Reference Expressions An Expression is a one line statement that generates a single calculated result Expressions can return a string numeric or Boolean value Expressions generate values automatically during instantiation An Expression can be as simple as a single decorative element token or can involve one or more operations involving one or more decorative elements and operators Expressions can be used in any field in the Library Designer plug in that accepts a calculated result These fields display the Ellipsis button to the right Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Applying Decoration to Library Object Elements Design Automation Concept The Library Designer Plug in and the Library Object Manager Application Overview Chapter 1 Expressions can incorporate any decorative element that is available to the current Library Object element as well as a set of logical and mathematical operators Expressions can be entered manually or created in the Expression Builder The Expression Builder is
99. an intuitive visually responsive environment to create test and save Expressions Refer to The Library Designer Plug in The Expression Builder on page 103 Decoration is added to the Library Object in the Library Designer plug in The decoration can then be applied to any field of any element of the Library Object that accepts values from the Expression Builder or Substitution Builder These fields display the Ellipsis button to the right The Library Object files are generated automatically by the Library Object Manager application Each Library Object is assigned a sequential Version Number based on previous iterations of Objects with the same Catalog Number and are stored in the ACM Database as HSL4 files The HSL4 files can be copied to other folders for distribution Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 21 Chapter1 Library Designer Plug in and the Library Object Manager Application Overview Notes 22 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter 2 Opening the Library Designer Plug in Cha pter Objectives This chapter provides information on the following topics e Accessing the Library Designer Plug in e Opening the Library Designer Plug in from the Studio 5000 Logix Designer Application e Opening the Library Designer Plug in from the Library Object Manager Application Accessing the Libra ry The Library Designer plug in can be accessed from eith
100. ary Checkbox If checked allows Substitutions added to the current Library Object to be Substitutions overridden Refer to The Substitution Builder on page 112 Changing the Tag Name or Description Ina typical development process Tag names are structured when the elements are added in the Logix Designer application to allow Substitutions to be added once to the Library Object and then extend consistently to all Tag elements contained within the Library Object For example a motor Library Object with an identifying string of MX001 in the Library Object name and with the Predefined Parameter ObjectName applied as a Substitution might have Tags named MX001_Permissives MX001_Interlock and MX001 IOFault Substitutions can also be added to the Project Library Object or Controller Library Object These will extend throughout the Project hierarchy and will take precedence over Substitutions added to the Library Object unless the Base Library field for the Library Object has been set to NONE The Decorator Panel allows the default Substitution to be overridden for individual Tags Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to
101. ary Objects Adding Decoration to a doe m pi is rm eh Decorator ipa the T from the Add Library Object window at the top as well as five decorative element Library Obj ect Custom Property tabs at the bottom e Parameters e Functions e Substitutions e Predefined Parameters e External References Library Attributes Catalog Number Lab_Valve Library Description Solenoid Operated Valve Type Module Base Library Lab Controller Instantiation Default Name XV100 Default Description Substitutions Name XV100 ObjectName Description Inlet Valve ObjectDescription f FindPartial Parameters Functions Substitutions Predefined External References Name Scope Default Value Lab_Valve 01 Programming and Execution Unit Lab_Valve 1 labh Waha TAY Danfimentinn ad 60 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Decorator Panel Fields The Library Designer Plug in Decorating Library Objects Chapter 5 When a Library Object is selected the top half of the Decorator Panel has the following fields Name Field Type Description Catalog Number Text entry The Library Object name which appears when the Library Object is registered in the Application Code Manager application Library Text entry The description of the Library Object Description Type Module Checkbox This checkbox i
102. ary Objects column displays all existing Library Objects in the current Project or ACD file Objects in the Selected Objects column become available for decoration when they are added to an existing Library Object or used as the basis for a new Library Object by copying them into this column Objects in the Selected Objects column are color coded to indicate whether all some or none of the associations from the initial instance in the Logix Designer application have been replicated in the Library Objects added in the Library Designer plug in Objects which are fully associated within the Library Designer plug in display as green Objects where some but not all of the associations have been replicated display as blue Objects which have no associations display as black An Object in the Selected Objects column may be associated with one or many Library Objects depending on the ownership settings for the Project For example an Add On Instruction may be associated with both a valve Library Object and a motor Library Object The Decorator Panel displays the fields and tools used to decorate the Library Objects Once an Object has been added to a new or existing Library Object in the Library Objects column it can be accessed and modified in the Decorator Panel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 31 Chapter3 Library Designer Plug in Main Graphic User Interface The Selected Objects Button The Selected Ob
103. as Modules in the Library Designer plug in will be brought into ACM Projects as Hardware components rather than Software components The Library Designer plug in features a Module Wizard that ensures that required Parameters are included when the new Module Library Object is created Parameters Substitutions Functions External References and Expressions created in the Library Designer plug in can be accessed reused and rescoped multiple times using the Expression Builder refer to The Library Designer Plug in The Expression Builder on page 103 Functions and Expressions that are saved in the Library Designer plug in become program resources and are available to all Projects that are opened in the program The Library Designer plug in also includes a set of Predefined Parameters that is available to all Projects Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 17 Chapter1 Library Designer Plug in and the Library Object Manager Application Overview Types of Decoration 18 Each type of decoration has a distinct role in configuring a Library Object Parameters A Parameter is an argument that is exposed for external access and that controls how the Library Object is instantiated Parameters have a simple data type Boolean string integer or real Parameters are set and modified by direct user input immediate calculation results or references to other Parameters Parameters added as a decorative elem
104. ating a New Sequential Function Chart Element When modifications are made in the Logix Designer application to a Sequential Function Chart that has been added to a Library Object in the Library Designer plug in the chart must be updated in the Library Designer plug in to include the modifications New elements will appear in the Sequential Function Chart but must be activated so that they are recognized by the Library Designer plug in TIP The connection wires appear dimmed for Elements that must be activated Follow these steps to activate an element 1 Click the connection wire to select it Right click to open the contextual menu 2 Select Add or click Add at the top of the Decorator Panel The wire displays as black IMPORTANT Default substitutions are inherited automatically Overrides to the default substitution and all other decoration must be applied manually to new elements of an existing Library Object Activating and Deactivating Sequential Function Chart Elements Follow these steps to deactivate one or more elements 1 Use the menu commands to select the elements to deactivate You can also select multiple elements by holding down the CONTROL key 2 Right click again on one of the selected elements to open the contextual menu 3 Select Remove or click Remove at the top of the Decorator Panel The Clear Directives window opens Clear Directives x A Clear directives from all selected objects 140 Rock
105. ation 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 or Canada 1 440 646 3434 Outside United States or Canada Use the Worldwide Locator at http www rockwellautomation com rockwellautomation support overview page or contact your local Rockwell Automation representative New Product Satisfaction Return Rockwell Automation tests all of its products to help ensure that they are fully operational when shipped from the manufacturing facility However if your product is not functioning and needs to be returned follow these procedures 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 this form publication RA DU002 available at http www rockwellautomation com literature Rockwell Automation maintains current product environmental information on its website at http www rockwellautomation com rockwellautomation about us sustainability ethics product environmental compliance page Rockwell Otomasyon Ticaret A S
106. ation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Adding a Selected Object to a Library Object Chapter 4 When fully active the New Library window has the following additional fields Name Field Type Description CatalogNumber Text entry The Library Object name which appears when the Library Object is registered in the Application Code Manager application Library Object Text entry The description of the Library Object Description Type Module Checkbox This checkbox identifies the Library Object as a Module A Module registers as Hardware rather than Software in the Application Code Manager application Refer to Adding a Module to a Library Object on page 53 Base Library Checkbox Allows you to select an existing Library Object in the Library Object hierarchy as a Base Library When a Base Library is selected the current Library Object inherits Substitutions from the Base Library and the Expression Builder accesses all Custom Properties of the Base Library when used in the current Library Object When NONE is selected the current Library Object does not inherit Custom Properties Instantiation Text entry Sets the default name for each instantiation of the Library Object The Default Name value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Libra
107. b for the new Library Object to open the contextual menu Select Paste The Substitution is added to Library Object IMPORTANT The Substitution will only take effect in the new location if the text string to be replaced and all decorative elements used in the Substitution are contained in the Library Object Follow these steps to use a Substitution as the template for a new Substitution in the same Library Object 1 Select the Substitution TIP You can select multiple Substitutions using the SHIFT or CONTROL keys 2 Right click the Substitution to open the contextual menu Select Copy Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 91 Chapter5 Library Designer Plug in Decorating Library Objects 3 Right click the group name or a different group name within the same Library Object to open the contextual menu Select Paste Substitution s The Rename window opens Rename ect a unique pair of starts the proce alue SubstituteValue Double of renaming editing OriginalValue SubstitutedValue w M100 DrumMotor a 4 Enter a new Substitution name to replace the highlighted name The Overwrite checkbox is deselected 5 Click OK The new Substitution is created with the same settings as the original Adding a New Substitution Follow these steps to add a new Substitution 1 Do one of the following a Click Add New b Right click anywhere in th
108. b_Controll Local String Slot Lab_Controll 0 0 16 Int Size Lab_Controll 17 4 17 Int Lab_Controller 02 HMI AreaPath Lab Controll String Lab_Project Project Definition Project Lab_Project String E Functions and Operators Format Modulus Round Abs Length GetParameterMax CalcBitNumber True False Or And Not lt gt amp gt gt lt lt f Expression Result Type Validate 104 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Decorative Elements Tabs The Library Designer Plug in The Expression Builder Chapter 6 From top to bottom the Expression Builder is divided into four functional areas Name Description Decorative The Decorative elements available to the current Expression These include all elements added Elements Tabs to the current Library Object and all elements added to Library Objects that are higher in scope These elements include Parameters Functions Predefined Parameters Functions and Expressions can also be saved within the Library Designer plug in and used in future Projects These appear in the Expressions and Saved Functions tabs Predefined A collection of logical and mathematical operators that can be used to manipulate the values Functions and generated by the decorative elements Operators Expression Box The Expression appears here as elements are added to it There are also field
109. bjects there will also be an option Once per sub object SubObject name for each SubObject Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to The Substitution Builder on page 112 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to The Substitution Builder on page 112 Changing the Task or Program Name or Description In a typical application Task and Program names and descriptions have a user accessible Parameter applied as a Substitution to the original text string This allows the user to assign instance specific identification to the Task or Program when it is added to an ACM Project Substitutions can also be inherited from the Library Object the Project Library Object or the Controller Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Name and Definition fields of a Task or Program element Refer to The Substitution Builder on page 112 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying Decoration to a Routine Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the L
110. box If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Setting a Rule for Instantiation on page 143 Changing the Structured Text Chart Name or Description In a typical application Structured Text Chart names are function based or are structured when the charts are created in the Logix Designer application to allow Substitutions to be added once to the Library Object and then extend consistently to the charts contained within the Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Name and Definition fields of a Structured Text Chart Refer to The Substitution Builder on page 112 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition cli
111. bra ry You can create a new Library Object from within a Folder Repository or the Obj ect ACM Database This Library Object will have no CLX content Follow these steps to create a new empty Library Object 1 Click the Folder or Database icon to make it active Right click to open the contextual menu 2 Select New Library The New Library window opens 4 New Library 15 13 Create Catalog Number Operation Family Solution Library Type Category New Libraries e Create 4 BH 4 01 Revision History Revision Description 02 Library Details CatalogNumber Description Family Solution Library Type Category Owner ACM Major Revision 1 Minor Revision 03 Library Usage Rules Upstream Keys Downstream Keys eccece Revision Description Description of any changes made to the library since the last revision 182 Rockwell Automation Publication LOGIX UM006A EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects Chapter 9 The New Library window has the following fields Name Field Type Description 01 Revision History Revision Text entry A description of the updates made to the current Library Object Description compared to previous versions of the Library Object Appears in the Revision History screen when the Object is registered in the Application Code Manager ACM application This is entered
112. brary E 5 Libraries 1 2 ProObj 8 1 E Controller 1 Ea Controller 1 B B ControlModule 4 EG Analog 1 19 Lab Analoglnput 1 2 Digital 1 Lab Digitallnput 1 2 H E Motor 1 5 02 Valve 1 H DesignPattern 1 3i Module 1 W Project 1 9 2 v0 0 Global 4 F Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 177 Chapter9 Library Object Manager Application Adding Repositories and Copying Library Objects 4 Right click the Folder icon to open the contextual menu 29 Deskto _ 5 5 Libraries New Library 2 2 ProObj 8 Open Folder Controller S L Contra Remove 2 Lat Refresh 5 ControlMc 5 2 Analog Expand All 3 Lat Collapse A Diaital The following table describes each command in the menu New Library Creates a new empty Library Object Refer to Creating a New Library Object on page 182 Open Folder Opens the repository folder in Windows Explorer Remove Remove the Folder from the Library Repositories column Refresh Refreshes the display Expand All Expands all collapsed elements contained within the ACD file Collapse Collapses all elements contained within the ACD file Removing a Folder Repository from the Library Object Manager Application Follow these steps to remove a Folder Repository 1 Click the Folder to make it active Right click to open the contextual menu 2 Select Rem
113. by double clicking in the field For Parameters with a data type of Integer the Min and Max fields can also be edited by double clicking in the field The Apply checkbox determines whether the Parameter will be included in the Library Object All boxes are checked by default Rockwell Automation Publication LOGIX UM006A EN P October 2015 53 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object Creating a New Empty Library Object 54 The Library Designer plug in generates an initial set of SubObjects for example an analog input Module opens in the wizard with Analog Input AI and Analog Output AO SubObjects The Channel Type field cannot be edited Other fields can be edited double click in the field to open it for editing Parameter names appear enclosed in angle brackets The Apply checkbox determines whether the SubObject will be included in the Library Object All boxes are checked by default Follow these steps to create a new empty Library Object 1 Do one of the following a Click Create a New Library b Right click the Libraries folder in the Library Objects column to open the contextual menu Select Add then select Library Library Objects 7 69 Custom Properties i 5 1 Add Library E Edit Project Library gh Delete i 2B t Controller Library H amp Copy E Paste 2 View Studio5000 Move Up Move Down TIP The Libraries
114. ccept the defaults or edit them in the wizard The Module Wizard Follow these steps to open the Module Wizard 1 Select a Module Object in the Selected Object Tree View 2 Add the Module Object to a Library Object using any of the three procedures described earlier Refer to Adding a Selected Object to a Library Object on page 46 The Module is added to the Library Object and the Module Wizard opens Ia Library Object Designer 34 Inclusions gx Selected Objects Library Objects 9 08 Controller Lab WM Procd bl Tasks ModuleWizard Motion Groups Module s T Analog 9 08 Add On Instructions uieis Type Eum H ae Parameters 51 69 1 0 Configuration Default Value Min Max Apply fa 1756 L85E Local Slot 1 0 7 8 1756 F16 Local_01 RPI 160 2 750 7 es ChassisName ParentChassisName N A N A v fJ 1756 OF8 Local 04 SubObjects Note These are the typical formats user needs to modify as required Qty Off Min Max Address Format ChFault Format Apply Al 0 0 0 1 ParentName Slot l Ch Channel D ParentName Slot Ch Channel F v AO 0 0 0 1 ParentName Slot O Ch Channel ParentName Slot Ch Channel F v The Library Designer plug in automatically assigns the Module Type This field cannot be edited The Library Designer plug in generates an initial set of Parameters The Parameter Name field cannot be edited The Default Value field can be edited
115. ch ACM Library P F Organize New folder e a Name Date modified Type Size WE Desktop 59 Libraries amp Computer d Floppy Disk Driv _ amp Local Disk C g WM01_Object ACD Type Logix Designer Project Logix Designer Pr 2 991 KB DVD RW Drive Size 342 MB Network Date modified 6 12 2015 8 36 PM Control Panel Recycle Bin J 21050319 Beta 0 ACM Library JL v10 Global gt JL v1 0 Global 6 3 2015 4 08 PM File folder J v10 Lab 5 15 2015 9 13 File folder d CLX22 ACD 5 28 2015 805 PM Logix Designer Pr 3 200 KB CLX66 ACD 6 4 2015 9 34 PM Logix Designer 2 716 KB df ProcessObjectsACD 6 12 2015 8 36 PM Logix Designer Pr 3 513 KB File name ProcessObjects ACD Y Logix Designer acd gt 4 The ACD file opens in the Library Object Manager application and is added to the Library Repository Tree View The red X next to the file icon indicates it is referenced but not yet mounted 5 Right click the ACD item to open the contextual menu Select Mount Library Repositories ES Repositories Lg Unmount Open ACD Launch Library Designer Export to L5X Remove Refresh Expand All Collapse 26 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Opening the Library Designer Plug in Chapter2 TIP You will not be able to mount the ACD file if it is open in the Logix Design
116. chema instance xmln T Mi Finckons B Private xsi type AoiPrivateData Guid D36783E6 15E 46A6 BC92 234B8 zd lt Attrib gt E Extemal References Subs gt ped lt Private gt lt DecoratedData gt Provider lt CustomProperties gt vailable Disabled IOFault e oo Description LocalizedDescription Lang en US lt CDATA Single Speed Motor lt LocalizedDescription gt lt Description gt lt RevisionNote gt oo lt LocalizedRevisionNote Lang en US gt lt CDATA See Release Notes for Library version 3 0 for details on changes LocalizedRevisionNote lt RevisionNote gt lt AdditionalHelpText gt Localized dditionalHelpText Lang en US CDATA Copyright Rockwell Automation Inc Doo All Rights Reserved This Instruction controls and monitors a single speed motor FVNR soft start etc and provides IE Adding FactoryTalk View SE ME Content toa Library Object Help Follow these steps to add FactoryTalk View SE ME content 1 Click the Library Object in the Library Content column to select it Right click to open the contextual menu Library Icd Add Section EE Revision I a P Help Expand All nM ES Definition Collapse amp FT Historian 2 Select Add Section gt FT View An FT View folder with subfolders for SE Symbols Site Edition and ME Symbols Machine Edition is added to
117. ck Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 143 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying Decoration to a Structured Text Chart Line Click a line to select it Hold down the SHIFT or CONTROL key to select multiple lines You can also click the Select All Lines command to select all the lines in the chart When a line is selected most of the fields in the top half of the Decorator Panel remain active Substitutions can be applied directly to the line using the contextual menu Name Line 15 Description Library Object Main Condition Always Conftgure Instantiation Rules Add Remove SelectAll Lines Clear Selection Description Language Logix Path ST_Motion Programs MainP
118. click to open the contextual menu 2 Select Delete TIP You can delete ELSEIF and nested IF statements but you cannot delete the root IF or ELSE statements Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 85 Chapter5 Library Designer Plug in Decorating Library Objects Editing a Function Follow these steps to edit a Function 1 Do one of the following a Double click the Function b Right click the Function to open the contextual menu Select Edit The Function Builder window opens 2 Edit the Function Refer to Adding a New Function on page 82 for a list of the fields in the Function Builder Listing a Function s References Once it has been added a Function may be referenced multiple times within a Library Object Functions added to a Project or Controller Library Object may be referenced from within multiple Library Objects Examples include the following e Asa field value for a Parameter or Library Object element e As part of an Expression As part of a Substitution e As part of another Function The References window lists all references to a Function and gives one click navigation to the referencing entities Toopen the References window for a Function right click the Function to open the contextual menu Select Show References The References window opens References 5 Library Used Details Navigate Lab WashMachine WM01 Rung Rung 16 HC100 Sts_Available gt
119. d 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 Refer to The Substitution Builder on page 112 Substitutions can be copied and pasted from one Library Object to another and can be copied and pasted between Library Objects of different scope The Substitutions Tab Substitutions are listed alphabetically They are not grouped FindPartial Parameters Functions Substitutions Predefined External References Original Value 4 Scope Replaced Value Search Mode Lab_WashMachine DrumMotor Operand Lab_WashMachine DrainPump Operand Washing Machine Lab_WashMachine ObjectDescription Lab_WashMachine ObjectName Lab_WashMachine InletValve Operand Lab_WashMachine SoapValve Operand All of the columns in the Substitutions Tab are sortable Rockwell Automat
120. d Type 03 Library Usage Rules Description Upstream Keys Text entry For Module Library Objects a rule that limits the upstream Hardware components that will be made accessible to the Library Object when it is added to an ACM Project Rule is entered manually as a logical expression Downstream Keys Text entry For Module Library Objects a rule that limits the downstream Hardware components that will be made accessible to the Library Object when it is added to an ACM Project Rule is entered manually as a logical expression 2 Enter the information for the Library Object 3 Click Apply to add the Library Object to the Repository or Cancel to cancel Follow these steps to copy multiple Library Objects from the ACD Repository at the same time 1 Select multiple Library Objects a Hold down the SHIFT key to select a contiguous block of Library Objects b Hold down the CONTROL key to select individual Library Objects that are not contiguous 2 Place the mouse within one of the selected items and drag all of the Library Objects on top of the Folder Repository or the ACM Database The Library Import Configuration window opens kabaka New Revision Library Import Configuration Import Catalog Number Operation Family Solution Library Type Category Revision New Libraries V Lab Project Lab Controller Lab Analoglnput Lab Valve Lab Motor Lab DigitalOutput
121. d reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying Decoration to a Sequential Function Chart Element When a Sequential Function Chart element is selected most of the fields in the top half of the Decorator Panel remain active Substitutions can be applied directly to the element using the contextual menu Add Remove Name ObjectName Description Description Language Library Object Lab Motor Logix Path Lab_WM_ProcessObjects Programs Motors P100 Sheet P_Motor Configure Instantiation Rules Condition Always Usage One per object Exclude Base Library Substitutions _ Exclude Library Substitutions PM Inp_RunFdbk Inp_PermOK F1 REI Inp NBPermOK Inp IntlkOK Inp NBIntlkOK Inp IOFault otor a a Substitutions Select By St Select Same a Select All 519 Remove 100 0
122. d to an ACM Project The condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Disabled Text entry Allows you to create a condition to disable the Parameter during instantiation The condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 This field only affects Parameters which are included in a SubObject Read Only TRUE FALSE pull down menu Determines whether the user will be able to enter values for the Parameter in the ACM application or only read values that have been generated This field appears if Immediate is selected in the Type field Reference Type field and String Integer or Real is selected in the Data Control Type Pull down menu Determines whether the user will be presented with a text entry field or a pull down menu to enter values into the Parameter This field appears if DropDownList is selected in the Control Type field Control Values Text entry Allows you to populate the pull down menu the user can select Options are entered as a comma separated string This is a required field when it a
123. dding FactoryTalk Historian content 207 215 Index 216 adding FactoryTalk View Content 191 adding Library content 189 copying a Library Object 184 186 187 creating a New Library Object 182 FactoryTalk Alarms and Events FTAE Digital Alarm adding 200 adding a new Message 204 adding an existing Message 205 adding Message content 206 changing the name 203 configuring 202 deleting Message content 206 editing a Message 206 Tag Update Rate 207 FactoryTalk Historian SE adding a Historian Tag 208 configuring a Historian Tag 209 deleting a Historian Tag 211 FactoryTalk View Symbol 192 adding 192 changing the name 194 configuring 193 configuring Object Tag and Path Parameters 194 configuring Parameters in Application Code Manager 194 configuring Parameters in FactoryTalk View Studio 194 configuring Parameters in Library Object Manager 196 configuring the location 198 Symbol Builder window 192 198 199 Symbol Builder window fields 192 features 161 Folder Repository 162 182 184 187 Library Content column 163 190 191 200 207 Library Import Configuration window 184 186 187 Library Import Configuration window fields 185 Library Repositories column 162 182 Library Repositories tree view 165 main GUI 162 Message Editor 204 Message Editor fields 204 New Library window 182 New Library window fields 183 opening 161 Properties panel 163 190 191 193 Digital tab fields 203
124. deactivating a Function Block element 134 141 deactivating a new Function Block element 133 146 deactivating an element 140 deactivating Rungs 126 decorating Library Object elements 111 decorating Tag values 118 152 Decorator Panel 31 34 45 59 111 112 119 121 123 127 128 130 134 137 144 146 149 153 155 157 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Decorator Panel fields 31 59 111 116 120 122 124 127 129 131 135 137 142 144 147 149 153 155 157 Ellipsis button 20 34 59 103 111 exduding inherited Substitutions 125 130 132 136 139 143 145 148 151 154 156 External References tab 98 adding a new External Reference 100 changing the columns displayed 99 deleting an External Reference 102 editing an External Reference 102 External References tab button bar 99 find feature 100 References Builder 101 References Builder fields 101 features 16 Functions tab 77 adding a calculated Function 82 adding a conditional Function 82 changing the columns displayed 78 copying a Function 80 asa template for a new Function 81 Decorator Panel 87 deleting a Function 87 editing a Function 86 find feature 79 Function Builder 80 82 86 Function Builder fields 82 Functions tab button bar 79 listing a Function s references 86 names must be unique within a Library Object 84 References window 86 References window fields 86 using a previously created Function 84 Inclusions p
125. ded to an ACM Project With FactoryIalk View Symbols there may be several options which are appropriate for different applications In this case you can add a Parameter which allows the end user to select the Symbol that best meets their need Follow these steps to set a rule for instantiation 1 Enter anew Parameter token in the Include Condition field as well as the condition example symbolstyle 1 for inclusion of the Symbol 2 Repeat the process for all other Symbol options Configuring the Object Tag and Path Parameters for a Symbol The Object Tag and Path Parameters must be set for correct substitution when the Symbol is instantiated in ACM Project This can be done in the FactoryTalk View Studio application before the Symbol is exported or in the Application Code Manager application after the Symbol has been added Follow these steps to configure the Parameters in the FactoryTalk View Studio application TIP A Global Object is used in this example The same procedure applies to other Objects although the display screens Object Tag name and XML code may be different 1 Open the Symbol Object Right click the Object to open the contextual menu 194 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter 10 2 Select Global Object Parameter Values The Global Object Parameter Values window opens
126. dentifies the Library Object as a Module A Module registers as Hardware rather than Software in the Application Code Manager application Base Library Pull down menu Lets you select an existing Library Object in the Library Object hierarchy as a Base Library When a Base Library is selected the current Library Object inherits Substitutions from the Base Library and the Expression Builder accesses all Custom Properties of the Base Library when used in the current Library Object When NONE is selected the current Library Object does not inherit Custom Properties Instantiation Text entry Sets the default name for each instantiation of the Library Object The Default Name value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Instantiation Text entry Sets the default description for each instantiation of the Library Object Default The value can be entered manually or generated by an Expression To Description create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Substitutions Text entry Sets the default substitution for a text string in the Library Object name Name when the Library Object is instantiated This s
127. der Refer to Setting a Rule for Instantiation on page 129 Configure Instantiation Pull down The number of times the Sheet will be instantiated Default is Once Rules menu per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 130 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 130 Changing the Sheet Description Sheets are identified by sequential numbering The name cannot be changed The Decorator Panel allows you to create Substitutions which can be applied directly to the Definition field of a Sheet element Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The L
128. describes the fields and commands in the Symbol Builder window Name Field Type Description Select Display Export Text entry Enter the name of the exported FactoryTalk View Symbol file that File holds the Symbols you wish to import or click Ellipsis to open Windows Explorer Select Root Node of List A list of all Symbols in the file Symbols may be selected Symbol individually or as a group Only one Symbol or group may be selected for each import Apply Substitutions Checkboxes Leave boxes checked to apply default Substitutions to these Symbol attributes OK Button Click to import the selection Cancel Button Click to cancel the import Help Button Opens the Help screens 192 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter 10 3 Enter the file location for the exported FactoryTalk View Symbol file in the Select Display Support File field or click Ellipsis to open Windows Explorer and navigate to the file The Symbols contained in the file display in the Select Root Node of Symbol field 4 Select the Symbol or group to import TIP In a typical application it is not necessary to uncheck any of the boxes in the Apply Substitutions area 5 Click OK to import the Symbol 6 Repeat for all Symbols needed for the Library Object Configuring a Symbol The Properties panel displays these fields w
129. e 10 0 60 Int Immediate 02 Device Configur After command time to reach position before fault sec Lab_Valve 03 IO Configuration Inp OpenLS Lab Valve String Reference 03 IO Configuration Open LS Address Inp OpenLSOk Lab Valve String Reference 03 IO Configuration Open LS Fault Inp ClosedLS Lab Valve String Reference 03 IO Configuration Closed LS Address Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 63 Chapter5 Library Designer Plug in Decorating Library Objects f FindPartial Groups can be collapsed and expanded using the arrow buttons on the right or by double clicking the group name Parameters are displayed alphabetically within their groups although the display order can be changed When a new Library Object is added an initial group is created in the Parameters Tab The group name matches the Library Object name Additional groups can be added as Parameters are added to the Library Object Refer to Adding a New Parameter on page 70 SubObjects appear in the Parameters Tab as a type of group SubObject names display in blue SubObject names are displayed in this format Library Object Name Sub Object Type The Parameters in the valve Library Object shown here are components of two SubObjects Lab Valve Interlock e Lab Valve Permissive Parameters Functions Substitutions Predefined External References Name Scope Lab_Valve Interlock Index Lab_V
130. e Equipment PPE Follow ALL Regulatory requirements for safe work practices and for Personal Protective Equipment PPE Allen Bradley Rockwell Software Logix5000 Studio 5000 Logix Designer FactoryTalk and Rockwell Automation are trademarks of Rockwell Automation Inc Trademarks not belonging to Rockwell Automation are property of their respective companies Table of Contents Preface Objectives 11 Purposeor This Manuali 11 Additional Resources 222395220 25 GR E 11 Abbreviations oi 11 Chapter 1 The Library Designer Plug in andthe Chapter Objectives sese 13 Library Object Manager Application Design PLOCESS we Re 13 Overview The Library Management Workflow 0 0 cece eee e ee 13 The Project Execution Workflow 5 rr rerre e eee 16 Features of the Library Designer Plug in 16 Library Objects oru LAE seat cared DR Pera 17 or Decorationy deo eens 18 Y ette Ee elle a 18 scu be pee e oves 18 SubskttdbloHs eism ir eo ob dese uc dete t 19 Predefined 20 External References mesa emet e ve VATER Sae V toda 20 DXDEESSSIOBS S ch cute D MM OM et eic 20 Applying Deco
131. e Not Available Add Not Available Undo Not Available Redo Not Available Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 127 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying Decoration to the Elements in a Function Block Diagram 128 Applying a Substitution to a Directive Follow these steps to apply a Substitution to a Directive 1 Select Substitution 2 Refer to The Substitution Builder on page 112 Decoration can be applied to a Sheet or to individual Function Block elements Applying Decoration to a Sheet When a Sheet is selected the Decorator Panel display has two functional areas The bottom half of the panel displays the Function Block Diagram Every instruction in the Sheet can be selected and all are open to decoration When an element is selected the top half of the Decorator Panel changes to display the fields available to the currently selected element Add Remove Name Sheet 1 Description ObjectName Description Language Library Object Lab Valve Logix Path Lab WM ProcessObjects PO DeviceControlValves TwoState XV100 Sheet Configure Instantiation Rules Condition Always Usage One per object Exclude Base Library Substitutions Exclude Library Substitutions ObjectN ame P_ValveSO k MEE Inp_OpenLS Out OpenLS D Inp_ClosedLS Sts_Closed Inp ClosedLS 7 Inp
132. e Substitutions Tab to open the contextual menu Select Add New amp FindPartial Parameters Functions Substitutions Predefined E Original Value Scope F WMO01 Lab WashMachine Washing Machine Lab WashMachine 1 XV100 XV101 Add New M100 Edit P100 Delete Copy Paste Move Up Move Down 92 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 The Add new Substitution window opens Add new Substitution Substitution Scope Lab_WashMachine NA Original Replacement Search Mode Text v All fields are required The following table describes the fields in the Add new Substitution window Name Field Type Description Scope Pull down menu The Library Object that will contain the Substitution The default is the current Library Object All Library Objects within the ACD file are available to select Original Text entry The text string to be replaced The value must be entered manually The text string may be as short as a single character There is no maximum string limit Replacement Text entry The value used to replace the text string entered in Original field The value can be entered manually or generated by an decorative element To select a decorative element click Ellipsis to the right of the field to open the Member Selector Refer to The Member Selector on page 93 Search
133. e columns displayed 1 Right click the column heading The contextual menu appears 2 Select Columns to display the submenu listing all columns 3 Mouse over an inactive column to add it to the display Mouse over an active column to remove it from the display FindPartial Parameters Functions Substitutions Predefined External Reference Name m Leone Reference amp cone Lab 8 Columns Sts_Err Lab_Analog np A nii Sts_Fail Lab Analoginp v Reference Scope Sts Hi Lab Analoginp Value Sts HiHi Lab Analoginp Data Type TIP Columns can be resized horizontally by mousing over the right side of the column until the pointer changes to a double arrow then clicking and dragging The External References Tab Button Bar The External References Tab Button Bar is shown below amp FindPartial The following table describes each External References Tab Button Bar command The Add New button opens the Reference Builder E The Move Up Move Down buttons are deactivated for this tab The Find pull down menu initiates a search for Functions that match a text string FindPartial you enter in the field Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 99 Chapter5 Library Designer Plug in Decorating Library Objects Using the Find Feature The Find feature highlights the E
134. e element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e Ifno Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 145 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying Decoration to a Motion Group 146 Applying a Substitution to a Structured Text Chart Line Follow these steps to apply a Substitution to a Structured Text Chart line 1 Double click the selected line The Substitution Builder opens 2 Refer to The Substitution Builder on page 112 Activating and Deactivating Structured Text Chart Lines Follow these steps to deactivate a line 1 Select the line Hold down the SHIFT or CONTROL key to select multiple lines 2 Click Remove at the top of the Decorator Panel The selected line
135. e field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Point Type Pull down menu The data type for the Historian point Options are Digital Float16 Float32 Float64 Int16 Int32 String Timestamp Blob Typical Value Text entry The Typical Value for the Historian Tag Can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Library Designer Plug in The Expression Builder on page 103 Zero Text entry The Zero Value for the Historian Tag This field is only active if a Float or Int option has been selected in the Point Type Field Span Read only The Span for the Historian Tag This field is only active if a Float or Int option has been selected in the Point Type Field 2 Make edits to the fields either manually or using the Expression Builder 3 Click Apply to apply the changes or Cancel to cancel When a Historian Tag is added to a Library Object a corresponding Parameter is also added to this subfolder in the Library Content column TIP Definition Data gt Parameters gt Object gt Historian Configuration This Parameter is used by the Project Engineer to configure the Historian Tag in the ACM application Library Content cH 1 15 Lab Motor 1 0 Library Icon Revision Hist
136. e fields in the Properties panel when a Historian Tag is selected Name Field Type Description Tag Name Text entry The name that will be applied to the Historian Tag when the Library Object is instantiated This name will appear in Application Code Manager screens The field is populated with a default name based on the Tag name and Library Object for the selected Tag Can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Include Condition Text entry Sets the condition under which the current Historian Tag is instantiated The default is Always A condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Scan Class Text entry The scan class for the Historian Tag The field is populated with a default value based on the Tag name for the selected Tag Can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Descriptor Text entry A description for the Tag Can be entered manually or generated by an Expres
137. e local substitution Cfg HasClosedLS used with logix object XV100 in library Lab Valve You will need to remove all references before the Library Designer plug in will allow the Parameter to be deleted 76 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Functions The Library Designer Plug in Decorating Library Objects Chapter 5 A Function is an argument that is not exposed to external access The value of a Function is generated by user defined logic created in the Library Designer plug in and by conditions that apply during instantiation A Function can be either Conditional or Calculated e A Conditional Function returns one of multiple possible results generated by Expressions and based on IF ELSE ELSEIF logic A Conditional Function allows for multiple branches and nesting e A Calculated Function generates a single value based on a single Expression Both types of Function are created using the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Functions can be copied between Library Objects and between Library Objects of different scope as long as the decorative elements used in the Expressions are common to both Library Objects Functions can be saved within the Library Object Manager application Saved Functions are available to all Projects opened in the Library Designer plug in Functions appear in fields other Functions and Expressions as to
138. e set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Applying Decoration to Data Type The Library Designer Plug in Decorating Library Object Elements Chapter 7 When a Data Type is selected the Decorator Panel disp
139. e the Usage field has been set to Include Once per Object Select By Repeat per SubObject Selects all Rungs where the Usage field has been set to Include Once per SubObject Select By Repeat per Include Once Selects all Rungs where the Usage field has been set to Include Once Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Select Conditional Inclusion The Library Designer Plug in Decorating Library Object Elements Chapter 7 Selects all Rungs where the Condition field matches the option selected in the submenu Submenu displays all conditional inclusions rules for the current diagram Select Same Selects additional Rungs that match the Usage field for the currently selected Rung Repeat Per Select Same Selects additional Rungs that match the Condition field for the currently selected Rung Conditional Inclusion Select Same Selects additional Rungs that match both the Usage field and the Condition field for the Both of the Above currently selected Rung Select Same Selects additional Rungs that reference the same Tag as the currently selected Rung Tag Select All Selects all Rungs Remove Deactivates the selected Rungs Add Not Available Undo Undoes the last action Redo Redoes the last action Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Lib
140. eck that the Library Object contains the referenced Tag before copying and pasting an External Reference External References are not available to the Expression Builder The External References Tab External References are listed alphabetically They are grouped based on the value in the Scope field for the External Reference f amp FindPartial Parameters Functions Substitutions Predefined External References Name Scope Reference Scope Value Data Type Lab Analoginput Sts Err Lab AnalogInput Object ObjectName Sts_Err Bool Sts_Fail Lab AnalogInput Object ObjectName Sts_Fail Bool Sts_Hi Lab Analoginput Object ObjectName Sts_Hi Bool Sts_HiHi Lab_Analoginput Object ObjectName Sts_HiHi Bool Lab AnalogInput Object ObjectName Sts_InpPV Sts_Lo Lab Analoginput Object ObjectName Sts_Lo Bool Sts_LoLo Lab_AnalogInput Object ObjectName Sts_LoLo Bool Sts_SubstPV Lab_AnalogInput Object ObjectName Sts_SubstPV Bool Val Lab AnalogInput Object ObjectName Val Real Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Changing the Columns Displayed in the External References Tab The External References Tab can display the following columns e Name e Scope Reference Scope e Value Data Type Refer to Adding a New External Reference on page 100 for a full description of these fields Follow these steps to change th
141. ectName lt parameter gt Applies to Parameters that are included in a SubObject Returns the maximum value for the Parameter inserted as lt parameter gt from within all SubObjects that match the Predefined Parameter SubObjectName within the Library Object that matches ObjectName CalcBitNumber Inserts CalcBitNumber ObjectName lt Subobjectlype gt lt parameter gt lt subobjectIndex gt lt resultDatalype gt Applies to Parameters that are included in a SubObject Returns the 2 value of all instances of the Parameter inserted as lt parameter gt in the SubObject inserted as lt subobjectlype gt based on the value inserted as lt subobjectIndex gt SubObjectCount Inserts SubObjectCount ObjectName lt subobjectlype gt Returns the number of SubObject instances for the SubObject inserted as lt subobjectlype gt within the Library Object that matches the Predefined Parameter ObjectName Logical and Mathematical Operators True Logical TRUE used to test value returned by a decorative element False Logical FALSE used to test value returned by a decorative element Or Logical OR And Logical AND Not Logical NOT lt gt Equal to not equal to Parentheses used to set order of operation for complex expressions amp Mathematical AND gt gt lt lt Greater than greater than or equal to less than or equal to less than Plus minus multiplied by divided by TI
142. ected Object to a New Library Object by Dragging or Copying and Pasting Follow these steps to add a selected Object to a new Library Object by dragging or copying and pasting 1 Click Inclusions to open the pull down menu Library Object Designer Inclusions Selecte 7 Add Children p Add Dependencies Allow Shared Ownership 2 Select whether Children or Dependencies will be included in the Library Object and whether the selected item will be exclusive to the Library Object or available for other Library Objects 3 Select the item or items you want to add TIP Hold down the SHIFT or CONTROL keys to select multiple items 48 Rockwell Automation Publication LOGIX UM006A EN P October 2015 The Library Designer Plug in Adding a Selected Object to Library Object Chapter 4 4 Doone of the following a Drag the selection on top of the Libraries folder in the Library Objects column b Right click the selection to open the contextual menu Select Copy Right click the Libraries folder to open the contextual menu Select Paste The New Library window opens TIP You do not have the option to add the selected Object to an existing Library Object New Library Library Attributes Catalog Number Library Description Type Module Instantiation Default Name Motors Default Description Substitutions Name Motors Description Base Library Lab_Contro
143. ective When a Directive is selected the only active field in the Decorator Panel is the Name field A Substitution can be applied using the Name field of the contextual menu for the Directive JSR Jump To Subroutine Routine Name 0 Substitutions Select By Has Directives Select Same No Directives Select All Repeat per Conditional Inclusion To select a Directive for decoration click the Directive name to select it Right click to open the contextual menu The following table describes the commands in the contextual menu Substitutions Opens the Substitution Builder Select By Selects all Rungs in the diagram that include Directives Has Directives Select By Selects all Rungs in the diagram that do not include Directives No Directives Select By Selects all Directives where the Usage field has been set to Include Once per Object Repeat per Object Select By Selects all Directives where the Usage field has been set to Include Once per SubObject Repeat per SubObject Select By Selects all Directives where the Usage field has been set to Indude Once Repeat per Indude Once Select By Selects all Directives where the Condition field matches the option selected in the Conditional Inclusion submenu Submenu displays all conditional inclusions rules for the current diagram Select Same Not Available Select All Selects all Rungs Remov
144. ed The following table describes the options in the Find pull down menu FindPartial Searches for the text string in any part of an entry FindPrefix Searches for the text string at the beginning of an entry Follow these steps to limit the display based on a text string 1 Select the Search option in the Find pull down menu 2 Type the text string to search for in the entry field to the right FindPartial Parameters Functions Substitutions Predefined Original Value 4 Scope Kioo Lab_WashMachine 101 Lab_WashMachine 90 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 The Substitutions Tab display reacts dynamically to the text string entered returning a shorter list of matching Substitutions as the text string grows TIP You must delete the text in the entry field to return the display to all Substitutions Copying a Substitution A Substitution can be copied to a different Library Object or can be used asa template for a new Substitution Follow these steps to copy a Substitution to a different Library Object 1 Select the Substitution TIP You can select multiple Substitutions using the SHIFT or CONTROL keys 2 Right click the Substitution to open the contextual menu Select Copy 3 Open the Library Object where you wish to add the Substitution 4 Right click anywhere in the Substitutions Ta
145. ed to the Digital Alarm when the Library Object is instantiated The field is populated with a default name based on the Tag name and Library Object for the selected Tag Condition Pull down The condition that activates the alarm Refer to FTAE documentation menu Severity Text entry The severity required for the event to activate the alarm Refer to FTAE documentation Minimum duration Text entry The minimum duration required for the event to activate the alarm Refer to FTAE documentation Latched Checkbox Determines whether the alarm remains in effect if the condition is no longer met Refer to FTAE documentation Acknowledge required Checkbox Determines whether an acknowledgement is required to turn off the alarm Refer to FTAE documentation Show Alarm as Tag Checkbox Determines whether the alarm is shown as a Tag Refer to FTAE documentation Message Text entry The text displayed when the Digital Alarm is triggered ID Read only The unique numeric ID for the message in the Message field New Button Opens the Message Editor to create a new message Edit Button Opens the Message Editor to edit an existing message Browse Button Opens the Message Browser Associated Tags Text entry Up to four Tags that may be included in the text of the Digital Alarm message Alarm Class Text entry The Class for the Digital Alarm Refer to FTAE documentation FactoryTalk View Text entry The FactoryTalk command that is executed when the alarm is C
146. elected Objects to a Library Button Follow these steps to add a Selected Object by clicking Add Selected Objects to a Library 1 Click Inclusions to open the pull down menu a Library Object Designer Inclusions Selecte Add Children Add Dependencies v 3 88 Allow Shared Ownership 2 Select whether Children or Dependencies will be included when the item is added to the Library Object and whether the selected item will be exclusive to the Library Object or available for other Library Objects 3 Select the item or items you want to add TIP Hold down the SHIFT or CONTROL keys to select multiple items 4 Click Add selected objects to a library The New Library window opens New Library Select Library Lab Project Create New Catalog Number Library Description Type Module Base Library Lab_Controller Default Name Default Description Name Motors gt ObjectName Description gt ObjectDescription 5 Add the selection to an existing Library Object or create a new Library Object a To add the selection to an existing Library Object select the Library Object from the Select Library pull down menu and click OK The selection is added to the Library Object b To add the selection to a new Library Object check the Create New checkbox The remaining fields in the window which appear dimmed by default become active 46 Rockwell Autom
147. ent are only accessible through the Application Code Manager application and are not accessible once the completed Project is exported to code Parameters created in the Library Designer plug in have these functions e Storing information that is pertinent to the specific instance of the Library Object but that is not functional for example the customer contact information for a Project e Differentiating each instance of a Library Object in a Project for example the slot location of Module Object e Configuring each instance of a Library Object in a Project for example to set whether a specific instance of a valve Object has Permissives or Interlocks e Populating a Tag through user input or a specific external reference Parameters allow a single instance of base controller code to have many variations and to be used in a variety of different applications Parameters are instantiated once A Parameter must be unique within a Library Object A Parameter can be copied to other Library Objects and to Library Objects of different scope Parameters can be collected together into a SubObject A SubObject is a grouped set of Parameters that can be instantiated multiple times Examples include the channels of an analog input or the contact information for a Project team member SubObjects can be auto generated during instantiation or added manually by the user when the Library Object is brought into an ACM Project Functions A Function
148. ent gt Allows you to select a different data source Selects a computer name and SQL server instance from a pull down menu You can enter a computer name and SQL server instance in the following format lt Computer Name gt lt SQL Server Instance gt Refreshes the Server name selections When this is selected username and password will be provided through the current Windows user information Name Field Type Data Source Read only Change Button Server name Text entry Refresh Button Log on to the server Use Windows Radio Authentication Button Use SQL Server Radio Authentication Button When this is selected username and password must be entered manually Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 179 Chapter9 Library Object Manager Application Adding Repositories and Copying Library Objects Username Text entry SQL server username entered during ACM Database creation Refer to the ACM manual for more information The default username is sa Password Text entry SQL server password entered when SQL Server Express was installed Refer to the ACM manual for more information Save my password Checkbox When this is checked the username and password are saved and entered by default in future sessions Connect to a database Select or enter a Radio Selects a database name from a pull down menu The default ACM Database database name
149. ents that match the Condition field for the currently selected Conditional Inclusion element Select Same Selects additional elements that match both the Usage field and the Condition field for Both of the Above the currently selected element Select Same Selects additional elements that reference the same Tag as the currently selected element Tag Select All Selects all elements Remove Deactivates the selected elements Add Activates the selected elements Only available when the selected elements have been added to an existing Library Object or when the selected elements have been previously deactivated Undo Undoes the last action Redo Redoes the last action Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 131 Chapter 7 132 The Library Designer Plug in Decorating Library Object Elements Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the defaul
150. equential Function Chart names are function based or are structured when the charts are created in the Logix Designer application to allow Substitutions to be added once to the Library Object and then extend consistently to the charts contained within the Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Name and Definition fields of a Structured Text Chart Refer to The Substitution Builder on page 112 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 135 Chapter 7 136 The Library Designer Plug in Decorating Library Object Elements Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The fiel
151. er application Close the file in the Logix Designer application to make it accessible to the Library Object Manager application P Error Loading ACD xX E Error Loading ACD 7 C Users ACM Desktop New_Lab Lab_WM_ProcessObjects ACD RxDbE FILE IN USE File is currently opened by another process 6 The ACD file mounts and the Library Objects contained in the file appear in the Library Repositories tree view 7 Right click che ACD file Repository to open the contextual menu then select Launch Library Designer Library Repositories B s Repositories E Libr Mount e 1 Unmount Open ACD Launch Library Designer 4 JU 1 Export L5X L L Remove Refresh ta 1 Expand All n THET Collapse TIP You cannot select individual Library Objects in the ACD repository from within the Library Object Manager application All Library Objects in the ACD file open in the Library Designer plug in Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 27 Chapter2 Opening the Library Designer Plug in Notes 28 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter 3 The Library Designer Plug in Main Graphic User Interface Cha pter Objectives This chapter provides information on the following topics e The Main Graphic User Interface e The Selected Objects Button Bar e The Selected Objects Tree View The Library Objects Button Bar
152. er Library Objects Base Libraries extend automatically to all elements contained within these Library Objects and to all Library Items that are lower in the hierarchy Parameters and Functions added to Project or Controller Library Objects are available to Expressions created in the Expression Builder at all levels of these Objects and to all Library Objects that are lower in the hierarchy Decoration inherited from a Library Object or Base Library can be overridden at the element level Predefined Parameters are available to the Expression Builder at all levels of all Library Objects They area feature of the Library Designer plug in and cannot be created modified or deleted by the user A Parameter is an argument that is exposed for external access and that controls how the Library Object is instantiated Parameters have a simple data type Boolean string integer or real Parameters are set and modified by direct user input immediate calculation results or references to other Parameters Parameters added as a decorative element are only accessible through the Application Code Manager application and are not accessible once the completed Project is exported to code Parameters created in the Library Designer plug in have these functions e Storing information that is pertinent to the specific instance of the Library Object but that is not functional for example the customer contact information for a Project Different
153. er the Studio 5000 Logix Designer Plug in Designer application or from the Library Object Manager application The Library Designer plug in opens in a separate window When you exit the Library Designer plug in either by saving or canceling the changes made you return to the program of origin TIP When you open the Library Designer plug in from the Logix Designer application you must also save the ACD file in the Logix Designer application to write the changes to the ACD file Changes saved in the Library Designer plug in are only temporary The ACD file name displayed at the top of the Logix Designer window shows an asterisk until the file is saved in amp Logix Designer ProcessObjects 1756 L75 27 11 File Edit View Search Logic Communications Tools Window Help When you open the Library Designer plug in from the Library Object Manager application changes saved in the Library Designer plug in are saved immediately to the ACD file when you return to the program Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 23 Chapter2 Opening the Library Designer Plug in Opening the Libra ry Designer Follow these n to open the Library Designer plug in from within the Logix Plug in from the Studio 5000 287 application Logix Designer Application 1 Select the item in the Controller Organizer tree that you wish to decorate 2 Right click to open the contextual menu then select Open Library Designer g Logix Designer
154. er9 Library Object Manager Application Adding Repositories and Copying Library Objects 7 The Red X no longer displays and the Library Objects are added to the repository 4 Library Object Manager Library Repositories Repositories Library Objects 2 Lab Project 2 Lab Controller 2 Lab Analoglnput 2 Lab Valve Lab Motor 2 Lab DigitalOutput 2 Lab Digitallnput 2 Lab WashMachine 2 Viva Valve Data Container Libraries 5 Instance Data Unmounting an ACD Repository Follow these steps to unmount an ACD Repository 1 Click the repository to make it active Right click to open the contextual menu 2 Select Unmount The repository remains in the Library Repositories column but the Library Objects are no longer accessible Editing an ACD Repository in the Studio 5000 Logix Designer Application You can move directly between the Library Object Manager application the Library Designer plug in and the Logix Designer application when working with a file Follow these steps to move from the Library Object Manager application to the Logix Designer application 1 Click the repository to make it active Right click to open the contextual menu 2 Select Unmount IMPORTANT You must unmount the ACD file before you will be able to open it in the Logix Designer application When the ACD file is mounted the Open ACD File command appears dimmed 174 Rockwell Automation Publication LO
155. ers without the need for high level programming support Librarians can rapidly create and distribute new Library Objects to meet the needs of specific applications Factorylalk View Studio Librarians use the FactoryTalk View Studio application to create Site Edition SE and Machine Edition ME Symbols The Symbol objects are created as graphic displays and exported to XML The XML files are imported into the Library Object Manager application and added as non Logix content to Library Objects Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 15 Chapter1 Library Designer Plug in and the Library Object Manager Application Overview Features of the Library Designer Plug in The Project Execution Workflow Application Code Manager In the Application Code Manager application Library Objects become the building blocks for Project Engineers to rapidly create and deploy Projects Execution is simply a matter of registering adding and configuring the Library Objects Projects can be completed without requiring high end programming support In the Project Execution workflow Project Engineers select Library Objects in the ACM application configure the Library Object Parameters to meet the requirements of the current application and then complete the workflow by creating the Project to ACD controller code Project Engineers can request new Library Objects from Librarians reuse Library Objects from their own previous
156. escription ObjectDescription Interlock Description Language Library Object Valve Logix Path ProcessObjects Tags XV003 Intik Configure Instantiation Rules Condition HasIntlkObj x Usage One per object gt Exclude Base Library Substitutions Exclude Library Substitutions Name Data Type Value Value Expression XV003 Intlk Enableln EnableOut H Inp Intlk0O Inp IntlkO1 Inp Intlk02 i Inp Intlk03 H Inp Intlk04 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 35 Chapter3 Library Designer Plug in Main Graphic User Interface Decorator Panel Task or Program Selected Refer to Applying Decoration to a Task or Program on page 119 Name TaskName Description Description Language Library Object Valve Logix Path ProcessObjects Tasks Task D 500ms Configure Instantiation Rules Condition Always ss X Usage One per object v Exclude Base Library Substitutions Exclude Library Substitutions Decorator Panel Routine Selected Refer to Applying Decoration to a Routine on page 121 Add Remove Name MainJSR Description Description Language Library Object Valve Logix Path ProcessObjects Task D 500ms Valve MainJSR Configure Instantiation Rules Condition Always Usage Include
157. he Function Block Diagram must be updated in the Library Designer plug in to include the modifications New elements will appear in the Function Block Diagram but must be activated so that they are recognized by the Library Designer plug in TIP The connection wires appear dimmed for Elements that must be activated Follow these steps to activate an element 1 Click the connection wire to select it Right click to open the contextual menu 2 Select Add or click Add at the top of the Decorator Panel The wire displays as black IMPORTANT Default substitutions are inherited automatically Overrides to the default substitution and all other decoration must be applied manually to new elements of an existing Library Object Activating and Deactivating Function Block Diagram Elements Follow these steps to deactivate one or more elements 1 Use the menu commands to select the elements to deactivate You can also select multiple elements by holding down the CONTROL key 2 Right click again on one of the selected elements to open the contextual menu 3 Select Remove or click Remove at the top of the Decorator Panel The Clear Directives window opens Clear Directives mem Clear directives from all selected objects Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 133 Chapter7 Library Designer Plug in Decorating Library Object Elements 4 Click OK to deactivate the elements or Cancel to cance
158. he Function Builder window click Import The Saved Functions window opens Saved Functions fs fon x Name Resulttype Function type test Bool Conditional FC HeatingCoilError String Conditional FC HeatingCoilError String Conditional FC HeatingCoilAvailable String Conditional Fn RPI Numeric Calculation Fn RPI Numeric Calculation Fn RPI Numeric Calculation zip Bool Calculation zip Bool Calculation E zip Bool Calculation FC HeatingCoilAvailable String Conditional Heb 2 The saved Functions window lists all Functions that were previously created in the current ACD File Columns list the Function name result type and Function type Select a saved Function and click OK 3 The saved Function populates the Function Builder Click OK to reuse the Function or edit the fields to create a new Function IMPORTANT Function names must be unique within a Library Object If you are reusing a saved Function and the Function name matches the name of an existing Function in the current Library Object a warning displays Error The function Chassis already exist in this library Click OK rename the Function then click OK in the Function Builder Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Adding Branches to a Conditional Statement Follow these steps to add branches to a conditional statement 1 Select an item in
159. he Library Designer window Selected Objects p Controller Lab WM ProcessObjects j G3 Tasks PO_DeviceControl Sis d Valves TwoState x Parameters and Local Tags MainRoutine B aa Interlocks B aa_Permissives xv100 Motion Groups 5 08 Add On Instructions G Data Types 08 Trends 53 1 0 Configuration TIP Items in the Library Designer plug in are color coded as black blue or green Green indicates that all elements contained by the object or element have been associated with an existing Library Object in the current Project Blue indicates that some but not all elements contained by the object or element have been associated with an existing Library Object Black indicates that no elements have been associated with an existing Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 25 Chapter2 Opening the Library Designer Plug in Opening the Libra ry Designer Follow these steps to open the Library Designer plug in from within the Library Plu g in from the Library Object Manager application Object Manager Application 1 Right click the Repositories item to open the contextual menu 2 Mouse over Add Repository to open the submenu then select ACD 3 Navigate to the ACD file you wish to open and click Open Library Repositories A ETT Reposiony gt Expand All Folder Collapse ACM RIS ect an l e J gt ACM Library gt Sear
160. he field value from its initial value through any Substitutions that have been applied The display is grouped as follows e 0 Initial Value displays the original value of the field e 1 Library substitution for Base Library Object Name displays the Substitution applied from the Base Library Object if one exists 2 Library substitution for Library Object Name displays the Substitution applied from the Library Object if one exists e 3 Field Name substitution displays Substitutions created for the current field TIP Depending on where in the hierarchy Substitutions have been added Groups 1 2 or 3 may not appear Substitutions appear highlighted in yellow The Element Substitution window allows you to track the current Substitutions for the current field and trace them back to their source The Create New Substitution Panel The bottom half of the Substitution Builder holds the fields and commands for creating a new Substitution The following table describes the fields and commands in the Substitution Builder Name Selected Element Field Type Read only Description The original text string entered in the Search For field Result Read only The result generated when the Apply button is clicked to test the Substitution Scope Pull down menu The scope for the new Substitution There are three options Current Field Library Object Base Library Object If Library Objec
161. he following topics Adding a Selected Object The Inclusions Pull down Menu Inclusions Ownership Adding a Selected Object to a Library Object Adding a Child Object or Dependency to an Existing Library Object Adding a Module to a Library Object Creating a New Empty Library Object Library Object Contextual Menu Commands Deleting a Library Object Use one of the following procedures to add an item in the Selected Objects Tree View to a Library Object Click Add Selected objects to a Library Drag it from the Selected Objects column to the Libraries folder or to one of the Library Object folders in the Library Objects column Right click the item select Copy from the contextual menu then right click a folder in the Library Objects column and select Paste from the contextual menu The Inclusions pull down menu on the Selected Objects Button Bar holds three menu commands that determine which elements are included when an item is added to a Library Object and which Library Objects the item may be added to All three commands toggle on and off select the menu command once to activate it and select it again to deactivate it All three commands affect future selections and have no effect on selections and inclusions that have already been made to existing Library Objects Choices remain active until they are changed and remain in effect when the Library Designer plug in is closed and reopened Rockwell Automation
162. hen a Symbol is selected Properties Symbol Name GO P Motor Pump R Include Condition Always Source Text group name ControlleeName ObjectName GO P Motor Pump R visible true wallpaper false tool Tip Text S 0 102 Cfg_Tag S 0 102 Cfg Desc exposeT oVba notExposed isReferenceObject true linkSize true linkConnections true linkAnimations linkWithExpression linkBaseObject RA BAS P Motor Graphics Library GO P Motor Pump R linkToolTipText true gt rectangle name ControllerName ObjectName _Motor_AlarmPolygon13 height 79 width 146 left Calc 405 SymbolWidth Leftindex top Calc 295 SymbolHeight T opindex visible true tool Tip Text expose ToVba notExposed isReferenceObject true linkSize true linkConnections true linkAnimations linkWithExpression linkBaseObject RA BAS P Motor Graphics Library Motor AlarmPolygon13 linkToolTipText true backStyle transparent backColor E0E0E0 foreColor black lineStyle solid lineWidth 2 patternStyle none ipatternColor black endColor white gradientStop Calc 50 SymbolHeight T opIndex gradientDirection gradientDirectionHorizontal igradientShadingStyle gradientHorizontalFromRight animations lt animateVisibility expression 102 Val Notify amp gt 0 expressionTrueState visible gt lt animateColor expression 102 Val Notify blinkRate 2 gt color value 0 foreBehavior solid f
163. his field Tags are added when Add is clicked Add Variable Pull down A list of Tags that can be added to the message This includes a number of Variable menu default variables as well as up to four variables added using the Associated Tags fields in the Properties panel Data Type Pull down Where applicable based on the Tag selected offers a choice of numeric or menu string for the data type of the Tag value within the message These fields appear if String is selected in the Data Type field Use Fixed Width Checkbox For use on displays with fixed display parameters Limits the entry in the Editor Window to the value entered in the Number of Characters field Number of Text entry For use in displays with fixed display parameters Sets the maximum Characters number of characters for a message line 204 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content to a Library Object Chapter 10 Name Field Type Description These fields appear if Numeric is selected in the Data Type field Number of Digits Text entry When the Data Type field is set to Numeric sets the number of digits to display for the Tag value within the message Decimal Places Text entry When the Data Type field is set to Numeric sets the number of decimal places to display for the Tag value within the message Left Fill Pull down When the Data Type field
164. iating each instance of a Library Object in a Project for example the slot location of Module Object Configuring each instance of a Library Object in a Project for example to set whether a specific instance of a valve Object has Permissives or Interlocks e Populating a Tag through user input or a specific external reference Parameters allow a single instance of base controller code to have many variations and to be used in a variety of different applications Parameters are instantiated once A Parameter must be unique within a Library Object A Parameter can be copied to other Library Objects and to Library Objects of different scope Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 amp FindPartial Parameters Functions Substitutions Predefined External References The Library Designer Plug in Decorating Library Objects Chapter 5 Parameters appear in fields Functions and Expressions in the Library Designer plug in as tokens with the following format Parameter Name The Expression shown here includes the token for the Parameter Cfg HasOpenLS Expression Cfg_HasOpenL 1 Parameter names must begin with an alphabetic character and can contain only alphanumeric characters and underscores Parameters can be collected together into a SubObject A SubObject is a grouped set of Parameters that can be instantiated multiple times Examples include the channels of an analog in
165. ibrary Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 129 Chapter 7 130 The Library Designer Plug in Decorating Library Object Elements Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e If no Substitutions have been added to the Library Object the field reverts to the original value for the element Applying Decoration to a Function Block Diagram Element When a Function Block Diagram element is selected most fields in the top half of the Decorator Panel become active Substitutions can be applied to the element using the contextual menu Add Remove Name ObjectName Description Description Language Library Object Lab Motor Logix Path Lab_WM_ProcessObjects Progra
166. ibrary Object eere rr rrr 192 Configuring a Symbols i 193 Changing the Symbol e eerte 194 Setting a Rule for InstaBtisuONaoveosd eset iet Vett da nts 194 Configuring the Object Tag and Path Parameters fora Symbol vara coat hc ecu abc IN 194 Configuring the Location for a 198 Deleting a Symbol from a Library 199 Adding FactoryTalk Alarms and Events FTAE Content to a Library Objects ode EI o dea et pem ES 200 Adding a Digital Alarm to a Library 200 Configuring a Digital Alarm cos ehe VER ARR Reed 202 Changing the Digital Alarm Name enn 203 Setting a Rule for 204 Rockwell Automation Publication LOGIX UM006A EN P October 2015 9 Table of Contents Index Adding a New Message to a Digital 204 Adding an Existing Message to a Digital Alarm 205 Editing an Existing Message 8 206 Adding Message Content to a Library 206 Deleting Message Content from a Library Object 206 Changing the Tag Update Rate for a Digital Alarm 207 Deleting a Digital Alarm from a Library Object 207 Adding FactoryTalk Historian Content to a Library Object 207 Adding Historian Tag to a
167. ibrary Object Substitution e Ifno Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 To edit the value of either field click Ellipsis to the right of either field The Substitution Builder window opens Name ObjectName Description ObjectDescription Description Language Substitution Builder Library Object Lab_Valve Element Substitutions in order Show existing substitutions which do NOT affect this element Logix Path Lab WM ProcessObjects Tad Mode Search for Replace with Locked Result Configure Instantiation Rules 0 Initial Value before any substitutions applied Xv100 ondition Always 1 Base library substitutions from Lab_Controller E Text ControlLogix Controller ControllerDescriptio xVv100 v Exclude Base Library Substitutions 2 Library substitutions from Lab_Valve Tex XV100 ObjectName ObjectName Exclude Library Substitutions ake anes Text Inlet Valve ObjectDescription ObjectName xv100 gt Create New Substitution Selected Element XV100 Inp OpenLS Inp ClosedLS Result ObjecttVame Inp_PermOK Inp_NBPermOK d Inp IntlkOK Scope Name x Operand re
168. ibrary Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field When a Routine is selected the Decorator Panel display has two functional areas The bottom half of the panel displays the Routine Every instruction and Directive in the Routine can be selected and all operands are open to decoration When an operand is selected the top half of the Decorator Panel changes to display the fields available to the currently selected operand Add Remove Name MainRoutine mm Description Description Language M Library Object Lab Valve Logix Path Lab WM ProcessObjects PO DeviceControl Valves TwoState MainR outine Configure Instantiation Rules Condition Always E y Usage Include Once Exclude Base Library Substitutions Fxclude Library Substitutions JSR 0 Jump To Subroutine Routine Name aa Interlocks JSR 1 Jump To Subroutine Routine Name aa_Permissives n JSR Jump To Subroutine Routine Name ObjectName N
169. ied by default Refer to Changing the Motion Group Name or Description on page 147 Description Language Read only The language used for the description The default is English Library Object Read only The Library Object that contains the Motion Group Logix Path Read only link A link to the Edit screen for the Motion Group in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Instantiation Text entry Sets the condition under which the current Motion Group is Rules instantiated Default is Always A condition can be entered manually Condition or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 148 Configure Instantiation Pull down The number of times the Motion Group will be instantiated Default is Rules menu Once per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 148 Exclude Library Checkbox If checked allows Substitution
170. ight then down one row when horizontal space requires Each symbol is positioned within a bounding box that includes the Symbol s height width and x and y offsets Symbols are added to the display in the same order as they were added to the Library Object in the Library Object Manager application 198 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter 10 Relative positioning is required if multiple instances of a Symbol will appear in a display absolute positioning would cause all instances to be stacked on top of each other Follow these steps to apply relative positioning to a Symbol 1 Click the SE Symbols or ME Symbols folder to select it Right click to open the contextual menu 2 Select Add The Symbol Builder window opens 3 Locate the Symbol you wish to add Check all of the Position options in the Apply Substitutions area 4 After the Symbol has been added review the XML code 5 Locate the Left and Top Parameters in the code The values are Expressions using the following formats left Calc bounding box offset Symbol Width LeftIndex top Calc bounding box offset SymbolHeight TopIndex Properties Symbol Name GO P DOut Include Condition T Source Text group name ControllerName ObjectName GO P DOut visible true wallpaper false toolTipText S 0
171. igner Plug in Decorating Library Objects Decorator Panel Function Block Sheet Selected 37 Decorator Panel Add On Instruction Selected 37 Decorator Panel Data Type 38 Decorator Panel Module Selected 38 Main Button Bar een 39 Chapter 4 Chapter Objectives errie ee piura webu gabe 41 Adding a Selected Object iios pua aliens 41 The Inclusions Pull down Menu eese 41 esee User pee el healt ie etie ttn rtt 42 Ownershipusz tube i c e ieee Pees ta s 43 Listing Ownership for a Selected 45 Adding a Selected Object to a Library 46 Adding a Selected Object to a Library Object by Clicking the Add Selected Objects to a Library Button 46 Adding a Selected Object to a New Library Object by Dragging or Copying and 48 Adding a Selected Object to an Existing Library Object by Dragging or Copying and 51 Adding Child Object or Dependency to an Existing Library Object asse Lectt vo EE ehe oe 52 Adding Module to Library Object zu durer eb tese e rei 53 The Module Wizard e oett cet E Pad eet 53 Creating New Empty Library Objects loeo vez 54 Library Object Contextual Me
172. igner application Configure Text entry Sets the condition under which the current Data Type is instantiated Instantiation Rules Default is Always A condition can be entered manually or generated by Condition an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 156 Configure Pull down The number of times the Data Type will be instantiated Default is Once Instantiation Rules menu per Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for the Substitutions current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 156 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 156 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 155 Chapter 7 156 The Library Designer Plug in Decorating Library Object Elements Changing the Data Type Description In a typical application Data Type descriptions have a user accessible Parameter applied as a Substitution to the original text string This allows the user t
173. ion Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Decoration can be applied to a Rung or a Directive Applying Decoration to a Rung When a Rung is selected a few fields in the top half of the Decorator Panel become active Substitutions can be applied to the Rung using the contextual menu Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 123 The Library Designer Plug in Decorating Library Object Elements The following table describes the fields in the top half of the Decorator Panel when a Rung is selected Name Field Type Description Configure Instantiation Text entry Sets the condition under which the current Rung is instantiated Rules Default is Always A condition can be entered manually or generated Condition by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 125 Configure Instantiation Pull down The number of times the Rung will be instantiated Default is Once per Rules menu Object Default options are Usage One per Object Incl
174. ion Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Follow these steps to sort the Substitutions by a column 1 Mouse over the column heading to make it active The heading displays a graduated blue fill 2 Click once to activate the sort feature for the tab The Substitutions are sorted in ascending order for the values in the column 3 Click a second time to toggle the sort to descending order 4 Click once in the Name column to revert to the default alphabetic listing Changing the Columns Displayed in the Substitutions Tab The Substitutions Tab can display the following columns e Original Value e Scope e Replacement Value e Search Mode Refer to Adding a New Substitution on page 92 for a full description of these fields Follow these steps to change the columns displayed 1 Right click the column heading The contextual menu appears 2 Select Columns to display the submenu listing all columns 3 Mouse over an inactive column to add it to the display Mouse over an active column to remove it from the display f 4 FindPartial Parameters Functions Substitutions Predefined External References Original Value 42 Sonne M100 Columns gt v Original Value P100 Lab WashMacd Y Scope Washing Machine Lab WashMacl v Replaced Value WMO1 Lab WashMacl Search Mode xvinn lah WashMartn TIP Co
175. ions and can be used in many Projects Library Designer The Library Management workflow continues in the Library Designer plug in Using the Library Designer plug in the Library can assign the Project the Controller and any of the Logix Objects to one or many Library Objects Each Library Object defines a set of functions capabilities and connections valve motor controller module Rather than being tied to one application Library Objects can be configured to meet the needs of multiple applications The Librarian adds decorative elements Custom Properties to the Library Object including Parameters SubObjects Functions Substitutions and External References Decoration allows the Library Object to be configured when it is implemented in a Project in the ACM application The ACM application can only access the decoration that has been added in the Library Designer plug in Logix Objects can be restricted to a single Library Object or assigned to multiple Library Objects each with a different set of decoration A Library Object can contain a single Logix Object or a Logix Object can be added as an element of a more complex Library Object For example a P_Alarm Add On Instruction can be assigned to a valve Library Object and can also be an element of a Motor or Pump Library Object Each ACD file can include one Project Library Object one Controller Library Object and any number of Logix Object Library Objects While decorati
176. is set to Numeric determines whether values menu will be filled in to match the value set in the Number of Digits field Add Button Adds the currently selected Tag to the message in the Editor Window ID Text entry The unique numeric ID for the Message OK Button Applies the message to the Message field and closes the Message Editor Cancel Button Closes the Message Editor without applying the message Help Button Opens the Help screens 2 Enter the text including Tag tokens in the Editor Window 3 Enteran ID for the message in the ID field IMPORTANT Thevalue within the ID field for each message must be unique for all Digital Alarm messages within a Project Blocks of ID numbers should be reserved for each Library Object and used exclusively for that Library Object 4 Click OK to apply the completed message or Cancel to Cancel Adding an Existing Message to a Digital Alarm Follow these steps to add an existing Message 1 Click the Browse button The Message Browser opens 74 Message Browser el ID Message 76 High Discharge Pressue of j S 0 Tag1 PSlInlet Pressure S 0 OK Hep 2 The Message Browser displays all messages that have been created within the current ACD file Select a listing and click OK to apply it or Cancel to cancel IMPORTANT value within the ID field for each message must be unique for all Digital Alarm messages within a Project Message
177. isting Library Object by Dragging or Copying and Pasting Follow these steps to add a selected Object to an existing Library Object by dragging or copying and pasting 1 Click Inclusions to open the pull down menu a Library Object Designer A gt Inclusions E Add Children Add Dependencies Allow Shared Ownership 2 Select whether Children or Dependencies will be included in the Library Object and whether the item will be exclusive to the Library Object or available for other Library Objects 3 Select the item or items you want to add TIP Hold down the SHIFT or CONTROL keys to select multiple items 4 Doone of the following a Drag the selection on top of an existing Library Object in the Library Objects column b Right click the selection to open the contextual menu Select Copy Right click the Library Object folder to open the contextual menu Select Paste The selection is added at the appropriate locations within the existing Library Objects structure The new elements inherit all applicable substitutions from the Library Object IMPORTANT Default Substitutions are inherited automatically Overrides to the default Substitutions and all other decoration must be applied manually to new elements of an existing Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 51 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object Adding
178. ject String 5 89 ANew LOM New folder 01 Programming and Execution umerence ig 3j Libraries Unit Reference Type Immediate 5 4 ProObj 2 E 02 Device Configuration TT H E MS 1 03 10 Configuration pe xus Value 22 489 localhost SQLACM ACM 4 04 Alarm Configuration SpPEN 5 5 Libraries H HMI Configuration D 0 Userinterface ProObj 8 4j SubObjects Group 01 Programming and Execution 8 02 Project 1 Functions me Type TextBox 89 02 Controller 1 dj External References r1 T H Module 1 Logix peer H E Controller 1 5 8 FT View 9 02 ControlModule 4 SE Symbols HL Digital 1 ME Symbols H E Analog 1 FTAE 5 Motor 1 Digital Alarms fLab_Motor 1 3 Messages 8 02 Valve 1 Tag Update Rates 8 2 DesignPattern 1 FT Historian H v0 0 Global 2 Historian Tags Name Enter the parameter name must be unique within its scope Apply Help 190 2 Click the Definition Data listing to select it Right click to open the contextual menu Select Expand All The column displays listings for all Parameters Functions and External References added to the Library Object 3 Click a listing for a decorative element to review its settings in the Properties panel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter
179. jects Button Bar is shown below Bar Inclusions The following table describes the Selected Objects Button Bar commands A The Show Hide Decorated Elements button toggles the display of items in the Selected Object Tree View which are associated with a Library Object Default is for these items to display as blue or green Click once to hide them and again to restore the display zx The Add selected elements to a Library button opens the New Library window forthe selected element This is one of three ways an item in the Selected Object Tree View may be moved to the Library Objects column Inclusions The Inclusions pull down menu allows you to select whether Child elements or Dependencies elements referenced by the selected element are included when the selected item is added to a new or existing Library Object You can also select whether the Library Designer plug in will restrict items to a single Library Object or allow them to be associated with multiple Library Objects The Selected Objects Tree The Selected Objects Tree View is shown below View Selected Objects 27 03 Tasks 08 Trends 9 88 Controller Lab WM ProcessObjects id MainTask a9 PO DeviceControl Analoginputs 3 Digitallnputs amp DigitalOutputs 4 08 Motors amp Valves TwoState Motion Groups Add On Instructions 3j 33 Data Types 33 53 1 0 Configuration Click the icon to the left of an ite
180. kens with the following format FunctionName The Expression shown here includes the token for the Function FC_HeatingCoilError Expression FC_HeatingCoilError 0 It is considered a best practice to precede Function names with a prefix such as FC_ or Fn_ so that tokens are easily recognized as Functions when they are placed in an Expression Function names must begin with an alphabetic character and can contain only alphanumeric characters and underscores The Functions Tab Functions are listed alphabetically under a single group heading named by the Library Object 4 FindPrefix Parameters Functions Substitutions Predefined External References Name Scope Function Type Function Scope Lab WashMachine FC_HeatingCoilAvailable Lab_WashM Conditional Object FC_HeatingCoilError Lab WashM Conditional Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 77 Chapter5 Library Designer Plug in Decorating Library Objects All of the columns in the Functions Tab are sortable Follow these steps to sort the Functions by a column 1 Mouse over the column heading to make it active The heading displays a graduated blue fill 2 Click once to activate the sort feature for the tab The Functions are sorted in ascending order for the values in the column 3 Click a second time to toggle the sort to descending order Click once in the Name column
181. l The selected elements appear dimmed Follow these steps to reactivate one or more deactivated elements 1 Select the element name Right click to open the contextual menu 2 Ifnecessary use the menu commands to select additional elements 3 Select Add or Undo TIP You can also click Add at the top of the Decorator Panel To reapply a deactivation to one or more elements 1 Select the element name Right click to open the contextual menu 2 Ifnecessary use the menu commands to select additional elements 3 Select Remove or Redo TIP You can also click Remove at the top of the Decorator Panel Applying Decoration toa When a Sequential Function Chart is selected the Decorator Panel display has Sequential Function Chart functional areas The bottom half of the panel displays the Sequential Function Chart Every element in the chart can be selected and all are open to decoration When an element is selected the top half of the Decorator Panel changes to display the fields available to the currently selected element Add Remove Name SimpleMotion Description s Description Language Library Object Main Logix Path MotionSFC MainTask MainProgram SimpleMotion Configure instantiation Rules Condition Always aes Usage One per object Exclude Base Library Substitutions Exclude Library Substitutions n 1 NonStored Action_000 yosOn Li MSO 1 a
182. l Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects 9 Adding a Folder Repository Follow these steps to add a Folder Repository 1 In the Library Repositories column click the Repositories item to make it active Right click to open the contextual menu Library Repositories Library a Add Repository ACD Expand All Folder Collapse ACM Browse For Folder Select a folder for the library repository WE Desktop 2 9 Libraries R Computer Network Control Panel X Recycle Bin JL 20150622 ACM nt Make New Folder cance 3 Select an existing folder or create a new one a To select an existing folder navigate to the folder and double click the listing Click OK b To create a new folder click Make New Folder A new folder is added to the current directory in the window The name is highlighted Change the name and click OK The Folder opens If the Folder contains Library Objects they are added to the tree view Library Objects are classified within a four level hierarchy Solution gt Library Type gt Category gt Catalog Number Library Objects in a repository Folder are organized according to this hierarchy with the Catalog Number and Version Number uniquely identifying the Library Object Desktop ACM Li
183. lOutput 01 Programming and Execution Unit Lab Digital 1 Lab_DigitalOutput 02 Device Configuration Cfg_HasPermObj Lab Digital 1 Cfg HaslntlkObj Lab Digital 1 Cfg HasOnFdbk Lab Digital 1 Cfg OnFailT Lab Digital 10 0 ec Cfg OffFailT Lab Digital 10 0 ec Lab DigitalOutput 03 IO Configuration IMPORTANT New Parameters and Functions can be added to the Project directly from the tabs in the Member Selector Refer to Adding a New Parameter on page 70 and Adding a New Function on page 82 To add a decorative element to the Replacement field double click the listing To add an additional decorative element click Ellipsis to the right of the Replacement field to reopen the Member Selector window locate the element and double click The Replacement field can also be edited manually Strings numeric characters and tokens can all be used in the replacement string Editing a Substitution Directly in the Substitutions Tab Follow these steps to edit a Substitution directly 1 Double click the Original Value or Replaced Value column for the Substitution The field becomes active for editing 2 Enter anew value manually Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Predefined Parameters The Library Designer Plug in Decorating Library Objects Chapter 5 Editing a Substitution in the Edit Substitutions Window Follow these steps to edit a Substitution in the Edi
184. lay has one functional area The bottom half of the panel displays the Tag and Tag Members for the Data Type but these cannot be edited or decorated Name STRING_12 Description Description Language Library Object Lab Controller Logix Path Lab WM ProcessObjects DataTypes STRING 12 Configure Instantiation Rules Condition Always Exclude Base Library Substitutions Exclude Library Substitutions Name Data Type DefaultValue STRING 12 STRING 12 LEN DINT 196 DATA SINT Description The following table describes the fields in the top half of the Decorator Panel when a Data Type is selected Name Field Type Description Name Read only This field is not available for editing Description Text entry The description that will be applied to the Data Type when the Library Objectis instantiated If Substitutions have been added that replace strings that appear in the original Data Type description these are applied by default Refer to Changing the Data Type Description on page 156 Description Language Read only The language used for the description The default is English Library Object Read only The Library Object that contains the Data Type Logix Path Read only link A link to the Edit screen for the Data Type in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Des
185. ld are filled in by default In a typical application the default values should not be changed Refer to Adding a New External Reference on page 100 3 Click OK to add the External Reference The new External Reference is added to the External References tab for the Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying Decoration to Module Tag Values Follow these steps to apply decoration to a Tag value 1 2 Click within the Value Expression column for the Tag listing Right click to open the contextual menu Select Add Edit Expression The Expression Builder window opens Edit the Expression Refer to The Library Designer Plug in The Expression Builder on page 103 Click OK to add the Expression The Expression token appears in the Value Expression column for the Tag indicating that the Tag will now use the Expression to generate values Decoration tokens appear as blue Follow these steps to edit the decoration applied to a Tag 4 Click within the Value Expression column for the Tag listing Right click to open the contextual menu Select Add Edit Expression The Expression Builder window opens Edit the Expression Refer to The Library Designer Plug in The Expression Builder on page 103 Click OK Follow these steps to delete the decoration applied to a Tag 1 2 Click
186. le describes the regions and controls on the Main Graphic User Interface Selected Objects Button Bar 1 Refer to The Selected Objects Button Bar on page 32 for more information Selected Objects Tree View 2 Refer to The Selected Objects Tree View on page 32 for more information Library Objects Button Bar 3 Refer to The Library Objects Button Bar on page 33 for more information Library Objects Tree View 4 Refer to The Library Objects Tree View on page 33 for more information Decorator Panel 5 Refer to The Decorator Panel on page 34 for more information Main Button Bar 6 Refer to Main Button Bar on page 39 for more information Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Main Graphic User Interface Chapter 3 The Library Designer Main Graphic User Interface is divided into three columns The Selected Objects column displays all of the elements of the current Project or ACD file that were brought into the Library Designer plug in when you opened the program The Selected Objects Tree View follows the structure of the Controller Organizer view or the Logical Organizer view in the Studio 5000 Logix Designer application The display varies depending on what was selected when you opened the Library Designer plug in It includes the Object or Objects that were selected and all referenced elements from the Project The Libr
187. lect NONE if you do not want inheritance to take place 5 Enter a default name and description in the Instantiation fields These will be applied as the default name and description for each instantiation of the Library Object TIP To use an Expression to generate the values rather than entering a text string click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 6 Enter initial substitutions in the Name and Description fields These substitutions extend to all elements within the objects and begin the decoration process Additional substitutions can be added once the Library Object has been created 7 Click OK to save the new Library Object or Cancel to cancel the procedure The new blank Library Object is created Library Objects 2 69 Custom Properties 1 9 Libraries Valve TwoState Library Content A Controller Tags Tasks 3 Motion Groups Add On Instructions Data Types Configuration 56 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Library Object Contextual Menu Commands The Library Designer Plug in Adding a Selected Object to a Library Object Chapter 4 Right clicking any item in the Library Objects menu brings up the Library Object contextual menu Different commands are active based on where the item is located in the Library Object structure 3x Library Objects
188. led From the Start menu select All Programs gt Rockwell Automation gt Application Code Manager gt Library Object Manager Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 161 Chapter8 The Library Object Manager Application The Main Graphic User This chapter describes the Main Graphic User Interface Main GUI for the Library Object Manager application Interface D Library Object Manager a foe fm Settings Library Repositories Library Content Properties E dh Repositories 3 H Lab Motor 1 3 z Lab_WM_ProcessObjects ACD 9 4 Library Objects Data Container Libraries 3 Instance Data 2 89 New LOM New folder 5 54 Libraries H ProObj 2 H 2 MS 1 localhost SQLACM ACM 3 5 Libraries 1 4 ProObj 8 Lj Project 1 H H Controller 1 2 00 Module 1 B E Controller 1 7 2 ControlModule 4 E Digital 1 Analog 1 S E Motor 1 34 H A Valve 1 H DesignPattern 1 9 2 v0 0 Global 2 Library Icon H E Revision History 2 2 Definition Data Ef Parameters i oe Object 01 Programming and Execution Unit 02 Device Configuration 03 10 Configuration 04 Alarm Configuration HMI Configuration cH SubObjects Functions External References age Logix 8 FT View f SE Symbols ME Symbols FTAE i Digital Alarms Messages Tag Update Rates 2 53 FT Historian
189. lick the Tag name The name highlights to indicated it has been selected 3 Right click the selected Tag name to open the contextual menu Select Add External Reference Name Data Type psP100 IOFault AND D OLE EnableIn BOOL 1 Ini 1 Ini Add as Parameter Ind Remove Paramete In Add External Reference 100 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 The References Builder window opens References Builder z 4 External Reference Name ReferenceScope Data Type Value In2 Object Bool ps ObjectName lOFault AND In2 Description Description of the external reference Gees Heb The following table describes the fields in the References Builder window Name Name Field Type Text entry Description The name of the External Reference This is a required field This field is populated automatically when you follow this procedure ReferenceScope Pull down menu Determines the scope ofthe External Reference within the current Library Object If the Library Object contains SubObjects these will appear as options on the list and the External Reference can be scoped to them If the Library Object has no SubObjects Object will be the only option in the list This field is populated automatically when you follow this procedure Data Type Pull down menu The data
190. ller X gt ObjectName gt ObjectDescription OK Cancel Help The New Library window has the following fields Name Field Type Description Catalog Number Text entry The Library Object name which appears when the Library Object is registered in the Application Code Manager application Library Object Text entry The description of the Library Object Description Type Module Checkbox This checkbox identifies the Library Object as a Module A Module registers as Hardware rather than Software in the Application Code Manager application Base Library Checkbox Allows you to select an existing Library Object in the Library Object hierarchy as a Base Library When a Base Library is selected the current Library Object inherits Substitutions from the Base Library and the Expression Builder accesses all Custom Properties of the Base Library when used in the current Library Object When NONE is selected the current Library Object does not inherit Custom Properties Instantiation Text entry Sets the default name for each instantiation of the Library Object The Default Name value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Instantiation Text entry Sets the default description for each instantiation of the Library Object
191. lt Type Sets the data type of the Expression result to one of three choices String Boolean Numeric Validate Validates the current Expression for syntax and data type Refer to Validating and Testing an Expression on page 109 Test Tests the current Expression and return the result Refer to Validating and Testing an Expression on page 109 Save Saves the Expression The Expression is added to the Saved Expressions Tab and becomes available to any Project opened in the Library Designer plug in The saved Expression is not applied to the current field until you click OK in the Expression Builder Button Bar The Expression Builder Button Bar has the following buttons Name Description OK Applies the Expression to the current field and closes the Expression Builder Cancel Closes the Expression Builder without applying the Expression Help Opens the Help screens for the Expression Builder The Expression Box displays the Expression as elements are added to it e Toadda decorative element to an Expression double click the listing a function or operator to an Expression click it once e To insert a decorative element into a function drag across the lt value gt token to select it then double click the element To manually edit an Expression click within the Expression Box Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in The Expression
192. lumns can be resized horizontally by mousing over the right side of the column until the pointer changes to a double arrow then by clicking and dragging Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 89 Chapter5 Library Designer Plug in Decorating Library Objects The Substitutions Tab Button Bar The Substitutions Tab Button Bar is shown below fT FindPartial The following table describes each Substitutions Tab Button Bar command The Add New button opens the Add New Substitution window 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 The Find pull down menu initiates a search for Substitutions that match a text FindPartial string you enter in the field Changing a Substitution s Location in the Tab Follow these steps to change a Substitution s location 1 Select the Substitution 2 Doone of the following a Click Move Up or Move Down b Right click the Substitution to display the contextual menu Select Move Up or Move Down TIP To return a Substitution to its default alphabetic location click the Name column to resort the Substitutions Tab alphabetically Using the Find Feature The Find feature limits the display in the Substitutions Tab to Substitutions that match the text string entered in the field All columns currently being displayed are search
193. m in the tree to display elements that are contained within it Click the icon to collapse the item 32 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Objects Button Bar The Library Objects Tree View The Library Designer Plug in Main Graphic User Interface Chapter 3 The Library Objects Button Bar is shown below The following table describes each of the Library Objects Button Bar commands The Create a New Library button opens the New Library window to create a new empty Library 5 Object x The Delete Selected Objects button deletes the selected Library Objects The Library Objects Tree View is shown below Library Objects a Custom Properties 5 63 Libraries H t Lab Project Lab Controller Lab Analoglnput 3 Lab Motor Lab DigitalOutput Lab Digitallnput zj Lab WashMachine 3H FH EH EH FH FH FH3 FF This column displays all Library Objects that are included in the current Project or ACD file Library Objects are structured in a three level hierarchy Project Library Object Controller Library Object Logix Object Library Objects Tasks Programs Modules Project can include one Project Library Object one Controller Library Object and multiple Logix Object Library Objects Library Objects have a three level structure Catalog Number Library Content Folder Controller Tags Tasks Motion Groups Add On Instructio
194. mber of times the line will be instantiated Default is Once per Rules menu Object Default options are Usage 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 Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 145 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 145 Changing the Structured Text Chart Line Description The Decorator Panel allows you to create Substitutions which can be applied directly to the Definition fields of a Structured Text Chart line Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit th
195. mbol Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 195 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object 6 Properties Review the XML code for the Symbol after it is added to a Library Object Find the Parameters list and locate the values for the Object Tag and Path Parameters The values set in the FactoryTalk View Studio application are correct and should not be edited These tokens can be modified by user input in the Application Code Manager application Symbol Name Include Condition Source Text B4 lt multistatelndicator gt lt group gt GO_P_DOut Always Follow these steps to configure the Parameters in the Library Object Manager application 1 Properties After the Symbol has been added review the XML code Find the Parameters list and locate an instance of the current value for the Path Parameter In this example the current value is ProcessObjix Include Condition Always Source Text Symbol Name GO_P_Motor_Conveyor_R lt connections gt lt parameters gt lt parameter name 102 description Motor Tag P Motor value ProcessObjix MyP_Motor gt lt parameter name 103 description Path include program scope iftag is a program scope tag value ProcessObjix gt Enter the text string in the Find field Enter the Predefined Parameter token Co
196. me that will be applied to the Module when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Module name these are applied by default Refer to Changing the Module Name Parent Module Slot Address RPI or Unicast on page 158 Library Object Read only The Module Library Object that contains the Module Major Version Read only The major version for the Library Object Minor Version Read only The minor version for the Library Object Parent Module Text entry The name that will be applied to the Module when the Library Object is instantiated A Predefined Parameter is assigned by default Slot Text entry The Module slot A Predefined Parameter is assigned by default Address Text entry For Ethernet enabled Modules the IP Address RPI Text entry The Requested Packet Interval RPI for the Module A Predefined Parameter is assigned by default Unicast Text entry For Ethernet enabled Modules the Unicast Address Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 157 Chapter 7 158 The Library Designer Plug in Decorating Library Object Elements Changing the Module Name Parent Module Slot Address RPI or Unicast When Module Library Objects are added default Substitutions are applied throughout the Library Object by the Module Wizard Refer to The Module Wizard on page 53 The Decorator Panel allows you to change the default Substitution fo
197. ms Motors P100 Sheet P_Motor Configure Instantiation Rules Condition Always Usage One per object X Exclude Base Library Substitutions _ Exclude Library Substitutions P_Motor rm Inp_RunFdbk E mm Inp_PermOK EC Out runt Inp_NBPermOK Select By gt b Select Same gt Inp_NBintlk Inp_IOFault Sti Select All ts emove S R Add v lt 100 0 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 The following table describes the fields in the Decorator Panel that are active when a Function Block Diagram element is selected Name Field Type Description Configure Instantiation Text entry Sets the condition under which the current element is instantiated Rules Default is Always A condition can be entered manually or generated Condition by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 132 Configure Instantiation Pull down The number of times the element will be instantiated Default is Once Rules menu per Object Default options are Usage per Object Include Once If the containing Library Object has SubObjects there will also be
198. n Builder 19 21 111 112 113 Create New Substitution panel 114 Create New Substitution panel fields 114 creating a new Substitution 115 showing Substitutions which do not affect the element 113 T Tag 16 111 116 118 151 158 159 Controller 13 20 24 98 112 Local 20 98 112 Member 98 112 member 16 20 Task 13 119 text string 16 19 88 value Boolean 20 103 calculated 16 numeric 20 103 string 20 103 X XML 17 193 196 198 199 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 217 Index Notes 218 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 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 install
199. n are saved to the individual HSL4 file or database entry for the Library Object and are not saved to the original ACD file Each Library Object file saved from the Library Object Manager application is classified within a four level hierarchy Solution gt Library Type Category gt Catalog Number For example an analog input module might be classified as follows e Solution RA LIB ACM 1 00 Solution will in most cases name the Library Object Repository for the Library Object Library Type Modules Library Type is a general classification for the Library Object based on its function such as Module valve or motor e Category Analog Category is a more specific classification for the Library Object based on its function e Catalog Number 1734 IE2C C The specific identifier for the Library Object Each Library Object file must have a distinct version number per Solution Just as the same Logix Object can be used to create one or many Library Objects within the Library Designer plug in the same Library Object can be used to create one or many distinct Library Object files versions within the Library Object Manager application Library Objects can be quickly distributed then registered into and configured for multiple Projects in multiple locations Library Objects are available to any Project Engineer that requires the functionality the Library Object provides Projects can be built and executed by Project Engine
200. nTask Logix Path ST Motion MainTask MainProgram Simple Motion Configure Instantiatton Rules Condition Always Usage One per object gt Exclude Base Library Substitutions Exclude Library Substitutions Structured Text Note the use of the Tag State By forcing a different value into this tag for various instructions it enables the user to direct the program flow and execute instructions only once This is handy for developing sequential program execution Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 141 The Library Designer Plug in Decorating Library Object Elements The following table describes the fields in the top half of the Decorator Panel when a Structured Text Chart is selected Name Field Type Description Name Text entry The name that will be applied to the Structured Text Chart when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Structured Text Chart name these are applied by default Refer to Changing the Structured Text Chart Name or Description on page 142 Description Text entry The description that will be applied to the Structured Text Chart when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Structured Text Chart description these are applied by default
201. nager ACM application e FactoryTalk View Studio The Library Management Workflow Studio 5000 Logix Designer The Library Management workflow begins when a Librarian creates a specific instance of ACD controller code in the Logix Designer application The specific instance is a single Project containing a single Controller The Project includes a logical structure allowing for these Logix Objects e Controller Tags e Tasks Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 13 Chapter 1 The Library Designer Plug in and the Library Object Manager Application Overview e Motion Groups e Add On Instructions Data Types e Trends e I O Configurations Each Logix Object has an internal hierarchy of elements for example a Task may contain one or more Programs each of which may contain one or more Routines Every Project has one Controller There may be one many or no instances of any type of Logix Object in the Project when the specific instance is created This single instance of controller code is saved to an ACD file Traditionally controller code was designed and configured for a specific Project In the Library Management workflow Librarians design content not for a specific Project but to provide a widely applicable set of functions Project components are used to create Library Objects Each Library Object is an independent functional entity that can be easily configured to meet a wide range of applicat
202. nd All Expands all collapsed elements in the Library Repositories column Collapse Collapses all elements in the Library Repositories column 2 Select Add Repository gt ACD The Select an ACD File window opens Q Select an ACD File ME Desktop gt Search Desktop P Organize New folder i e Favorites 2 Size Item type Libraries Desktop 3 RB ACM 9 Libraries amp Computer _ Documents Network E Music JL 20150622 ACM Pictures ACM Library B Videos Outputs J LOM Libraries AppData J New LOM Application Dat J New Lab Contacts g ACMSampleDistribute ACD Cookies 3l 4 Deskton TIR File name Logix Designer acd gt 3 Navigate to the ACD file you wish to add and double click the listing or click Open 4 The ACD file opens Note that the file displays with a red X next to the name and that the Library Objects are not accessible To make the Library Objects accessible the ACD file must be mounted G Library Object Manager Library Repositories Repositories 2 Lab_WM_ProcessOb Mount Unmount Library Open ACD Launch Librar Export to L5X y Designe Remove Refresh Expand All Collapse Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objec
203. ns Data Types I O Configuration Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 33 Chapter3 Library Designer Plug in Main Graphic User Interface The Decorator Panel 34 The structure contained in each Library Object matches the structure of a Project created in the Logix Designer application and all elements included in the Library Object are placed at the appropriate location in the Project hierarchy This makes it possible for the Library Object of a valve that is dependent on Controller Tags Add On Instructions and Data Types to include all of these required elements when it is instantiated in an ACM Project The Decorator Panel is shown below Library Attributes Catalog Number Lab_Valve Library Description Solenoid Operated Valve Type Module Base Library Lab Controller Instantiation Default Name XV100 8 Default Description Substitutions Name XV100 ObjectName Description Inlet Valve ObjectDescription f FindPartial Parameters Functions Substitutions Predefined References Name Scope Default Value Lab_Valve 01 Programming and Execution zi Unit Lab Valve Tank1 Lab TAa Danian Anl 4 j The Decorator Panel becomes active when an element within a Library Object is selected The Decorator Panel displays the fields and functions available to add modify or delete deco
204. nt of the currently selected View Library Object Library Content 5 15 Lab Motor 1 3 Library Icon H E Revision History Definition Data B Parameters B Object 01 Programming and Execution H S 02 Device Configuration Gy 03 10 Configuration Gy 04 Alarm Configuration amp HMI Configuration H SubObjects i Functions External References Logix 5 93 FT View SE Symbols ME Symbols FTAE Digital Alarms Messages Tag Update Rates 5 99 FT Historian i Historian Tags Object elements generated by the Studio 5000 Logix Designer application and the Library Designer plug in display with read only fields in the Properties panel Elements generated by the Library Object Manager application display with editable fields in the Properties panel 166 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Chapter 8 The Properties Panel The Properties panel becomes active when an element within a Library Object is selected It displays the fields and functions available to that element The display changes based on the currently selected element Properties EB 01 General Name Unit Library Object Designer Parameter Parameter Help Unit Reference Data Type String 02 Reference Reference Type Immediate 03 Data Default Value Tank1 Append 04 Userinterface Group 01 Programming and Execution Control Type TextBox
205. ntrollerName in the Replace field Click Apply Substitution Enter the current value for the Object Tag Parameter from the XML code in the Find field In this example the current value is MyP_Motor Note that in this example the Parameter is named Motor Tag P_Motor rather than Object Tag Enter the Predefined Parameter ObjectName in the Replace field Click Apply Substitution 196 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content to a Library Object TIP Chapter 10 If Controller references are created in the FactoryTalk View Studio application as FactoryTalk View parameters example 1103 rather than direct references the reference functionality will be handled by the FactoryTalk View application during actual operation and these substitutions will not be necessary When the Library Object is instantiated in the ACM application the name that the Project Engineer applies to the instance substitutes for the Symbol s ObjectName token The AreaPath token substitution takes place when the Project Engineer enters a value in the AreaPath Parameter for the Controller In the example shown here a motor Library Object has been added to the myCLX Controller and given the name MT 100 The default value for the AreaPath Parameter Area shortcut has been changed to Area myCLX The Object Tag for thi
206. nu Commands 57 Deleting a Library ite elei eere 58 Chapter 5 Chapter Objectives er deno dedu eiie se du SA RR E RU RH i 59 The Decorator Panel 15 oot Sienna sec een mE ERR 59 Adding Decoration to a Library 60 The Decorator Panel Bieldss tou leta p Xe Ex LU Ced 61 The Decorative Elements Tabs 61 Parameters svc Aet eux eet et rou mob oleh at Ath rat do E cte 62 Th Parameters c PROP ayaa ada IESUS Ud SU 63 Changing the Columns Displayed in the Parameters Tab 65 The Parameters Tab Button 66 Using the Find e afe 66 Adding a New Group to the Parameters 67 Deleting Group from the Parameters 67 Rename a Groupies ak ae he CG hs ee ees 67 Adding a SubObject to the Parameters 68 Moving a Parameter within a 69 4 Rockwell Automation Publication LOGIX UMO06A EN P October 2015 Table of Contents Copying eet du Oe tag or ee 69 Moving a Parameter to a Different Group 70 Adding New Paramctets c cnck van dee 70 The Parameter Filter Builder 0ccccccccucucseevesece 74 Editing Te e e pe ERA 75 Listing a Paramete
207. o assign instance specific identification to the Add On Instruction when it is added to an ACM Project Substitutions can also be inherited from the Library Object the Project Library Object or the Controller Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Definition field of an Add On Instruction Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox
208. olumn for the Tag listing 2 Right click to open the contextual menu Select Add Edit Expression The Expression Builder window opens 3 Edit the Expression Refer to The Library Designer Plug in The Expression Builder on page 103 4 Click OK Follow these steps to delete the decoration applied to a Tag 1 Click within the Value Expression column for the Tag listing 2 Right click to open the contextual menu Select Remove Expression The Expression is deleted from the column Applying Decoration toa as a or Program is selected the Decorator Panel display has a single Task or Program unctional area Name TaskName Description Description Language v Library Object Lab_Valve Logix Path Lab WM ProcessObjects Tasks PO DeviceControl Configure Instantiation Rules Condition Always LJ Usage Include Once bd Exclude Base Library Substitutions Exclude Library Substitutions Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 119 The Library Designer Plug in Decorating Library Object Elements The following table describes the fields in the Decorator Panel when a Task or Program is selected Name Field Type Description Name Text entry The name that will be applied to the Task or Program when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Task or Program name the
209. ommand triggered Refer to FTAE documentation Changing the Digital Alarm Name In a typical application the default name should be used Alternatively a name can be entered manually in the Name field Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 203 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Setting a Rule for Instantiation By default Digital Alarms are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Include Condition field or click Ellipsis to the right of the field to open the Expression Builder 2 Refer toThe Library Designer Plug in The Expression Builder on page 103 Adding a New Message to a Digital Alarm Follow these steps to add a new Message 1 Click the New button The Message Editor opens E Message Editor seen High Discharge Pressue ofj S 0 Tag1 PSI Variable Inlet Pressure S 0 Tag2 Variable 1 v Data Type Numeric Number of Digits 8 i Decimal Places 0 5 Left Fill None lt Add ID 76 Hep The following table describes the fields in the Message Editor Name Field Type Description Editor Window Text entry The message appears here as it is compiled Text can be entered directly in t
210. on The default is English menu Library Object Read only The Library Object that contains the Tag Logix Path Read only link A link to the Monitor Tag screen for the Tag in the Studio 5000 Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Text entry Sets the condition under which the current Tag is instantiated Default is Instantiation Rules Always A condition can be entered manually or generated by an Condition Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 121 116 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Name Field Type Description Configure Pull down The number of times the Tag will be instantiated Default options are Instantiation Rules menu One per Object Usage Include Once If the containing Library Object has SubObjects there will also be an option Once per sub object SubObject name for each SubObject Default value is One per Object Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for the Substitutions current Library Object to be overridden Refer to The Substitution Builder on page 112 Exclude Libr
211. on is stored as part of the ACD file it is treated as a separate layer of information from the base controller code Decoration allows the Librarian to control how the Library Object is instantiated including configurations such as naming tag values conditional inclusion and connections to other Library Objects Project Engineers can instantiate one or many distinct instances of a Library Object within an ACM Project and can separately configure each instance Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in and the Library Object Manager Application Overview Chapter 1 Library Object Manager The Library Management workflow is completed when the Librarian opens the decorated ACD file in the Library Object Manager application The Library Object Manager application lets the Librarian publish each Library Object either directly to the ACM Database or to a file in HSL format The published Library Object can be registered by an ACM Project HSL4 files can be distributed individually or as part of a Repository The Librarian can add non Logix user interface features such as HMI FactoryTalk View SE ME and Historian FactoryTalk Historian SE components to the Library Object in the Library Object Manager application This can only be done after the Library Object has been published from the ACD file to a Folder or ACM Database Repository The features added in the Library Object Manager applicatio
212. oreColor1 E0E0E0 foreColor2 E0E0E0 backBehavior solid backColor1 E0E0E0 backColor2 E0E0E0 fillColorMode 2 endColor white gradientStop Calc 50 SymbolHeight T opindex gradientDirection gradientDirectionHorizontal gradientShadingStyle gradientHorizontalFromRight gt color value 1 foreBehavior blink foreColor1 white foreColor2 E0E0E0 backBehavior blink backColor1 white backColor2 E0E0E0 fillColorMode 2 endColor white gradientStop Calc 50 SymbolHeight T opindex gradientDirection gradientDirectionHorizontal gradientShadingStyle gradientHorizontalFromRight gt color value 2 foreBehavior solid foreColorl 00A7F7 foreColor2 00A7F 7 backBehavior solid backColorl 00A7F 7 backColor2 00A7F 7 fillColorMode 2 endColor white gradientStop Calc 50 SymbolHeight T opindex gradientDirection gradientDirectionHorizontal gradientShadingStyle gradientHorizontalFromRight gt color value 3 foreBehavior blink foreColor1 00A7F 7 foreColor2 black backBehavior blink backColor1 00A7F 7 backColor2 an black fillColorMode 2 endColor white gradientStop Calc 50 SymbolHeight Toplndex j Apply Substitutions Find Replace Apply Substitution The following table describes the fields in the Properties panel when a Symbol is selected Name Field Type Description Name Text entry The name that will be applied to the Symbol
213. ory Definition Data Parameters ra Object 38 01 Programming and Execution 02 Device Configuration 03 10 Configuration 04 Alarm Configuration Historian Configuration SubOBJE Functions External References age Logix 83 FT Historian Historian Tag ControllerName ObjectName _Interlock Sts_Intlk 1 210 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Library Content a Library Object Chapter 10 Deleting a Historian Tag from a Library Object Follow these steps to delete a Historian Tag 1 Click the Historian Tag to highlight it Right click to open the contextual menu 2 Select Delete IMPORTANT Whena Historian Tag is added to a Library Object a corresponding Parameter is also added This Parameter is used by the Project Engineer to configure the Historian Tag in the ACM application When a Historian Tag is deleted the corresponding Library Object Parameter must be deleted as well 3 Locate the Parameter for the deleted Historian Tag in this subfolder in the Library Content column Definition Data Parameters Object gt Historian Configuration 4 Click the Parameter to highlight it Right click to open the contextual menu 5 Select Delete Library Content Library Content 3 H Lab Motor 1 0 5 15 Lab Motor 1 0 Library Icon Library Icon 8
214. ory Field Type Description Revision Description Text entry A description of the updates made to the current Library Object compared to previous versions of the Library Object Appears in the Revision History screen when the Object is registered in the Application Code Manager ACM application This is entered manually This is a required field 02 Library Details CatalogNumber Text entry The Library Object name which appears together with the revision number in the Library Object listing when the Library Object is registered in ACM This is entered manually This is a required field If you are copying into the ACM Database the field value is generated by the database and cannot be edited Library Object Description Text entry The description of the Library Object This is a required field If you are copying into the ACM Database the field value is generated by the database and cannot be edited Family Pull down menu The family of the Library Object This is a required field If you are copying into the ACM Database the field value is generated by the database and cannot be edited Solution Pull down menu The Solution for the Library Object Refer to The Library Management Workflow on page 13 for more information on the naming conventions for Library Objects This is a required field Library Type Pull down menu The Library Type for the Library Object Refe
215. otor Library Description Motor Type Module Base Library Lab Controller Instantiation a Edit Parameter 15 pte 4 01 General Name Unit Parameter Help Unit Reference Scope Lab_Motor Data Type String 02 Reference Reference Type Immediate 4 03 Data Tanki Append 04 Userinterface Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 103 Chapter6 Library Designer Plug in The Expression Builder Expressions can be entered manually or created in the Expression Builder IMPORTANT The Expression Builder When an Expression is entered manually decorative element and function tokens must be entered in the correct format e The token must be enclosed in curly brackets Thename must contain only alphanumeric characters and underscores Thename must match the capitalization of the original e Tokens which return a string value must be enclosed in single quotes apostrophes Text entered into an Expression which is to be evaluated as a string value must also be enclosed in single quotes apostrophes The Expression Builder is an intuitive visually responsive environment to create test and save Expressions Window Expression Builder E x amp FindPartial ete si Functions Expressions Predefined Name Scope Default Value Min Max Data Type Lab_Controller 01 Controller ChassisName La
216. ove The Folder is closed in the Library Object Manager application and its listing is removed from the Library Repositories column All Library Objects added to the Folder are saved to the folder location and can be registered in ACM 178 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects 9 Adding the ACM Database as Follow these steps to add the ACM Database a Repository 1 In the Library Repositories column click the Repositories item to make it active Right click to open the contextual menu Library Repositories 5 EET Add Repository Expand All Collapse 2 Library ACD amp Folder wy ACM Select Add Repository gt ACM The Connection Properties window opens Connection Properties Data source Microsoft SQL Server SqlClient Server name 9 Change localhost SQLACM Log onto the server Refresh Use Windows Authentication Use SQL Server Authentication Save my password Connectto a database Select or enter a database name ACM Attach a database file Test Connection Advanced The following table describes the fields and controls on the Connection Properties window Description Displays the current data source in the following format lt Database gt lt Cli
217. part ofthe ACD file and must be published to a Folder or Application Code Manager ACM database before they can be added to an ACM Project ACD files are first added to the Library Object Manager application then mounted to make the Library Objects accessible to the program Folder A new or existing Windows folder Individual Library Object files can be copied into Folders for remote distribution e ACM An instance of the ACM Database Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Chapter 8 When a Library Object is copied into a Folder or the ACM Database the Library Object Manager application generates an HLS4 file for the Library Object Library Objects may be copied multiple times Each time a Library Object is copied a distinct version of the Library Object is created and a distinct HLS4 file is generated The Library Content column displays a tree view of the content of a Library Object that has been selected in the Library Repositories column The Library Content column becomes active when a Library Object that has been copied to a Folder or to the ACM Database is selected By default the column displays Library Object content as a read only display in the Properties panel under these headings Revision History The information entered when the current version of the Library Object was created e Definition Data The decoration added in the Library Designe
218. placement _ Revet Text replacement Delete 4 erences hfi Search for Apply Replace with bs Lock The Substitution Builder allows you to create Substitutions that are specific to the current element You can create one or many Substitutions based on the text strings contained in the original field value Top to bottom the Substitution Builder has two functional areas the Element Substitutions window and the Create New Substitutions panel The Element Substitutions in order Window The top of the Substitution Builder displays a list of Substitutions and their effect on the value of the current field e Ifthe Show existing substitutions which do NOT affect this element checkbox is not checked the window limits the display to Substitutions which include text strings that are part of the original value of the current field e Ifthe Show existing substitutions which do NOT affect this element checkbox is checked the window displays all Substitutions that have been added to the current Library Object and to Library Objects that are higher in the Project hierarchy TIP Displaying all Substitutions shows potential conflicts and unexpected replacements for Substitutions you add to the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 113 Chapter7 Library Designer Plug in Decorating Library Object Elements The display traces t
219. ppears 2 Enter the values for the new Parameter 3 Click OK to add the new Parameter or Cancel to cancel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 73 Chapter5 Library Designer Plug in Decorating Library Objects The Parameter Filter Builder The Filter field can be used to limit the External References available to a Parameter where the Reference Type is set to Reference The Parameter Filter Builder opens when you click Ellipsis to the right of the field Parameter Filter Builder Filters Saved filters Filter gt Value 2 Library CatalogNumber alk Library CatalogNumber Lab_Project Library CatalogNumber Lab_Controller Library CatalogNumber Lab Analoglnput Library CatalogNumber Lab Valve Y Filters and Operators Library CatalogNumber Library Family Library Category And Or Library SolutionType Library Type SubObject Type Expression Validate OK Cene From top to bottom the Parameter Filter Builder is divided into four functional areas Name Filters Saved Filters Tabs Description The Filters tab lists Objects and elements within the current hierarchy of Library Objects as well as their current values They are grouped in descending order by the four classification levels applied when the Library Object is saved in the Library Object Manager application Catalog Number Category Family Library Type The Sa
220. pression The Expression Builder window opens Edit the Expression Refer to The Library Designer Plug in The Expression Builder on page 103 Click OK Follow these steps to delete the decoration applied to a Tag 1 2 Click within the Value Expression column for the Tag listing Right click to open the contextual menu Select Remove Expression The Expression is deleted from the column 152 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Applying Decoration to an Add On Instruction The Library Designer Plug in Decorating Library Object Elements Chapter 7 When an Add On Instruction is selected the Decorator Panel display has one functional area The bottom half of the panel displays the Tag and Tag Members for the Add On Instruction but these cannot be edited or decorated P_Motor Description Singld Speed Motor Description Language en US Library Object Lab Motor Logix Path Lab WM _ProcessObjects AddOnInstructionDefinitions P_Motor Configure Instantiation Rules Condition Always Exclude Base Library Substitutions Exclude Library Substitutions Name Usage Data Type Alias For Default Style Motor P Motor 3 EnableIn Input BOOL Decimal EnableOut Output BOOL Decimal Inp RunFdbk Input BOOL 0 Decimal Inp PermOK Input BOOL 1 Decimal Inp NBPermOK Input BOOL 1 Decimal _ lt mm B gt The following table describes
221. put or the contact information for a Project team member SubObjects can be auto generated during instantiation or added manually by the user when the Library Object is brought into an ACM Project The Parameters Tab Parameters are listed alphabetically by default Parameters can be grouped to make organization and access more intuitive Group names display in blue Group names are displayed in this format Library Object Name Group Name The Parameters in the valve Library Object shown here have been divided into three groups Lab Valve 01 Programming and Execution Lab Valve 02 Device Configuration e Lab Valve 03 IO Configuration Name Scope Default Value Min Max Data Type Ref Type Group Parameter Help Lab_Valve 01 Programming and Execution a Unit Lab_Valve Tank1 String Immediate 01 Programming a Unit Reference Lab_Valve 02 Device Configuration Cfg HasOpenLS Lab Valve 1 Bool Immediate 02 Device Configur 1 Valve provides an Open Limit Switch signal Cfg HasClosedLS Lab Valve 1 Bool Immediate 02 Device Configur 1 Valve provides a Closed Limit Switch signal Cfg_HasPermObj Lab_Valve 1 Bool Immediate 02 Device Configur 1 Has Permissive Object Cfg_HasIntkObj Lab_Valve 1 Bool Immediate 02 Device Configur 1 Has Interlock Object Cfg_FullStallT Lab_Valve 5 0 60 Int Immediate 02 Device Configur After command time with no motion before Fault sec Cfg_TransitStalT Lab_Valv
222. r any of the active fields in a Module Refer to The Substitution Builder on page 112 Adding a Module Tag as a Parameter Adding a Tag or Tag Member as a Parameter makes the Tag value accessible to the Application Code Manager ACM application Follow these steps to add a Tag as a Parameter 1 Click the Tag name to highlight it 2 Right click the highlighted name to open the contextual menu Select Add as Parameter The Add new Parameter window opens 3 Edit the Parameter Some fields will be filled with default values based on the Tag settings Refer to Adding a New Parameter on page 70 for fields and settings available in the window 4 Click OK to add the Parameter The new Parameter is added to the Parameters tab for the Module Library Object The token for the new Parameter appears in the Value Expression column for the Tag indicating that the Tag will now accept values from the Parameter Decoration tokens appear as blue Adding a Module Tag as an External Reference Adding a Tag or Tag Member as an External Reference makes the Tag value accessible to reference type Parameters in ACM Follow these steps to add a Tag as an External Reference Follow these steps to add a Tag as an External Reference 1 Click the Tag name to highlight it 2 Right click the highlighted name to open the contextual menu Select Add External Reference The Reference Builder window opens TIP All fields other than the Description fie
223. r plug in Logix The actual logix code for the Library Object displayed as XML You can also use the Library Content column to add these features to a selected Library Object FactoryIalk View SE ME A Human Machine Interface HMI element Refer to Adding FactoryIalk View SE ME Content to a Library Object on page 191 e FactoryTalk Alarms and Events FTAE A FactoryTalk Alarm and Events element Refer to Adding FactoryTalk Alarms and Events FTAE Content to a Library Object on page 200 e FactoryIalk Historian SE A FactoryTalk Historian element Refer to Adding FactoryTalk Historian Content to a Library Object on page 207 These features can only be added after a Library Object has been copied to a Folder or the ACM Database They are included in the individual HSL4 Library Object file but are not added to the original ACD file The Properties panel displays the fields for the Revision History Decoration and Logix code of the selected Library Object It also displays the fields and controls available when an element that can be actively edited is selected Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 163 Chapter8 The Library Object Manager Application Setting the Default Options for Library Object Classification The Settings window allows you to set default options for the Library Type Category and Family fields in the Properties panel These options display in the pull down menu
224. r s 75 Deleting a Parameter ce las 76 FUnCtiOns Bs eae ss PN a IND E TS 77 The Functions T dau Fata pe rd iron ROS 77 Changing the Columns Displayed in the Functions Tab 78 The Functions Tab Button 79 Using the Find 79 Copying d PUnctlon ct esee ae eas V eR 80 Addinga New Function ds ds Uit eter eek Re vehe eite en ete 82 Using a Previously Created 84 Adding Branches to a Conditional 85 Deleting Branches from a Conditional Statement 85 Editing a Function i x rex e ue PER IS S 86 Listing Function s 8 86 Deleting Functions tiv reto eO HE Re DE Res 87 sata S Eo uM AL i Ss 88 The Substitutions lab RM 88 Changing the Columns Displayed in the Substitutions Tab 89 The Substitutions Tab Button 90 Changing a Substitution s Location in the 90 Using the Find duca ntes 90 Copyinga Substitution s tasas o eoru ed ERA ER eee EUM 91 Adding New Substitution cero ete tA RIP ERE RN ARA US 92 The Member selectors sas ES iat S do 93 Editing a Substitution Directly in the Substitutions
225. r to The Library Management Workflow on page 13 for more information on the naming conventions for Library Objects This is a required field Category Pull down menu The Category for the Library Object Refer to The Library Management Workflow on page 13 for more information on the naming conventions for Library Objects This is a required field Owner Text entry The user or entity that originally published the Library Object This is a required field If you are copying into the ACM Database the field value is generated by the database and cannot be edited Major Revision Text entry integer The major revision number for the Library Object For a new Library Object this defaults to 1 If you are copying into the ACM Database the database generates a default entry based on existing Library Objects with the same CatalogNumber Minor Revision Text entry integer Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The minor revision number for the Library Object For a new Library Object this defaults to 0 If you are copying into the ACM Database the database generates a default entry based on existing Library Objects with the same CatalogNumber 185 Chapter 9 Copying Multiple Library Objects from the ACD Repository to a Folder Repository or the ACM Database 186 The Library Object Manager Application Adding Repositories and Copying Library Objects Fiel
226. ram is the only element that is added to the Library Object With Add Children activated the Local Tags and Routines contained within the valve Program are also added to the Library Object With Add Children and Add Dependencies activated Controller Tags Add On Instructions and Data Types that are referenced by the valve Program are also added to the Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Adding a Selected Object to a Library Object Chapter 4 The Inclusion commands allow you to add fully functional Objects or specific Object elements to a Library Object as needs dictate Library Objects Library Objects Library Objects 5 69 Custom Properties Custom Properties 3 83 Custom Properties 23 9 Libraries 5 69 Libraries 5 89 Libraries amp 3 Lab Valve 5 19 Lab Valve 2 19 Lab Valve 1 9 Library Content A Controller Tags A Parameters and Local Tag Motion Groups Add On Instructions 53 Data Types 5 69 Library Content A Controller Tags psXV100 lOFault AND psXV100 lOFault NOT Eh MainRoutine EJ A Parameters and Local Tag S S Library Content 5 A Controller Tags SS Tasks Tasks LSL100 PO DeviceControl 5 99 PO DeviceControl 2 TT100 fens Valves_TwoState E3 88 Valves_TwoState 2 xv100 XV100_Interlock XV100_Permissive Tasks a PO DeviceControl Jj e Valves_TwoState Inclusions
227. rary Object in the respective fields IMPORTANT The Catalog Number is the only required field and must be unique within the ACD file If the Library Object defines a Hardware component rather than a Software component check the Module checkbox Modules are identified as Hardware when the Library Object is added to an ACM Project Select a Base Library from the Base Library pull down menu if you want the new Library Object to inherit substitutions from an existing Library Object Select NONE if you do not want inheritance to take place Enter a default name and description in the Instantiation fields These will be applied as the default name and description for each instantiation of the Library Object TIP To use an Expression to generate the values rather than entering a text string click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Enter initial substitutions in the Name and Description fields These substitutions extend to all elements within the objects and begin the decoration process Additional substitutions can be added once the Library Object has been created Click OK to save the new Library Object or Cancel to cancel the procedure Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Adding a Selected Object to a Library Object Chapter 4 Adding a Selected Object to an Ex
228. rary Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e Ifno Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 125 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying a Substitution to a Rung Rung names are applied sequentially and cannot be changed If inherited Substitutions have been excluded Substitutions applied to the
229. ration The display changes based on the currently selected element and its location within the Library Object structure Fields that can be edited display with white backgrounds Fields which are locked for editing appear dimmed Fields which can accept calculated values show the Ellipsis button to the right Clicking this button opens the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Main Graphic User Interface Decorator Panel Library Object Selected Chapter 3 Refer to The Library Designer Plug in Decorating Library Objects on page 59 Library Attributes Catalog Number Lab_Valve Library Description Solenoid Operated Valve Type Module Base Library Lab Controller Instantiation Default Name XV100 Default Description Substitutions Name XV100 gt ObjectName Description Inlet Valve ObjectDescription f 4 FindPartial Parameters Functions Substitutions Predefined External References Name Scope Default Value Lab_Valve 01 Programming and Execution Unit Lab_Valve Tank1 gt 4 lnb Vb TAD In TI D annfim sentima r Decorator Panel Controller or Local Tag Selected Refer to Applying Decoration to a Tag on page 116 Name ObjectName _Intlk D
230. ration to Library Object Elements 21 Design Automation Concept 8 888 21 Chapter 2 Opening the Library Designer Plug in Chapter Objectives ee 23 Accessing the Library Designer 1 23 Opening the Library Designer Plug in from the Studio 5000 Logix Designer 24 Opening the Library Designer Plug in from the Library Object Manager Application 26 Chapter 3 The Library Designer Plug in Main Chapter nega dance eee Get 29 Graphic User Interface The Main Graphic User Interface 30 The Selected Objects Button Bars iere sucer terae Ren RES 32 The Selected Objects Tree PURA ERIS 32 The Library Objects Button bere YER ETE 33 The Library Objects Tree View i cesset RI re oes etre nn 33 Th Decorator estem Eva tel ue or moi viet 34 Decorator Panel Library Object 35 Decorator Panel Controller or Local Tag Selected 35 Decorator Panel Task or Program 36 Decorator Panel Routine 1 36 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 3 Table of Contents The Library Designer Plug in Adding a Selected Object to a Library Object The Library Des
231. re XML formatted and registered in the ACM Database A Library Object typically defines parameters subclasses user interface contents and portions of controller code for example Logix and HMI code for example FactoryIalk View SE ME f Library Object E Library Manager Objects 1 ACD T Studio 5000 L5X Enoi Logix ngine Import Export 9 FactoryTalk View FactoryTalk amp Alarm amp Events FactoryTalk Historian Instance Manager Database ACM Library Objects contain controller code as well as decoration Custom Properties Decoration is applied to a Library Object in the Library Designer plug in Decoration can be inherited from a Library Object that is higher in scope Decoration that is applied to a Library Object is inherited by or available to all elements that are contained within the Library Object Decoration can also be applied directly to an element overriding inheritance from the Library Object and from Library Objects of higher scope The Project Library Object and Controller Library Object are added to an ACD file using separate menu commands in the Library Designer plug in The Project and Controller Library Objects are placed higher in the Library Object hierarchy than any Logix Object Library Objects and have predefined Parameters It is not necessary to create these Library Objects in order to create Library Objects from the Logix Objects in the ACD file Library Objects designated
232. rogram Simple_Motion Line Usage w A Structured Text Exclude Library Substitutions Exclude Base Library Substitutions Note the use of the Tag State By forcing a different value into this tag for various instructions it enables the user to direct the developing sequential program execution n The following table describes the fields in the Decorator Panel that are active when a Structured Text Chart line is selected Name Field Type Description Name Read only This field is not available for editing Description Text entry The description that will be applied to the line when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original description these are applied by default Refer to Changing the Structured Text Chart Line Description on page 145 Configure Instantiation Text entry Sets the condition under which the current line is instantiated Default Rules Condition is Always A condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 145 144 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Name Field Type Description Configure Instantiation Pull down The nu
233. ry Object in the respective fields IMPORTANT The Catalog Number is the only required field and must be unique within the ACD file 7 Ifthe Library Object defines a Hardware component rather than a Software component check the Module checkbox Modules are identified as Hardware when the Library Object is added to an ACM Project 8 Select a Base Library from the Base Library pull down menu if you want the new Library Object to inherit substitutions from an existing Library Object Select NONE if you do not want inheritance to take place Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 47 Chapter4 Library Designer Plug in Adding a Selected Object to a Library Object 9 Enter a default name and description in the Instantiation fields These will be applied as the default name and description for each instantiation of the Library Object TIP To use an Expression to generate the values rather than entering a text string click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 10 Enter initial substitutions in the Name and Description fields These substitutions extend to all elements within the objects and begin the decoration process Additional substitutions can be added once the Library Object has been created 11 Click OK to save the new Library Object or Cancel to cancel the procedure Adding a Sel
234. ry Designer Plug in The Expression Builder on page 103 Instantiation Text entry Sets the default description for each instantiation of the Library Object Default The value can be entered manually or generated by an Expression To Description create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Substitutions Text entry Sets the default substitution for a text string in the Library Object name Name when the Library Object is instantiated This string can be the complete name or a substring within the name The substitution extends to the names of all elements within the Library Object By default the Library Object Manager application assigns the Predefined Parameter ObjectName as the Substitution for the entered string Substitutions Text entry Sets the default substitution for a text string in the Library Object Description description when the Library Object is instantiated This string can be the complete description or a substring within the description The substitution extends to the descriptions of all elements within the Library Object By default the Library Object Manager application assigns the Predefined Parameter ObjectDescription as the Substitution for the entered string If you are creating a new Library Object follow these steps 6 Enter the Catalog Number name and Description of the Libra
235. ry Object where you wish to add the Parameter 4 Right click the name of the group in the Parameters Tab where you wish to add the new Library Object to open the contextual menu Select Paste Parameter The Parameter is added to Library Object TIP The Parameter retains its original group name Follow these steps to use a Parameter as the template for a new Parameter in the same Library Object 1 Select the Parameter TIP You can select multiple Parameters using the SHIFT or CONTROL keys 2 Right click the Parameter to open the contextual menu Select Copy 3 Right click the group name or a different group name within the same Library Object to open the contextual menu Select Paste Parameter s The Rename window opens Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 69 70 Chapter5 Library Designer Plug in Decorating Library Objects 4 Enter a new Parameter name to replace the highlighted name The Overwrite checkbox is deselected 5 Click OK The new Parameter is created with the same settings as the original Moving a Parameter to a Different Group Follow these steps to move a Parameter to a different group 1 Double click the Parameter The Edit Parameter window opens 2 Enter the name of the group where you want to add the Parameter in the Group field 3 Click OK Adding a New Parameter Follow these steps to add a Parameter 1 Do one of the following
236. ry Objects Between Folder Repositories and the ACM Database The design process begun with the creation of a single instance of ACD controller code continues in Library Object Manager application with these steps 1 2 An ACD repository is opened and mounted A Folder or an instance of the Application Code Manager ACM Database is opened Library Objects from the ACD repository are copied to the Folder or to the ACM Database FactoryTalk View FactoryIalk Alarms and Events FTAE or FactoryTalk Historian features are added to the Library Object The Library Object file is saved as a new distinct version of the Library Object and becomes available for use in an ACM Project Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 171 Chapter 9 The Library Object Manager Application Adding Repositories and Copying Library Objects Adding and Mounting an ACD Repository 172 Follow these steps to add and mount an ACD repository 1 In the Library Repositories column click a Repositories item to make it active Right click to open the contextual menu Library Repositories Library BET Add Repository d ACD Expand All Folder Collapse te ACM The following table describes each command in the menu Add Repository Opens an explorer window to locate an ACD file an ACD file folder or a connection to the local ACM Database Expa
237. s Symbol is Area myCLX MT 100 Project myProject EET l RA LIB ACM 1 00 H i RA LIB Process 3 1 8 j DemoSolution Unassigned BE Controllers E CLX MyCLX Hg 3 EJ Software 3j FE Task_C_250ms Task D 500ms Task E 1s Task F 2s Task G 5s Task H 10s Unscheduled 6 8 8 EH Ed EH EH ca E en je e eo Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Name Solution myCLX Description Basic Controller Library Catalog Number Basic Controller 1 0 RA LIB ACM 1 00 z 21 Parameters B 8 Bo1 Controller ChassisName Slot 5 Size SoftwareRevision ProcessorType 02 HMI AreaPath Parameters Be 24 01 Controller ChassisName Slot 5 Size SoftwareRevision ProcessorType El 02 HMI 1756 75 197 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Configuring the Location for a Symbol The Top and Left Parameters for each Symbol should be checked and if necessary modified in the Properties panel Symbols are positioned within a display based on the coordinates of their top left corner The positioning can be absolute in which case the Symbol is positioned relative to the top left corner of the screen or relative in which case the Symbol is positioned based on an offset from its individual bounding box Absolute
238. s added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 148 Changing the Motion Group Name or Description In a typical application Motion Group names and descriptions have a user accessible Parameter applied as a Substitution to the original text string This allows the user to assign instance specific identification to the Motion Group when it is added to an ACM Project Substitutions can also be inherited from the Library Object the Project Library Object or the Controller Library Object The Decorator Panel allows you to create Substitutions which can be applied directly to the Name or Definition field of a Motion Group Refer to The Substitution Builder on page 112 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 147 Chapter 7 148 The Library Designer Plug in Decorating Library Object Elements Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single in
239. s added using the Message Browser retain their original ID Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 205 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Editing an Existing Message Follow these steps to edit an existing Message 1 Click the Edit button The Message Browser opens 2 Edit the text in the Editor Window 3 Click OK to apply the changes or Cancel to cancel Adding Message Content to a Library Object Follow these steps to add Message content 1 Click the Message subfolder to select it Right click to open the contextual menu Library Content 5 15 Lab Motor 1 0 Library Icon H Revision History Help Document Definition Data or Logix amp z FTAE Ej Digital Alarms ControllerName ObjectName Err Alarm ControllerName ObjectName Err Sim Add Delete i TagU Expand All Collapse 2 Select Add The Message Editor window opens 3 The Properties panel displays a listing of all existing messages when the Messages subfolder is selected You can also open the Message Editor window by right clicking within the panel to open the contextual menu Select Add 4 Refer to Adding a New Message to a Digital Alarm on page 204 Deleting Message Content from a Library Object Follow these steps to delete a Message 1 Click the Message subfolder to select it 2 The Properties panel displays
240. s and buttons to set the data type of the Expression result and to validate test and save the Expression The validation bar at the bottom displays a color coded response when the Expression is validated Button Bar The OK Cancel and Help buttons for the Expression Builder window The Decorative Elements Tabs hold all decorative elements that are available to the current element All decorative elements added to the current Library Object are available as well as all decorative elements added to Library Objects that are higher in the Library Object hierarchy IMPORTANT New Parameters and Functions can be added to the current Project directly from the tabs in the Expression Builder Refer to The Library Designer Plug in Decorating Library Objects on page 59 for the procedures to add new Parameters and Functions Refer to The Parameters Tab on page 63 for a complete description of the features of the Parameters Tab Refer to The Functions Tab on page 77 for a complete description of the features of the Functions Tab Refer to The Predefined Tab on page 96 for a complete description of the features of the Predefined Tab TIP The Expression Builder window that opens for the Instantiation Default Name and Instantiation Default Description fields for a Library Object also includes the External References Tab for that Library Object Refer to External References Tab on page 98 Rockwell Automation P
241. s defaults to 0 03 Library Usage Rules Upstream Keys Text entry For Module Library Objects a rule that limits the upstream Hardware components that will be made accessible to the Library Object when it is added to an ACM Project Rule is entered manually as a logical expression Downstream Keys Text entry For Module Library Objects a rule that limits the downstream Hardware components that will be made accessible to the Library Object when it is added to an ACM Project Rule is entered manually as a logical expression 3 Enter the information for the new Library Object 4 Click Apply to create the Library Object or Cancel to cancel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 183 Chapter9 Library Object Manager Application Adding Repositories and Copying Library Objects Copying a Library Object Follow these steps to copy a Library Object from the ACD Repository toa 1 Select the Library Object in the ACD Repository and drag it on top of the Folder Repository or the ACM icon for the Folder Repository or ACM Database Database ibrary Repositories 5 4 Repositories 5 8 Lab WM ProcessObjects ACD Library Objects Lab_Project Lab_Controller Lab Analoginput Lab Mot Lab Digite Output Lab Digitali t Lab_WashMachine Viva_Valve Data Container z Libraries 3 Instance Data eem tal 5 Libraries B localhost SQLACM ACM 5 5 Libraries 33 24 ProObj 8 La v0 0
242. s for these fields although the fields also accept direct text entry Follow these steps to set the default options 1 Click the Settings command at the top of the Library Object Manager window The Settings window opens 1 Library Object Manager Settings Settings Library Repog ries Solutions DemoSolution 5 54 Librari Library Types Project Controller Module ControlModule DesignPattern HMI His EJ Prq a Categories Analog Communication Digital Drives Motor PID Valve Speciali Famili oa amilies Project Logix 1756 1734 1738 1794 rrrere a OK Cancel _ Help 2 Click Ellipsis for one of the fields listed The List Editor window opens List Editor Brim Enter the strings in the list one per line Project Controller Module ControlModule DesignPattern HMI Historian rewer 3 Enter the options for the field one per line 4 Click OK to accept the options or Cancel to cancel 5 Click OK in the Settings window to save the changes Resizing the Main Graphic User Interface Follow these steps to resize the interface 1 Clickand hold on a border or a corner of the window 2 Dragto resize a If you have selected the top or bottom border the resize will be limited to vertical b If you have selected the left or right border the resize will be limited to horizont
243. s to limit the display based on a text string 1 Select the Search option in the Find pull down menu 2 Type the text string to search for in the entry field to the right FindPartial Has t Parameters Functions Substitutions Predefine Name Scope Lab_Valve 02 Device Configuration Cfg_flasppents Lab Valve Cfg Hasposedus Lab Valve Cfg Haspermobj Lab Valve Cfg Ras ntikobj Lab Valve Lab Valve 04 Alarm Configuration Cfg RasfulstalAim Lab Valve HasjransitStalAIm Lab Valve Cfg Has ntikTripAim Lab Valve Cfg HasjoFauitAlIm Lab Valve The Parameters Tab display reacts dynamically to the text string entered returning a shorter list of matching Parameters as the text string grows TIP You must delete the text in the entry field to return the display to all Parameters 66 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 Adding a New Group to the Parameters Tab All groups other than the default group must contain at least one Parameter Parameter groups are added modified and deleted through the Group field in the Add new Parameter and Edit Parameter windows Refer to Adding a New Parameter on page 70 and Editing a Parameter on page 75 Follow these steps to add a new group 1 Adda new Parameter or edit an existing Parameter 2 Enter a new name in the Group field 3 Click OK
244. se are applied by default Refer to Changing the Task or Program Name or Description on page 120 Description Text entry The description that will be applied to the Task or Program when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Task or Program description these are applied by default Refer to Changing the Task or Program Name or Description on page 120 Description Language Pull down The language used for the description The default is English menu Library Object Read only The Library Object that contains the Task or Program Logix Path Read only link A link to the Edit screen for the Task or Program in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Instantiation Text entry Sets the condition under which the current Task or Program is Rules instantiated Default is Always A condition can be entered manually Condition or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 121 Configure Instantiation Pull down The number of times the Task or Program will be instantiated Default Rules menu is Once per Object Default options are Usage One per Object Include Once If the containing Library Object has SubO
245. se 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 P 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 Protectiv
246. sible to reference type Parameters in the ACM application Follow these steps to add a Tag as an External Reference 1 2 Click the Tag name to highlight it Right click the highlighted name to open the contextual menu Select Add External Reference The Reference Builder window opens TIP All fields other than the Description field are filled in by default In a typical application the default values should not be changed Refer to Adding a New External Reference on page 100 Click OK to add the External Reference The new External Reference is added to the External References tab for the Library Object Applying Decoration to Tag Values Follow these steps to apply decoration to a Tag value 1 2 Click within the Value Expression column for the Tag listing Right click to open the contextual menu Select Add Edit Expression The Expression Builder window opens Edit the Expression Refer to The Library Designer Plug in The Expression Builder on page 103 118 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 4 Click OK to add the Expression The Expression token appears in the Value Expression column for the Tag indicating that the Tag will now use the Expression to generate values Decoration tokens appear as blue Follow these steps to edit the decoration applied to a Tag 1 Click within the Value Expression c
247. signer plug in You will return to the Library Object Manager application with the modifications saved Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 175 Chapter9 Library Object Manager Application Adding Repositories and Copying Library Objects Exporting an ACD Repository to L5X Format Follow these steps to export an ACD Repository to L5X 1 Click the repository to make it active Right click to open the contextual menu 2 Select Export to L5X 3 The Save As window opens Navigate to the folder location where you wish to save the file and click Save to save or Cancel to cancel CO Ik New Lab ll Search New 1 1 71 Save As Ea 9 Organize New folder e JL 20150622 Beta Name Date modified Samples ACM Library J v1 0 Global J v10 Lab J ACM Outputs LOM Libraries Project MasterP JL New folder New LOM Bic Lab WM ProcessObjects L5X 6 23 2015 5 45PM Logix Designer X E D File name Save as type Logix Designer XML File L5X z Hide Folders Cancel Removing an ACD Repository from the Library Object Manager Application Follow these steps to remove an ACD Repository 1 Click the repository to make it active Right click to open the contextual menu 2 Select Remove The repository is closed in the Library Object Manager application and its listing is removed from the Library Repositories column 176 Rockwel
248. sion To create an Expression click Ellipsis to the right of the field to open the Expression Builder This is a required field when Conditional has been selected in the Type field Else Text entry The value used if the condition returns FALSE The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder This is a required field when Conditional has been selected in the Type field These buttons appear at the bottom of the window for both Calculated and Conditional Functions Import Button Opens the Saved Functions window which gives access to all functions previously created in the current ACD file OK Button Saves the current Functions and inserts the Function token as the value of the current field Cancel Button Returns to the current field without saving the Function Help Button Opens the help screens 2 Enter the values for the new Function 3 Click OK to add the new Function or Cancel to cancel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 83 Chapter 5 The Library Designer Plug in Decorating Library Objects 84 Using a Previously Created Function The Import button allows you to reuse a previously created Function either to populate the current field or as a template to create a new Function Follow these steps to use a previously created Function 1 In t
249. sion To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 209 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Name Engineering Units Field Type Text entry Description The engineering unit for the Tag Can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Library Designer Plug in The Expression Builder on page 103 Instrument Tag Text entry The ItemID that will be applied to the Historian Tag when the Library Object is instantiated The field is populated with a default name based on the Tag name and Library Object for the selected Tag Can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 FTLD Interface Number Text entry The FactoryTalk Historian Live Data FTLD Interface number for the Historian Tag The field is populated with a default value based on the selected Tag Can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of th
250. sion Builder on page 103 2 Set the Usage field to One per object or select Include Once to limit the element to a single instance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 139 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying a Substitution to a Sequential Function Chart Element Follow these steps to apply a Substitution to a Sequential Function Chart element 1 Click the element to select it Right click to open the contextual menu TIP If necessary use the resize slider at the bottom of the ladder logic diagram window to show more of the diagram 2 Click Substitution 3 Refer to The Substitution Builder on page 112 Activ
251. stance in the Project To revert to the default condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution e If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying Decoration to a Motion Group Axis When Motion Group Axis is selected the Decorator Panel display has two functional areas The bottom half of the panel displays the Tag and Tag Members for the Motion Group Axis N Name Axis 0 Description Library Object MotionO1 Logix Path Condition Always Description Language ST Motion Tags Axis 0 Configure instantiation Rules Usage One per object Exclude Base Library Substitutions Exclude Library Substitutions Name Axis 0 MotionGroup MotionModule ConversionConstant Outp
252. stitutions be overridden Refer to Changing the Routine Name or Description on page 123 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Applying Decoration to the Elements in a Ladder Logic Diagram The Library Designer Plug in Decorating Library Object Elements Chapter 7 Changing the Routine Name or Description In a typical application the main Routine for a Program is named Main Routine Other Routine names are structured when the elements are added in the Logix Designer application to allow Substitutions to be added once to the Library Object and then extend consistently to these Routine elements contained within the Library Object For example a motor Library Object with an identifying string of MX001 in the Library Object name and with the Predefined Parameter ObjectName applied as a Substitution might have Routines named MX001 MX001_permissives and MX001_ interlocks The Decorator Panel allows you to create Substitutions which can be applied directly to the Name and Definition fields of a Routine element Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Express
253. t localhost SQLACM ACM 21 19 Libraries LE ProObj 8 PE 2 Project 1 S E Controller 1 22 02 Controller 1 E H Module 1 E E ControlModule 4 8 2 DesignPattern 1 1 2 v0 0 Global 2 W Module 2 6 Right click the ACM Database icon to open the contextual menu Sg ocalhostiSQLACM ACME 2 54 Libraries New Library 1 04 ProObj 8 H Project 1 Remove H E Controller Refresh H Module 1 H ControlMo Expand All H E DesignPa Collapse PL The following table describes each command in the menu New Library Creates a new empty Library Object Refer to Creating a New Library Object on page 182 Remove Remove the Folder from the Library Repositories column Refresh Refreshes the display Expand All Expands all collapsed elements contained within the ACD file Collapse Collapses all elements contained within the ACD file Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 181 Chapter9 Library Object Manager Application Adding Repositories and Copying Library Objects Removing the ACM Database from the Library Object Manager Application Follow these steps to remove the ACM Database 1 Click the ACM Database icon to make it active Right click to open the contextual menu 2 Select Remove The ACM Database is closed in the Library Object Manager application and its listing is removed from the Library Repositories column Creating a New Li
254. t Line 146 Activating and Deactivating Structured Text Chart Lines 146 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 7 Table of Contents The Library Object Manager Application Applying Decoration to a Motion Changing the Motion Group Name or Description Setting a Rule for Instantiation Excluding Inherited Substitutions Applying Decoration to a Motion Group Axis Changing the Motion Group Axis Name or Description Setting Rule for Instantiation Excluding Inherited Substitutions 00 0 cee 8 Adding a Motion Group Tag as a Parameter Adding a Motion Group Tag as an External Reference Applying Decoration to Motion Group Tag Values Applying Decoration to an Add On Instruction Changing the Add On Instruction Description Setting Rule for Instantiation Excluding Inherited Substitutions ee e ERO YS Applying Decoration to a Data tree emere Changing the Data Type Description Setting a Rule for Instantiation Excluding Inherited Substitutions Applying Decoration to a Module 8 Changing the Module Name Parent Module
255. t Substitution window 1 Do one of the following a Double click the Scope or Search Mode column for the Substitution b Right click the Substitution to open the contextual menu Select Edit The Edit Substitution window opens 2 Edit the Substitution Refer to Adding a New Substitution on page 92 for a list of the fields in the Edit Substitution window They are the same as the fields in the Add new Substitution window Deleting a Substitution 1 Right click the Substitution Select Delete The Delete Objects window opens Delete Objects Object s have been selected be permanently deleted Continue Yes 2 To finish the deletion click Yes To cancel the deletion click No IMPORTANT Warning window does not display for Substitutions A Predefined Parameter is one of a set of Parameters that are automatically available to all Library Objects created in the Library Designer plug in They are defined and scoped by the program They are the same for all Library Objects in the hierarchy as well as for all elements of all Library Objects and are available to all Substitutions Expressions and Functions Users cannot create modify or delete Predefined Parameters IMPORTANT All Predefined Parameters are available to the Expression Builder regardless of the scope of the current element A Predefined Parameter used to supply a field value to an Object or element of higher scope will return no val
256. t condition click Revert red X to the right of the Condition field Excluding Inherited Substitutions To remove Substitutions that have been inherited from the Library Object check the Exclude Library Substitutions checkbox The field reverts to the original value for the element To remove Substitutions that have been inherited from the Base Library Object for the current Library Object check the Exclude Base Library Substitutions checkbox e If Substitutions have also been added to the Library Object the field switches to the Library Object Substitution If no Substitutions have been added to the Library Object the field reverts to the original value for the element Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying a Substitution to a Function Block Diagram Element Follow these steps to apply a Substitution to a Function Block Diagram element 1 Click the element to select it Right click to open the contextual menu TIP If necessary use the resize slider at the bottom of the ladder logic diagram window to show more of the diagram 2 Click Substitution 3 Refer to The Substitution Builder on page 112 Activating a New Function Block Diagram Element When modifications are made in the Logix Designer application to a Function Block Diagram which has been added to a Library Object in the Library Designer plug in t
257. t or Base Library Object are selected the new Substitution will replace previous Substitutions added to that Library Object for the same text string Search For Text entry The text string to replace Replace With Text entry The replacement text This can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Operand replacement Text replacement Radio buttons Sets the condition under which the current Tag is instantiated Default is Always A condition can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 117 Revert Button Reverts to the current Substitution for the field 114 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Name Field Type Description Delete Button Deletes the currently selected line in the Element Substitutions window IMPORTANT Deleting a Substitution removes it from the Library Object Apply Button Tests the current Substitution and adds it to the Element Substitution window Unlock Lock Button Unlocks an existing Substitution allowing it to be edited or locks a Substitution preventing it from being edited Creating a Ne
258. the Conditional Statement menu tree Right click to open the contextual menu Function Builder Name FC HeatingCoilAv Function Builder E Conditional _ FC_HeatingCoilAy Function Builder Result Type Sting Type Conditional Name FC_HeatingCoilAvailable Function Scope Object A E Type Function Scope Object Sring Pisa Condition S Function Scope Object gt i L Add If 1 amp Condition Statement Definition Delete Li Elseifthis expressionis true E E t Else Add If E Delete urn this value Import OK Cancel Help 2 Select the root Condition item to add an ELSEIF statement to the root level of the statement The Function Builder adds an Else if this expression is true and a Return this value field TIP Adding ELSEIF statements to the Conditional Statement causes it to function like a CASE statement 3 Select an IF or an ELSEIF item to nest an IF statement within it The Function Builder adds an If this expression is true a Return this result and an Else field TIP There is no limit to the number of branches or the number of nested levels you can add to a Conditional Statement Deleting Branches from a Conditional Statement Follow these steps to delete branches from a conditional statement 1 Select an item in the Conditional Statement menu tree Right
259. the Library Object Library Content 5 15 Lab Motor 1 3 Library Icon H Revision History El Help Document H Definition Data i Logix SEIFT View SE Symbols ME Symbols Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 191 Chapter 10 Library Object Manager Application Adding Library Content to a Library Object Adding a Symbol to a Library Object Follow these steps to add a Symbol 1 Click the SE Symbols or ME Symbols folder to select it Right click to open the contextual menu Library Content 5 15 Lab Motor 1 3 Library Icon E Revision History Help Document H Definition Data Logix 8j FT View ME Sym Add Delete Expand All Collapse 2 Select Add The Symbol Builder window opens Name Group2 Araun 4 iO P Motor Conveyor R iO P Motor Fan D iO P Motor RPump GO P Motor Pump 160 P Motor Pump L ETE NEN Motor_AlarmPolygon13 Motor_Touchpoint13 Motor QuickTouchpoint13 Symbol Builder boha Select Display Export File EATech Support Stuf Sample Displays ov_Motors xml Select Root Node s of Symbol Type group 3 group group group group group rectangle rectangle rectangle Apply Substitutions v Name Prefix v Line Position v Left Position v Arc Position OK v Top Position Cancel Help The following table
260. the fields in the top half of the Decorator Panel when an Add On Instruction is selected Name Field Type Description Name Read only This field is not available for editing Description Text entry The description that will be applied to the Add On Instruction when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Add On Instruction description these are applied by default Refer to Changing the Add On Instruction Description on page 154 Description Language Read only The language used for the description The default is English Library Object Read only The Library Object that contains the Add On Instruction Logix Path Read only link A link to the Edit screen for the Add On Instruction in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Text entry Sets the condition under which the current Add On Instruction is Instantiation Rules instantiated Default is Always A condition can be entered manually or Condition generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to Setting a Rule for Instantiation on page 154 Configure Pull down The number of times the Add On Instruction will be instantiated Instantiation Rules menu Default is Once per Object
261. tion click No IMPORTANT Warning window displays if the Function is referenced You will not however be prevented from deleting the Function Warning FC_HeatingCoilAvailable is used within Lab_WashMachine but found in parent Lab Project Continue to delete Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 87 Chapter5 Library Designer Plug in Decorating Library Objects Substitutions 88 A Substitution is a user defined rule which 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 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 the Studio 5000 Logix Designer application and in the text strings selected for substitution in the Library Object Manager application Substitution which affects text strings in unexpected locations can make the Library Object function in unexpected ways or fail to validate 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 containe
262. to revert to the default alphabetic listing Changing the Columns Displayed in the Functions Tab The Functions Tab can display the following columns e Name e Scope e Function Type e Function Scope Refer to Adding a New Function on page 82 for a full description of these fields Follow these steps to change the columns displayed 1 Right click the column heading The contextual menu appears 2 Select Columns to display the submenu listing all columns 3 Mouse over an inactive column to add it to the display Mouse over an active column to remove it from the display 4 FindPrefix Parameters Functions Substitutions Predefined External References Name Lab_WashMachine Columns v Name FC_HeatingCoiAvailable Scope FC HeatingCoilError v Function Type v Function Scope TIP Columns can be resized horizontally by mousing over the right side of the column until the pointer changes to a double arrow then clicking and dragging 78 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 The Functions Tab Button Bar The Functions Tab Button Bar is shown below f FindPartial The following table describes each Functions Tab Button Bar command The Add New button opens the Functions Builder The Move Up Move Down buttons are deactivated for this tab The Find
263. to take place and displays a warning Warning Cannot add Valves_TwoState Single ownership is selected The object or parent object already belongs to another library Ownership is also tracked to verify that Parent and Child Objects remain associated with the same Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 43 Chapter 4 The Library Designer Plug in Adding a Selected Object to a Library Object For example ifa Main Task and its child valve Program are associated with a Library Object in the Library Designer plug in and the valve Program is reassigned to a different Task within the Studio 5000 Logix Designer application the Library Designer plug in displays the Library Ownership Conflicts window the next time it is opened Library Ownership Conflicts Name C amp Va lves TwoState ba x Type Conflict Action Resolution Valves_TwoState belongs to Delete decoration Pun libraries Lab Valve Valves TwoState will be Its parent MainTask belongs to libraries Lab WashMachine Re Assign decoration removed from Lab_Valve There are two choices available in the Action pull down menu Delete decoration This command is always available When selected it removes the Child Object from the Library Object it is associated with The Child Object can then be reassigned in the Library Designer plug in Re Assign decoration This command is only available
264. tring can be the complete name or a substring within the name The substitution extends to the names of all elements within the Library Object The Library Object Manager application assigns the Predefined Parameter ObjectName as the Substitution for the entered string Substitutions Text entry Sets the default substitution for a text string in the Library Object Description description when the Library Object is instantiated This string can be the complete description or a substring within the description The substitution extends to the descriptions of all elements within the Library Object The Library Object Manager application assigns the Predefined Parameter ObjectDescription as the Substitution for the entered string The values entered when the Library Object was created display by default They are all available for editing The Decorative Elements Tabs Decoration Custom Properties can only be added at the Library Object level Decoration added to a Library Object extends to all elements contained by the Library Object Substitutions extend automatically unless they are specifically overridden Parameters and Functions are available to Expressions created in the Expression Builder at all levels of the Library Object Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 61 Chapter5 Library Designer Plug in Decorating Library Objects Parameters 62 Substitutions added to Project or Controll
265. ts 9 5 Select the ACD file to make it active Right click to open the contextual menu The following table describes each command in the menu Mount Mounts the ACD file Unmount Unmounts the ACD file The listing becomes inactive but remains in the Library Repositories column Open ACD Opens the ACD file in the Studio 5000 Logix Designer application This command is only available if the ACD file is not mounted Launch Library Designer Opens the ACD file in the Library Designer plug in This command is only available if the ACD file is mounted Export to L5X Exports the ACD file to L5X format This command is only available if the ACD file is mounted Remove Remove the ACD file from the Library Repositories column Refresh Refreshes the display Expand All Expands all collapsed elements contained within the ACD file Collapse Collapses all elements contained within the ACD file 6 Select Mount IMPORTANT You will not be able to mount the ACD file if it is currently open in the Logix Designer application An error window displays Error Loading ACD x Error Loading ACD C Users ACM Desktop New_Lab Lab_WM_ProcessObjects ACD RxDbE_FILE_IN_USE File is currently opened by another process To make the ACD file accessible to the Library Object Manager application close it in the Logix Designer application Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 173 Chapt
266. tutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 139 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 139 Right click to open the contextual menu The following table describes the commands in the contextual menu Substitutions Opens the Substitution Builder Select By Has Directives Selects all elements in the chart Select By No Directives Deselects all elements in the chart Select By Repeat per Object Selects all elements where the Usage field has been set to Include Once per Object Select By Repeat per SubObject Selects all elements where the Usage field has been set to Include Once per SubObject Select By Repeat per Include Once Selects all elements where the Usage field has been set to Include Once Select By Conditional Inclusion Selects all elements where the Condition field matches the option selected in the submenu Submenu displays all conditional inclusions rules for the current diagram Select Same Repeat Per Selects additional elements that match the Usage field for the currently selected element Select Same Conditional Inclusion Selects additional elements that match the Condition field for the currentl
267. tween Library Objects of different scope Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 19 Chapter 1 20 The Library Designer Plug in and the Library Object Manager Application Overview Predefined Parameters A Predefined Parameter is one of a set of Parameters that are automatically available to all Library Objects created in the Library Designer plug in They are defined and scoped by the program They are the same for all Library Objects in the hierarchy as well as for all elements of all Library Objects and are available to all Substitutions Expressions and Functions Users cannot create modify or delete Predefined Parameters IMPORTANT Predefined Parameters appear generically at all levels of the Project hierarchy Care must be taken when applying a Predefined Parameter to verify that the use is properly scoped Predefined Parameters are populated during instantiation when a Library Object is added to an ACM Project Predefined Parameters cannot be copied or pasted since they are defined by the Library Designer plug in and are identical for all Library Objects External References An External Reference makes the value of a Local Tag Controller Tag or Tag Member within a Library Object accessible to Parameters in other Library Objects Used in conjunction with Parameters that have been assigned to accept values by reference External References provide the points of contact between Library Objects in
268. type of the External Reference Options are String Integer Real Boolean This field is populated automatically when you follow this procedure Value Text entry The specific location of the External Reference once the Library Object has been instantiated By default uses the Predefined Parameter ObjectName Displays in the format ObjectName Tag Name The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder This field is populated automatically when you follow this procedure Description Text entry The description of the External Reference that appears when it is highlighted in ACM This must be entered manually 4 Enter the values for the new External Reference or accept the default values generated by the Library Object Manager application 5 Click OK to add the new Function or Cancel to cancel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 101 Chapter 5 102 The Library Designer Plug in Decorating Library Objects Editing an External Reference To edit an External Reference right click the External Reference to open the contextual menu Select Edit The References Builder window opens TIP Refer to Adding a New External Reference on page 100 for a list of the fields in the References Builder Deleting an External Reference Follow these steps to
269. u Select Edit 2 The Edit Parameter window opens TIP Refer to Adding a New Parameter on page 70 for a list of the fields in the Edit Parameter window The two windows display the same fields Listing a Parameter s References Once it has been added a Parameter may be referenced multiple times within a Library Object Parameters added to a Project or Controller Library Object may be referenced from within multiple Library Objects These are examples of ways a Parameter can be referenced e Asapart of a field value for other Parameters or SubObject Parameters e As part of an Expression As part of a Substitution e As part ofa Function The References window lists all references to a Parameter and gives one click navigation to the referencing entities To open the References window for a Parameter right click the Parameter to open the contextual menu Select Show References The References window opens References Library Usedin Details Navigate Lab Valve Parameter Inp_ClosedLSOk Visible 4 Lab Valve Parameter Inp ClosedLS Visible 4 Lab Valve Sheet 1 IRef IRef Expression Cfg HasClosedLS AND Inp ClosedLS Lab_Valve Sheet 1 IRef IRef Expression Cfg_HasClosedLS Lab_Valve Tag XV100 gt Cfg_HasClosedLS Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 75 Chapter5 Library Designer Plug in Decorating Library Objects
270. ublication LOGIX UMOOGA EN P October 2015 105 Chapter6 Library Designer Plug in The Expression Builder The Predefined Functions and Operators 106 The Expressions Tab The Expressions Tab gives quick access to saved and recently used Expressions This eliminates repetitive Expression coding when multiple fields use the same Expression or when an existing Expression can be used as a template The Library Objects Designer plug in saves a running list of the last ten Expressions created in the Expression Builder Saved Expressions are available to all Projects opened in the Library Designer plug in Refer to Saving an Expression on page 110 FindPartial Parameters Functions Expressions Predefined Name Group Value Most Recently Used a 1 Most Recently Used InstOn Yes 2 Most Recently Used Doit_ Index 3 Most Recently Used Round Cfg_FullStallT 4 Most Recently Used Abs Cfg_TransitStallT gt 10 Saved a Exp Saved Chassis HC100 NOT Cfg_HasPermObj IMPORTANT Saved and Recently Used Expressions are carried over from previous Projects The decorative elements in these Expressions may not be present in the current Project The functions and operators available in the Expression Builder give you the ability to test and manipulate the values returned by the decorative elements Predefined Functions and Operators Format Modulus Round Abs Length GetParameterMax CalcBitNumber
271. ubstitutions Predefined External Name Scope Default Lab Valve 02 Device Canfiauratiant Cfg HasOpenLS Cfg HasClosedLS Add new Parameter Paste Parameter s Cfg HasPermObj Add new SubObject Cfg HasIntlkObj FullStalT Cfg TransitStallT Paste SubObject Collapse Library The New SubObject window opens New SubObject EX SubObject Attributes Inp_Perm Index Permissivelnput escriptio v The following table describes the fields in the New SubObject window Name Field Type Description Name Text entry The name that will be applied to the SubObject when it is added to an ACM Project The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Type Text entry The identity for the SubObject group in the Parameters Tab This is a required field The name must be unique for the Library Object Description Text entry A description of the SubObject that appears at the bottom of the ACM window when the SubObject is active The value can be entered manually or generated by an Expression To create an Expression click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on
272. ude Once If the containing Library Object has SubObjects there will also be an option Once per sub object SubObject name for each SubObject Exclude Base Library Checkbox If checked allows Substitutions added to the Base Library Object for Substitutions the current Library Object to be overridden Refer to Excluding Inherited Substitutions on page 125 Exclude Library Checkbox If checked allows Substitutions added to the current Library Object to Substitutions be overridden Refer to Excluding Inherited Substitutions on page 125 JSR q Jump To Subroutine Substitutions _ Routine Name aa Interlocks Select By 4 Has Directives SelectSame No Directives JSR 1 Select All Repeat per Jump To Subroutine Remove Conditional Inclusion gt Routine Name aa Permissives Add N _ JSR 1 Jump Subroutine Redo Routine Name ObjectName To select Rung for decoration click a Rung name to select the Rung Right click to open the contextual menu If necessary use the resize slider at the bottom of the ladder logic diagram window to show more of the diagram TIP The following table describes the commands in the contextual menu Substitutions Opens the Substitution Builder Select By Has Directives Selects all Rungs that include Directives Select By No Directives Selects all Rungs that do not include Directives Select By Repeat per Object Selects all Rungs wher
273. ue Care should be taken to scope Predefined Parameters correctly when they are used to populate field values Predefined Parameters are populated during instantiation when a Library Object is added to an ACM Project Predefined Parameters cannot be copied or pasted since they are defined by the Library Designer plug in and are identical for all Library Objects Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 95 Chapter 5 96 The Library Designer Plug in Decorating Library Objects The Predefined Tab Predefined Parameters are listed alphabetically They are grouped by scope Group names display in blue Groups can be collapsed and expanded using the arrow buttons on the right or by double clicking the group name Parameters are displayed alphabetically within their groups All of the columns are sortable Predefined Parameters sort within their groups f 4 FindPartial Parameters Functions Substitutions Predefined External References Name Global ControllerDescription ControllerName ParentName ProcessorType ProjectDescription ProjectName SoftwareRevision Local ObjectDescription ObjectName Scope Global Global Global Global Global Global Global Local Local Data Type 2 string string string string string string string string string The following table describes the Predefined Parameters
274. ull down menu 41 Inclusions pull down menu commands 42 Library Objects button bar 33 Library Objects column 31 49 52 54 111 Library Objects tree view 33 Library Ownership Conflicts window 44 Library Ownership Conflicts window commands 44 Library Ownership window 45 Main button bar 39 main graphic user interface 29 New Library window 46 49 55 New Library window fields 47 49 55 opening from Library Object Manager LOM 26 opening from Studio 5000 Logix Designer 23 opening the program 23 Parameters tab 63 Add new Parameter window 71 Parameter Filter Builder 74 Parameter Filter Builder functional areas 74 Add new Parameter window fields 71 adding a new group 67 adding a new Parameter 70 button bar 66 button bar commands 66 changing the columns displayed 65 collapsing a group 64 copying a Parameter 69 as a template for a new Parameter 69 to a different Library Object 69 deleting a group 67 deleting a Parameter 76 editing a Parameter 75 expanding a group 64 find feature 66 group 63 moving a Parameter to a different group 70 moving a Parameter within a group 69 listing a Parameter s references 75 New SubObject window 68 New SubObject window fields 68 References window 75 References window fields 76 renaming a group 67 Predefined tab 96 find feature 97 group 96 Predefined tab button bar 97 reactivating a Function Block element 134 141 146 reactivating Rungs 126 Selected Objects button bar 32 41 Selected Objects col
275. umn 25 31 44 52 59 Selected Objects tree view 31 32 53 setting a rule for instantiation 121 123 125 129 132 136 143 145 148 150 154 156 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Index Substitutions tab 88 Add new Substitution window 93 Member Selector 93 Add new Substitution window fields 93 adding a new Substitution 92 changing a Substitution s location 90 changing the columns displayed 89 copying a Substitution 91 as a template for a new Substitution 91 to a different Library Object 91 deleting a Substitution 95 editing a Substitution directly in the tab 94 in the Edit Substitution window 95 Substitution Builder 88 Substitutions tab button bar 90 Library Object 16 19 31 77 98 111 112 163 184 187 190 adding a selected Object 41 assignment 14 associated items 25 31 43 52 contextual menu commands 57 Controller 17 54 create an empty Library Object 54 Decorator Panel 116 default Module Parameters 53 default Module SubObjects 54 deleting 58 hierarchy 17 19 54 88 111 inheritance 19 Logix Object 14 Module 17 53 Project 14 17 54 revision 183 185 structure 33 Library Object classification 15 183 185 Category 15 Library Type 15 Solution 15 version number 15 Library Object Manager ACD file Repository 26 mounting 26 ACD Repository 162 184 ACM Database Repository 162 184 187 adding FactoryTalk Alarms and Events FTAE content 200 a
276. utCamExecutio PositionUnits AverageVelocityTime St RotaryAxis Data Type Value group1 ST motion C 8000 0 0 Revs 0 25 Linear The following table describes the fields in the top half of the Decorator Panel when a Motion Group Axis is selected Name Field Type Description Name Text entry The name that will be applied to the Motion Group Axis when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Motion Group Axis name these are applied by default Refer to Changing the Motion Group Axis Name or Description on page 150 Description Text entry The description that will be applied to the Motion Group Axis when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Motion Group Axis description these are applied by default Refer to Changing the Motion Group Axis Name or Description on page 150 Description Read only The language used for the description The default is English Language Library Object Read only The Library Object that contains the Motion Group Axis Logix Path Read only link A link to the Edit screen for the Motion Group Axis in the Logix Designer application Click the link to open the screen You will need to close the Library Designer plug in to access the Logix Designer application Configure Text entry Sets the condition under
277. utions 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 the Logix Designer application and in the text strings selected for substitution in the Library Object Manager application Substitution which affects text strings in unexpected locations can make the Library Object function in unexpected ways or fail to validate 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 refer to The Substitution Builder on page 112 Substitutions can be copied and pasted from one Library Object to another and can be copied and pasted be
278. ved Filters tab displays filters which were previously created for the current ACD file Filters and Operators The most commonly used elements are listed here for quick access as well as the logical AND logical OR and equals functions Expression The parameter filter appears here as elements are added to it There is also a button to validate the filter The validation bar at the bottom displays a color coded response when the filter is validated Button Bar The OK Cancel and Help buttons for the Parameter Filter Builder window 1 To add an Object to a filter expression double click its listing The Object is added in this format Library Classification Level Object 2 To add a logical operator to the expression do one of the following a Click the operator listing once b Enter text manually 74 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Objects Chapter 5 3 Click Validate to validate the filter The filter is validated for internal syntax and data type The validation bar displays green for a passed validation and red with an error message for a failed validation 4 Click OK to accept the filter expression or Cancel to cancel Editing a Parameter Follow these steps to edit a Parameter 1 Do one of the following a Double click the Parameter b Right click the Parameter to open the contextual men
279. w Substitution Follow these steps to create a new Substitution Review the Substitutions listed in the Element Substitution window to trace the origin of the current Substitution if one exists TIP Check Show existing substitutions which do NOT affect this element to see all current Substitutions This shows potential conflicts and unexpected replacements for new Substitutions you create Select a scope in the Scope field 3 Enter an initial text string to be replaced in the Search For field Enter a replacement string in the Replace With field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expression Builder on page 103 Select a scope for the text search Operand replacement limits the search to the tokens for operands so it should only be selected if this is where the substitution should take place Text replacement limits the search to text strings not in tokens Click Apply to test the Substitution The new Substitution appears under Group 3 in the Element Substitutions window Click OK to exit the Substitution Builder or Cancel to cancel If necessary check the Exclude Base Library Substitutions or Exclude Library Substitutions checkbox so the new Substitution takes precedence Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 115 Chapter7 Library Designer Plug in Decorating Library Object Elements Applying Decoration toa
280. warning icon You will not be able to add that Library Object until all required fields are filled You can uncheck a listing to skip it when the Apply button is clicked Refer to Copying a Library Object from the ACD Repository to a Folder Repository or the ACM Database on page 184 for a description of the fields in the Library Object Configuration window Copying Libra ry Objects a these steps copy multiple Library Objects between Folder Repositories Between Folder Repositories Database and the ACM Database 1 Select multiple Library Objects a Hold down the SHIFT key to select a contiguous block of Library Objects b Hold down the CONTROL key to select individual Library Objects that are not contiguous c Select a Solution Library Type or Category listing to select all of the contained Library Objects or select the Libraries listing to select all of the Library Objects in the Repository 2 Place the mouse within one of the selected items and drag all of the Library Objects on top of the Folder Repository or the ACM Database The Library Import Configuration window opens IMPORTANT Library Objects copied from a Repository are copied intact You will not be able to edit any information for the Library Objects 3 Click Apply to complete the copy or Cancel to cancel Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 187 Chapter9 Library Object Manager Application Adding Repositories and Cop
281. well Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Applying Decoration to a Structured Text Chart 4 Click OK to deactivate the elements or Cancel to cancel The selected elements appear dimmed Follow these steps to reactivate one or more deactivated elements 1 Select the element name Right click to open the contextual menu 2 Ifnecessary use the menu commands to select additional elements 3 Select Add or Undo TIP You can also click Add at the top of the Decorator Panel Follow these steps to reapply a deactivation to one or more elements 1 Select the element name Right click to open the contextual menu 2 Ifnecessary use the menu commands to select additional elements 3 Select Remove or Redo TIP You can also click Remove at the top of the Decorator Panel When a Structured Text Chart is selected the Decorator Panel display has two functional areas The bottom half of the panel displays the Structured Text Chart Every line in the Chart can be selected and all are open to decoration Additional commands at the top of the display allow you to select all or deselect all lines Add Remove SelectAll Lines Clear Selection Name Simple_Motion J Description Program to enable two axes gear them together move the master jump to a subroutine wait for a timer repeat the Description Language Library Object Mai
282. window opens to display whether or not the connection was successful If the connection is not successful the OK button is deactivated until a successful connection is made Test results Xx Test results lt DBNETLIB ConnectionOpen Connect SQL Server does not Test connection succeeded exist or access denied 180 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Object Manager Application Adding Repositories and Copying Library Objects 9 5 see detailed information about the data connection click Advanced The Advanced Properties window opens Advanced Properties Replication False Security Encrypt False Integrated Security True Password Persist Security Info False TrustServerCertificate False User ID a 4 Source AttachDbFilename Context Connection False localhosASQLACM Data Source Indicates the name of the data source to connect to Data Source localhost SQLACM1Initial Catalog ACM Integr CE The ACM Database or the selected database or file opens The Library Objects in the database are added to the tree view Library Objects are classified within a four level hierarchy Solution gt Library Type gt Category gt Catalog Number Library Objects in the ACM Database are organized according to this hierarchy with the Catalog Number and Version Number uniquely identifying the Library Objec
283. within the Value Expression column for the Tag listing Right click to open the contextual menu Select Remove Expression The Expression is deleted from the column Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 159 Chapter7 Library Designer Plug in Decorating Library Object Elements Notes 160 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives Features of the Library Object Manager Application Opening the Library Object Manager Application Chapter 8 The Library Object Manager Application This chapter provides information on the following topics Features of the Library Object Manager Application Opening the Library Object Manager Application The Main Graphic User Interface The Library Repositories Tree View The Library Content Tree View The Properties Panel Main Button Bar The Library Object Manager application allows a Librarian to perform these tasks Saving Library Objects as individual files or entities in a database Adding non Logix components to Library Objects including FactoryTalk View SE ME Symbols FactoryTalk Historian Tags and FactoryTalk Alarms and Events FTAE Digital Alarms Creating Repositories for storing and distributing Library Object files To open the Library Object Manager application do one of the following Click the Library Object Manager application shortcut on the desktop if a shortcut has been instal
284. xis MSO NonStored Action 008 mso 0 axisO_MSO Pulse Action 009 n gear ratio 0 Tran 000 axisl ServoActionStatus axisO0 ServoActionStatus 10095 134 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 The following table describes the fields in the top half of the Decorator Panel when a Sequential Function Chart is selected Name Field Type Description Name Text entry The name that will be applied to the Sequential Function Chart when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Sequential Function Chart name these are applied by default Refer to Changing the Sequential Function Chart Name or Description on page 135 Description Text entry The description that will be applied to the Sequential Function Chart when the Library Object is instantiated If Substitutions have been added that replace strings that appear in the original Sequential Function Chart description these are applied by default Refer to Changing the Sequential Function Chart Name or Description on page 135 Description Language Pull down The language used for the description The default is English menu Library Object Read only The Library Object that contains the Sequential Function Chart
285. xternal References that match the text string entered in the field All columns currently being displayed are searched The following table describes the options in the Find pull down menu FindPartial Searches for the text string in any part of an entry FindPrefix Searches for the text string at the beginning of an entry Follow these steps to limit the display based on a text string 1 Select the Search option in the Find pull down menu 2 Type the text string to search for in the entry field to the right 4 FindPrefix Pro Parameters Functions Substitutions Predefined External References Name 4 Reference Scope Va 1756 OB32 CatNum Object 1756 0832 ProductCode Object 17 ProductType Object 7 1756 OB32 DI Address DI ChFault DI The Functions Tab display reacts dynamically to the text string entered TIP You must delete the text in the entry field to return the display to its default Adding a New External Reference IMPORTANT While all of the fields in the Reference Builder are open to manual editing it is recommended that you follow this procedure and allow the Library Designer plug in to enter values automatically Follow these steps to add a new External Reference 1 Locate the Tag within the Library Object that you wish to add as an External Reference TIP Controller Tags and Local Tags are open for use as External References 2 Double c
286. y 3 Right click the group name or a different group name within the same Library Object to open the contextual menu Select Paste Function s The Rename window opens Rename eal Ple unique name to rename xisting if applicable HeatingCoilErro Overwrite 4 Enter new Function name to replace the highlighted name The Overwrite checkbox is deselected 5 Click OK The new Function is created with the same settings as the original Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 81 Chapter 5 The Library Designer Plug in Decorating Library Objects Adding a New Function Follow these steps to add a new Function 1 Doone of the following a Click Add New b Right click the group name to open the contextual menu Select Add new Function amp FindPartial Parameters Functions Substitutions Predefined Name Lab WashMar Add new Function FC HeatingCoil FC Paste Function s The Function Builder window opens The window for a Function with the Type field set to Conditional is shown on the left and a Function with the Type field set to Calculation is shown on the right Function Builder Name Type Result Type Function Scope Condition If Else Function Builder
287. y 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 Activates the selected elements Only available when the selected elements have been added to an existing Library Object or when the selected elements have been previously deactivated Undo Undoes the last action Redo Redoes the last action Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 The Library Designer Plug in Decorating Library Object Elements Chapter 7 Changing the Sequential Function Chart Element Description The Decorator Panel allows you to create Substitutions which can be applied directly to the Definition field of a Sequential Function Chart element Refer to The Substitution Builder on page 112 Setting a Rule for Instantiation By default elements are set to instantiate under all conditions and to instantiate once every time the Library Object is added to an ACM Project Follow these steps to set a rule for instantiation 1 Enter a value in the Condition field or click Ellipsis to the right of the field to open the Expression Builder Refer to The Library Designer Plug in The Expres
288. ying Library Objects Notes 188 Rockwell Automation Publication LOGIX UMOOGA EN P October 2015 Chapter Objectives Overview Chapter 10 The Library Object Manager Application Adding Library Content to a Library Object This chapter provides information on the following topics Overview Viewing the Decoration Settings of a Library Object Viewing the Logix Code ofa Library Object Adding FactoryTalk View SE ME Content to a Library Object Adding FactoryTalk Alarms and Events FTAE Content to a Library Adding FactoryTalk Historian Content to a Library Object Librarians can add and configure non Logix HMI content to Library Objects in the Library Object Manager application including FactoryTalk View SE ME Symbols FactoryTalk Historian Tags and FactoryTalk Alarms and Events Digital Alarms Refer to the FactoryTalk documentation for more information on configuring these components TIP Library Objects which have been modified in the Library Object Manager application display with an asterisk next to their name until their Repository is removed When the Repository is removed from the Library Object Manager application updates are saved to the HLSA file Library Repositories Repositories Lab_WM_ProcessObjects ACD 5 8 Desktop New_Lab 5 5 Libraries ProObj 2 localhost SQLACM ACM 5b Libraries Lad ProObj 8 2 Project 1 2 Controller 1 2 Module 1 2 ControlModule 4 89 22 Digital

Download Pdf Manuals

Related Search

Related Contents

取扱説明書 - Copal Electronics  HAVER EML 200 digital plus  En vision C onsole Installation Manual  Postal Ballot_Notice Form 2015  MANUAL TÉCNICO Cartel “Altura Maxima Excedida”  34._--—\.\J [age  Ewent EW1215 mobile device charger  

Copyright © All rights reserved. Failed to retrieve file