Dashboard widget configuration

From TempusServa wiki
Jump to navigation Jump to search

Configuration help

Styling

All widgets have a field called "Custom CSS". This allows addition of styling, when that stylesheet is shown.

As of version 8359 it is possible to use #THISWIDGET# to target that specific widget.

#THISWIDGET# will automatically be replaced by the unique html-id of that widget, eg. #Widget69, thus allowing css that can be copied to another widget without the need to know the ID.

Buttons

All the below properties are required for the button

Optimally buttons are places in the Toolbar zone on the page, where they are rendered as normal buttons. If placed in other zones they are rendered as large squares.

Sizing

Length

Setting the length of a widget limits how many rows are shown. This setting only applies to lists.

Size

Setting the height of a widget forces it to be that number, times 100, pixels tall. This setting does not affect lists.

Setting the width of a widget applies a set of bootstrap column-classes, setting the width in a responsive manner.

The lookup follows this logic:

  • 1 = col-4 col-md-2 col-xl-1
  • 2 = col-6 col-md-4 col-xl-2
  • 3 = col-6 col-lg-4 col-xl-3
  • 4 = col-12 col-md-6 col-xl-4
  • 5 and 6 = col-12 col-lg-8 col-xl-6
  • 7, 8, and 9 = col-12 col-xl-8
  • 10, 11, and 12 = col-12
  • Above 12 = col

SQL Query

An SQL Query may extract almost anything from the database.

This process ignores the security restrictions in the system, so you will have to implement them yourself (see special keywords below).

This widget supports different rendering modes, for a deep dive on the diagrams, click here.

Sample: Limited status distribution

The following example displays quite well in a pie chart. 

 SELECT s.Status, count(*)
 FROM data_leads1 as d
 JOIN formstatus as s ON  s.StatusID = d.StatusID 
 WHERE d.StatusID IN (11344,11343,11345)
 GROUP BY 1

Special keywords / variables

  • %UserID%
  • %ExclusiveGroupID%
  • %GroupListSql%
  • %ExclusiveGroupListSql%
  • %AndRecordFilter%

Lists

To setup a list view, simple copy/paste the URL of a view.

Optimally you should strip anything but the parameters from the URL. 

?SagID=252&command=list&QUERY_FIELD_1=OPFLGNING& ...

Filtering the list

To filter the list, add three parameters to the url, pr filter. Make sure that every set of parameters have their own unique number. 

?SagID=252&command=list&QUERY_FIELD_1=OPFLGNING&QUERY_PARAM_1=1&QUERY_VALUE_1=0 ...

Operators:

ID Command Note
1 = Only rows with values equal to
2 < Only rows with value lower than
3 > Only rows with values higher than
4 != Only rows with values not equal to
5 <= Only rows with value lower than or equal to
6 >= Only rows with values higher than or equal to
7 CONTAINS
8 Starts with
9 Ends with
10 IS null
11 IS NOT NULL
15 IN DAY
16 IN MONTH
17 IN YEAR
20 HAS
21 HAS NOT
22 HAS NONE
23 HAS ANY
24 IN Only rows with values equal to one of the given (comma separated list)

If you are signed in as an admin on a server with a version newer than 7956, you will have access to the "url button".

This button redirects you to the full url, that generates the current filtering, that you have on your list.

This might be an easier way to generate the correct url, when creating dashboard-list-widgets.

Special case: List of values in search parameters

Currently lists of search parameters are encoded 

 ... &QUERY_VALUE_3=11344%2C11343%2C11345& ...

To make them work in list views, please decode the kommas 

 ... &QUERY_VALUE_3=11344,11343,11345& ...

(just change "%2C" to ",")

Other widgets

Codeunit

This widget displays raw HTML ouput from any PageContentCodeunit.

Distribution

This creates one of many diagrams to show records of an entity. Bar, circle, and table diagrams work, but the others don't.

It should at the very least have the SagID of the entity and a QUERY_GROUPBY parameter to know what should be shown. If it does not have this, it will always show the status of the records.

Content should look something like this:

?SagID=3&QUERY_GROUPBY=TOPIC

Pro tips

Asking the right questions

To add the right content into dashboards widgets you will need to define what should be displayed

First choose either List of records (worklists) or Aggregated values (charts, tables or number)

List of records

  • Fields displayed in list ?
  • Sorting field ?

Aggregated values

  • Format ?
    • Number
    • Table
    • Chart (pie,bar)
  • Metric ?
    • Field
    • Method (sum, average, min, max)
  • Option: Categorization (group by another fields value)
  • Option: Link to detailed data

Next consider which filters limit the data

  • Period ranges ?
  • Status limitations ?
  • User relation information ?

In case you are generating normal record lists no effort is required for security filters and hiding deleted items.

Retrieved from "https://wiki.tempusserva.dk/index.php?title=Dashboard_widget_configuration&oldid=6791"