5  Configuration

Root application configuration.

This class defines the complete configuration model for the application. It aggregates settings for logging, internationalization (i18n), Redis and PostGIS database connections, STAC data sources, TIN generation, and IFC export configuration. The configuration is typically loaded from a YAML file using the load() class method, which supports environment variable expansion.

5.1 Type: object

Property Type Required Possible values Default Description
logging_level string string Logging level for the application (e.g., DEBUG, INFO, WARNING)
redis object RedisConfig Redis configuration
db object DBConfig Database configuration
ifc object IFCConfig IFC (Industry Foundation Classes) export configuration
i18n object or null I18nConfig null Internationalization (i18n) configuration
stac object STACConfig STAC configuration for external data sources
tin object TINConfig TIN (Triangulated Irregular Network) generation configuration

6 Definitions

6.1 AttributeConfig

Attribute mapping configuration

6.1.0.1 Type: object

Property Type Required Possible values Description
attribute string string Attribute name (Only applied if the attribute exists on the entity)
value string string Attribute value

6.2 BuildingAttributeConfig

Attribute mapping configuration for building feature type

6.2.0.1 Type: object

Property Type Required Possible values Description
attribute string string Attribute name (Only applied if the attribute exists on the entity)
source object BuildingSourceConfig Source configuration for this attribute

6.3 BuildingEntityConfig

Entity mapping configuration for building feature type

6.3.0.1 Type: object

Property Type Required Possible values Default Description
attributes array BuildingAttributeConfig [] List of attribute mappings
properties array BuildingPropertyConfig [] List of property mappings
building_parts array BuildingPartConfig [] List of building parts belonging to this building entity

6.4 BuildingFeatureType

Feature type configuration for building feature type

6.4.0.1 Type: object

Property Type Required Possible values Default Description
name string string Feature type name for the building
sql_path string string Path to SQL definition for the building feature type. Must return at least a column named ‘egid’.
egid_xpath string string XPath expression to extract EGID identifier from city gml building entities
entity_mapping object BuildingEntityConfig Entity mapping configuration for the building
spatial_structure_mapping object BuildingSpatialEntityConfig Spatial structure mapping for the building
group_mapping array BuildingSourceConfig [] Group mappings for the building feature type

6.5 BuildingPartConfig

Building part configuration for building feature type

6.5.0.1 Type: object

Property Type Required Possible values Default Description
entity string string Name of entity according to IFC schema, e.g. ‘IfcWall’
geometry_mapping object or null GmlGeometryMapping null Geometry mapping for the building part
color object Color "white" Color assigned to the building part

6.6 BuildingPropertyConfig

Property mapping configuration for building feature type

6.6.0.1 Type: object

Property Type Required Possible values Description
property string string Property name
property_set string string Property set name
source object BuildingSourceConfig Source configuration for this property

6.7 BuildingSource

Supported source types for properties and attributes in building feature types

6.7.0.1 Type: string

Possible Values: STATIC or SQL or CITY_GML

6.8 BuildingSourceConfig

Source configuration for building feature type

6.8.0.1 Type: object

Property Type Required Possible values Description
type string BuildingSource Type of the data source
expression string string Expression defining the source data

6.9 BuildingSpatialEntityConfig

Spatial structure mapping configuration for building feature type

6.9.0.1 Type: object

Property Type Required Possible values Default Description
attributes array BuildingAttributeConfig [] List of attribute mappings
properties array BuildingPropertyConfig [] List of property mappings

6.10 Color

Color configuration based on red, green, blue and alpha channels

6.10.0.1 Type: object

Property Type Required Possible values Default Description
r number 0.0 <= x <= 1.0 Red channel
g number 0.0 <= x <= 1.0 Green channel
b number 0.0 <= x <= 1.0 Blue channel
a number 0.0 <= x <= 1.0 0.0 Alpha channel

6.11 CoordinateReferenceSystem

Coordinate reference system for IFC export

6.11.0.1 Type: object

Property Type Required Possible values Description
epsg_code string string EPSG code for the coordinate reference system
description string string Description of the coordinate reference system
geodetic_datum string string Geodetic datum for the coordinate reference system
vertical_datum string string Vertical datum for the coordinate reference system

6.12 DBConfig

Postgis connection configuration

6.12.0.1 Type: object

Property Type Required Possible values Description
dbname string string Database name
user string string Database username
host string string Database host address
port integer integer Database port number
password string string Database password

