Administrate a c2cgeoportal application

The administration interface is located at https://<server>/<project>/admin.

Authentication for the administration interface is done through the main application interface. Role role_admin is required.

OGC Server

This is the description of an OGC server (WMS/WFS). For one server we try to create only one request when it is possible.

If you want to query the same server to get PNG and JPEG images, you should define two OGC servers. Attributes:

  • Name: the name of the OGC Server.
  • Description: a description.
  • Basis URL: the server URL.
  • WFS URL: the WFS server URL. If empty, the Basis URL is used.
  • Server type: the server type which is used to know which custom attribute will be used.
  • Image type: the MIME type of the images (e.g.: image/png).
  • Authentication type: the kind of authentication to use.
  • WFS support: whether WFS is supported by the server.
  • Single tile: whether to use the single tile mode (For future use).

Metadata

You can associate metadata to all theme elements (tree items). The purpose of this metadata is to trigger specific features, mainly UI features. Each metadata entry has the following attributes:

  • Name: the type of Metadata we want to set (the available names are configured in the vars files in admin_interface/available_metadata).
  • Value: the value of the metadata entry.
  • Description: a description.

To set a metadata entry, create or edit an entry in the Metadata view of the administration UI. Regarding effect on the referenced tree item on the client side, you will find a description for each sort of metadata in the GmfMetaData definition in themes.js.

Some metadata items are used by the layers views (for editing) on the server side:

  • editingAttributesOrder: Specify the order of the editable attributes in the edit interface.
  • geometryValidation: Force validation of the geometries according to the layer type (point, line, polygon), for example, to prevent creation of a 2-point polygon.
  • lastUpdateDateColumn: Define a column which will be automatically filled with the date of the last edit.
  • lastUpdateUserColumn: Define a column which will be automatically filled with the user of the last edit.
  • readonlyAttributes: Set attributes as read only.

Functionalities

Roles and Themes can have some functionalities. Attributes:

  • Name: the type of functionality we want to set (configured in the vars files in admin_interface/available_functionalities).
  • Description: a description.
  • Value: the value of the functionality.

Layers

Layer definitions are found in two tables: layer_wms and layer_wmts. The legacy table layerv1 is still present, but only for being able to migrate the application. For information on migrating layers, see From CGXP to ngeo.

Common attributes

All the layers in the admin interface have the following attributes:

  • Name: the name of the WMS layer/group, or the WMTS layer. It is used through the i18n tools to display the name on the layers tree.
  • Metadata URL: (deprecated; use Metadata instead)
  • Description: a description.
  • Public: makes the layer public. also it is accessible through the Restriction areas.
  • Geo table: the related database table, used by the Editing.
  • Exclude properties: the list of attributes (database columns) that should not appear in the Editing so that they cannot be modified by the end user. For enumerable attributes (foreign key), the column name should end with ‘_id’.
  • Interfaces: visible in the checked interfaces.
  • Restriction areas: the areas through which the user can see the layer.
  • Metadata: Additional metadata.
  • Dimensions: the dimensions, if not provided default values are used.

WMS layer

On internal WMS layers, we have the following specific attributes:

  • OGC Server: the used server.
  • WMS layer name: the WMS layers. Can be one layer, one group, or a comma separated list of layers. In the case of a comma separated list of layers, you will get the legend rule for the layer icon on the first layer, and to support the legend you should define a legend metadata.
  • Style: the style used, can be empty.
  • Time mode: used for the WMS time component.
  • Time widget: the component type used for the WMS time.

WMTS layer

On WMTS layers, we have the following specific attributes:

  • GetCapabilities URL: the URL to the WMTS capabilities.
  • WMTS layer name: the WMTS layer.
  • Style: the style to use; if not present, the default style is used.
  • Matrix set: the matrix set to use; if there is only one matrix set in the capabilities, it can be left empty.
  • Image type: the MIME type of the images (e.g.: image/png).

When using self generated WMTS tiles, you should use the following url: config://local/tiles/1.0.0/WMTSCapabilities.xml. * config://local is a dynamic path based on the project configuration. * /tiles is a proxy in the tilecloudchain container.

Queryable WMTS

To make the WMTS queryable, you should add the following Metadata:

  • ogcServer with the name of the used OGC server,
  • wmsLayers or queryLayers with the layers to query (groups not supported).

It is possible to give some scale limits for the queryable layers by setting a minResolution and/or a maxResolution Metadata value(s) for the WMTS layer. These values correspond to the WMTS layer resolution(s) which should be the zoom limit.

LayerGroup

Attributes:

  • Name: It is used through the i18n tools to display the name on the layers tree.
  • Metadata URL: (deprecated. Use Metadata instead).
  • Description: a description.
  • Expanded: (deprecated).
  • Children: the ordered children elements.
  • Metadata: Additional metadata.

Background layers

The background layers are configured in the database, with the layer group named background (by default).

Theme

  • Name: It is used through the i18n tools to display the name on the layers tree.
  • Metadata URL: (deprecated. Use Metadata instead).
  • Description: a description.
  • Public: makes the layer public. You must use the Restriction Roles to make a private theme accessible.
  • Icon: the icon URL.
  • Interfaces: visible in the checked interfaces.
  • Restricted Roles: Restricted to the following roles.
  • Functionalities: The linked functionalities.
  • Children: the ordered children elements.
  • Metadata: Additional metadata.

Restricted area

A restricted area is an area for which a user must possess a specific role in order to be able to see (and edit, if applicable) the features within this area.

  • Name: a name.
  • Description: a description.
  • Roles: Restricted to the following roles.
  • Read/write: Allows the linked users to change the objects.
  • Area: Active in the following area; if not defined, it is active everywhere.

Users

Each user may have from 1 to n roles, but each user has a default role from which are taken some settings. The default role (defined through the “Settings from role” selection) has an influence on the role extent and on some functionalities regarding their configuration.

Role extents for users can only be set in one role, because the application is currently not able to check multiple extents for one user, thus it is the default role which defines this unique extent.

Any functionality specified as single can be defined only once per user. Hence, these functionalities have to be defined in the default role.

By default, functionalities are not specified as single. Currently, the following functionalities are of single type:

  • default_basemap
  • default_theme
  • preset_layer_filter
  • open_panel

Any other functionality (with single not set or set to false) can be defined in any role linked to the user.