Page tree
Skip to end of metadata
Go to start of metadata

When importing regions into Hydra, specify the Parent region into which the import will be performed. This can be either a country or a particular city. If your company operates in several cities and regions, it may be easier to create large cities manually and import each one from a separate file in stages.

If a region with the same name (code, case-insensitive) and type already exists in the Hydra directory, it will be skipped by the loader, although its child regions will still be processed.

File format

  • The file content format is CSV.

  • UTF-8 encoding is used for text.

  • No text separator (quotation marks around values) is used.

  • Fields (columns) are separated by semicolons — ;
    Field separators are not allowed in values. If a semicolon is required in values, another printable character can be used as a field separator.

  • A header row with field names is recommended to simplify file verification by external tools, but is not required.

Field descriptions

The header row with field names is not used during import (it can be omitted) — the order of the fields is crucial.

In general, all fields are optional, i.e., they can be left blank. However:

  • To load buildings (field #10), at least one of the higher-level regions must be specified: city, internal locality, or street.
  • Binding of a federal region to a municipal one (fields #13–16) and the import of real estate parameters (fields #17–20) can only be performed for buildings (field #10).

In the most simple scenario, it is sufficient to fill in: city, street, and building — these fields are marked with a (tick) icon in the description below.

Number

Name

Description

1

Federal-level district

Region of the District type (type code — REGION_TYPE_District), in which the settlement is located.

(lightbulb) It is recommended to specify this when the registry contains settlements with the same name in different districts.

2

City

(tick) Name of the settlement. For example: San Francisco.

In the regions registry of Hydra it's the region Code.

3City type

Full or abbreviated name of the region type. For example: City, Town, Set. or Settlement.

(warning) All values must be specified in Hydra: Master Data → Reference Data → Region types.

(green star) If not specified, the City type is used.

4

Internal locality

Name of the internal (within the City) settlement. For example: Buena Vista, Glen Park.

In the regions registry of Hydra it's the region Code.

5Internal locality typeFull or short name of the type of locality. For example: Neighborhood, Vicinity, Town, Set. or Settlement.

(warning) All values must be specified in Hydra: Master Data → Reference Data → Region types.

(green star) If not specified, the City type is used.

6

Locality external code

A code or identifier from a third-party directory. In the Hydra regions registry, this is the region’s External code.

(lightbulb) Can be used later to search for or update data in the Hydra registry.

(info) If an internal locality is specified (field #4), this is considered its external code.

7

Street

(tick) Street name. Region's code in Hydra registry of regions. For example: Line Wall, Baker, Trafalgar.

In the Hydra regions registry, this is the region’s Code.

8Street typeFull or short name of the type of street. For example: Rd. or Road, St. or Street, Sq. or Square.

(warning) All values must be specified in Hydra: Master Data → Reference Data → Region types.

(green star) If not specified, the Street type is used.

9

Street external code

A code or identifier from a third-party directory. In the Hydra regions registry, this is the region’s External code.

(lightbulb) Can be used later to search for or update data in the Hydra registry.

10

Building

(tick) Building can be represented in two ways:

  • Extended — Bldg. <house> Corpus <pavilion> Annex <structure> Ownership <property>
    (info) Specify only the necessary details of the building, keeping respective abbreviated designations. For example: "Bldg. 25 Annex A".
  • Basic — only the house number (if it starts with a digit) or only the pavilion (if it starts with a letter).
11

Building external code

A code or identifier from a third-party directory. In the Hydra regions registry, this is the region’s External code.

(lightbulb) Can be used later to search for or update data in the Hydra registry.

12

Postal code

The ZIP code will be stored for the first of the specified regions: Building, Street, Internal locality, or City.

(lightbulb) May be useful in print forms and data exports.

13

Municipal region code

The Code of the municipal region in Hydra that the building should be included in: neighborhood, block, or residential area.

(warning) The municipal hierarchy in the registry of regions must be populated before importing federal regions.

14Municipal region type

Full or short name of the type of municipal region. For example: bl. or Block, Neighborhood, Area.

15

Parent municipal region code

The Code of the municipal Parent region in Hydra.

(lightbulb) It is recommended to specify this, as the numbering of neighborhoods and blocks is often the same across different municipalities.

16Parent municipal region type

Full or short name of the type of parent municipal region. For example: Metropolitan, Municipal territory.

17

Number of residential premises

The corresponding property parameters for buildings.

In the current version, only the standard system parameters for these properties are supported for import.

(lightbulb) Can be used in calculations of penetration, reports, data exports, and technical inventory.

18
19
20

Example

FederalDistrict;City;CityType;InternalLocality;InternalLocalityType;LocalityExternalCode;Street;StreetType;StreetExternalCode;Building;BuildingExternalCode;PostalCode;MunicipalRegionCode;MunicipalRegionType;ParentMunicipalRegionCode;ParentMunicipalRegionType;NumberOfApartments;NumberOfNonResidentialPremises;NumberOfFloors;NumberOfSections
Central;London;City;Westminster;Town;a38bcacf-7cc6-4c38-943f-67b322230ff6;Baker;St.;b0521d2c-86c2-4986-ad40-5f794c77e7ab;Bldg. 11 Corpus 7;67fd01ab-f5d3-49a8-836e-89d09efbd259;NW1 6XE;5;Block;Marylebone;Metropolitan;192;15;9;6
;Manchester;City;;;;King;Street;;38;;;;;;;;;;


  • No labels