openrouteservice

This configuration is required when using the plugin Routing_Openrouteservice.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<openrouteserviceConfiguration
<service
<url
>
required
anyURI

Main URL of the service, such as https://routing.gdi.disy.net/ors.

</url>
<version
xsd:string
v2

Version 2 of OpenRouteService, the latest as of end 2021.

>
required

API version setting of the routing. Currently only v2 is supported by the Cadenza client implementation. Version 1 is not supported.

</version>
<apiKey
>
optional
string

API key necessary for accessing some restricted OpenRouteServices.

</apiKey>
<capabilities
<profiles
<profile
xsd:string
driving-car

Car.

driving-hgv

Heavy goods vehicle.

cycling-regular

Bicycle.

cycling-road

Road bicycle.

cycling-mountain

Mountain bicycle.

cycling-electric

Electric bicycle.

foot-walking

Pedestrian.

foot-hiking

Hiker.

wheelchair

Wheelchair.

default
optional
=
boolean

true to set the profile as default. The profile will be selected initially when routing is started.

Default: false

>
requiredmax. unbounded

Routing profile. At least one has to be defined.

</profile>
>
required

Provision of one or more route profiles (modes of transportation). At least one profile must be configured. Supported modes of transportation () are car (driving-car), heavy goods vehicle (driving-hgv), bicycle (cycling-regular), pedestrian (foot-walking), and currently only for Germany, wheelchair (wheelchair). By default, the first configured route profile is initially selected.

Using the 'default' attribute, a different route profile can be initially selected, deviating from the standard.

</profiles>
<elevation
>
optional

Add this element without content if elevation data is available and supported for the service.

</elevation>
<isochrones
<direction
>
optional

Add this element without content if direction for isochrones requests are supported for the service and its profiles.

</direction>
>
optional

Add this element without content if isochrone requests are supported for the service and its profiles.

</isochrones>
<statistic
>
optional

Enables the consideration of statistical traffic data when calculating routes (only when specifying a start or arrival time) and isochrones (only in 'time' mode). The routing service has statistics for almost all of Germany, except for some rural areas. The user can also disable the use of statistical traffic data if needed. Note: For the currently supported service, traffic data is available for the profiles car (driving-car) and heavy goods vehicle (driving-hgv).

</statistic>
>
required

Property settings of the routing. Defines what the service offers via its API, most importantly, which routing profiles are available. Other information such as the availabilty of elevation data can be provided as well, enabling the client to query and display additional data for a route.

</capabilities>
<tuning
<language
>
optional
string

The language in which the description of the calculated route is displayed. By default, the Cadenza language is used. Change this setting e.g. in case your ORS instance does not support the Cadenza language.

</language>
<defaultIsochroneDuration
xsd:duration
>
optional

Initial time duration between the isochrones in minutes. The time format is specified according to ISO 8601 in the PnYnMnDTnHnMnS format, e.g., PT600S means 'until 600 seconds from now'. Note: The values must be below the constraint defined in the <restrictions> section.

</defaultIsochroneDuration>
<defaultIsochroneDistance
xsd:int
>
optional

Initial distance between zone borders in meters. The user can adjust the time duration between the isochrones for their accessibility analysis. Note: The values must be below the constraint defined in the <restrictions> section.

</defaultIsochroneDistance>
<httpRequestTimeout
>
optional
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

Duration (according to the ISO 8601 standard) the OpenRouteService will wait for a response. A response timeout value is already globally defined for Cadenza, but since requests for the isochrones can take longer than usual, it may be useful to define a higher timeout value here.

Default: PT30S

</httpRequestTimeout>
>
optional

Optional tuning settings for the routing. Set properties to more preferable defaults, e.g. set default language for textual instructions (the service does not support all languages and using the user language may not be possible). Note: Setting may be overwritten by a client request, e.g. because the user chose a different routing language.

</tuning>
<restrictions
<maxStopovers
>
optional
int

Maximum number of stopovers between start and end point. Can be between 0 and 48 (resulting in a maximum of 50 waypoints in total). Note: Start and end point are not counted.

</maxStopovers>
<maxIsochroneLocations
>
optional
int

Number of isochrone waypoints.

Default: 2

</maxIsochroneLocations>
<maxIsochroneZones
>
optional
int

Number of isochrone zones.

Default: 7

</maxIsochroneZones>
<maxIsochroneDuration
xsd:duration
>
optional