6.13 ExtrusionAttributeConfig

Attribute mapping configuration for extrusion feature type

6.13.0.1 Type: object

Property Type Required Possible values Description
attribute string string Attribute name (Only applied if the attribute exists on the entity)
source object ExtrusionConfigSource Source configuration for this attribute

6.14 ExtrusionConfigSource

Source configuration for extrusion feature type

6.14.0.1 Type: object

Property Type Required Possible values Description
type string ExtrusionSource Type of the data source
expression string string Expression defining the source data

6.15 ExtrusionEntityConfig

Entity mapping configuration for extrusion feature type

6.15.0.1 Type: object

Property Type Required Possible values Default Description
entity string string Name of entity according to IFC schema, e.g. ‘IfcWall’
attributes array ExtrusionAttributeConfig [] List of attribute mappings
properties array ExtrusionPropertyConfig [] List of property mappings

6.16 ExtrusionEntityTypeConfig

Entity type mapping configuration for extrusion feature type

6.16.0.1 Type: object

Property Type Required Possible values Default Description
attributes array ExtrusionAttributeConfig [] List of attribute mappings
properties array ExtrusionPropertyConfig [] List of property mappings

6.17 ExtrusionFeatureType

Feature type configuration for extrusion feature type

6.17.0.1 Type: object

Property Type Required Possible values Default Description
name string string Feature type name for the extrusion
entity_mapping object ExtrusionEntityConfig Entity mapping configuration for the extrusion
sql_path string or null string null Path to SQL definition for the extrusion feature type. Exact specification can be found in the configuration documentation.
entity_type_mapping object or null ExtrusionEntityTypeConfig null Entity type mapping configuration for the extrusion. (Only supported for entities with TypeObject)
spatial_structure_mapping object ExtrusionSpatialEntityConfig Spatial structure mapping for the projection
group_mapping array ExtrusionConfigSource [] Group mappings for the projection feature type
color object Color "white" Color assigned to the extrusion feature type

6.18 ExtrusionPropertyConfig

Property mapping configuration for extrusion feature type

6.18.0.1 Type: object

Property Type Required Possible values Description
property string string Property name
property_set string string Property set name
source object ExtrusionConfigSource Source configuration for this property

6.19 ExtrusionSource

Supported source types for properties and attributes in extrusion feature types

6.19.0.1 Type: string

Possible Values: STATIC or SQL

6.20 ExtrusionSpatialEntityConfig

Spatial structure mapping configuration for extrusion feature type

6.20.0.1 Type: object

Property Type Required Possible values Default Description
attributes array ExtrusionAttributeConfig [] List of attribute mappings
properties array ExtrusionPropertyConfig [] List of property mappings

6.21 GeoReferencing

Supported geo referencing methods

6.21.0.1 Type: string

Possible Values: LO_GEO_REF_30 or LO_GEO_REF_40 or LO_GEO_REF_50

6.22 GmlGeometry

Supported gml geometry types

6.22.0.1 Type: string

Possible Values: MULTI_SURFACE or SOLID or COMPOSITE_SOLID

6.23 GmlGeometryMapping

Geometry mapping for building part

6.23.0.1 Type: object

Property Type Required Possible values Description
xpath string string XPath expression to locate the building part geometry in source data
geometry string GmlGeometry Referenced geometry type of the building part

6.24 GridSize

Available grid sizes for projections

6.24.0.1 Type: number

Possible Values: 0.5 or 2.0

6.25 GroupConfig

Group configuration for IFC export

6.25.0.1 Type: object

Property Type Required Possible values Description
path string string Path identifier for the group
entity_mapping object GroupEntityConfig Entity mapping configuration for the group

6.26 GroupEntityConfig

Entity mapping configuration for group

6.26.0.1 Type: object

Property Type Required Possible values Default Description
entity string string Name of entity according to IFC schema, e.g. ‘IfcWall’
attributes array AttributeConfig [] List of attribute mappings
properties array PropertyConfig [] List of property mappings

6.27 I18nConfig

Internationalization (i18n) configuration

6.27.0.1 Type: object

Property Type Required Possible values Default Description
de string or null string null Path to the german translation file
fr string or null string null Path to the french translation string
it string or null string null Path to the italian translation string

6.28 IFCConfig

IFC export configuration

6.28.0.1 Type: object

