Widgets
Widgets in Lobster Data Platform / Orchestration are small categorized applications, which can be displayed as tiles in designated places. Depending on the widget, a user can change its size.
Depending on the widget, a user can change its size. By default, rudimentary widgets are already available. In addition, a configurator can also design widgets itself.
Which widgets are available to the user is determined by Association criteria and role permissions.
Widget panel
In any place where a user can include widgets, a so-called widget panel appears. It specifies an area which is divided by unit tiles. The user can add widgets to the panel using various functions (Add button, panel context menu) and place them freely on the given grid.
Widget panels are also available as a form element.
Example of a widget panel
Create custom widgets
Under the Widgets menu item, custom widgets can be created, categorized and assigned accordingly. The Form designer with its common functions is available for this purpose. Since a widget is not loaded in the context of a data type, the Form Designer also does not offer any predefined data field elements.
General settings
(1) Name: The widget's development name, which is also used for identification. This name remains hidden from the end user.
(2) Category: The category under which the widget is listed to the end user (depending on the context, only certain categories can be offered to the user).
Categories are managed in the 'Widget category' enumeration (Dynamic enumerations menu item).
(3) Description: A description for the configurator. This remains hidden from the end user.
(4/5) Preview: Image/Icon: A preview image that is displayed to the user in the widget selection list. This image is limited to 100x100 pixels in size. Icons are also allowed as a preview image.
If the image is smaller than the given size (e.g. icon), a corresponding background color can be defined with (5) Preview: Background color.
(6/7) Title and Details text: Defines a translated title and description text for the widget, which will be displayed to the user in the drop-down list.
Example configuration (4 – 7)
|
Configuration |
Result |
|
|
|
Editor
Below the form element, there is the visible root element for the widget (A). This element defines the frame and background (4) as well as the basic layout and size (1/2/3).
Size
The size of a widget is specified in "number of slots" in horizontal and vertical direction. By default, a widget is 1x1 slots in size.
In (1), the initial size that the widget assumes when it is newly added to a panel by the end user is defined.
(2) defines whether the user is allowed to change the size of the widget. In this case, a minimum size can be defined via (3), which the end user may not go below.
Background color (4)
Specifies the background color of the widget. In addition, the opacity of the color may also be specified here in order to be able to create contrasting colors independently of the color of the widget panel.
►NOTE◄ In principle, widgets can be designed freely, but a few facts should always be taken into consideration:
Widgets can be displayed anywhere in the software depending on the theme (e.g. Urban theme main menu), therefore expensive or slow operations, as well as complex layouts should be avoided.
Any number of widgets can appear, provided that they are offered by the system.
Provide widgets to the user
In order for a user to select a widget, it must also be assigned to them using one or more Association criteria.
If a user is unassigned after adding the widget to a panel, a placeholder widget is displayed in its place. This prevents the loss of configurations if, for example, the role or company is temporarily changed.