Maximum duration for temporal isochrones.

</maxIsochroneDuration>
<maxIsochroneDistance
xsd:int
>
optional

Maximum sum of inter-isochrone distances.

</maxIsochroneDistance>
<maxGeometryPointCount
>
optional
int

Maximum number of points for a geometry or route.

Default: 50000

</maxGeometryPointCount>
<maxAvoidPolygonCount
>
optional
int

Maximum number of polygon-delimited regions to avoid in the route and isochrone calculations.

Default: 5

</maxAvoidPolygonCount>
<maxAvoidPolygonArea
>
optional
long

Maximum area in square meters of each polygon-delimited region to avoid in the route and isochrone calculations.

Default: 500000000

</maxAvoidPolygonArea>
<maxAvoidPolygonWidth
>
optional
int

Maximum width in meters of the bounding box of each polygon-delimited region to avoid in the route and isochrone calculations.

Default: 20000

</maxAvoidPolygonWidth>
<maxAvoidPolygonHeight
>
optional
int

Maximum height in meters of the bounding box of each polygon-delimited region to avoid in the route and isochrone calculations.

Default: 20000

</maxAvoidPolygonHeight>
<onDemand
>
optional

Indication that the route should only be calculated when the user clicks the corresponding button on the user interface. By default, the route is dynamically calculated as the user sets the waypoints of the route (exception: for avoidance areas). This setting only affects route calculation. The isochrone calculation for accessibility analysis is always started only at the user's request.

</onDemand>
>
optional

Settings for restricting the capabilities of the routing service, in order to prevent overloading the system or the user. Restrictions could be length of routes, quality of received routing geometry or number of stopovers. Also allows restricting the service to be only executed on demand, rather than automatically on drag'n'drop of way points.

</restrictions>
>
optionalmax. unbounded

Settings for the connection of a routing service. Can be one or more. That way, you can add different settings for each profile of a routing service. Note: Currently only OpenRouteService (API version v2) is supported. Note: Cadenza does not validate if a routing service actually supports the API version, configured profiles or further configured properties (e.g. maximum 48 waypoints).

</service>
>
required

Configuration of an OpenRouteService routing service for Cadenza.

</openrouteserviceConfiguration>
<service
<url
>
required
anyURI

Main URL of the service, such as https://routing.gdi.disy.net/ors.

</url>
<version
xsd:string
v2

Version 2 of OpenRouteService, the latest as of end 2021.

>
required

API version setting of the routing. Currently only v2 is supported by the Cadenza client implementation. Version 1 is not supported.

</version>
<apiKey
>
optional
string

API key necessary for accessing some restricted OpenRouteServices.

</apiKey>
<capabilities
<profiles
<profile
xsd:string
driving-car

Car.

driving-hgv

Heavy goods vehicle.

cycling-regular

Bicycle.

cycling-road

Road bicycle.

cycling-mountain

Mountain bicycle.

cycling-electric

Electric bicycle.

foot-walking

Pedestrian.

foot-hiking

Hiker.

wheelchair

Wheelchair.

default
optional
=
boolean

true to set the profile as default. The profile will be selected initially when routing is started.

Default: false

>
requiredmax. unbounded

Routing profile. At least one has to be defined.

</profile>
>
required

Provision of one or more route profiles (modes of transportation). At least one profile must be configured. Supported modes of transportation () are car (driving-car), heavy goods vehicle (driving-hgv), bicycle (cycling-regular), pedestrian (foot-walking), and currently only for Germany, wheelchair (wheelchair). By default, the first configured route profile is initially selected.

Using the 'default' attribute, a different route profile can be initially selected, deviating from the standard.

</profiles>
<elevation
>
optional

Add this element without content if elevation data is available and supported for the service.

</elevation>
<isochrones
<direction
>
optional

Add this element without content if direction for isochrones requests are supported for the service and its profiles.

</direction>
>
optional

Add this element without content if isochrone requests are supported for the service and its profiles.

</isochrones>
<statistic
>
optional

Enables the consideration of statistical traffic data when calculating routes (only when specifying a start or arrival time) and isochrones (only in 'time' mode). The routing service has statistics for almost all of Germany, except for some rural areas. The user can also disable the use of statistical traffic data if needed. Note: For the currently supported service, traffic data is available for the profiles car (driving-car) and heavy goods vehicle (driving-hgv).

</statistic>
>
required

