Page History
| Warning | ||
|---|---|---|
| ||
This feature is no longer supported since Blueriq 16.7 and DCM Dashboard service 1.0.0. Use Encore to model and export a DCM dashboard. DCM Dashboard service 0.4.0 contains both JSON and Encore export functionality to support a grace periode. |
To create a dashboard definition one would need to know what it means to create a definition. In one definition you model a single dashboard application contains pages, widgets and menu's. You can see it as the skeleton of a dashboard application. Dashboard definitions are created using JSON and contain some constraints, which aren't actively enforced yet so be sure to follow this guide.
...
Dashboard Event
Inside Blueriq Studio one Encore one can use service calls to cause events specific to DCM dashboard functionality. These events can be mapped on a page so the frontend performs a certain navigation action.
Properties
| Property | Type | Explanation |
|---|---|---|
| type | open-case start-case start-task | The type of events for which the dashboard should listen to |
| context | String | The context property can be used to send additional data to distinguish the event even |
| further, typically the Case Type is used as context. |
Constraints
- N/A
Menu Item
A menu item can be used to navigate to other dashboard page.
Properties
| Property | Type | Explanation |
|---|---|---|
| path | String | A value which matches an dashboard page id |
| displayText | String | Display value which is used as the content of the menu item |
| roles | String Array | An array of roles which to used to distinguish if a user can use the menu item. If the user does not contain one of the roles the menu item is not displayed. |
Constraints
- The path of a menu items has to match the ID of a dashboard page
...
Dashboard columns contain widgets definitions.
Properties
| Property | Type | Explanation |
|---|---|---|
| widgets | DashboardWidget Array | An array of dashboard widgets |
Constraints
- N/A
Dashboard Widget
Dashboard widgets are reference referenced to an, exposed Blueriq Flow, or a Widget Flow, containing a single widget. The Dashboard widget is a replacement of the ordinary dashboard widget which could be modelled in the DCM 1.0 and 2.0. There are currently two types of dashboard widgets which can be chosen: blueriq-flow and blueriq-task.
Generic Properties
| Property | Type | Explanation |
|---|---|---|
| id | String | The ID of the dashboard column |
| type | blueriq-flow blueriq-task | The type of the widget blueriq-flow is used to display an exposed flow blueriq-task is used to start and execute a case task |
| baseUrl | String | The context path of a Blueriq Runtime where this widget can be found. For example "/Runtime" which is the default. |
| roles | String Array | An array of roles which to used to distinguish if a user can use the widget. If the user does not contain one of the roles the widget is not displayed. |
Constraints
- The ID of a dashboard page must be unique.
...
A flow that does not end is generally used to display lists, statistics, timelines, etc.
Properties
| Property | Type | Explanation |
|---|---|---|
| projectName | String | The name of the project to use |
| versionName | String | The version of the project to use |
| flowName | String | The name of the flow to start |
| shortcutName | String | The name of the shortcut to start |
Constraints
- The referenced flow must be exposed.
- The referenced flow should never end.
- When a shortcutName is provided it will take precedence over a projectName, versionName, and flowName combination.
...
Overview
Content Tools