User documentation for the CST Web Processing Service

The CST Web Processing Service offers the transformation functionality of the Humboldt Alignment Editor (HALE) as a web service. It supports transforming a GML source data set in to a transformed GML output, given the respective application schemata and the mapping specification in OML (as created in HALE). For using the service 'by hand' a simple web interface is offered, which allows uploading the needed input files.

The CST WPS comes bundled with its own web server and as such doesn't require you to provide an application server. To expose the CST WPS through an existing web server you can configure a reverse proxy (e.g. using mod_proxy for Apache web servers).

Installation

Download the CST-Web package suitable for your system from http://www.esdi-community.eu/projects/hale/files.
Extract the archive to where you wish the application to reside.

For Linux/MacOS a set of scripts is provided for managing the CST-Web server:
  • startup.sh - start the server (calls cst_web.sh)
  • shutdown.sh - stop the server (calls cst_web.sh)
  • cst_web.sh - takes 'start' or 'stop' argument, e.g. for the usage as an init script
On Windows, you can install the CST-Web server as a Windows service:
  • service-install.bat - installs a service named 'CST web server'
  • service-remove.bat - removes a previously installed service (must be executed from the same directory)

By default, the server will run on port 8080 and
the WPS will be available at http://localhost:8080/cst?service=WPS&version=1.0.0&request=GetCapabilities,
the web interface at http://localhost:8080/client.

When started, the server will create a log file logs\hale-server.log. If you experience any problems, have a look if there are any errors reported.

Configuration

The configuration file cst_web.ini can be used to adapt the server configuration. Each line in the file is a configuration parameter. There are two kinds of parameters:
  • Application parameters (all lines before -vmargs) and
  • Java VM parameters (all lines after -vmargs).

Attention: If using the server as a windows service, changes to cst_web.ini don't apply. Instead the cmdline entry in the file cst_service.ini must be adapted. After a change, stop, remove and reinstall the service.

Change the server port

You can change the port the server uses by changing the Java VM parameter -Djetty.port=<port_number>, where <port_number> is the desired port number.
The default configuration is:

-Djetty.port=8080

Change the server URL provided by the service

The URL that service states for accessing the server can also be changed. This is especially useful if you are running the server behind a reverse proxy. Use the Java VM parameter -Dservice_url=<url>, where <url> is the URL that should be used to access the server (e.g. <url>/client would be the URL to access the web interface).
The default configuration is:

-Dservice_url=http://localhost:8080

Set the webmaster mail address

The web interface offers a link to contact the webmaster through e-mail. The Java VM Parameter -Dwebmaster_mail=<email>, where <email> is the webmaster e-mail address, can be used to set a custom value.

Usage

The service can be used either as an OGG Web Processing Service (Version 1.0.0) or through the provided simple web interface. Both rely on the right input data being provided:
  1. The source data to be transformed (GML file)
  2. The corresponding source schema (GML application schema)
  3. A ZIP archive providing any dependencies that are locally referenced from the source schema (optional)
  4. The target schema (GML application schema)
  5. A ZIP archive providing any dependencies that are locally referenced from the target schema (optional)
  6. The mapping between source and target schema (OML file)

If the transformation is successful, a GML file with the transformed Features contained in a FeatureCollection is the result.

All inputs can be provided either inline (in the web interface through upload) or as a reference to a resource accessible on the web. The source and target schema dependency archives serve to provide dependencies, of the main source or target schema, that don't reside on the web but are available only locally with the main schema.

The Web Processing Service by default (local installation) is available at http://localhost:8080/cst:

The web interface by default is available at http://localhost:8080/client.