Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Introduction and generalities

What is cartostation?

cartostation is a web application platform offering tools for managing, visualizing and publishing spatial data.

These functionalities are available online, through carefully designed interfaces, with a view to making this tool available to the greatest number of people.

The basic applications of cartostation allow, in particular, to easily publish maps with legends on the web and to integrate them into third party websites.

cartostation is a software under free license (AGPL v3), whose code is available at https://gitlab.com/atelier-cartographique/carto-station

cartostation is currently deployed in administrations of the Brussels-Capital Region (Bruxelles Environnement and Perspective.Brussels) under the name Geodata.

Project philosophy

cartostation is developed with a strong attention to the context of its use, both at the individual level and at the level of the organizations that employ it.

At the user level, the aim is to facilitate access to tools for manipulating spatial data. Geomatics and cartography are complex fields, at the crossroads of many fields (scientific, visual, political, technological, etc.). One of the major ambitions of cartostation is to lower the technical level required to apprehend and act in these fields.

At the level of an organization, cartostation, as an information system, plays an important role because it participates in the structuring, manipulation, and publication of information internally or externally.

This position of the information system, which is often particularly sensitive and influential in organizations, invites us to propose delicate and adapted approaches.

Two approaches are combined to address these issues.

Firstly, cartostation favours an architecture that separates the major functionalities into dedicated applications, which are lighter and less complex to apprehend than a vast generalist application.

Then, an important place is given to interface design, and more broadly to the design of the (co)creation process of the tools. This dimension comes into play from the beginning of the application production period, in close relationship with the clients in order to produce a tool that remains in contact with the needs and is adapted to the skills of the end users.

This mode of operation makes particular sense when it comes to creating innovative tools, dedicated to numerous operators within large-scale organisations: the future users of the platform - technophiles and less technophiles - can thus grasp the project from its conception, and take it over conceptually in a global way.

As a spatial information system, cartostation is positioned as a benevolent solution, anxious to place its users in a position of capacity with regard to the technological tool. By combining this attention to the technical quality of its development, cartostation can thus accompany more structural transitions within the organizations that use it through the prism of the data and the technological and organizational tool that accompanies them.

Applications and modularity

cartostation is structured in two parts: a simple kernel, connected to a spatial database, and a series of applications assuming various functionalities.

In addition to the benefits of use mentioned above, this modular architecture allows great development agility, and promotes the creation of tools that are easy to access in view of the complexity inherent in the processing and visualization of spatial data.

The software kernel is therefore intended to be light, in order to facilitate its maintenance and evolution; while the applications linked to it each follow this logic of compactness, offering users simple and clearly identified tools, and developers a readable and compartmentalized platform.

Some of the applications are generic, responding to common needs (creation of maps, visualization etc…), while other applications are developed to measure, to meet more specific needs.

Applications are activated according to deployment.

Open-source development

cartostation is distributed under the free AFFERO GPL 3 license: https://www.gnu.

alias

The alias application allows you to create aliases for values from the underlying data structures that are configured to be alias-supported.

For example, column names for database tables may be abbreviations or technical terms that are of little interest when this information is to be communicated.

Especially since in some contexts this information must be available in different languages.

The alias application therefore makes it possible to build up a dictionary of aliases and to translate these abbreviations into information that is more comprehensible to a targeted audience.

atlas

Generalities

atlas presents the maps created in the studio application. In addition to the classic functions of map navigation, access to the map legend and editorial content, a series of tools are available to refine the consultation of the data.

BrugeoTool

Installation

the BrugeoTool application is a client application of the cartostation platform.

This application is available here: https://gitlab.com/atelier-cartographique/carto-station/-/tree/master/clients/brugeotool

All the data used by BrugeoTool is managed by the geothermal-loader module.

Both repositories contain their own documentation.

The whole code of cartostation and geothermie-loader is open, and under a free license (AGPLV3).

Administration of the BrugeoTool application

Creation of the reference map for the BrugeoTool application

The reference map can be built using the Studio application.

Please refer to the documentation of the Studio application for details.

TIP: It is not necessary to publish the map in the Atlas to use it as a reference map. However, it must be referenced as publicly available, via the platform administration, as for all public maps.

Creation of layer groups for the reference map

The creation of a layer group is done in the Django admin of the platform at admin/api/layergroup/.

Once the group is created, the data layers that will be in it must reference that group, at admin/api/layerinfo/.

Setting the reference map for the BrugeoTool application

