Skip to main content

Command: Visualization Element Repository

Symbol: _visu_icon.png

Function: The command opens the Visualization Element Repository dialog opens for editing the location and visualization profile.

Call: Tools menu

Repository to manage the visualization profiles and the visualization element libraries

Tip

If you want to use your own control, you have the following options:

  • Integrate the control as an HTML5 control

  • Use the control in a frame

    You can configure and use the frame like a visualization element.

Note

In CODESYS Visualization 4.7.0.0 and higher, the "Visualization Element Repository" function is also available when the project is open. The command is always visible. The requirement for this is that CODESYS Development System 3.5.20.0 is installed.

Dialog: Visualization Element Repository

In this dialog, you can find out which elements are contained in which visualization profile.

Important

  • Only an empty directory can be selected as a new location for a repository.

  • The System repository cannot be modified. This is indicated by the entry in italics in the repository list.

Tip

Currently only a single version of an element can be installed.

Location

Location for the repository in the file system

Usually: System

The list box displays the configured repositories for visualization elements.

Edit Locations

Opens the Edit Repositories dialog for modifying the repository currently selected in Location or for creating a new repository

Dialog: Edit Repositories

Location, Name

For managing the visualization elements, one or more repositories can be used. All currently defined locations are listed here with file path and name.

The order from top to bottom is also the search order for the visualization elements.

File path and name of the location selected previously in the Repository for Visualization Elements dialog.

Note

A "System" location is always defined automatically, which cannot be modified or deleted.

Add

Edit

Opens the Location for repository dialog for creating a new location or for editing the current location

To specify: Location and Name (file path of an – empty – directory)

The name is symbolic.

Example: Element Category 1

Remove

Deletes the repository currently selected in the repository list

Move Up, Move Down

Moves the entries within the list

Note

The repositories are searched from top to bottom.

Profile or extension selection: Create or Update Profile

A profile is a collection of visualization elements in a specific version. These elements originate from one or more libraries. They are available in the toolbox of the visualization editor when the profile is used in the project.

Creating and editing a profile is possible only if the CODESYS VisuElement Toolkit add-on is installed. The buttons on the right side of the dialog can be used only in this case.

You can configure a new profile in the dialog or modify an existing one. Then, the New, Copy, and Delete buttons are operable, as well as the Installed Elements and Available Elements views.

If the _visu_img_radio_button.png: Create or Update Profile option is selected, then the following settings are available.

Profile

Currently selected profile

The list box provides all profiles available in the location (repository) set above.

New

Opens the Specify Name of Visualization Profile dialog

Specify a unique name for the new profile. Otherwise the previously used name is automatically appended with _0.

Example: CODESYS Visualization 4.3.0.0_0

The Installed Elements list is empty.

Copy

Opens the Specify Name of Visualization Profile dialog

The elements of the selected profile are applied. They are listed in the Installed Elements window.

Delete

Deletes the currently selected profile

The entry is removed from the list box.

Table 90. Installed Elements

Elements which are assigned to the selected profile

Name

Vendor

Library

Information about the element

Update code

Refreshes the list with any changes in the implementation code of the library POUs

Update All

Refreshes the list with any changes in the implementation code and in the interfaces (declaration part) of the library POUs

Uninstall

Uninstalls all elements in the list which are currently selected

As a result, they are removed from the Available Elements list.

Export Localization

Opens the Export Localization in the Visualization Profile dialog

Import Localization

Opens the Import Localization in the Visualization Profile dialog



Table 91. Available Elements

Name

Library

Vendor

Version

Repositories

Profiles

Elements which are available in the system and can be installed into the current profile

The selection depends on the installed element libraries and element packages.

The tree structure displays the libraries with the contained elements below them. Elements display in green are already installed for the specified profile or extension.

Profiles shows the elements installed for the profiles.

Install element

Adds the elements selected in the list to the Installed Elements view

Existing elements are overwritten.

Install library

Opens the Library Repository dialog where another library can be installed in order to accept its elements in the Available Elements view



Note current library versions only

standard icon: When refreshing the list, only the most current version of the library is searched, not all libraries.

Overwrite profiles without prompting

standard icon: For actions that change the profile, the usual prompt does not appear for confirming the change.

Profile or extension selection: Create or Update Extension

You can create a new extension for the selected profile.

If the _visu_img_radio_button.png Create or Update Extension option is selected, then the following settings are available.

Profile

Currently selected profile

The list box provides all profiles available in the location (repository) set above.

Extension

The extension which is currently selected for the specified profile

The list box provides all extensions available for the profile.

To configure a new extension, use the New or Copy buttons.

New

Opens the Specify Visualization Extension dialog to define a new extension. In this dialog, the name, company, and version of the extension are displayed.

Version syntax: Sequence of numbers and points with a number at the end

Hint: Specify a unique name for the new extension. Otherwise the previously used name is automatically appended with _0.

The Installed Elements list is empty.

Copy

Opens the Specify Visualization Extension dialog

The elements of the selected profile are applied. They are listed in the Installed Elements window.

Delete

Deletes the currently selected extension

The entry is removed from the list box.

Profile and extension selection: HTML5 Controls

A freely available HTML5 control is encapsulated with a custom XML wrapper ElementWrapper.js and given an interface to CODESYS. CSS files can also be specified to define the appearance of the element (color, font, images).

To use a freely available HTML5 control in CODESYS Visualization, JavaScript (ElementWrapper.js) has to be used to adapt the element to an interface to CODESYS.

If the _visu_img_radio_button.png: HTML5 Controls option is selected, then the following settings are available.

HTML5 Controls

_visu_img_radio_button.png: Lists all existing HTML5 controls in the Installed Elements field

Use the buttons to the right of the field to manage an HTML5 control which you have selected.

Table 92. Installed Elements

Name

Vendor

Version

General identifying information of the HTML5 control

Signature

Status of the signature

  • _visu_icon_signed_element.png: Trusted signed element

  • _visu_icon_unsigned_element.png: Unsigned element

  • _visu_icon_signed_untrusted_library.png: Untrusted signed element

  • _visu_icon_verification_failed.png: Check failed. The signature has an invalid format or is from an untrusted source.



Install

Opens the file manager so that an HTML5 control file (.html5contol) can be selected

Open Editor

Opens the HTML5 control editor

This is where the HTML5 control configuration is created and managed:

  • Declaration of the general identifying data and specification of the XML wrapper(ElementWrapper.js) with the additional required files (CSS, PNG, BMP or SVG files)

  • Declaration of the interface with categories, standard properties and specific properties between XML wrapper and CODESYS

  • Localization of the names of the categories and element properties

The element is displayed with this configuration in the Visualization Editor under the Visualization Toolbox and Properties views.

For more information, see: HTML5 Control Editor

Uninstall

Uninstalls the selected HTML5 control

Details

Opens a message box with information about the HTML5 control and its signature

Signing

Opens the Elements to Sign dialog to sign the selected element with a certificate of your choice or manage the existing certificate.

For more information, see: Signing

Dialog: Elements to Sign

Certificate

Name of the certificate

The ... button opens the Certificate Selection dialog.

For more information, see: Dialog: Certificate Selection

Timestamp server

Optional

Example: http://timestamp.sectigo.com

Note: If not used, the trustworthiness depends on the runtime of the signing certificate.