The minimum setup required for a WMS map engine is the capabilities URL for the service.
...
Name | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | yes | Unique identifier | |
url | string | yes | The capabilities URL for the WMS service. You should not include the SERVICE, REQUEST or VERSION parameters in the URL, just use the base URL, these parameters will be added automatically based on the type of request that is being made. Note: WMS version 1.3.0 may be forced on by including the URL VERSION parameter, however, this is not recommended and Weave will use WMS version 1.1.1 by default. | |
format | string | no | first format reported by map engine | Default format that the map engine will request from the WMS server if one is not specified. |
transparent | boolean | no | false | Determines if the areas of the image not covered by spatial data are rendered as transparent or as a solid colour (as set by the background property). Enabling transparency requires an image format that supports it (jpeg and png24 do not). |
background | integer | no | white | The RGB value for the image background if transparency is not enabled |
username | string | no | A username for connecting to the server. | |
password | string | no | A password for connecting to the server. This should be encrypted using 'encrypt' at the osgi prompt. | |
| qgis | boolean | no | Force the map engine to be treated as though it were QGIS. Weave will try to determine if the underlying WMS service is provided by QGIS and perform additional optimisations and expose additional capabilities if it is. Sometimes Weave might not be able to determine this correctly, in which case you can set this property to true in the configuration and the map engine will be treated as though it were being served from QGIS. If Weave incorrectly determines that the WMS service is QGIS when it is not, then you can set this property to | |
| geoserver | boolean | no | Force the map engine to be treated as though it were GeoServer. Weave will try and determine if the underlying WMS service is provided by GeoServer and perform additional optimisations and expose additional capabilities if it is. Sometimes Weave might not be able to determine this correctly, in which case you can set this property to true in the configuration and the map engine will be treated as though it were being served from GeoServer. If Weave incorrectly determines that the WMS service is GeoServer when it is not, then you can set this property to | |
| arcgis | boolean | no | Force the map engine to be treated as though it were ArcGIS. Weave will try and determine if the underlying WMS service is provided by ArcGIS and perform additional optimisations and expose additional capabilities if it is. Sometimes Weave might not be able to determine this correctly, in which case you can set this property to true in the configuration and the map engine will be treated as though it were being served from ArcGIS. If Weave incorrectly determines that the WMS service is ArcGIS when it is not, then you can set this property to | |
| arcims | boolean | no | For those still using ArcIMS I'm sure you can figure out what this property does by reading the three properties before this one | |
| disableTests | boolean | no | false | Set to true to disable the background checks to validate WMS connections |
| testInterval | integer | no | 60,000 | milliseconds Milliseconds between tests when the WMS connection is working (minimum 15,000) |
| testIntervalWhileFailing | integer | no | 15,000 | milliseconds Milliseconds between tests when the WMS connection is failing (minimum 5,000) |
| testFailingDuration | integer | no | 300,000 | how How long before a failing WMS connection is determined to have failed (minimum 60,000) |
| testIntervalWhenFailed | integer | no | 600,000 | milliseconds Milliseconds between tests when the WMS connection has failed (minimum 120,000) |
| cql | boolean | no | false | Set to true if the map engine supports filtering using CQL. If the map engine is one that is not directly supported by Weave but does support using CQL to filter layers then setting this to true will enable the support for layer filtering using CQL. |
| cqlparamname | string | no | cql_filter | The name of the parameter to add to the request URL if CQL filtering support was enabled by setting cql to true |
| cqlseparator | string | no | ; | The filter separator to add to the request if CQL filtering support was enabled by setting cql to true |
...
Name | Type | Cardinality | Description |
|---|---|---|---|
layers | #layers | 0..1 | Refine what layers are included in the map description. |
sort | #sort | 0..1 | |
styles | #style | 0..1 | |
| crs | #crs | 0..n | Refine what CRSs the map engine lists as being supported, as opposed to including all of them (as there might be thousands of CRSs that the WMS server says that it supports). Without any |
| tokens | #tokens | 0..1 | Additional tokens to add to the request. The tokens available are dependent on the WMS server implementation and are generally used to support implementation specific extensions to the WMS specification. |
layers
Sub-tags
Name | Type | Cardinality |
|---|---|---|
layer | #layer | 0..n |
remove | #remove | 0..1 |
...
| Note |
|---|
As of version 1.3.7 of the WMS bundle, the password can be encrypted using the OSGi encrypt command. |
WMS 1.3.0
Don't "upgrade" to WMS 1.3.0 unless you really have to.
Version 2.15.16 of the com.cohga.server.map.wms bundle (released as part of Weave 2.5.21) improves support for WMS 1.3.0 by supporting map services that require their axis order to be swapped.
...