The minimum setup required for a WMS map engine is the capabilities url for the service.
...
Name | Type | Required | 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 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 | Default format that the map engine will request from the WMS server if one is not specified. |
transparent | boolean | no | Determines if the areas of the image that are 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 | The RGB value for the image background if transparency is not enabled, the default is #ffffff |
username | string | no | A username to connect to the server as. |
password | string | no | A password to connect to the server as. This should be encrypted using 'encrypt' at the osgi prompt. |
| qgis | boolean | no | Force the map engine as to be treated as though it were QGis. Weave will try and figure out if the underlying WMS service is QGis and perform additional optimisations and expose additional capabilities if it is, but sometimes Weave might not be able to determine this correctly in which case you can set this property to true in the config and the map engine will be treated as though it were being served from QGis. Additionally if Weave is incorrectly guessing that a WMS service is QGis when it isn't you can set this property to false to disable the additional functionality. (Note: Weave does not automatically identify QGis 3.4 hence need to set qgis=true.) |
| disableTests | boolean | false | Set to true to disable the background checks to validate WMS connections |
| testInterval | integer | 60,000 | milliseconds between tests when the WMS connection is working (minimum 15,000) |
| testIntervalWhileFailing | integer | 15,000 | milliseconds between tests when the WMS connection is failing (minimum 5,000) |
| testFailingDuration | integer | 300,000 | how long before a failing WMS connection is determined to have failed (minimum 60,000) |
| testIntervalWhenFailed | integer | 600,000 | milliseconds between tests when the WMS connection has failed (minimum 120,000) |
Sub-tags
Name | type | cardinality |
|---|---|---|
layers | #layers | 0..1 |
sort | #sort | 0..1 |
styles | #style | 0..1 |
| crs | #crs | 0..n |
...
Name | Type | Required | Description |
|---|---|---|---|
layer | string | yes | The id of the layer, from the map engine, to override the style for |
name | string | yes | The name of the style to use |
crs
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| force | boolean | no | Ensure the CRS is added to the list of available CRS's even if the underlying server doesn't indicate that it supports the EPSG code |
Content
The EPSG code of the coordinate reference system to add
...
| 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.
...