Dashboard (DB)

This entity stores the configuration of a dashboard. If you have dashboards in your project, such configuration should be always stored in a version control.

Fields

uniqueName – Dashboard unique name.

label – The name of the dashboard, visible to users on the screen. If empty, then the uniqueName will be used.

category – Label of a category (kind of folder), to which this dashboard belongs. This makes sense if you have a lot of dashboards and need the user to be able to easily navigate among them.

configuration – (String with JSON) Keeps the name of the logic to be used for the dashboard, and the definitions (and initial "default" values) of the input fields.

dynamicInputs – (boolean) Decision, if the input definitions should be collected just at the time, when the user opens the dashboard (i.e., the dashboard logic will be executed in input generation only, once the user tries to open the dashboard).

hide – (boolean) If true, the dashboard will not be shown to the user on the screen in the list of available dashboards. Set this to true for embedded dashboards, which are not to be used on their own, as standalone dashboards.

targetDate – (Date) A fixed date to be used for logic execution. If empty, the system will use today date. Unless you have specific reasons, keep this empty.

relativeTargetDateDays – (integer) When the dashboard logic is executed, the target date will be modified by this number (i.e., the target date will be shifted either forward or backwards by a couple of days).

userGroupViewDetails – Use this to limit visibility of the dashboard to specific groups of users. If empty, anyone can see it.

userGroupEdit – Use this to limit visibility of the dashboard to specific groups of users. If empty, anyone can see it.