You are viewing the documentation for Blueriq 16. Documentation for other versions is available in our documentation directory.

No Longer Supported

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.

The dashboard


The root JSON object in the definition is the dashboard itself. 

Properties

PropertyTypeExplanation
IdStringThe ID of the dashboard
entryPageString

The default page which will be loading when starting a dashboard application

pagesDashboardPage Array

An array of DashboardPage objects.

Constraints

  • The entryPage must match one the IDs of the dashboard pages.
  • A dashboard can contain one or more pages.

Dashboard Page

A dashboard page displays widgets for a specified layout, structured in columns. To navigate between dashboard pages each page contains a menu.

Properties

PropertyTypeExplanation
IdStringThe ID of the dashboard page
eventsDashboardEvent Array

An array of DashboardEvent objects. Can be left out when a dashboard page does not have listen to events. 

layout

single-column

two-equal-columns

left-sidebar

right-sidebar

The layout which is used to display the dashboard page

single-column takes up the whole page

two-equal-columns divides the page in two equals columns

left-sidebar divides the page into a one-third column and two-third's column

right-sidebar divides the page into a two-thirds columnand one-third column

columnsDashboardColumn Array

An array of DashboardColumn objects, containing widgets.

menuItemsMenuItem Array

An array of MenuItem objects.

Constraints

  • The ID of a dashboard page must be unique.
  • The amount of dashboard columns must align with the layout option that is provided.

Dashboard Event

Inside Blueriq 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

PropertyTypeExplanation
type

open-case

start-case

start-task

The type of events for which the dashboard should listen to

contextStringThe 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

PropertyTypeExplanation
pathStringA value which matches an dashboard page id
displayTextStringDisplay 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 Column

Dashboard columns contain widgets definitions.

Properties

PropertyTypeExplanation
widgetsDashboardWidget ArrayAn array of dashboard widgets 

Constraints

  • N/A

Dashboard Widget

Dashboard widgets are 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

PropertyTypeExplanation
idStringThe 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.

Blueriq Flow Widget

A flow that does not end is generally used to display lists, statistics, timelines, etc.

Properties

PropertyTypeExplanation
projectNameStringThe 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.

Blueriq Task Widget

A flow specifically meant for executing DCM tasks. These must end somehow.

Properties

No additional properties have to be provided.

Example
{
  "id": "dashboard",
  "entryPage": "page",
  "pages": [
    {
      "id": "page",
      "events": [
        {
          "type": "start-case",
          "context": "someCaseType"
        },
        {
          "type": "start-case",
          "context": "otherCaseType"
        }
      ],
      "layout": "two-equal-columns",
      "columns": [
        {
          "widgets": [
            {
              "id": "widget",
              "type": "blueriq-flow",
              "shortcutName": "ListOfStuff",
              "baseUrl": "/runtime"
            }
          ]
        }
      ],
      "menuItems": [
        {
          "path": "otherPage",
          "displayText": "Some Other Page"
        }
      ]
    }
  ]
}