How to create a dashboard definition

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

The Dashboard

The main JSON object represents the dashboard.
A single dashboard can have one or more pages.
On these pages you can define widgets that each represent a single Blueriq flow.
The entry page is the page we will start on when the dashboard is opened for the first time in a user session.

The Page

A page has widgets and a menu. The menu has single items that link to other pages.
Additionally, you can choose a layout for how the widgets are placed on the page.
Possible layouts include:

• two-equal-columns
• single-column

The Widget

A widget has an 'id' property that uniquely identifies all widgets among each other. A 'type' of widget can be:

• blueriq-flow: A flow that does not end is generally used to display lists, statistics, timelines, etc.
• task-execution-flow: A flow specifically meant for executing DCM tasks. These must end somehow.

A widget needs a 'baseUrl' defined when the runtime it runs on has a context path.
The flow the widget uses can be configured in using two methods:
1. A shortcuts name.
2. The project, flow and version names.

The Page Events

Inside Blueriq Studio one can use service calls to cause certain events specific too DCM dashboard functionality.
These events can be mapped on a page so the frontend performs a certain navigation action.
The events are:

• 'open-case' -> Opens a case.
• 'start-case' -> Starts a new case.
• 'start-task' -> Starts a task from a case.

The context property can be used to send some extra data, so you can open different flows/pages on different types of cases and tasks.