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 column must align with the layout option that is provided.

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

{
  "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 Page

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.