Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The minimum setup required for a WMS map engine is the capabilities URL for the service.

...

A WMS Tester tool is available from here, it can . It can help resolve issues with WMS servers.

...

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 for connecting to the server as.

password

string

no

A password to connect for connecting to the server as. This should be encrypted using 'encrypt' at the osgi prompt.

qgisbooleannoForce the map engine as to be treated as though it were QGisQGIS. Weave will try and figure out to determine if the underlying WMS service is QGis and QGIS, perform additional optimisations and expose additional capabilities if it is, but sometimes . Sometimes Weave might not be able to determine this correctly, in which case you can set this property to true in the config configuration and the map engine will be treated as though it were being served from QGisQGIS. Additionally if If Weave is incorrectly guessing determines that a the WMS service is QGis QGIS when it isn't is not, then you can set this property to false to disable the additional functionality. (Note: Weave does not automatically identify QGis QGIS 3.4 hence the need to set qgis=true.)
disableTestsbooleanfalseSet to true to disable the background checks to validate WMS connections
testIntervalinteger60,000milliseconds between tests when the WMS connection is working (minimum 15,000)
testIntervalWhileFailinginteger15,000milliseconds between tests when the WMS connection is failing (minimum 5,000)
testFailingDurationinteger300,000how long before a failing WMS connection is determined to have failed (minimum 60,000)
testIntervalWhenFailedinteger600,000milliseconds between tests when the WMS connection has failed (minimum 120,000)

...

NameTypeRequiredDescription
forcebooleannoEnsure the CRS is added to the list of available CRS's CRSs even if the underlying server doesn't indicate that it supports the EPSG code

...

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.

...

Code Block
languagexml
titleEnabling support for WMS 1.3.0
<wms:mapengine id="test">
  <url>http://server/wms/test?VERSION=1.3.0</url>
</wms:mapengine>

If you're lucky this is This is typically all you need to do to enable support for WMS 1.3.0. If you're unlucky It is possible that you may be using a coordinate reference system that requires requests sent to the server to reverse the order of x, y coordinates, and it's . It is update 2.14.16 of the Weave WMS map engine bundle that allows you to tell Weave to change the order of the coordinates when sending requests to the server. This is done by setting swapAxis to true in the map engine config, e.g.

...

Further to this the change between 2.14.16 and 2.15.16 adds the ability for Weave to determine automatically if it should swap the axis or not when working with WMS 1.3, removing the need to use the swapAxis setting at all and the need to have two map engines configured if you need to use both swapped and un-swapped axis (you still need to include VERSION=1.3.0 in the url, to enable WMS 1.3 support, but that too may be removed eventually).

Unfortunately to To enable the automatic determination of whether to swap the axis or not, you must update your startup setting to remove the org.geotools.referencing.forceXY setting. This is done by editing startup.cmd (or startup.sh)or editing wrapper.conf and removing the option that sets this property to true, otherwise Weave will always think that the axis order is x, y regardless of the projection used.

...