geocoder

This configuration is required when using the plugin Geocoder.

Documentation
YAML Format
XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.

<geocodingConfiguration

required

With a geocoding service, the geographical position can be determined based on a postal address or other location information, e.g. for points of interest (POIs). Conversely, it is possible to find the closest address or other specific location from a position on the map.

<geocodingServices

optional

Settings for the geocoding services. The geocoding services must be OpenLS compliant.

<geocodingService

required

string

Unique ID for the service connection. Other functionalities of Cadenza can use this ID for referencing this service.

<supportedRequestTypes

required

Settings for search request types supported by the geocoding service.

<requestType

xsd:string

structured

Request with structured address data.

unstructured

Request with unstructured address data.

reverse

Request with coordinate pairs.

poi

Request with information about POIs.

requiredmax. unbounded

Supported search request type.

</requestType>

</supportedRequestTypes>

<server

<url

requiredstring

URL of the service.

</url>

<wrapperMappingUrl

optionalstring

URL of the mapping interface of the Geocoding Wrapper. If the Geocoding Wrapper is used, the service response may contain additional data beyond the OpenLS standard. The mapping interface returns information about how this additional data should be mapped. Only needed if the Geocoding Wrapper is used.

</wrapperMappingUrl>

<timeout

optionalduration

Timeout for the search query in PnYnMnDTnHnMnS format, e.g. PT600S means until in 600 seconds from now (for more information see https://www.w3.org/TR/xmlschema-2/#duration).

Default: PT30S

</timeout>

required

Settings for the server providing the geocoding service.

</server>

<properties

<property

xsd:string

name

required

string

Name of the property. Currently, only multipleAddressesPerGeocodeRequest is available. Set the value of the property to true if the addresses should be passed to the geocoding service all together, in case they are not accepted individually. Otherwise, use false to pass them one by one (default). Note: If the service does not return any results when importing addresses with this configuration, the import may result in a runtime error. So use true only if the probability of invalid address data is very low.

description

optional

string

Not used at the moment.

optionalmax. unbounded

An additional search request property.

</property>

optionalmax. 1

Settings for additional search request properties.

</properties>

optionalmax. unbounded

Settings for a geocoding service, must be OpenLS compliant.

</geocodingService>

</geocodingServices>

<reverseGeocoding

geocoderId

optional

string

ID of a geocoding service configured in <geocodingServices> that should (also) be used for reverse geocoding.

<maxSearchDistance

required

Settings for the distance to the geographic position. Addresses are searched for within this distance.

value

optional

double

Value of the search distance.

unit

optional

string

Unit of the search distance. Allowed values: M or KM.

</maxSearchDistance>

<defaultResult

required

Settings for the format of the result address in countries for which no specific <result> block is configured.

<line

requiredmax. unboundedstring

One line of the address output. The address components must be specified in curly brackets, e.g. {CountryCode}. The following address components can be used: CountryCode (according to ISO 3166-1), CountrySubdivision, CountrySecondarySubdivision, Municipality, MunicipalitySubdivision, Settlement (content identical to MunicipalitySubdivision), PostalCode, Street, Housenumber.

</line>

</defaultResult>

<result

optionalmax. unbounded

Setting for the format of a result address in a specific country.

countryCode

optional

string

Country code according to ISO 3166-1, e.g. DE for Germany.

<line

requiredmax. unboundedstring

</line>

</result>

optionalmax. 1

Settings for the reverse geocoding service. At most one service can be configured for this purpose.

</reverseGeocoding>

</geocodingConfiguration>

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.

cadenzaconfig:
  settings:
    geocoder:
      geocodingServices:
      - id: "text"
        supportedRequestTypes:
        - "structured"
        - "structured"
        server:
          url: "text"
          wrapperMappingUrl: "text"
          timeout: "P2DT3M"
        properties:
        - name: "text"
          description: "text"
          value: "text"
        - name: "text"
          description: "text"
          value: "text"
      - id: "text"
        supportedRequestTypes:
        - "structured"
        - "structured"
        server:
          url: "text"
          wrapperMappingUrl: "text"
          timeout: "P2DT3M"
        properties:
        - name: "text"
          description: "text"
          value: "text"
        - name: "text"
          description: "text"
          value: "text"
      reverseGeocoding:
        geocoderId: "text"
        maxSearchDistance:
          value: 133.7
          unit: "text"
        defaultResult:
        - "text"
        - "text"
        result:
        - countryCode: "text"
          line:
          - "text"
          - "text"
        - countryCode: "text"
          line:
          - "text"
          - "text"

Filename: geocoder-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<geocodingConfiguration>
  <geocodingServices>
    <geocodingService id="text">
      <supportedRequestTypes>
        <requestType>structured</requestType>
        <requestType>structured</requestType>
      </supportedRequestTypes>
      <server>
        <url>text</url>
        <wrapperMappingUrl>text</wrapperMappingUrl>
        <timeout>P2DT3M</timeout>
      </server>
      <properties>
        <property name="text" description="text">text</property>
        <property name="text" description="text">text</property>
      </properties>
    </geocodingService>
    <geocodingService id="text">
      <supportedRequestTypes>
        <requestType>structured</requestType>
        <requestType>structured</requestType>
      </supportedRequestTypes>
      <server>
        <url>text</url>
        <wrapperMappingUrl>text</wrapperMappingUrl>
        <timeout>P2DT3M</timeout>
      </server>
      <properties>
        <property name="text" description="text">text</property>
        <property name="text" description="text">text</property>
      </properties>
    </geocodingService>
  </geocodingServices>
  <reverseGeocoding geocoderId="text">
    <maxSearchDistance value="133.7" unit="text"/>
    <defaultResult>
      <line>text</line>
      <line>text</line>
    </defaultResult>
    <result countryCode="text">
      <line>text</line>
      <line>text</line>
    </result>
    <result countryCode="text">
      <line>text</line>
      <line>text</line>
    </result>
  </reverseGeocoding>
</geocodingConfiguration>