[FrontPage] [TitleIndex] [WordIndex

deegree configuration tool

This page describes how to setup and use the deegree configuration tool.

1. Overview

The deegree configuration tool can be used to configure a WMS with simple WFS based layers and WCS based layers. Simple WFS featuretypes can be created as well as coverages for the WCS. It can either operate directly on the services, or use a (possibly remote) configuration service.

The configuration tool is an OpenJUMP package comprising a few plugins. Since it operates directly with services such as WMS, WFS etc. it is required that recent versions of the deeJUMPplugin and the WFSplugin are installed as well.

2. Setting up OpenJUMP and plugins

The deeJUMPplugin page contains a lot of information about setting up the various required plugins. In short, installing the configtool amounts to the following:

IMPORTANT NOTE: the nightly build of OpenJUMP is currently not available. You should use a prepackaged, inofficial version from OpenJumpPackages instead and swap .jars as needed.

You'll probably end up with too many libraries in the lib folder, if you use the stable version, but that should be alright (makes upgrading later on easier).

If I didn't make a mistake here, you should by now have an OpenJUMP version with a 'deegree' menu. That already enables you to edit services locally, but the configuration service makes many things more convenient even if you only use it on your own machine.

3. Releases

Here you can find specific "released" versions of the config tool packages (it is best to rename them to the basename, ie. owsconfig-0.9.jar -> owsconfig.jar after downloading):

You can run java -jar owsconfig.jar resp. java -jar wcfgs.jar to find out which version you have right now (this only works from 0.9 upward).

4. Configuration service

The configuration service is just another Java web application that can be used with tomcat. The following steps may help you to set it up on your machine:

People who wish to upgrade to the latest bleeding edge version of the service download the wcfgs.jar here.

4.1. Configuration options

Here's an explanation of all configuration parameters. Almost all of these exist in both the stable and the unstable version of the service (it is noted where not).

5. Using the config tool

The config tool can be used in a variety of ways. Some common scenarios will be explained in the following sections.

The options can be roughly grouped into three types. There are options to manage local services, options to manage remote services and admin functions for a remote service.

All options related to WCS and coverages are only available in the bleeding edge version.

5.1. Using the config tool without the service

The most straightforward functions to use the config tool are the ones labelled Edit local W*S. With these functions one can edit already existing services. One can also create new local services with this function, although this only includes editing the service configuration itself (and no handling of libraries, tomcat contexts etc.). In particular, one can edit the service metadata of all the service types.

The editing of the services itself should be straightforward as well, you can edit feature types, layers, remove them etc. They should be fairly self-explanatory. Adding new components is only available for WCS here, all other services have special wizards to create new feature types/layers.

The Add to ... WMS configuration option can only be used if you opened a shape file and selected the related OpenJUMP layer.

WCS coverages are usually created using the RasterTreeBuilder. The Create new coverage option provides a front end to this command line tool.

5.2. Using the config tool with the service

In principle, you have similar options here as with local editing of services. You find them under the menu entry Manage services, where one can also add and remove services. Users of the bleeding edge version can also start, restart and stop services here.

When adding a new service, one is asked to provide a server address. This is the value that will be used in all related configuration documents as the new services' address. If the service will be reached by the address http://www.deegreelovers.org/MyNewService/services?request=... you should enter http://www.deegreelovers.org here.

There are also the special options Extract WFS/WCS and Overwrite local WFS/WCS. Every WMS has a local WFS and/or WCS integrated. These internal services can be extracted and overwritten with these options. This is useful if you want to edit the style of a WFS layer, add a few more coverages, rename coverages, edit feature types etc. of these services. For the time the services are extracted, they can be used just like any other service.

Please take note that some of the wizards behave a little different than their local counterparts. For example, adding a new WFS feature type locally may be based directly on a shape file. If you add a remote feature type, the shape file will be stored in a database. The same is true for adding WMS layers, which are always based on shape files when used locally, and always stored in a databased when used remotely.

5.3. Using the config tool to manage the service/users

Besides changing your own password, an administrator may also add, edit and remove users for the remote configuration service. Depending on the administrators wishes, the service can be used in different ways.

It's possible to set up new users so they cannot add/remove services. If that's what's desired, the administrator should create some services for a new user and add them to his list. The new user will only be able to edit the services which he is allowed to.

The administrator can also add the same service to several users. This has the advantage that not too many services are used, but the disadvantage that concurrent changing of services may lead to consistency problems. Do it on your own risk.

The most flexible way is that users can add/remove their own services.

5.4. Customizing the config tool so as not to confuse its users

Administrators installing the configuration tool for users may wish to control which features the users have access to. This may be done by placing a owsconfig.properties in the user's $HOME/.jump/ directory. Separators can be added with a line like -=yes. The default file looks like this:


6. Issues

The issues are now collected at wald.

Issues fixed in the unstable version:

7. Wishes/Improvements

The issue tracker at wald supports wishes and improvements, so they shouldn't go here any more.

Issues fixed in the latest trunk:

8. Tips

The best tip is to setup a PostGIS database somewhere, get some shape files, setup the config service and try it out. By using the tool you'll get a feel for how it works. Setting up a deegree WMS from a shape file has never been so easy.

Since you'll probably jump on one bug or another, feel free to contact Andreas <schmitz AT SPAMFREE lat-lon DOT de> so he can fix them.


2018-04-20 12:04