Dashboard
- Uffe Svensson
The Dashboard is the default view the user will see when entering User Admin. It consists of a set of configurable and grouped widgets, such as links to Weave clients, other links, data widgets or grids.
Groups
Groups are used for ordering and separate widgets. It is configured with a label and an id (which widgets are registered to).
Widgets
There are a few widgets available by default
Client widget
The client widget are used to forward users to clients, or any other url. It has a title, a target url, and description (optional). If the (ref) config is set, available clients that the user have access to will automatically be added. By default, clients are displayed before all other widgets.
Data Widget
The Data widget displays a single value backed by a data definition
Grid Widget
The Grid widget displays tabular data backed by a data definition
Namespace
urn:se.viamap.useradmin.widget#1.0
In addition to below configuration options, a scale config may be set to any widget controlling the scale of the widget depending on the device type. Sub scales are divided into small, medium, and large and take an integer value, representing the widget’s width in percentage. Available options are: 20, 25, 33, 40, 50, 60, 80, and 100
Note: A widget must belong to a group. If a widget reference a group that does not exist, it will not be available in the dashboard.
Tags
group
Properties
Property | Required | Type | Description |
|---|---|---|---|
id | yes | String | Unique identitier |
title | yes | String | The title of the group |
sort | no | Integer | Sorting priority when compared to other groups (ascending). Defaults to 0. |
acl | no | A reference to an ACL to attach to the configuration |
client
Properties
Property | Required | Type | Description |
|---|---|---|---|
title | yes | String | The title of the client |
description | no | String | Additional description of the client |
url | yes | String | URL to the client |
iconCls | no | String | Icon class to be displayed with the client |
height | no | Integer | The height in pixels of the widget, defaults to 140 |
group | no | String | Reference to Widget group this client belong to (defaults to ‘client’) |
sort | no | Integer | Sorting priority when compared to other widgets (ascending). Defaults to 0. |
acl | no | A reference to an ACL to attach to the configuration |
data
Properties
Property | Required | Type | Description |
|---|---|---|---|
id | yes | String | Unique identifier |
description | no | String | Additional description of the widget |
url | yes | String | URL to the client |
iconCls | no | String | Icon class to be displayed with the widget |
height | no | Integer | The height in pixels of the widget, defaults to 140 |
datadefinition | yes | Reference to a data definition | |
valuecolumn | yes | String | Reference to the value column in the target data definition |
labelcolumn | yes | String | Reference to the label column in the target data definition |
group | no | String | Reference to Widget group this widget belong to (defaults to ‘default’) |
sort | no | Integer | Sorting priority when compared to other widgets (ascending). Defaults to 0. |
acl | no | A reference to an ACL to attach to the configuration |
grid
Properties
Property | Required | Type | Description |
|---|---|---|---|
id | yes | String | Unique identifier |
title | no | String | The title of the widget |
height | no | Integer | The height in pixels of the widget, defaults to 140 |
datadefinition | yes | Reference to a data definition | |
group | no | String | Reference to Widget group this widget belong to (defaults to ‘default’) |
sort | no | Integer | Sorting priority when compared to other widgets (ascending). Defaults to 0. |
acl | no | A reference to an ACL to attach to the configuration |
Configuration example
<?xml version="1.0" encoding="UTF-8"?>
<config xmlns= "urn:com.cohga.server.config#1.0"
xmlns:ikartan= "urn:se.viamap.useradmin#1.0"
xmlns:widget= "urn:se.viamap.useradmin.widget#1.0"
xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd= "http://www.w3.org/2001/XMLSchema">
<!-- Override client group title -->
<widget:group id="client" title="Available clients" />
<!-- Set a specific sort for this group, and require acl access -->
<widget:group id="sys1" title="System one" sort="3" acl="acl.sys1" />
<!-- Link to Weave Admin -->
<widget:client acl="acl.admin" sort="1">
<iconCls>x-fa fa-wrench</iconCls>
<title>Weave Admin</title>
<description>Administration tool for Weave</description>
<url>admin.html</url>
</widget:client>
<!-- Data widget -->
<widget:data id="open_tickets" group="sys1" acl="acl.sys1" sort="0">
<scale small="100" medium="33" large="25" />
<iconCls>x-fa fa-calendar-minus-o</iconCls>
<description>Open tickets</description>
<datadefinition>dashboard.open_ticket</datadefinition>
<valuecolumn>value1</valuecolumn>
<labelcolumn>label1</labelcolumn>
</widget:data>
<!-- Grid widget with custom height -->
<widget:grid id="grid.open_tickets" group="sys1" acl="acl.sys1" sort="-1">
<scale small="100" medium="100" large="50" />
<height>300</height>
<title>Open tickets</title>
<datadefinition>dashboard.grid.open_ticket</datadefinition>
</widget:grid>
</config>