Property Type Required Possible values Default Description
author string string Author of the IFC model
version string string IFC schema version
application_name string string Name of the application generating IFC
project_name string string Project name in IFC
geo_referencing string GeoReferencing Georeferencing configuration for IFC
coordinate_reference_system object CoordinateReferenceSystem Coordinate reference system for IFC
projection_feature_types array ProjectionFeatureType [] List of projection feature type definitions
building_feature_types array BuildingFeatureType [] List of building feature type definitions
extrusion_feature_types array ExtrusionFeatureType [] List of extrusion feature type definitions
groups array GroupConfig [] List of group configurations for IFC

6.29 ProjectionAttributeConfig

Attribute mapping configuration for projection feature type

6.29.0.1 Type: object

Property Type Required Possible values Description
attribute string string Attribute name (Only applied if the attribute exists on the entity)
source object ProjectionConfigSource Source configuration for this attribute

6.30 ProjectionConfigSource

Source configuration for projection feature type

6.30.0.1 Type: object

Property Type Required Possible values Description
type string ProjectionSource Type of the data source
expression string string Expression defining the source data

6.31 ProjectionEntityConfig

Entity mapping configuration for projection feature type

6.31.0.1 Type: object

Property Type Required Possible values Default Description
entity string string Name of entity according to IFC schema, e.g. ‘IfcWall’
attributes array ProjectionAttributeConfig [] List of attribute mappings
properties array ProjectionPropertyConfig [] List of property mappings

6.32 ProjectionEntityTypeConfig

Entity type mapping configuration for projection feature type

6.32.0.1 Type: object

Property Type Required Possible values Default Description
attributes array ProjectionAttributeConfig [] List of attribute mappings
properties array ProjectionPropertyConfig [] List of property mappings

6.33 ProjectionFeatureType

Feature type configuration for projection feature type

6.33.0.1 Type: object

Property Type Required Possible values Default Description
name string string Feature type name for the projection
sql_path string string Path to SQL definition for the projection feature type. Must return at least a column named ‘wkt’.
entity_mapping object ProjectionEntityConfig Entity mapping configuration for the projection
entity_type_mapping object or null ProjectionEntityTypeConfig null Entity type mapping configuration for the projection. (Only supported for entities with TypeObject)
spatial_structure_mapping object ProjectionSpatialEntityConfig Spatial structure mapping for the projection
group_mapping array ProjectionConfigSource [] Group mappings for the projection feature type
color object Color "white" Color assigned to the projection feature type

6.34 ProjectionPropertyConfig

Property mapping configuration for projection feature type

6.34.0.1 Type: object

Property Type Required Possible values Description
property string string Property name
property_set string string Property set name
source object ProjectionConfigSource Source configuration for this property

6.35 ProjectionSource

Supported source types for properties and attributes in projection feature types

6.35.0.1 Type: string

Possible Values: STATIC or SQL

6.36 ProjectionSpatialEntityConfig

Spatial structure mapping configuration for projection feature type

6.36.0.1 Type: object

Property Type Required Possible values Default Description
attributes array ProjectionAttributeConfig [] List of attribute mappings
properties array ProjectionPropertyConfig [] List of property mappings

6.37 PropertyConfig

Property mapping configuration

6.37.0.1 Type: object

Property Type Required Possible values Description
property string string Property name
property_set string string Property set name
value string string Property value

6.38 RedisConfig

Redis connection configuration

6.38.0.1 Type: object

Property Type Required Possible values Default Description
host string string Redis host address
port integer integer Redis port number
db object RedisDBConfig Nested Redis database configuration
global_keyprefix string or null string null Optional global keyprefix for the Redis result backend
queue string or null string null Optional queue name for Celery tasks

6.39 RedisDBConfig

Redis databases configuration

6.39.0.1 Type: object

Property Type Required Possible values Description
celery_broker integer 0 <= x DB index for Celery broker
celery_backend integer 0 <= x DB index for Celery result backend
file_cache integer 0 <= x DB index for file cache

6.40 STACConfig

STAC URLs configuration for external data sources

6.40.0.1 Type: object

Property Type Required Possible values Default Description
dtm_items_url string or null string null URL to STAC items for DTM data
building_items_url string or null string null URL to STAC items for building data

6.41 TINConfig

TIN generation configuration

6.41.0.1 Type: object

Property Type Required Possible values Description
grid_size number GridSize TIN grid size
max_height_error number 0.0 <= x <= 0.05 Maximum allowed height error for TIN generation

Markdown generated with jsonschema-markdown.