Programming Manual Logix5000 Controllers Import/Export Project Components Catalog Numbers 1768-L43, 1768-L45
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.
Summary of changes This manual contains new and updated information. This table contains the changes made to this revision. Topic Page Introduction: Added a description of Library Management. See Introduction on page 9. Export Components: Updated procedure to explain the difference between exporting programs from the Logical Organizer versus the Controller Organizer. See Export logic components on page 11.
Table of contents Preface Studio 5000 environment ..................................................................................... 7 Chapter 1 Import and export logic components Introduction ............................................................................................................ 9 Export considerations .......................................................................................... 10 Export logic components...............................................................
Table of Contents Chapter 4 Additional considerations for programs and equipment phases Introduction .......................................................................................................... 43 Export considerations .......................................................................................... 43 Import considerations..........................................................................................
Preface Use this manual to become familiar with importing and exporting project components for Logix5000 controllers. The project components covered in this manual include the importing and exporting of rungs, routines, programs and equipment phases, user-defined types, tags, and Add-On Instructions. This manual is one of a set of related manuals that show common procedures for programming and operating Logix5000 controllers.
Chapter 1 Import and export logic components Introduction This chapter explains import and export of logic components. You use the Logix Designer application to perform online edits for the Logix family of controllers. The import/export functionality provides a greater degree of flexibility during development and deployment of projects.
Chapter 1 Import and export logic components Export considerations Keep the following considerations in mind when exporting components. • You may get more than you expected in an .l5x file. Some components referenced by the exported component are also exported. • Starting with version 24 of Logix Designer, you can use program parameters to share data directly between programs in addition to Controller-scoped tags.
Import and export logic components • Only the offline data values of tags are exported to the .l5x file, even when the project is online with the controller. When exporting components that include tags while online, the software prompts you to upload tag values before exporting the component. Important: • Export logic components Chapter 1 Whether exporting while offline or online with the controller, only offline data values of tags are exported to the .l5x file.
Chapter 1 Import and export logic components 4. (Optional) In the File description, edit the default description or type a description, if desired. A default description is supplied for some component exports. Tip: The file description can be viewed in a tooltip during import when selecting which file to import. 5. Click Export. Import considerations This section covers general considerations for all component-type imports.
Import and export logic components Chapter 1 Topic Consideration Online options When importing programs, equipment phases, routines, or rungs online, the logic can be imported as: • Pending Edits that exist only in the offline project and are not downloaded to the controller. • Accepted Edits that are downloaded to the controller where they can be tested, accepted, or canceled. • Finalized Edits that are downloaded to the controller, assembled, and cannot be canceled.
Chapter 1 Import and export logic components Topic Consideration Asynchronous import Import operations are not synchronized with the Program Scan (just as online editing operations are not synchronized). For most objects, this does not matter because: • Existing online tag data values are never overwritten. • New tags and their initial data values are written to the controller before the new logic runs. • The switch-over to the new logic is synchronized with the program scan (just like online editing).
Import and export logic components Chapter 1 Safety Topic Consideration Safety components limitations while online Safety components cannot be created, modified or deleted during an online import. Safety components limitations while offline Safety components cannot be created, modified or deleted during an offline import. If a Safety Signature exists, the project is Safety locked.
Chapter 1 Import and export logic components To import a Right-click And choose Set of rungs A rung or set of rungs within a Ladder routine editor Import Rungs Routine A program or equipment phase Import Routine Program A task, the Controller Fault Handler folder, the Power-Up Handler folder, or the Unscheduled Programs/Phases folder Import Program Equipment Phase A task or the Unscheduled Programs/Phases folder Import Equipment Phase User-defined data type User-Defined folder Import Data
Import and export logic components Chapter 1 The following screen capture shows a typical Import Configuration dialog box. Your dialog box might contain options different than those shown here, depending on the component you import. An import component collides with an existing component if a component of the same type, scope, and with the same name exists in the project.
Chapter 1 Import and export logic components collision or other situations, for example, project security privileges, may affect what Operations are permitted for a component. The following table describes the configuration options. Configuration Description Import Name The Import Name is read-only and shows the name of the component as read from the import file. Operation The Operation determines whether the component from the import file is imported.
Import and export logic components Chapter 1 Configuration Description Schedule In The Schedule In setting determines the task in which the imported component is scheduled. The default setting for Schedule In depends on the Operation setting and whether you import the component into the Controller Organizer or the Logical Organizer.
Chapter 1 Import and export logic components Configuration Description Parent Determines where the imported component is organized. The default setting for Parent depends on whether you exported the component from the Controller Organizer or the Logical Organizer, whether you are importing it to the Controller Organizer or the Logical Organizer, and on the Operation setting.
Import and export logic components Chapter 1 For components that do not collide, click Properties for more information on the component. Important: A component you select for import that collides with an existing component defaults to overwriting the project component unless the components are identical, in which case, the project component is used. If the project component is used, references may still be imported.
Chapter 1 Import and export logic components The following screen capture shows a typical Import Configuration dialog box for multiple components. Your dialog box might contain options different than those shown here, depending on the components you import. Imported items are listed in the Import Content pane based on the items that are part of the import content.
Import and export logic components Chapter 1 • Programs -- If you are importing multiple programs, the grid shows the programs that are being imported into the project. If you are importing multiple hierarchies, the grid shows the programs and the children of the programs that are being imported into the project. • Tags, Add-On Instructions, Data Types and Other Components -References include any tags directly referenced by any imported logic or tags (using Alias For).
Chapter 1 Import and export logic components Configuration Description Parent Specifies how the programs are organized upon import. • When you import a program into the Logical Organizer, the default is the Parent in the selected program in the Logical Organizer. • The default is when a Parent is not specified in the selected program in the Logical Organizer, or when you are importing programs into the Controller Organizer.
Import and export logic components Chapter 1 In My Original Project, the parameters in Program1 are connected to parameters in Program2. When you import the original Program1 into My New Project, the parameters in Program1 connect automatically to matching parameters in Program2. Parameters that do not match are flagged as errors. You need to change the Final Connector for those parameters.
Chapter 1 Import and export logic components To open the Connections grid, click Connections on the Import Configuration dialog box. The following screen capture shows the Connections grid as it would appear when you import Program1 into My New Project, as described earlier in this section. To fix the connection errors, you can select Disconnect in the Operation box, or you can select a different connection in the Final Connection box.
Import and export logic components Chapter 1 Column Description Parameter The parameter identified in this box is the parameter in the import content that is to be connected to another parameter on a program that exists in the project. A New Connection option is available on the last row of the grid if the import content contains only one program.
Chapter 1 Import and export logic components Example: using the operation and final connection boxes to establish connections Parameter in Imported File Connection in Imported File Operation Value Final Connection box What happened in this case \Prog1.InA \Prog2.OutA Connect \Prog2.OutA This connection exists in both the import content and in the program in the project, so the connection is the same. \Prog1.InB \Prog2.OutB Connect \Prog2.
Import and export logic components Chapter 1 Configure component references In addition to determining how the component is imported, you must configure how references are imported. The references are all other components used by the exported component at the time it was exported. For example, a program .l5x file contains the definition of all controller-scoped tags, user-defined data types, userdefined string types, and Add-On Instructions referenced by the program at the time the program was exported.
Chapter 1 Import and export logic components Icons in the Differences column ( ) on the Import Configuration dialog box show whether components collide with differences, or the component only exists in the import file or the project. Click the icon in the Details column ( ) and a Collision dialog box opens showing the differences between the import component and the colliding project component. Use the information in the Collision dialog box to determine whether to overwrite or use the existing component.
Import and export logic components Chapter 1 References configuration example The following example shows how an imported routine plugs into the components in a project after you configure it. For example, if you import a routine, the routine itself is the main import component. References that should be connected during the import could include program-scope tags, controller-scope tags, user-defined data types, any routines called by JSR instructions, and any Add-On Instructions in the routine logic.
Chapter 1 Import and export logic components During import configuration, connect each: • Reference tag in the import routine to a program or controller-scoped tag in the project. • Reference routine in the import routine to a routine in the project. • User-defined data type defining a reference tag in the import routine to a user-defined data type in the project. • Add-On Instruction in the import routine to an Add-On Instruction in the project.
Import and export logic components Chapter 1 are excluded from the import file and they also appear with an Operation of Undefined if the component does not exist in the project. During import configuration, these undefined references can be configured as well. Since there is no definition for these components in the .l5x file, you cannot overwrite a project component or create a component during the import process, but you can use an existing component for that reference.
Chapter 1 Import and export logic components Designer application for a project, you can dynamically switch between languages in that project as you use the software. The following project documentation items support multiple languages.
Import and export logic components Chapter 1 If the project has project documentation turned on, all language-switched comments from the .l5x file are imported into the project. This may result in additional languages being available in the project after import. Selecting a language in Current Import Documentation Language allows you to edit that language’s comments from the import file during the import configuration process.
Chapter 1 Import and export logic components 3. To replace text that is found, enter the replacement text in the Replace With box. To use wildcards in your search string and in the replacement text, select the Use Wildcards check box. Use asterisks (*) as wildcard characters. This table provides examples of Find-Replace operations using wildcards.
Import and export logic components Chapter 1 The import/export feature supports forward compatibility for export operations, and does not support backward compatibility for export operations. Earlier versions of the Logix Designer application cannot read .l5k or .l5x files that were created with later versions of the application. In some cases, an .l5k or .l5x file created with a later version of the Logix Designer application may import with warnings into an earlier version of the application.
Chapter 2 Additional considerations for rungs Introduction This chapter explains import and export of rungs. Export considerations One rung or a contiguous set of selected rungs may be exported to an .l5x file. The export file may also include any program-scoped tags, controller-scoped tags, Add-On Instructions, user-defined data types, and user-defined string types that are referenced by the rungs.
Chapter 2 Additional considerations for rungs Topic Consideration Tag scope When you export rungs from a program or equipment phase and import them into an AddOn Instruction routine, any referenced controller-scoped or program-scoped tags are converted on import. The tag is converted to a local tag unless local scoped is not allowed (for example, a Motion Group tag cannot be a local tag), in which case the tag is converted to an InOut parameter.
Chapter 3 Additional considerations for routines Introduction This chapter explains the import and export of routines. Export considerations A routine can be exported to an .l5x file. Routines of all language types, Function Block Diagram, Sequential Function Chart, Ladder Diagram and Structured Text, may be exported. However, routines may not be exported from an Add-On Instruction container and SoftLogix external routines may not be exported.
Chapter 3 Additional considerations for routines For considerations for referenced user-defined types, Add-On Instructions, and tags that may be imported with the rungs see: 42 • Additional considerations for user-defined types on page 47 • Chapter 6, Import and export Add-On Instructions on page 49 • Additional considerations for tags on page 59 Rockwell Automation Publication 1756-PM019E-EN-E - October 2014
Chapter 4 Additional considerations for programs and equipment phases Introduction This chapter explains import and export of programs. All topics apply to equipment phases as well; any exceptions are noted. Export considerations A program can be exported to an .l5x file. The exported program includes all of its program tags and routines, which are imported with the program automatically.
Chapter 4 Additional considerations for programs and equipment phases The following are considerations when importing a program. Topic Consideration Accepted or Test Edits exist A program with Accepted Edits or Test Edits may not be overwritten. Deletes of program-scoped tags and routines during program overwrite When importing a program to replace an existing program, any tags or routines in the existing program that are not in the new program are deleted during import.
Chapter 5 Additional considerations for user-defined types Introduction This chapter explains import and export of user-defined data types and userdefined string types. Export considerations A user-defined type or user-defined string type can be exported to an .l5x file. The export file may also include any Add-On Instructions, user-defined data types, and user-defined string types referenced by the exported user-defined type.
Chapter 5 46 Additional considerations for user-defined types Rockwell Automation Publication 1756-PM019E-EN-E - October 2014
Chapter 6 Import and export Add-On Instructions Introduction This chapter explains import and export of Add-On Instructions. Create export files When you export an Add-On Instruction, the exported Add-On Instruction includes all of its parameters, local tags, and routines. These are imported with the Add-On Instruction automatically. Optionally, you can include any nested Add-On Instructions or user-defined data types that are referenced by the exported Add-On Instruction.
Chapter 6 Import and export Add-On Instructions Export to separate files If you want to store many Add-On Instructions that share a set of common AddOn Instructions or user-defined data types in a common location, you can export each Add-On Instruction and user-defined data types to separate files without including references. Follow these steps to export to separate files. 1. Right-click the Add-On Instruction in the Controller Organizer, and choose Export Add-On Instruction. 2.
Import and export Add-On Instructions Chapter 6 makes it easier to maintain the instructions because you have to update only one export file. To use Add-On Instructions that were exported in a separate file without references, you must first import any user-defined data types of Add-On Instructions that the exported instruction references before the import of the referencing instruction can be successful.
Chapter 6 Import and export Add-On Instructions 2. Select the location to store the .l5x file. 3. In the File name box, type a name for the file. 4. Select the Include all referenced Add-On Instructions and User-Defined Types check box. 5. Click Export. This procedure exports the selected Add-On Instruction and all referenced instructions into the same export file. This file can be used to distribute an AddOn Instruction.
Import and export Add-On Instructions Chapter 6 When importing Add-On Instructions directly or as references, consider these guidelines. Topic Consideration Tag Data Imported tags that reference an Add-On Instruction in the import file may be affected if the Add-On Instruction is not imported as well. In this case, the imported tag’s data may be converted if the existing Add-On Instruction’s data structure is different. Tag data may be lost.
Chapter 6 Import and export Add-On Instructions Import Configuration When you select a file to import, you use the Import Configuration dialog box to choose how the Add-On Instruction and referenced components are imported. If no issues exist, you can click OK to complete the import. If your Add-On Instruction collides with an Add-On Instruction in the project, you can: • Rename it by typing a new, unique name in the Final Name box. • Choose Overwrite from the Operation menu.
Import and export Add-On Instructions Chapter 6 The Collision Details button lets you view the Property Compare tab, which shows the differences between the two instructions, and the Project References tab, which shows where the existing Add-On Instruction is used and how the arguments are updated to locations where the existing Add-On Instruction is called. Update an Add-On Instruction to a later revision using import When you must update an instruction to a later revision, you can import it from an .
Chapter 6 Import and export Add-On Instructions 4. Click Collision Details to see any differences in the Add-On Instruction definition, and to see any changes that will be made to the logic where the Add-On Instruction is called. Differences listed in the Property Compare tab are shown in bold in the Name column. Tip: The Compare dialog box compares metadata for each instruction definition, such as description, revision, or edited date.
Import and export Add-On Instructions Chapter 6 The Project References tab shows a list of locations where the Add-On Instruction is called, and for each location, shows how the arguments in the Add-On instruction will be updated to adapt to the new parameters.
Chapter 7 Additional considerations for tags Introduction This chapter explains import and export of referenced tags. Tip: Export considerations Starting with version 24 of Logix Designer application, you can use program parameters to share data between programs in much the same way that you use controller-scoped tags. Program parameters are imported and exported in the same way as tags in most instances.
Chapter 7 Additional considerations for tags Topic Consideration Tag data Imported tags that reference an Add-On Instruction or user-defined data type in the import file may be affected if the Add-On Instruction or user-defined data type is not imported as well. In this case, the imported data for the tag may be converted if the existing data structure is different and tag data may be lost.
Index A Add-On Instruction 53 export 13 import 19 attention flags 37 B backward compatibility 41 C canceled import 37 collision import 58, 59 communication timeouts 14, 57 compare instructions 59 component configuration 58 export 11, 13 import 11, 19 configuration attention flags 37 components 58 example 35 import 33, 58 options 20, 57 references 33 undefined references 36 Connections grid 32 considerations export 12 import 57 motion 17 online import 14 safety 17 security 18 D E equipment phase 47 expor
Index Add-On Instruction 53 canceled 37 components 11, 19 configuration 33, 58 considerations 57 equipment phase 47 failed 37 L5X 11, 19 local tag 65 multiple components 24 parameter 65 program 47 routine 45 rungs 43 tag 65 user-defined data type 51 user-defined string type 51 Import Configuration dialog box 59 import considerations equipment phase 57 local tag 57 multiple components 18 parameter 57 program 57 routine 57 rungs 57 tag 57 user-defined data type 57 user-defined string type 57 importIXimport 5
Index export considerations 65 import considerations 57 tooltip attention flags 37 trend export 13 import 19 U undefined references 36 update Add-On Instruction revision 59 user-defined data type 51 export 13 export considerations 65 import 19 import considerations 57 user-defined string type 51 export 13 export considerations 65 import 19 import considerations 57 UTF-8 file format 11 W wildcards 40 X XML files 11 Rockwell Automation Publication 1756-PM019E-EN-E - October 2014 61
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.
