Object 'Library Manager'Permalink

Symbol: _cds_icon_library_manager

The Library Manager lists all libraries that were integrated in the project for creating applications. It provides information about the type of library, its properties, and its contents.

You can expand or collapse the list of integrated libraries, as well as edit library properties for non-dependent libraries.

The Library Manager consists of three views:

  • Upper view: List of integrated libraries

  • Lower left view: Tree structure with all modules of the library selected in the upper view

  • Lower right view: Documentation for the module selected in the tree

List of integrated libraries

List of all libraries integrated in the project. If a library depends on other libraries, then these referenced libraries are automatically integrated.

Displayed in gray fonts

The library was added to the project automatically by means of a plug-in.

Displayed in black fonts

The library was added to the project automatically by means of the “Add Library” command.

“Name”

Display of the integrated library in the following syntax:

“<placeholder name> = <library name>, <version> (<company>)”:

“<placeholder name>”: If it is a placeholder library for a library, then the placeholder name is before a “ = ”.

“<library name>”: Name of the library that is used for management in the library repository.

“<version>”: Version that was referenced at the first time it was integrated.

“(<company>)”: Vendor (optional)

“Namespace”

Namespace for unique access to the contents of the library.

It is prepended to a module identifier for this purpose:

<namespace>.<library module identifier>

The namespace usually coincides with the library name.

Note: If the library has the property ‎LanguageModelAttribute "qualified-access-only"‎, then you must access the library module in the application code by means of the namespace. Qualified (unique) access is enforced.

You can modify the standard namespace for local use (within the project) in the “Properties” dialog.

“Effective version”

Version of the library after the resolution. This version is used in the project.

Requirement: The Library Manager exists in the “Devices” view and a placeholder library is selected.

Example: ‎3.5.10.0‎

A placeholder library that is integrated below an application is resolved by assigning a special resolution to the placeholder library in the “Placeholders” dialog. Then the selected library is loaded. Other resolutions are ignored. If no special resolution is given, then a check is performed as to whether or not a resolution is specified in the device description and library profile of the application. The first search hit is applied.

_cds_icon_info

Symbol with tooltip to notify about the current device-dependent resolution of the selected library.

Example when the Library Manager is in the “Devices” view: “This placeholder is explicitly redirected to this version (see the Placeholders dialog)”

Example when the Library Manager is in the “POUs” view: “In the 'Device_1' device, the placeholder is resolved to 'VisuElemsAlarms, 1.0.0.0 (System)”

A placeholder library that is integrated in the “POUs” view is resolved by checking depending on the application whether or not a resolution is specified in the device description. Afterwards, the library profile is checked. The first detected resolution is used. If you have assigned a special resolution to the placeholder library in the “Placeholders” dialog, then this will always be ignored. The result is shown in the tooltip of the _cds_icon_info symbol.

_cds_icon_libman_signed_lib

Library that is signed with a trusted certificate (compatible with CODESYS >= V3 SP15)

_cds_icon_libman_signed_lib_with_deps

Library that is signed with a trusted certificate, but references at least one unsigned library

_cds_icon_libman_signed_legacy_lib

Library that is signed with a private key and token (compatible with CODESYS < V3 SP15)

_cds_icon_libman_legacy_lib

Library that is not signed, or signed with an untrusted or expired certificate. In the case of an untrusted certificate, the “Trust Certificate” command is provided in the context menu.

_cds_icon_libman_unavailable_opt_lib

Library that is defined as optional and not currently available

_cds_icon_libman_try_to_reload

Library whose status is being determined

_cds_icon_libman_unlicensed_lib

Licensed library for which no valid license is currently available

_cds_icon_tampered_library

Library symbol for a library that cannot be loaded because its signature (encryption) could not be verified

Table 585: Commands in the Library Manager

_cds_icon_libman_add_library “Add Library”

Opens the dialog for selecting a library. All libraries installed in the library repository are offered.

_icon_delete_library “Delete Library”

Removes the presently selected library from the project

_cds_icon_properties_library “Properties”

Opens the dialog for the display and editing of the properties of the presently selected library

_cds_icon_details “Details”

Opens a dialog with details for the presently selected library (general information, contents, properties, license information)

_cds_icon_libman_try_to_reload “Try to Reload Library”

If you select a library marked as not found, you can attempt to load it into the project again using this command.

_cds_icon_libman_download “Download Missing Libraries”

CODESYS scans for the missing libraries in the download servers specified in the project options.

After that you can download and install the library.

_cds_icon_placeholders “Placeholders”

The “Placeholders” dialog opens. The current resolution is displayed there and you can edit it.

_icon_library_repository “Library Repository”

Opens the “Library Repository” dialog for installing and uninstalling libraries and for defining library locations

_cds_icon_libman_icon_legend “Icon legend”

Opens the “Information” dialog with a legend of the icons that display the current status of a library in the list of integrated libraries (see above)

_cds_icon_summary “Summary”

Opens the “Library Summary” dialog. All libraries referenced in the project are displayed in a tree structure in the dialog, and those libraries which reference these libraries.

  • Command “Display all occurrences in library hierarchy and close dialog”: In the editor of the Library Manager, the libraries in the open tree structure are marked which reference or use this library. Requirement: A library is selected. The “Information” dialog is then closed.

    This command is also executed when you double-click a library.

Display of the libraries

  • “Managed Library”: Name and version of the library

  • “Number of Occurrences”: Number of locations where this library is referenced by other libraries.

When you click “+” for a library, the libraries, which reference this library, are displayed in the next level down.

_cds_icon_libman_trust_cert “Trust Certificate”

Only in the context menu of a library selected in the Library Manager, in which the library has been signed with an untrusted certificate. The command turns the untrusted certificate into a trusted certificate and the prepended icon changes from _cds_icon_libman_legacy_lib to _cds_icon_libman_signed_lib.

“Export Library”

Only in the context menu of a library selected in the Library Manager: Opens the default dialog for saving the library file in the file system

Tree structure of all modules of a selected library

All library modules that were integrated with the library are listed in the tree structure.

Requirement: A library is selected in the upper view.

The usual sorting and search functions are available in the menu bar.

Documentation for the library module selected in the lower left view

Tab “Inputs/Outputs”

Interface (inputs/outputs) of the library module

Tab “Graphical”

Graphical display of the module

Tab “Documentation”

Documentation for the library module.

Note: As a library developer, you have to follow the rules for documentation inclusion in 'Guidelines for library development'.

Tab “Parameter List”

Requirement: The library project contains a parameter list.

You can change the values of these parameters in the column “Value (editable)”.