documentatie

Documentation utilisateur [FR]
Gebruikersdocumentatie [NL] User guide [EN]

Administration

This section is a first version of the admin documentation of cartostation.

For more technical (ie: developers infos), please refer to the readme about the server here and about the client applications here.

For now this section is a one-long-page. It might be good to split it in the future.

General settings

Permissions : Users and Groups

Can be set up in /admin/auth/

Users

Users can have 4 permission status

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.

Configure a WMS base-map layer

In the section admin/webservice/wmslayer/ you can configure WMS layers.

Name is the identifier of this layer, so it’s a good practice to keep it simple and accurate.

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

illustration

While you can do it on the fly, you might want to configure a service first :

illustration

Override message records

In the section /api/editedrecord/ it is possible to override the default message records used in cartostation.

The key should be structured this way : app_prefix/messageRecord

Available app prefixes are :

MessageRecord are visible in the /src/locale folder in each app :

WFS 2

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

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

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

App settings

[Metadata]

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

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).

nb1 : 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..)

[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 :

Views are specific visualisation widgets.

Layout system

The layout system uses the following components :

Exemples :

Boxes can contain other boxes, UIs or views.

illustration Layout principle exemple with empty boxes

It is usually a good practice to start the design of a new profile on paper.

Options

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

Exemple :

title=”another_title”

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

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.

class=”class_name”

Will add an extra css class on the IU.
This allows to invoke special style on the IU.

TO BE DOCUMENTED

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/315" 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=”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).

[angled-project] : 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.

[angled-project] : 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/