Retrieve Administrative Divisions processor
The Retrieve Administrative Divisions processor uses a geopoint to retrieve information (name, code, and geoshapes) of administrative divisions.
Note that using this processor will count against your quota of Data Hub datasets consumed. However, if you reuse the processor in other datasets with the same geographical subdivision, it will not be counted again.
The Retrieve Administrative Divisions processor is available for the following countries:
Australia
Belgium
Canada
France
Germany
Israel
Italy
Mexico
The Netherlands
Portugal
Spain
Sweden
Switzerland
The United Kingdom
The United States
World
Setting the processor
To set the parameters of the Retrieve Administrative Divisions processor, follow the indications from the table below.
Label | Description | Mandatory |
Geo Point | Field that contains the geopoint the processor will use to retrieve the administrative divisions | Yes |
Country | Choose the country where the geopoints are located. If the geopoints are not confined into a single country, select "World." | Yes |
Administrative Level | Choose an administrative level of the chosen country. If you selected "World" as a country, it is a choice between 1 (largest scale) and 7 (smallest scale). See the Referentials section to know which administrative levels are available, depending on the country where the geopoint is, and to know what the levels actually correspond to. | Yes |
Output Division Name | Field where the name of the chosen administrative division will be displayed. It can be an existing field chosen from the list, or a new field created for that purpose (in that case, choose Input text from the list and write the name of the new field in the text area below). | Yes |
Output Division Code | Field where the code of the chosen administrative division will be displayed. It can be an existing field chosen from the list, or a new field created for that purpose (in that case, choose Input text from the list and write the name of the new field in the text area below). | Yes |
Output Division Geo Shape | Field where the geoshape of the chosen administrative division will be displayed. It can be an existing field chosen from the list, or a new field created for that purpose (in that case, choose Input text from the list and write the name of the new field in the text area below). | Yes |
Referentials
When you select a country in the processor, you will see the administrative levels available for that country. You may also consult this table to know what administrative levels are available for each country.
When using the 'World' country, the processor will try to retrieve the divisions corresponding to the chosen level (between 1 and 7). Be aware, though, that administrative divisions are not homogenized across countries. For example, French "cantons" are considered level 4, whereas Swiss "kantons" are level 2.
If the referential used has a license with mandatory attribution, using Retrieve Administrative Divisions processor will transfer the attribution.