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

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

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

Constraints

• N/A

Menu Item

A menu item can be used to navigate to other dashboard page.

Properties

Constraints

• The path of a menu items has to match the ID of a dashboard page

Dashboard Column

Dashboard columns contain widgets definitions.

Properties

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

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

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.

{
  "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"
        }
      ]
    }
  ]
}