Property settings of the routing. Defines what the service offers via its API, most importantly, which routing profiles are available. Other information such as the availabilty of elevation data can be provided as well, enabling the client to query and display additional data for a route.

</capabilities>
<tuning
<language
>
optional
string

The language in which the description of the calculated route is displayed. By default, the Cadenza language is used. Change this setting e.g. in case your ORS instance does not support the Cadenza language.

</language>
<defaultIsochroneDuration
xsd:duration
>
optional

Initial time duration between the isochrones in minutes. The time format is specified according to ISO 8601 in the PnYnMnDTnHnMnS format, e.g., PT600S means 'until 600 seconds from now'. Note: The values must be below the constraint defined in the <restrictions> section.

</defaultIsochroneDuration>
<defaultIsochroneDistance
xsd:int
>
optional

Initial distance between zone borders in meters. The user can adjust the time duration between the isochrones for their accessibility analysis. Note: The values must be below the constraint defined in the <restrictions> section.

</defaultIsochroneDistance>
<httpRequestTimeout
>
optional
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

Duration (according to the ISO 8601 standard) the OpenRouteService will wait for a response. A response timeout value is already globally defined for Cadenza, but since requests for the isochrones can take longer than usual, it may be useful to define a higher timeout value here.

Default: PT30S

</httpRequestTimeout>
>
optional

Optional tuning settings for the routing. Set properties to more preferable defaults, e.g. set default language for textual instructions (the service does not support all languages and using the user language may not be possible). Note: Setting may be overwritten by a client request, e.g. because the user chose a different routing language.

</tuning>
<restrictions
<maxStopovers
>
optional
int

Maximum number of stopovers between start and end point. Can be between 0 and 48 (resulting in a maximum of 50 waypoints in total). Note: Start and end point are not counted.

</maxStopovers>
<maxIsochroneLocations
>
optional
int

Number of isochrone waypoints.

Default: 2

</maxIsochroneLocations>
<maxIsochroneZones
>
optional
int

Number of isochrone zones.

Default: 7

</maxIsochroneZones>
<maxIsochroneDuration
xsd:duration
>
optional

Maximum duration for temporal isochrones.

</maxIsochroneDuration>
<maxIsochroneDistance
xsd:int
>
optional

Maximum sum of inter-isochrone distances.

</maxIsochroneDistance>
<maxGeometryPointCount
>
optional
int

Maximum number of points for a geometry or route.

Default: 50000

</maxGeometryPointCount>
<maxAvoidPolygonCount
>
optional
int

Maximum number of polygon-delimited regions to avoid in the route and isochrone calculations.

Default: 5

</maxAvoidPolygonCount>
<maxAvoidPolygonArea
>
optional
long

Maximum area in square meters of each polygon-delimited region to avoid in the route and isochrone calculations.

Default: 500000000

</maxAvoidPolygonArea>
<maxAvoidPolygonWidth
>
optional
int

Maximum width in meters of the bounding box of each polygon-delimited region to avoid in the route and isochrone calculations.

Default: 20000

</maxAvoidPolygonWidth>
<maxAvoidPolygonHeight
>
optional
int

Maximum height in meters of the bounding box of each polygon-delimited region to avoid in the route and isochrone calculations.

Default: 20000

</maxAvoidPolygonHeight>
<onDemand
>
optional

Indication that the route should only be calculated when the user clicks the corresponding button on the user interface. By default, the route is dynamically calculated as the user sets the waypoints of the route (exception: for avoidance areas). This setting only affects route calculation. The isochrone calculation for accessibility analysis is always started only at the user's request.

</onDemand>
>
optional

Settings for restricting the capabilities of the routing service, in order to prevent overloading the system or the user. Restrictions could be length of routes, quality of received routing geometry or number of stopovers. Also allows restricting the service to be only executed on demand, rather than automatically on drag'n'drop of way points.

</restrictions>
>
required

Exists only for testing the service definition directly, e.g. in OrsRoutingRequestBuilderTest.

