NeonDashletConfiguration
This page provides generated reference documentation for the NeonDashletConfiguration data model.
A configuration for dashlets in a view
Overview
| Property | Summary |
|---|---|
| categories | Categories of the dashlet configuration. These categories are used to group information for example in the dashlet-store. A dashlet can have several categories… |
| description | Description |
| fragment | Predefined URL fragment, which is passed on to the linked view. Useful for filter tables, whose search condition is passed on by the URL. This could be for… |
| fragmentCustomizable | Flag, determining if the URL fragment can be editied by users |
| icon | Image. |
| iconProcess | Specifies the icon dynamically. If the icon has no effect, neither will the result of the process. |
| parameters | Allows to specify values for parameters (params are defined in the linked entity). Note that you do not have access to any code/variables. It's only possible… |
| preview | Preview picture that is shown for example in the dashletstore as base64-encoded string |
| provider | Set a specific entity provider for the dashlet to load the data |
| requiresConfiguration | Flag, determining if the dashlet has to be configured by the user to work properly. If so, the user is asked to configure it when adding the dashlet. |
| singleton | Flag, determining if the dashlet can be active only once at a time (per user). So a singleton dashlet cannot exist twice or more within one dashboard. |
| storeRoles | Names of the roles, which have access to the configuration in the dashletstore |
| title | Singular title of the dashlet configuration |
categories
Type: Categories
Categories of the dashlet configuration. These categories are used to group information for example in the dashlet-store. A dashlet can have several categories at the same time (1:n)
description
Type: String
Description
fragment
Type: String
Predefined URL fragment, which is passed on to the linked view. Useful for filter tables, whose search condition is passed on by the URL.
This could be for example in a filter_view: {{nameofContext}}/filter like Activity/filter.
fragmentCustomizable
Type: Boolean
Default: false
Flag, determining if the URL fragment can be editied by users
icon
Type: String
Image.
Depending on the datamodel, this has different effects:
- Entity: used as symbol in the designer. Do not confuse this property with the
iconIdproperty - Context: used as symbol in the designer. If the contexts entity has an icon set, the entities icon is used
- System, Language, Role, Application: icon that appears only in the designer.
- Template: Same effect as on the respective component
- Alias, User: no effect
- Frame, Process, Report, NeonFrame: icon that appears in the designer and in the client for the frame.
<!--EOF-->
You can add a custom icon by placing an icon.png file in the folder of your data model.
iconProcess
Type: String
Specifies the icon dynamically. If the icon has no effect, neither will the result of the process.
Depending on the datamodel, the result of the process has to be different:
-
When you can specify an icon-avatar-text (e.g.
VAADIN:USERS): You've to return theicon-avatar.textwithresult.string(...) -
When you can specify an image in the icon: This is returned as a string with the ID of the image in the
ASYS_BINARIESviaresult.string().
Error messages from this process do not arrive at the client, they are only visible in the server log.
parameters
Type: DashletConfigurationParameters
Allows to specify values for parameters (params are defined in the linked entity). Note that you do not have access to any code/variables. It's only possible to specify hard-coded values there.
Example: If you want to limit records to those wo were created by the current logged-in user, it's possible to add a param filterCreatedByMe_param in the entity, limit the data in the recordContainer whenever the param is true and then specify in the parameters-config of the dashlet the value of filterCreatedByMe_param as true.
preview
Type: String
Preview picture that is shown for example in the dashletstore as base64-encoded string
provider
Type: String
Set a specific entity provider for the dashlet to load the data
requiresConfiguration
Type: Boolean
Default: false
Flag, determining if the dashlet has to be configured by the user to work properly. If so, the user is asked to configure it when adding the dashlet.
singleton
Type: Boolean
Default: false
Flag, determining if the dashlet can be active only once at a time (per user). So a singleton dashlet cannot exist twice or more within one dashboard.
storeRoles
Type: String[]
Names of the roles, which have access to the configuration in the dashletstore
title
Type: String
Constraints: Verification: TITLE_LENGTH
Singular title of the dashlet configuration