Home Screen – Dashboards and Widgets

By default, the yuuvis® RAD client home screen displays a dashboard that consists of pre-configured widgets.

Example: The Unread messages widget displays the number of unread messages and opens the inbox by clicking the widget. The widget will not be displayed if there are no unread messages.

The following widgets are included on the default dashboard:

• Quick search

• Recently edited and created objects

• Objects to be filed

• Unread messages

Users with the Save settings functional right can create additional dashboards and edit the default dashboard: insert, delete, change, and position widgets. The dashboard configuration is saved for the specific user.

The configuration of the default dashboard is read from the dashboard.json file in the <service-manager-data>\webresource\public\client\assets\ directory.

You can create a dashboard.json file in the <service-manager-data>\webresource\resources\client\assets\ directory that overwrites the default configuration. A dashboard.json file can be created via the user interface with a specific configuration in yuuvis® RAD client.

Default configuration:

{
    "currentWorkspace": "yuv.default.dashboard",
    "workspaces": [
      {
        "id": "yuv.default.dashboard",
        "label": "eo.workspace.widget.default.dashboard",
        "preventDelete": true,
        "preventRename": true,
        "preventEdit": false,
        "grid": [
          {
            "id": "yuv.wdg.quickSearch",
            "widgetName": "yuv.widget.quickSearch",
            "x": 2,
            "y": 5,
            "rows": 19,
            "cols":6
          },
          {
            "id": "yuv.wdg.LastEdited",
            "widgetName": "yuv.widget.LastEdited",
            "x": 8,
            "y": 3,
            "rows": 25,
            "cols": 2
          },
          {
            "id": "yuv.wdg.infoIntray",
            "widgetName": "yuv.widget.infoIntray",
            "widgetConfig": {"title": "eo.dashboard.info.intray.msg"},
            "x": 0,
            "y": 2,
            "rows": 4,
            "cols": 2
          },
          {
            "id": "yuv.wdg.infoInbox",
            "widgetName": "yuv.widget.infoInbox",
            "widgetConfig": {"title": "eo.dashboard.info.inbox.msg"},
            "x": 0,
            "y": 7,
            "rows": 4,
            "cols": 2
          }
        ]
      }
    ]
  }

Example of the 'Webpage' widget

{
  "id": "19627fab-acae-c478-4f59-a5f5b0634aa7",
  "widgetName": "yuv.widget.iframe",
  "widgetConfig": {
    "title": "OS",
    "url": "https://www.optimal-systems.de"
  },
  "x": 2,
  "y": 1,
  "rows": 5,
  "cols": 5
}

Further information on developing widgets can be found in the developer area.

Editing and Managing the Default Dashboard

The default dashboard has the write protection property preventEdit: false and can be changed by users with the Save settings functional right. Changes are saved for the specific user. Users can reset changes to the default dashboard via the settings in yuuvis® RAD client.

If a default dashboard with the write protection property preventEdit: true is created via the dashboard.json file, it is activated for all users. User-specific default dashboards are then no longer active; however, they are reactivated if the write protection property is changed.

A read-only default dashboard can be temporarily changed by users with the Save settings functional right, but changes are not saved. The default dashboard is active again after a restart or an update of yuuvis® RAD client.

If a default dashboard has the write protection property preventEdit: true, users with the Save settings functional right can temporarily change the default dashboard and then export it as a JSON file via the settings in yuuvis® RAD client. The exported JSON file has the write protection property preventEdit: false.

This exported file can continue to be edited and saved as dashboard.json in the <service-manager-data>\webresource\resources\client\assets\ directory.

This makes it easier to configure the default dashboard in yuuvis® RAD client via the user interface.

Steps:

• Create dashboard.json in the <service-manager-data>\webresource\resources\client\assets\ directory.

• Set write protection to: preventEdit: true.

• Edit the default dashboard in yuuvis® RAD client.

• Export the default dashboard in yuuvis® RAD client via the settings.

• Save the file as dashboard.json in the <service-manager-data>\webresource\resources\client\assets\ directory.
  If desired, set the write protection to: preventEdit: true.