</service>
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:
    openrouteservice:
      service:
      - url: "text"
        version: "v2"
        apiKey: "text"
        capabilities:
          profiles:
          - default: true
            value: "driving-car"
          - default: true
            value: "driving-car"
          elevation: {}
          isochrones:
            direction: {}
          statistic: {}
        tuning:
          language: "text"
          defaultIsochroneDuration: "P2DT3M"
          defaultIsochroneDistance: 15
          httpRequestTimeout: "P2DT3M"
        restrictions:
          maxStopovers: 15
          maxIsochroneLocations: 15
          maxIsochroneZones: 15
          maxIsochroneDuration: "P2DT3M"
          maxIsochroneDistance: 15
          maxGeometryPointCount: 15
          maxAvoidPolygonCount: 15
          maxAvoidPolygonArea: 25
          maxAvoidPolygonWidth: 15
          maxAvoidPolygonHeight: 15
          onDemand: {}
      - url: "text"
        version: "v2"
        apiKey: "text"
        capabilities:
          profiles:
          - default: true
            value: "driving-car"
          - default: true
            value: "driving-car"
          elevation: {}
          isochrones:
            direction: {}
          statistic: {}
        tuning:
          language: "text"
          defaultIsochroneDuration: "P2DT3M"
          defaultIsochroneDistance: 15
          httpRequestTimeout: "P2DT3M"
        restrictions:
          maxStopovers: 15
          maxIsochroneLocations: 15
          maxIsochroneZones: 15
          maxIsochroneDuration: "P2DT3M"
          maxIsochroneDistance: 15
          maxGeometryPointCount: 15
          maxAvoidPolygonCount: 15
          maxAvoidPolygonArea: 25
          maxAvoidPolygonWidth: 15
          maxAvoidPolygonHeight: 15
          onDemand: {}

Filename: openrouteservice-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"?>
<openrouteserviceConfiguration>
  <service>
    <url>text</url>
    <version>v2</version>
    <apiKey>text</apiKey>
    <capabilities>
      <profiles>
        <profile default="true">driving-car</profile>
        <profile default="true">driving-car</profile>
      </profiles>
      <elevation/>
      <isochrones>
        <direction/>
      </isochrones>
      <statistic/>
    </capabilities>
    <tuning>
      <language>text</language>
      <defaultIsochroneDuration>P2DT3M</defaultIsochroneDuration>
      <defaultIsochroneDistance>15</defaultIsochroneDistance>
      <httpRequestTimeout>P2DT3M</httpRequestTimeout>
    </tuning>
    <restrictions>
      <maxStopovers>15</maxStopovers>
      <maxIsochroneLocations>15</maxIsochroneLocations>
      <maxIsochroneZones>15</maxIsochroneZones>
      <maxIsochroneDuration>P2DT3M</maxIsochroneDuration>
      <maxIsochroneDistance>15</maxIsochroneDistance>
      <maxGeometryPointCount>15</maxGeometryPointCount>
      <maxAvoidPolygonCount>15</maxAvoidPolygonCount>
      <maxAvoidPolygonArea>25</maxAvoidPolygonArea>
      <maxAvoidPolygonWidth>15</maxAvoidPolygonWidth>
      <maxAvoidPolygonHeight>15</maxAvoidPolygonHeight>
      <onDemand/>
    </restrictions>
  </service>
  <service>
    <url>text</url>
    <version>v2</version>
    <apiKey>text</apiKey>
    <capabilities>
      <profiles>
        <profile default="true">driving-car</profile>
        <profile default="true">driving-car</profile>
      </profiles>
      <elevation/>
      <isochrones>
        <direction/>
      </isochrones>
      <statistic/>
    </capabilities>
    <tuning>
      <language>text</language>
      <defaultIsochroneDuration>P2DT3M</defaultIsochroneDuration>
      <defaultIsochroneDistance>15</defaultIsochroneDistance>
      <httpRequestTimeout>P2DT3M</httpRequestTimeout>
    </tuning>
    <restrictions>
      <maxStopovers>15</maxStopovers>
      <maxIsochroneLocations>15</maxIsochroneLocations>
      <maxIsochroneZones>15</maxIsochroneZones>
      <maxIsochroneDuration>P2DT3M</maxIsochroneDuration>
      <maxIsochroneDistance>15</maxIsochroneDistance>
      <maxGeometryPointCount>15</maxGeometryPointCount>
      <maxAvoidPolygonCount>15</maxAvoidPolygonCount>
      <maxAvoidPolygonArea>25</maxAvoidPolygonArea>
      <maxAvoidPolygonWidth>15</maxAvoidPolygonWidth>
      <maxAvoidPolygonHeight>15</maxAvoidPolygonHeight>
      <onDemand/>
    </restrictions>
  </service>
</openrouteserviceConfiguration>