The previously created map must be referenced as the “base” map for the BrugeoTool platform.
This is done in the admin section of the platform at admin/geothermie/mapselection/.

Only one map must be selected, and referenced in the top panel.

Definition of additional information for a layer group

It is possible to define additional information for a particular group of layers in admin/geothermie/infobulle/.

Simply select the layer group and the info in question. This can be created on the fly, or on the admin/geothermie/bulle/ page.

Changing application texts and labels

All the labels and texts of the platform can be modified via the administration interface. see the documentation on this subject](https://cartostation.com/documentation/en/admin/index#override-message-records)

IMPORTANT: some texts are written in Markdown and it is desirable that people who encode new texts are familiar with this language.

TIP: replacing texts via the administration interface does not destroy the basic texts, so it is easy to test updates.

BruWater

BruWater is a portal for displaying qualitative and quantitative data on groundwater and surface water in the Brussels-Capital Region. It is a Cartostation module designed for professionals and the general public, developped for Environnement.brussels.

This application offers a module for displaying time series to compare physico-chemical measurements for the same station.

This application can be used at this address:https://geodata.environnement.brussels/client/bruwater/

An FAQ is available at this address (in French): https://environnement.brussels/pro/outils-et-donnees/sites-web-et-outils/bruwater-donnees-sur-les-eaux-de-surface-et-les-eaux-souterraines-en-region-bruxelloise

solar map

The solar map of the Brussels-Capital Region responds to a specific request from the energy department of Environment.brussels. It is specific to a data schema of BE.

It is an application aimed at the general public, in order to provide synthetic and scientifically valid information on the solar energy potential per building in the region.

This application can be used at this address: https://geodata.environnement.brussels/client/solar/.

An FAQ is available at this address: https://environnement.brussels/content/carte-solaire-de-la-region-bruxelloise-faq

dashboard

dashboard allows users to access applications that were configured at the time of cartostation deployment.

For ease of use, it is also possible to not show applications that are still configured in the deployment (such as login or embed applications, which are not useful to show in the dashboard).

These configurations are made at the time of cartostation deployment.

embed : A simplified map viewer for publishing a map on a third party site

How to embed a map from cartostation in another site?

The simplest solution consists in copying the code proposed on a map in the atlas application, and to insert it in the HTML code of the page of your site.

Note : In the case of a manual embed, the person creating the iframe must make sure that the map url points to the application embed, and not to atlas.

Profile selection

Different profile types are available:

  • Map with legend
  • Map with tools
  • Simple map

“Map with legend” profile

  • Language switch
  • Link to Atlas
  • Title
  • Description
  • Caption
  • Display information when clicking on the map

“Map with tools” profile

Simple Profile +

  • Address search
  • Zoom buttons

“Simple map” profile

  • Language switch
  • Link to Atlas
  • Display information when clicking on the map

Language selection

The language selection of the embedded map is taken from the interface’s language of the user. It is still possible to change the language afterward by editing lang=fr, lang=nl or lang=en in the URL of the code of the embed.

To get additional information about the URL format, you can check out the details of the URL format structure at the bottom of this page.

Iframe size

Maps embedded in third-party sites are generally constrained by the layout in which the iframe will be inserted.

However, it is still important to adjust the size of the iframe to the content of the map, particularly in terms of the size of the description, the legend and the information available.

A size of 1000x600px is generally the minimum required to display the information comfortably.

  • Adjust the map content to match the editorial content of the site. If the content and context of the map are already included in the site page, the map description can be concise. Its title can also be adapted.
  • Use a simple, understated legend

Practices to avoid

Embedding an Atlas map in an iframe is not recommended. An Atlas map includes many additional tools and is not suitable for use on a third-party site.

A button is available from the embed iframe to view the map with all its tools in the Atlas of the mapping portal.

Visibility of the application

embed is an application that is not intended to be visible as a stand alone application in the user menu. However, it must be activated during cartostation deployment to be usable.

This application is automatically used when the third party site publication code is copied from the corresponding widget in atlas.

Creating embed URLs manually

It’s recommended to use the embed creation system in the interface as seen above. It’s still however possible to configure embedded maps manually. URLs are structured according to the following model:

[deployment-url]/client/embed/[map-ID]?profile=[profile-type]&lang=[language_code]

The available profile types are the following:

  • simple which is “Map with legend”
  • all-tools which is “Map with tools”
  • full-screen which is “Simple map”

Infiltrasoil

Infiltrasoil is a portal to facilitate the analysis of rainwater infiltration opportunities in the Brussels Capital Region: with Infiltrasoil, information on the regulatory and technical context of infiltration is available in a few clicks. This application has been designed for professionals and the general public, and is integrated as a complementary module to the Geodata platform of the Brussels Environment administration

This application can be used at this address: https://geodata.environnement.brussels/client/infiltrasoil/home

A guide is available at this address (in French): https://environnement.brussels/pro/outils-et-donnees/sites-web-et-outils/infiltrasoil?highlight=infiltrasoil

login

Access to some cartostation features may require a user account with the corresponding access rights.

This simple application allows authentication.

Connection LDAP server

The cartostation authentication system can be connected to the LDAP server of the organizations that use it in order to be synchronized with accounts that are otherwise internally activated.

metadata

The metadata application is used to edit the metadata associated with cartostation data layers.

A part of this metadata can be generated automatically (see Admin documentation), while another part, more qualitative, must be encoded manually by the persons in charge of this data.

NB: This application was developed primarily to meet the INSPIRE directive (https://inspire.ec.europa.eu/) in the context of Bruxelles Environnement administration. Its purpose could/should be more generic, and should be the subject of a specific project.

plans and projects

The application plans and projects is a specific application for the Perspective.brussels data schema.

The application plans et projets allows to encode and visualize information related to plans and real estate projects. One of its particularities is to keep the whole history of each encoded information.

This application proposes an approach at the project scale.
For a more global approach, in the form of a list of projects, see the application query.

query

Generalities

The application query allows to filter and extract projects encoded via the application plans and projects, in order to be able to consult them in the form of a listing, to make exports exploitable in a spreadsheet, or to create dynamic maps.

To do this, the application offers a dedicated query creation wizard, which allows users who are not familiar with SQL to extract data on a more semantic basis.

In a second step, once the query is built, it is possible to choose which information will be part of the result of this query.

A query can be saved for personal use, or shared with other users of the application.

The query result is dynamic, which means that it always presents up-to-date results, depending on what is encoded in the plans and projets application, either in the form of a table or a map.

studio

The studio provides functionalities to create and publish maps from the available data.

The studio brings tools to create simple, categorized and continuous legends, as well as to define more advanced settings such as editing the available information by data layer element.

Published maps are accessible in the atlas application.

terms

This application allows you to create and define Terms and Domains, which are used among the information units to be encoded in the application plans and projects.

A domain is the equivalent of a category, while the terms of a domain are the possible qualifiers within that particular category.

This application, which is essential for the plans and projets application, is very textual and technically very simple: it is a matter of describing and defining a thesaurus for qualifying urban plans and projects.

As the notions at work are moving and evolving, this application gives the ability to the operators to build and update the whole semantics underlying their information system.

This freedom comes with the responsibility of structuring and defining terms collectively, in order to progressively consolidate a common language.

Table

The table is a component that recurs regularly in cartostation, in various contexts. Depending on the case, a certain set of features is available.

Viewing information

The information contained in the table can be of a very diverse nature. Sometimes the cells do not display all the information. In all cases, the information is fully displayed when the mouse hovered it, and can be copied by selecting the contents of the cell with a double-click + ctrl-C.

In some cases, when a row in the table is selected, a summary sheet of the information in the row is displayed in a side panel.

Arrange according to a column

Clicking on a column title will order the table in alphabetical order of the values in the selected column.

Filter data (text, numeric, dates)

It is possible to filter the information by column. Filters can be cumulative, and offer operators such as equal to, greater than or equal to, less than or equal to for numeric values and dates.

It is therefore possible to filter on a numeric or time interval, while refining according to textual categories for example.

Export data to CSV

Depending on the case, an export of the table data is available. The file produced is a .csv file, which can be read by standard spreadsheet softwares.

map component

Map navigation

Navigation on the map is mainly done with the mouse :

  • the mouse wheel allows you to zoom in/out.
  • the click + drag allows you to move the center of the map.

Zoom functions are also available via buttons on the map, with an additional full-screen function and reset of map rotation (north up - mobile use).

Tip: holding down the Shift + click key draws the area to be zoomed in.

Drawing on the map

In some cases, the user is expected to draw on the map.

Point: It is usually sufficient to click on the map at the desired location to create a point.

Line: The segments that make up the line must be drawn. Clicking on the last point ends the line.

Polygon: You must draw the segments that consitute the polygon. Clicking back on the first created point closes the polygon, as does double-clicking.

Tip: in the case of lines and polygons, holding down the Shift + click key allows you to draw freehand.

In most cases the navigation features remain active while drawing. It is therefore possible to zoom in and out and move around the map while drawing on the map.

General settings

Generalities

cartostation’s backend is built with Django.

The admin part is located at /admin, and you must be a registered user with staff permissions to access it.

Permissions : Users and Groups

Can be set up in /admin/auth/

Users

Users can have 4 permission status

  • Active
  • Staff
  • SuperUser
  • Group(s)

Active : will activate or de-activate the user account. If unchecked, it doesn’t delete it.
Staff : if checked, it will allow this user to log in the administration page. By default the user won’t be able to do anything. He will need to be part a group with permissions set up to be able to use part of the administration.
Superuser : grant all the permissions to this user.
Group(s) : see below

Groups

You can define groups with specific permissions. The permissions defined in the group page are about functionalities in the administration part.

If a user is part of several groups, it will be granted with the union of the privileges of the groups.

Some specific functionalities can be related to group per apps.

App access by group

CLIENTS configuration accept a “groups” key that takes a list of group names, thus limiting access to these apps to users belonging to these groups.

User and collaborators

Sometimes it is useful to let multiple people access a map in the studio. It is possible to add collaborators to the map in the ‘/admin/api/usermap’ section. Collaborators have the same rights as the user (generaly the creator) of the map, except that they can’t delete it.

Transparency in Atlas

We think it’s good practice to carefully choose the transparency in the Studio so that the user will not have to deal with it in the Atlas. But the possibility exists in the administration platform to add a widget to the atlas for some chosen layers, to let change the transparency in the Atlas. You only need to check the “Opacity selector” option in the layer page (section admin/api/layerinfo/).

Configure a WMTS base-map layer

In the section admin/webservice/ you can configure basemap layers. The basemap layers can then be selected in the compose to be displayed in the view

The base layer is where the basemap is configured. The following elements are described: display name, sort index, recommended, webservice set, service layer links

Display name

The (multi-lingual) name that might be shown to the users in the client applications.

Sort index

The index indicates the level of the base layer in listings. An index of 1 will place the base layer on top of the list.

If ticked, the base layer will be pre-selected by default in the studio for any new map.

Webservice set

The webservice sets allow to group a set of base layers, for example on a thematic basis, that will be displayed in the compose or view.

You can create one on the fly, or create them in the section admin/webservice/wmslayercategory/add/

The layers you want to add to the basemap. The sort index allows you to define which layer is on top. An index of 1 will place the layer at the bottom (it is the first one to be drawn). A bigger index will place the layer on top.

The layers can be configured in the section admin/webservice/servicelayer/add

Setting up the service layers

Layers

Layers is multilingual, which means you can use a different layer per language.
It is also possible to stack layers together.

Crs

Configure the CRS of the WMS.
For now, only EPSG:31370 is supported.

Styles

No style yet. But an empty string is needed.

Service

The service you want to connect to.

While you can do it on the fly, you might want to configure a service first in the section admin/webservice/service/add/:

Override message records

Some of the structuring text elements in cartostation are message records. It is possible to override the default message records used in cartostation and replace them with edited content in the administration part (in section admin/api/editedrecord/), by entering the message’s key and then the text that should replace the default message: the record.

Message record key

In any application, by adding ?debug=1 at the end of the url, you enter debug mode, which replaces each editable content (the default message records) in the interface by its key.

This debug mode can be used to find a specific key right from where it is used.

For example, in the view app, at url https://geodata.environnement.brussels/client/view/?debug=1, the keys appear after the ‘TR:’, between brackets:

The key should be structured this way : app_prefix/messageRecord

For example, the title of the applications in the view app has the key view/applicationsListTitle

This key will be used to add (or change) an Edited Record in the administration platform (in section admin/api/editedrecord/).

To quit debug mode, simply reload the page.
The new record will appear directly.

NB for developers: All the original key:value are stored in the /locale directory of the client applications.

WFS 2

A read-only WFS 2.0 with authentication is accessible on cartostation.

url : [HOST-NAME]/basic-wfs/[lang]

TIP : If needed, a QGIS plugin is available to connect on a WFS 2.0 : http://plugins.qgis.org/plugins/wfsclient/

Configure base layers for a quick switch (in view and compose)

To get a “quick switch” between two base layers on the map, the chosen base layers have to be define in the admin. To do this, exactly two “highlighted base layers” have to be created. If you create only one, it will not appear. For the moment, the application does not support more than two layers either. This will be done in future developments

Maintenance Events

To prevent the use of the platform during a maintenance period, it’s possible to define a maintenance event. Therefore, a ‘maintenance’ group has to be defined in the admin (see ‘groups’). You can add any user in this group. This group has to be mentioned in the settings under the key MAINTENANCE_GROUP_NAME.

During the maintenance period, this page will be shown for all users but the ones in the maintenance group:

The event itself has to be defined in the administration platform. An announcement should be defined, that will be shown between its start date and the start of the maintenance event, under the header of the app.

It is also possible to define a specific message for a given app, that will be shown during a given period.

angled-project

Visualisation profiles

In the section admin/angled/profile/ you can configure viusalisation profiles.
Those profiles are used to filter and organize the information displayed to users in [angled-project] app.

nb : it is only related to data visualization, not data access control, and all profiles are available to use by anyone.

It is possible to display two types of informations :

  • Information Units (IU)
  • Views

Views are specific visualisation widgets.

Layout system

The layout system uses the following components :

  • page / operator : new
  • box / operators : horizontal and vertical
  • unit / list : see list in profile creation page
  • view / list : see list in profile creation page

Exemples :

  • page new will create a new page.
  • box horizontal will create a box in which the content will be stacked horizontally
  • box vertical will create a box in which the content will be stacked vertically.
  • unit note will display the IU “note”
  • view housing will display the specific view “housing”

Boxes can contain other boxes, UIs or views.

Layout principle exemple with empty boxes

This layout would be declared this way :

%A comment on this profil%
page new
  box horizontal
    box vertical
      unit a
      unit b
      unit c
    box vertical
      unit d
      box horizontal
        unit e
        unit f

Important : indentation is strictly 2 spaces

tip : It is usually a good practice to start the design of a new profile by hand, on paper.

Options

Options can be used to customise the output of a IU or view, they are declared using key=value

Exemple :

Change a title : title="another_title"

ex : unit note title="another_title" will override the default title of the IU “note”.

Hide a UI in read mode : hidden=1

usecase : show the IU in write mode but not in read mode. Usefull in combination with a view element, so you encode the datas, but only display the computed view.

Trigger a specific style : class="class_name"

Will add an extra CSS class on the IU.

This allows to invoke a specific style on the IU, in the current profile context.

For now this functionality is not used, but it does exist, and can be triggered if needed.

Filter UI’s content : filter="field_name/term_ID"

It is possible to filter the content of a IU based on the Terms it uses.

The filter can be used this way : filter="field_name/term_ID"
Separators can be / or . or =.

Exemple : unit note filter="type/51" will display only the note content related to the Term ID 51 (which is “source/bron” ).

Since it is possible to display multiple times the same IUs in profiles, it this bring a bit of complexity, but gives the administrators a great flexibility to create highly customized profiles.

Exclude a value : exclude="field_name/term_ID"

To display all values except one, it is possible to exclude a specific value by using exclude="field_name/term_ID"

Exemple : unit note exclude="type/314" will display all notes except the one related to the initial import (tagged with term 314).

Audience

Audience are created to restrict the visibility of the information to specifics users.

It is defined by informations authors in angled-project app, and used everywhere angled-project datas are used, such as in the angled-query app or in the maps showing project datas.

When visualizing a project in angled-project, users without the right Audience permissions will be nonetheless advertised that there is an information, that they are not allowed to see.

Create a new Audience

To create a new Audience, visit the section /admin/angled/audience/.

To add one, just give it name, a description, and attach it to a group.

The users part of that group will then be part that Audience.

Tags

To create a new Tag, visit the section /admin/angled/tag/.

The new tags will be available in the tag list in Projects application.

nb : Tags are meant to qualify information, so their definition should follow a common guideline, shared among users.

Domain field mapping

To limit the number of domains displayed in a list, it is possible to map a domain to a unit field in admin/angled/domainfieldmapping/

Domain : display all the available domains created in the Terms application.

Unit : code name for the UI where this domain is used

Field : the UI field that contain the domain/term list

The complete UI/Field list can be found in the data-loader repository.

If the UI names have been aliased (and thus not easy to catch in the interface itself), this mapping will be then available in the Alias section.

Metadata

Geographical ressources (GeoJSON data) on cartostation are represented by metadata instances.

To make a resssource available in the Studio application, it has to be represented by a metadata instance.

The model in use is compliant with the European INSPIRE directive.

Add metadata

All metadata fields are described below.

Title

Set up a title for your ressource.

This field can be edited in the Metadata application.

Abstract

Set up an abstract for your ressource.

This field can be edited in the Metadata application.

Set up a link to the external ressource (optional).

This field can be edited in the Metadata application

Ressource identifier

Ressource identifier is structured like a URL.

It is templatized as : loader://path

It is an internal identifier which is converted into a proper URL pointing to the ressource by the loader itself (eg: postgis loader).

ex :

  • postgis : postgis://schema/table_name
  • angled : angled://UI_code_name/query_ID where UI_code_name can be point, line or polygon

nb1 : you can point to distant ressources : for an accesible GeoJSON in EPSG:31370 ressource, an absolute URL will do the job.

nb2 : To delete a metadata, you will be asked to delete all the objects dependant on it. (Layers in maps etc..)

Geometry type

Select the geometry type of your ressource.

Bounding box

Has to be 0.0, 0.0, 0.0, 0.0 for now. It will be removed soon.

Point of contact

Point of contact for this ressource.

A point of contact is a user connected to an organization.

Create a centroid layer

Note : Works only for a polygon layer frome a query created via the Query application

  • Duplicate a query (polygon only) metadata sheet
  • Adjust metadata title accordingly
  • Add /centroid at the end of its Resource identifier (eg : angled://l/45/polygon -> angled://l/45/polygon/centroid)
  • Change geometry type for Point

Manage Metadata

Large amounts of matadata require maintenance. The advanced search function allows to filter the metadata by date, and also by count (how many map layers are actually using the table associated to the metadata).

Metadata can be deleted, and will not appear anymore.

Statistics

The statistics app is used to monitor the use of the other apps. Therefore, there are some ‘captors’ spread in the apps to log some activities (such as: ‘visiting an app’, ‘go to a map’, …). To choose what to show, you can create ‘dashboards’ (named ‘activity profiles’ in admin), that will structure the data we want to represent.

Actions

For now, users’ actions available to log (and thereafter to represent on the dashboards) are:

For multiple apps

- 'visit': visit an app,
- 'link': clic on a link,
- 'navigate-map': go to a map,
- 'print-map': print a map,
- 'lang-choice': go to an app in a given language or change the language,

Only for the ‘angled-query’ app:

- 'navigate-query': see a query,

Only for the ‘angled-project’ app:

- 'save-units': count the number of edits when someone save changes of an information unit,

Dashboards

Can be set up in /admin/activity/activityprofile/

Name

Name of the dashboard.

Profile Layout

A profile layout is declared using the following syntax :

page new
    box vertical
      box horizontal
        multiwidget graph graphtype="barchart" action="visit" ns=view,compose,embed,angled-project,angled-query,mdq titleFR="Nombre de visites" titleNL="Aantal bezoeken"
        multiwidget applist aggregation="count" ns=view,compose action="visit" ns=view,compose

        widget list nb=10 ns="view" action="navigate-map" titleFR="Liste des cartes les plus vues" titleNL="Meest gezien kaarten"
        widget list nb=5 ns="compose" action="navigate-map"
        widget value aggregation="count" ns="view" action="link"
      box horizontal
        widget graph graphtype="piechart" ns="angled-project" action="save-units"
        widget graph graphtype="piechart" ns="view" action="lang-choice"
        widget graph graphtype="piechart" ns="mdq" action="lang-choice"
      box horizontal
        widget graph graphtype="time-barchart" ns="view" action="visit"

Each ‘widget’ needs a type of representation (how we want to show the data, see below), one or more namespaces (the app(s) concerned by the action, one for a widget, more for a multiwidget), an action type (which data we want to use).

page declares a page. box declares a layout box. Available operators are [horizontal, vertical] widget declares a widget to be displayed. Available operators are:

  • list: lists n elements with biggest occurence. It needs option “nb”.
  • value: renders one number. It needs the option “aggregation” that can take next values: [count, sum, min, max, avg].
  • graph: renders a graph. It needs the option “graphtype” that can take next values: [barchart, piechart, time-barchart]

multiwidget declares a widget that concerns multiple apps. Available operators are:

  • graph: renders a graph. It needs the option “graphtype” that can take next value: [barchart]
  • applist: lists apps (listed in ‘ns’ option) with a number linked to an action. The calculation of the number is described by the option “aggregation” that can take next values: [count, sum, min, max, avg].

There are also optional informations: [‘title’, ‘titleFR’, ‘titleNL’], to declare using the same form [key=value].

Default profile

A default profile can be defined in the deployment settings with DEFAULT_MONITORING_DASHBOARD=“PROFILE_NAME”