Using the UDI Library

UDI Definitions • Definition Library • Reuse Across Projects

Overview

The UDI Library (Definition Library) is a feature within the UDI Management panel that lets you store User Defined Instruction (UDI) definitions outside of any single project, organize them into groups, and reuse them across multiple projects. Instead of rebuilding the same UDI — a motor start routine, a conveyor sequence, a palletizer block — from scratch in every project, or exporting from one project and into another project, you can save a finished definition to the library once and drop it into future projects as needed.

This article covers the Definition Library specifically: creating and importing groups, adding definitions to the library, and moving definitions between the library and your project. For details on creating individual UDI definitions, security keys, or the rest of the UDI Management panel, see the Related Topics at the end of this article.

Access: The UDI Management panel is opened from the Tools menu (Tools → UDI Management Panel) or with the shortcut Alt+T, then U. Reference: Topic P340.

Creating Groups in the Definition Library

Groups are sub-folders within the main Definition Library folder used to organize related UDI definitions (for example, grouping all motor-related UDIs together).

Steps to Create a New Group

1.   Right-click on Definition Library.

2.   Select Create Group.

3.   Enter a name for the group.

4.   Select the file location and enter a file name.

5.   Select OK.

6.   The new group is now shown in the library, and definitions can be added to it as needed.

Note: The group name and the .udi file name can be different. The file location you choose is used by the software to keep the group updated.

Steps to Import a Group

1.   Right-click on the Definition Library folder.

2.   Select Import Group.

3.   Select the .udi file to be imported and select Open.

4.   The newly imported group, along with any associated definitions, is now listed in the Definition Library.

Editing Groups in the Library

Right clicking any group or definition name in the library opens a context menu with the following options:

Note: Deleting a definition from the library removes it from the list of available definitions but does not delete the underlying .udi file from its saved location.

Adding UDI Definitions to the Library

Definitions can be added to the Definition Library using either of the following methods:

•     Drag and drop: Drag a definition from any of the Definitions folders onto an existing Definition Library folder.

•     Right-click: Right-click a definition in any of the UDI Management folders, select Add to Definition Library, then choose a new group or an existing Definition Library folder.

Once added, the definition appears in the chosen folder within the UDI Library.

Note: The default location for .udi files is Documents\AutomationDirect\Productivity.

Editing Definitions in the Library

Right-clicking on any individual definition within the library shows these options:

Adding a Library Definition to a Project

To move a definition from the library into a project's UDI Definitions folder, use either method below:

•     Drag and drop: Drag a definition from the library and drop it into the project's Definitions folder — either directly on the folder name or anywhere within the folder, indicated by a gray line.

•     Right-click: Right-click the definition in the library and select Add Definition to Project.

Adding a definition to a project opens the UDI Group Properties window, which lists the definition(s) to be copied into the project. Select OK to complete the copy, or Select All Required if the definition depends on other nested definitions.

Note: If a definition from the library is moved into a project folder that already contains a definition with the same name, a copy is generated and “_1” is appended to the new definition’s name.

Note: Secure UDI definitions require a password to edit or view most of their content, but both secure and unsecure definitions can be instantiated in a project without a password.

Best Practices

•     Build once, reuse everywhere: Save finished, tested UDIs (motor starters, conveyor logic, alarm handling) to the library so future projects can reuse proven code instead of rebuilding it.

•     Use groups to stay organized: Create logical groups (e.g., “Motors,” “Conveyors,” “Communications”) rather than storing every definition loose in the library root.

•     Keep nested UDIs together: When a definition contains nested UDI definitions, make sure all related definitions are exported/imported together to avoid errors.

•     Remember library deletes are local: Deleting a definition from the library list does not delete the .udi file on disk — locate the file directly if you need to remove it permanently.

Quick Reference

For full parameter details and additional application examples, refer to the Productivity Suite Help topic:

•     UDI (User Defined Instruction) Management: Topic P340