selfserviceoperationgeocoding

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.
<operationGeocoding
<geocodingServices
<structuredGeocodingService
id
required
=
string

Id of a geocodingService that will be used for geocoding address data. The geocodingService should be configured for the application and must support the structured or unstructured request type respectively.

batchSize
optional
=
int

Batch size for the geocoding, at most this many addresses will be sent to the geocoder at once for geocoding using this geocoder. Explicit batching for geocoding is disabled for non positive values. The default value is 100.

Default: 100

>
optional
</structuredGeocodingService>
<unstructuredGeocodingService
id
required
=
string

Id of a geocodingService that will be used for geocoding address data. The geocodingService should be configured for the application and must support the structured or unstructured request type respectively.

batchSize
optional
=
int

Batch size for the geocoding, at most this many addresses will be sent to the geocoder at once for geocoding using this geocoder. Explicit batching for geocoding is disabled for non positive values. The default value is 100.

Default: 100

>
optional
</unstructuredGeocodingService>
>
required
</geocodingServices>
<geocodingLimit
>
optional
int

Maximum number of records to be geocoded in one geocoding process, not to be confused with the batch size which is the number of records to be geocoded in one single geocoding request.

Default: 10000

</geocodingLimit>
<attributeMappings
<country
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</country>
<federalState
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</federalState>
<countrySecondarySubdivision
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</countrySecondarySubdivision>
<zipCode
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</zipCode>
<city
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</city>
<cityDistrict
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</cityDistrict>
<street
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</street>
<streetNumber
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</streetNumber>
<streetNumberSuffix
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</streetNumberSuffix>
<freeFormAddress
<attributeName
>
optionalmax. unbounded
string

Name of a source attribute which is suggested to be used for a specific geocoding request attribute.

</attributeName>
>
optional
</freeFormAddress>
>
required
</attributeMappings>
>
required
</operationGeocoding>
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:
    selfserviceoperationgeocoding:
      geocodingServices:
        structuredGeocodingService:
          id: "text"
          batchSize: 15
        unstructuredGeocodingService:
          id: "text"
          batchSize: 15
      geocodingLimit: 15
      attributeMappings:
        country:
        - "text"
        - "text"
        federalState:
        - "text"
        - "text"
        countrySecondarySubdivision:
        - "text"
        - "text"
        zipCode:
        - "text"
        - "text"
        city:
        - "text"
        - "text"
        cityDistrict:
        - "text"
        - "text"
        street:
        - "text"
        - "text"
        streetNumber:
        - "text"
        - "text"
        streetNumberSuffix:
        - "text"
        - "text"
        freeFormAddress:
        - "text"
        - "text"

Filename: selfserviceoperationgeocoding-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"?>
<operationGeocoding>
  <geocodingServices>
    <structuredGeocodingService id="text" batchSize="15"/>
    <unstructuredGeocodingService id="text" batchSize="15"/>
  </geocodingServices>
  <geocodingLimit>15</geocodingLimit>
  <attributeMappings>
    <country>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </country>
    <federalState>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </federalState>
    <countrySecondarySubdivision>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </countrySecondarySubdivision>
    <zipCode>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </zipCode>
    <city>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </city>
    <cityDistrict>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </cityDistrict>
    <street>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </street>
    <streetNumber>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </streetNumber>
    <streetNumberSuffix>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </streetNumberSuffix>
    <freeFormAddress>
      <attributeName>text</attributeName>
      <attributeName>text</attributeName>
    </freeFormAddress>
  </attributeMappings>
</operationGeocoding>