Configuration reference

This section formally describes the GBD WebSuite configuration, which is nested key-value structure. The keys are always strings, the values should belong to one of the types listed below.

The top-level configuration is of type gws.common.application.Config.

Basic types

Fundamental data types, as used in the Python language.

str String, must be in the UTF-8 encoding
bool Boolean true or false
int Integer number
float Floating-point number
dict Generic key-value object
[T…] List (array) of elements of type T

gws.common.application.Config

Application configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
api gws.common.api.Config system-wide server actions no  
auth gws.common.auth.types.Config authorization methods and options no  
client gws.common.client.Config gws client configuration no  
db gws.common.application.DbConfig database configuration no  
fonts gws.common.application.FontConfig fonts configuration no  
helpers [gws.types.ext.helper.Config…]   no  
locales [str…] default locales for all projects no  
projectDirs [gws.types.DirPath…] directories with additional projects no  
projectPaths [gws.types.FilePath…] additional project paths no  
projects [gws.common.project.Config…] project configurations no  
seeding gws.common.application.SeedingConfig configuration for seeding jobs no  
server gws.server.types.Config server engine options no  
timeZone str timezone for this server no “UTC”
uid str unique ID no  
web gws.common.application.WebConfig webserver configuration no  

gws.common.api.Config

Server actions

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
actions [gws.types.ext.action.Config…] available actions no  
uid str unique ID no  

gws.common.application.DbConfig

Database configuration

Properties:

name type   required default
providers [gws.types.ext.db.provider.Config…]   yes  
uid str unique ID no  

gws.common.application.FontConfig

Fonts configuration.

Properties:

name type   required default
dir gws.types.DirPath directory with custom fonts yes  
uid str unique ID no  

gws.common.application.SSLConfig

SSL configuration

Properties:

name type   required default
crt gws.types.FilePath crt file location yes  
key gws.types.FilePath key file location yes  
uid str unique ID no  

gws.common.application.SeedingConfig

Seeding options

Properties:

name type   required default
concurrency int number of concurrent seeding jobs no 1
maxTime gws.types.Duration max. time for a seeding job no 600
uid str unique ID no  

gws.common.application.WebConfig

Web server configuration

Properties:

name type   required default
sites [gws.web.site.Config…] configured sites no  
ssl gws.common.application.SSLConfig ssl configuration no  
uid str unique ID no  

gws.common.auth.types.Config

Authentication and authorization options

Properties:

name type   required default
cookie gws.common.auth.types.CookieConfig session cookie parameters no  
httpEnabled bool http authorization enabled no true
httpsOnly bool http authorization via ssl only no false
providers [gws.types.ext.auth.provider.Config…] authorization providers yes  
session gws.common.auth.types.SessionConfig session configuration no  
uid str unique ID no  

gws.common.auth.types.CookieConfig

Session cookie parameters

Properties:

name type   required default
name str name for the cookie no “auth”
path str cookie path no “/”
uid str unique ID no  

gws.common.auth.types.SessionConfig

Session configuration

Properties:

name type   required default
heartBeat bool refresh sessions automatically no false
lifeTime gws.types.Duration session life time no 1200
storage str session storage engine no “sqlite”
uid str unique ID no  

gws.common.client.Config

GWS client configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
addElements [gws.common.client.ElementConfig…] add elements to the parent element list no  
elements [gws.common.client.ElementConfig…] client UI elements no  
options dict client options no  
removeElements [gws.common.client.ElementConfig…] remove elements from the parent element list no  
uid str unique ID no  

gws.common.client.ElementConfig

GWS client UI element configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
after str insert after this tag no  
before str insert before this tag no  
tag str element tag yes  
uid str unique ID no  

gws.common.db.SqlTableConfig

SQL database table

Properties:

name type   required default
geometryColumn str geometry column name no  
keyColumn str primary key column name no  
name str table name yes  
searchColumn str column to be searched for no  
uid str unique ID no  

gws.common.layer.types.CacheConfig

Cache configuration

Properties:

name type   required default
enabled bool cache is enabled no false
maxAge gws.types.Duration cache max. age no “7d”
maxLevel int max. zoom level to cache no 1
uid str unique ID no  

gws.common.layer.types.ClientOptions

Client options for a layer

Properties:

name type   required default
exclusive bool only one of this layer’s children is visible at a time no false
expanded bool the layer is expanded in the list view no false
listed bool the layer is displayed in this list view no true
selected bool the layer is intially selected no false
unfolded bool the layer is not listed, but its children are no false
visible bool the layer is intially visible no true

gws.common.layer.types.EditConfig

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
uid str unique ID no  

gws.common.layer.types.FlattenConfig

Flatten the layer hierarchy.

Properties:

name type   required default
level int flatten level yes  
uid str unique ID no  
useGroups bool use group names (true) or image layer names (false) no false

gws.common.layer.types.GridConfig

Grid configuration for caches and tiled data

Properties:

name type   required default
metaBuffer int pixel buffer no 0
metaSize int number of meta-tiles to fetch no 0
origin str position of the first tile (nw or sw) no “nw”
tileSize int tile size no 256
uid str unique ID no  

gws.common.layer.types.LegendConfig

Properties:

name type   required default
enabled bool   no true
uid str unique ID no  
url gws.types.Url   no  

gws.common.layer.types.OwsConfig

Properties:

name type   required default
name str layer name for ows services no  
servicesDisabled [str…] services disabled for this layer no  
servicesEnabled [str…] services enabled for this layer no  
uid str unique ID no  

gws.common.map.Config

Map configuration

Properties:

name type   required default
center gws.types.Point map center no  
coordinatePrecision int precision for coordinates no  
crs gws.types.Crs crs for this map no “EPSG:3857”
extent gws.types.Extent map extent no  
extentBuffer int extent buffer no  
layers [gws.types.ext.layer.Config…] collection of layers for this map yes  
skipInvalidLayers bool remove invalid layers from the map no false
title str map title no  
uid str unique id no  
zoom gws.gis.zoom.Config map scales and resolutions no  

gws.common.metadata.Config

Object metadata configuration

Properties:

name type   required default
abstract str object abstract description no  
accessConstraints str   no  
attribution str attribution (copyright) string no  
contact gws.common.metadata.ContactConfig contact information no  
fees str   no  
image gws.types.Url image (logo) url no  
images dict further images no  
inspire dict INSPIRE properties no  
iso dict ISO-19115 properties no  
keywords [str…] keywords no []
language str object language no  
links [gws.common.metadata.LinkConfig…] additional links no []
modDate gws.types.Date modification date no  
name str object internal name no  
pubDate gws.types.Date publication date no  
serviceUrl gws.types.Url service url no  
title str object title no  
uid str unique ID no  
url gws.types.Url metadata url no  

gws.common.metadata.ContactConfig

Contact metadata configuration

Properties:

name type   required default
address str   no  
area str   no  
city str   no  
country str   no  
email str   no  
fax str   no  
organization str   no  
person str   no  
phone str   no  
position str   no  
uid str unique ID no  
url gws.types.Url   no  
zip str   no  

gws.common.metadata.LinkConfig

Object link configuration

Properties:

name type   required default
function str ISO-19115 function, see https://geo-ide.noaa.gov/wiki/index.php?title=ISO_19115_and_19115-2_CodeList_Dictionaries#CI_OnLineFunctionCode no  
scheme str link scheme no  
uid str unique ID no  
url gws.types.Url link url yes  

gws.common.model.Config

Data model.

Properties:

name type   required default
crs gws.types.Crs   no  
geometryType gws.types.GeometryType   no  
rules [gws.common.model.ModelRule…]   yes  
uid str unique ID no  

gws.common.model.ModelRule

Attribute conversion rule

Properties:

name type   required default
editable bool attribute is editable no true
expression str attribute conversion expression no  
format gws.types.FormatStr attribute formatter no  
name str target attribute name no  
source str source attribute no  
title str target attribute title no  
type gws.types.AttributeType target attribute type no “str”
value str constant value no  

gws.common.ows.service.UseInspireConfig

Properties:

name type   required default
data bool enable INSPIRE data models for this service no false
meta bool enable INSPIRE metadata for this service no false
uid str unique ID no  

gws.common.printer.Config

Properties:

name type   required default
templates [gws.types.ext.template.Config…]   yes  
uid str unique ID no  

gws.common.project.Config

Project configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
api gws.common.api.Config project-specific actions no  
assets gws.web.site.DocumentRootConfig project-specific assets options no  
client gws.common.client.Config project-specific gws client configuration no  
description gws.types.ext.template.Config template for the project description no  
locales [str…] project locales no  
map gws.common.map.Config Map configuration no  
meta gws.common.metadata.Config project metadata no  
multi gws.types.Regex filename pattern for a multi-project template no  
overviewMap gws.common.map.Config Overview map configuration no  
printer gws.common.printer.Config printer configuration no  
search gws.common.search.Config project-wide search configuration no  
title str project title no  
uid str unique id no  

gws.common.search.Config

Properties:

name type   required default
enabled bool search is enabled no true
providers [gws.types.ext.search.provider.Config…] list of search prodivers no  

gws.common.style.Config

Feature style

Properties:

name type   required default
text str raw style content / selector yes  
type gws.types.StyleType style type yes  
uid str unique ID no  

gws.common.template.FeatureFormatConfig

Feature format

Properties:

name type   required default
category gws.types.ext.template.Config feature category no  
description gws.types.ext.template.Config template for feature descriptions no  
label gws.types.ext.template.Config feature label on the map no  
teaser gws.types.ext.template.Config template for feature teasers (short descriptions) no  
title gws.types.ext.template.Config feature title no  
uid str unique ID no  

gws.ext.action.alkisgeocoder.Config

ALKIS Geocoder action.

Properties:

name type   required default
type str object type yes  
uid str unique ID no  

gws.ext.action.alkissearch.BuchungConfig

Access to the Grundbuch (register) information

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
uid str unique ID no  

gws.ext.action.alkissearch.Config

Flurstückssuche (cadaster parlcels search) action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
buchung gws.ext.action.alkissearch.BuchungConfig access to the Grundbuch (register) information no  
eigentuemer gws.ext.action.alkissearch.EigentuemerConfig access to the Eigentümer (owner) information no  
export gws.ext.helper.alkis.util.export.Config csv export configuration no  
featureFormat gws.common.template.FeatureFormatConfig template for on-screen Flurstueck details no  
limit int search results limit no 100
printTemplate gws.types.ext.template.Config template for printed Flurstueck details no  
type str object type yes  
ui gws.ext.action.alkissearch.UiConfig ui options no  
uid str unique ID no  

gws.ext.action.alkissearch.EigentuemerConfig

Access to the Eigentümer (owner) information

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
controlMode bool restricted mode enabled no false
controlRules [str…] list of regular expression for the restricted input control no  
logTable str data access protocol table name no  
uid str unique ID no  

gws.ext.action.alkissearch.UiConfig

Flurstückssuche UI configuration.

Properties:

name type   required default
autoSpatialSearch bool activate spatial search after submit no false
gemarkungListMode str plain = only “gemarkung”, combined = “gemarkung(gemeinde)”, tree = “gemeinde”, then “gemarkung” no “combined”
searchSelection bool search in selection enabled no false
searchSpatial bool spatial search enabled no false
uid str unique ID no  
useExport bool export function enabled no false
usePick bool pick mode enabled no false
useSelect bool select mode enabled no false

gws.ext.action.asset.Config

Asset generation action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.auth.Config

Authorization action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.cloud.Config

Cloud admin action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.dimension.Config

Dimension action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
layers [str…] target layer uids no  
pixelTolerance int pixel tolerance no 10
type str object type yes  
uid str unique ID no  

gws.ext.action.dprocon.Config

D-Procon action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
cacheTime gws.types.Duration   no “24h”
dataTableName str table to store consolidated results yes  
dataTablePattern str pattern for result tables to consolidate yes  
infoTitle str   no  
requestTableName str table to store outgoing requests yes  
requestUrl gws.types.Url   yes  
type str object type yes  
uid str unique ID no  

gws.ext.action.edit.Config

Feature edit action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.gekos.Config

GekoS action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
crs gws.types.Crs CRS for gekos data no  
db str database provider uid no  
featureFormat gws.common.template.FeatureFormatConfig template for the Flurstueck details popup no  
instances [str…] gek-online instances no  
params dict additional parameters for gek-online calls yes  
position gws.ext.action.gekos.PositionConfig position correction for points no  
table gws.common.db.SqlTableConfig sql table configuration yes  
type str object type yes  
uid str unique ID no  
url gws.types.Url gek-online base url yes  

gws.ext.action.gekos.PositionConfig

Properties:

name type   required default
angle int angle for points repelling no 0
distance int radius for points repelling no 0
offsetX int x-offset for points yes  
offsetY int y-offset for points yes  
uid str unique ID no  

gws.ext.action.georisks.AarteLinkConfig

AarteLink system configuration

Properties:

name type   required default
serviceLogin str service login yes  
servicePassword str service password yes  
serviceUrl str service url yes  
systemKey str systemKey for the aarteLink connector yes  
uid str unique ID no  

gws.ext.action.georisks.Config

Georisks action

Properties:

name type   required default
aarteLink gws.ext.action.georisks.AarteLinkConfig AarteLink system configuration yes  
access [gws.types.AccessRuleConfig…] access rights no  
db str database provider uid no  
report gws.ext.action.georisks.ReportConfig report function config yes  
type str object type yes  
uid str unique ID no  

gws.ext.action.georisks.ReportConfig

Configuration for the report function

Properties:

name type   required default
imageQuality int jpeg quality level no 75
maxImageLength int max image size in megabytes no 5
maxImageSize int max image size in pixels no 1000
privacyPolicyLink dict url of the privacy policy document no  
uid str unique ID no  

gws.ext.action.map.Config

Map rendering action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.ows.Config

OWS server action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
services [gws.types.ext.ows.service.Config…] services configuration no  
type str object type yes  
uid str unique ID no  

gws.ext.action.printer.Config

Print action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.project.Config

Project information action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.search.Config

Search action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
limit int search results limit no 1000
type str object type yes  
uid str unique ID no  

gws.ext.action.storage.Config

Storage action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
type str object type yes  
uid str unique ID no  

gws.ext.action.tabedit.Config

Table Editor action

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
dataModel gws.common.model.Config user-editable template attributes no  
db str database provider uid no  
project gws.ext.action.tabedit.ProjectConfig qgis project template no  
sort str sort expression no  
table gws.common.db.SqlTableConfig sql table configuration yes  
type str object type yes  
uid str unique ID no  

gws.ext.action.tabedit.ProjectConfig

Properties:

name type   required default
datePattern str   yes  
path str   yes  
template gws.types.FilePath   yes  
uid str unique ID no  

gws.ext.auth.provider.file.Config

File-based authorization provider

Properties:

name type   required default
path gws.types.FilePath path to the users json file yes  
type str object type yes  
uid str unique ID no  

gws.ext.auth.provider.ldap.Config

LDAP authorization provider

Properties:

name type   required default
activeDirectory bool true if the LDAP server is ActiveDirectory no true
bindDN str bind DN yes  
bindPassword str bind password yes  
displayNameFormat gws.types.FormatStr format for user’s display name no “{dn}”
timeout gws.types.Duration LDAP server timeout no 30
type str object type yes  
uid str unique ID no  
url str LDAP server url “ldap://host:port/baseDN?searchAttribute” yes  
users [gws.ext.auth.provider.ldap.UserSpec…] map LDAP filters to gws roles yes  

gws.ext.auth.provider.ldap.UserSpec

Map LDAP filters to authorization roles

Properties:

name type   required default
matches str LDAP filter the account has to match no  
memberOf str LDAP group the account has to be a member of no  
roles [str…] gws role names yes  

gws.ext.db.provider.postgres.Config

Postgres/Postgis database provider

Properties:

name type   required default
connectTimeout gws.types.Duration connection timeout no 0
database str database name no  
host str database host no “localhost”
password str password yes  
port int database port no 5432
timeout gws.types.Duration query timeout no 0
type str object type yes  
uid str unique id yes  
user str username yes  

gws.ext.helper.alkis.Config

ALKIS helper.

Properties:

name type   required default
crs gws.types.Crs CRS for the alkis data yes  
dataSchema str schema where ALKIS tables are stored, must be readable no “public”
db str database provider ID no  
excludeGemarkung [str…] Gemarkung (AU) IDs to exclude from search no  
indexSchema str schema to store gws internal indexes, must be writable no “gws”
type str object type yes  
uid str unique ID no  

gws.ext.helper.alkis.util.export.Config

CSV Export configuration.

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
groups [gws.ext.helper.alkis.util.export.GroupConfig…]   no  
uid str unique ID no  

gws.ext.helper.alkis.util.export.GroupConfig

Export group configuration.

Properties:

name type   required default
buchung bool   no false
dataModel gws.common.model.Config   no  
eigentuemer bool   no false
title str   yes  
uid str unique ID no  

gws.ext.helper.csv.Config

CSV format settings

Properties:

name type   required default
decimal str decimal sign no “.”
delimiter str field delimiter no “,”
encoding str encoding for CSV files no “utf8”
formulaHack bool prepend numeric strings with an equal sign no true
precision int precision for floats no 2
quote str quote sign no “”“
rowDelimiter str row delimiter no “n”
type str object type yes  
uid str unique ID no  

gws.ext.helper.storage.Config

Storage

Properties:

name type   required default
backend gws.ext.helper.storage.Backend   yes  
path str   no  
permissions [gws.ext.helper.storage.PermissionRule…]   no  
type str object type yes  
uid str unique ID no  

gws.ext.helper.storage.PermissionRule

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
category str storage category name yes  
mode gws.ext.helper.storage.Mode allowed mode (read/write) yes  
uid str unique ID no  

gws.ext.layer.geojson.Config

GeoJson layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “client”
edit gws.common.layer.types.EditConfig editing permissions no  
editDataModel gws.common.model.Config data model for input data no  
editStyle gws.common.style.Config style for features being edited no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
keyProp str property name for unique ids no “id”
legend gws.common.layer.types.LegendConfig legend configuration no  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) no “all”
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
path gws.types.FilePath geojson file yes  
search gws.common.search.Config layer search configuration no  
style gws.common.style.Config style for features no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.group.Config

Group layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “box”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
layers [gws.types.ext.layer.Config…] layers in this group yes  
legend gws.common.layer.types.LegendConfig legend configuration no  
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
search gws.common.search.Config layer search configuration no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.osm.Config

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “box”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
legend gws.common.layer.types.LegendConfig legend configuration no  
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
search gws.common.search.Config layer search configuration no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.postgres.Config

Postgres layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
db str database provider uid no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “client”
edit gws.common.layer.types.EditConfig editing permissions no  
editDataModel gws.common.model.Config data model for input data no  
editStyle gws.common.style.Config style for features being edited no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
legend gws.common.layer.types.LegendConfig legend configuration no  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) no “all”
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
search gws.common.search.Config layer search configuration no  
style gws.common.style.Config style for features no  
table gws.common.db.SqlTableConfig sql table configuration yes  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.qgis.Config

QGIS Project layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
cache gws.common.layer.types.CacheConfig cache configuration no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
directRender [str…] QGIS providers that should be rendered directly no  
directSearch [str…] QGIS providers that should be searched directly no  
display gws.common.layer.types.DisplayMode layer display mode no “box”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
flatten gws.common.layer.types.FlattenConfig flatten the layer hierarchy no  
grid gws.common.layer.types.GridConfig grid configuration no  
imageFormat gws.common.layer.types.ImageFormat image format no “png8”
legend gws.common.layer.types.LegendConfig legend configuration no  
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
path gws.types.FilePath path to a qgs project file yes  
search gws.common.search.Config layer search configuration no  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use as roots no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.qgisflat.Config

QGIS direct layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
cache gws.common.layer.types.CacheConfig cache configuration no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “box”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
grid gws.common.layer.types.GridConfig grid configuration no  
imageFormat gws.common.layer.types.ImageFormat image format no “png8”
legend gws.common.layer.types.LegendConfig legend configuration no  
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
path gws.types.FilePath qgis project path yes  
search gws.common.search.Config layer search configuration no  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.tile.Config

Tile layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
cache gws.common.layer.types.CacheConfig cache configuration no  
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “tile”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
grid gws.common.layer.types.GridConfig grid configuration no  
imageFormat gws.common.layer.types.ImageFormat image format no “png8”
legend gws.common.layer.types.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
search gws.common.search.Config layer search configuration no  
service gws.ext.layer.tile.ServiceConfig service configuration no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url gws.types.Url rest url with placeholders {x}, {y} and {z} yes  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.tile.ServiceConfig

Tile service configuration

Properties:

name type   required default
crs gws.types.Crs service CRS no “EPSG:3857”
extent gws.types.Extent service extent no  
origin str position of the first tile (nw or sw) no “nw”
tileSize int tile size no 256

gws.ext.layer.wfs.Config

WFS layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents no “1d”
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “client”
edit gws.common.layer.types.EditConfig editing permissions no  
editDataModel gws.common.model.Config data model for input data no  
editStyle gws.common.style.Config style for features being edited no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) no  
legend gws.common.layer.types.LegendConfig legend configuration no  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) no “all”
maxRequests int max concurrent requests to this source no 0
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
params dict extra query params no  
search gws.common.search.Config layer search configuration no  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use no  
style gws.common.style.Config style for features no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url gws.types.Url service url yes  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.wms.Config

WMS layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
cache gws.common.layer.types.CacheConfig cache configuration no  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents no “1d”
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document no false
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “box”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
getMapParams dict additional parameters for GetMap requests no  
grid gws.common.layer.types.GridConfig grid configuration no  
imageFormat gws.common.layer.types.ImageFormat image format no “png8”
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) no  
legend gws.common.layer.types.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
search gws.common.search.Config layer search configuration no  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url gws.types.Url service url yes  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.layer.wmts.Config

WMTS layer

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
cache gws.common.layer.types.CacheConfig cache configuration no  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents no “1d”
clientOptions gws.common.layer.types.ClientOptions options for the layer display in the client no  
dataModel gws.common.model.Config layer data model no  
description gws.types.ext.template.Config template for the layer description no  
display gws.common.layer.types.DisplayMode layer display mode no “tile”
edit gws.common.layer.types.EditConfig editing permissions no  
extent gws.types.Extent layer extent no  
extentBuffer int extent buffer no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
grid gws.common.layer.types.GridConfig grid configuration no  
imageFormat gws.common.layer.types.ImageFormat image format no “png8”
legend gws.common.layer.types.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta gws.common.metadata.Config layer meta data no  
opacity float layer opacity no 1
ows gws.common.layer.types.OwsConfig OWS services options no  
params dict query string parameters no  
search gws.common.search.Config layer search configuration no  
sourceLayer str WMTS layer name no  
sourceStyle str WMTS style name no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url gws.types.Url service url yes  
zoom gws.gis.zoom.Config layer resolutions and scales no  

gws.ext.ows.service.csw.Config

CSW Service configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
enabled bool   no true
featureNamespace str feature namespace name no “gws”
featureNamespaceUri str feature namespace uri no “http://gws.gbd-consult.de”
meta gws.common.metadata.Config service metadata no  
name str service name no  
profile str ISO or DCMI profile no “ISO”
templates [gws.types.ext.template.Config…] service XML templates no  
type str object type yes  
uid str unique ID no  
useInspire gws.common.ows.service.UseInspireConfig INSPIRE configuration no  

gws.ext.ows.service.wfs.Config

WFS Service configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
enabled bool   no true
featureNamespace str feature namespace name no “gws”
featureNamespaceUri str feature namespace uri no “http://gws.gbd-consult.de”
meta gws.common.metadata.Config service metadata no  
name str service name no  
templates [gws.types.ext.template.Config…] service XML templates no  
type str object type yes  
uid str unique ID no  
useInspire gws.common.ows.service.UseInspireConfig INSPIRE configuration no  

gws.ext.ows.service.wms.Config

WMS Service configuration

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
enabled bool   no true
featureNamespace str feature namespace name no “gws”
featureNamespaceUri str feature namespace uri no “http://gws.gbd-consult.de”
meta gws.common.metadata.Config service metadata no  
name str service name no  
templates [gws.types.ext.template.Config…] service XML templates no  
type str object type yes  
uid str unique ID no  
useInspire gws.common.ows.service.UseInspireConfig INSPIRE configuration no  

gws.ext.search.provider.nominatim.Config

Nominatim (OSM) search provider

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
country str country to limit the search no  
dataModel gws.common.model.Config feature data model no  
defaultContext str default spatial context (‘view’ or ‘map’) no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
language str language to return the results in no  
tolerance str tolerance, in pixels or map units no “10px”
type str object type yes  
uid str unique ID no  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search no “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search no “allowed”

gws.ext.search.provider.postgres.Config

Postgres search

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
dataModel gws.common.model.Config feature data model no  
db str database provider uid no  
defaultContext str default spatial context (‘view’ or ‘map’) no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
sort str sort expression no  
table gws.common.db.SqlTableConfig sql table configuration yes  
tolerance str tolerance, in pixels or map units no “10px”
type str object type yes  
uid str unique ID no  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search no “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search no “allowed”

gws.ext.search.provider.qgispostgres.Config

Qgis/Postgres automatic search provider

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
dataModel gws.common.model.Config feature data model no  
dataSource dict qgis data source yes  
defaultContext str default spatial context (‘view’ or ‘map’) no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
tolerance str tolerance, in pixels or map units no “10px”
type str object type yes  
uid str unique ID no  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search no “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search no “allowed”

gws.ext.search.provider.qgiswms.Config

Qgis/Postgres automatic search provider

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
dataModel gws.common.model.Config feature data model no  
defaultContext str default spatial context (‘view’ or ‘map’) no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
path gws.types.FilePath project path yes  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use no  
tolerance str tolerance, in pixels or map units no “10px”
type str object type yes  
uid str unique ID no  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search no “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search no “allowed”

gws.ext.search.provider.wfs.Config

WFS search

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents no “1d”
dataModel gws.common.model.Config feature data model no  
defaultContext str default spatial context (‘view’ or ‘map’) no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) no  
maxRequests int max concurrent requests to this source no 0
params dict extra query params no  
sourceLayers gws.gis.source.LayerFilterConfig source layers to use no  
tolerance str tolerance, in pixels or map units no “10px”
type str object type yes  
uid str unique ID no  
url gws.types.Url service url yes  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search no “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search no “allowed”

gws.ext.search.provider.wms.Config

WMS search

Properties:

name type   required default
access [gws.types.AccessRuleConfig…] access rights no  
capsCacheMaxAge gws.types.Duration max cache age for capabilities documents no “1d”
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document no false
dataModel gws.common.model.Config feature data model no  
defaultContext str default spatial context (‘view’ or ‘map’) no  
featureFormat gws.common.template.FeatureFormatConfig feature formatting options no  
invertAxis [gws.types.Crs…] projections that have an inverted axis (yx) no  
maxRequests int max concurrent requests to this source no 0
sourceLayers gws.gis.source.LayerFilterConfig source layers to use no  
tolerance str tolerance, in pixels or map units no “10px”
type str object type yes  
uid str unique ID no  
url gws.types.Url service url yes  
withGeometry gws.common.search.provider.ParameterUsage whether to use geometry with this search no “allowed”
withKeyword gws.common.search.provider.ParameterUsage whether to use keywords with this search no “allowed”

gws.ext.template.html.Config

HTML template

Properties:

name type   required default
dataModel gws.common.model.Config user-editable template attributes no  
path gws.types.FilePath path to a template file no  
qualityLevels [gws.types.TemplateQualityLevel…] list of quality levels supported by the template no  
text str template content no  
title str template title no  
type str template type yes  
uid str unique ID no  

gws.ext.template.qgis.Config

Qgis print template

Properties:

name type   required default
dataModel gws.common.model.Config user-editable template attributes no  
path gws.types.FilePath   yes  
qualityLevels [gws.types.TemplateQualityLevel…] list of quality levels supported by the template no  
text str template content no  
title str template title no  
type str template type yes  
uid str unique ID no  

gws.ext.template.text.Config

text-only template

Properties:

name type   required default
dataModel gws.common.model.Config user-editable template attributes no  
path gws.types.FilePath path to a template file no  
qualityLevels [gws.types.TemplateQualityLevel…] list of quality levels supported by the template no  
text str template content no  
title str template title no  
type str template type yes  
uid str unique ID no  

gws.ext.template.xml.Config

XML template

Properties:

name type   required default
dataModel gws.common.model.Config user-editable template attributes no  
path gws.types.FilePath path to a template file no  
qualityLevels [gws.types.TemplateQualityLevel…] list of quality levels supported by the template no  
text str template content no  
title str template title no  
type str template type yes  
uid str unique ID no  

gws.gis.source.LayerFilterConfig

Layer filter

Properties:

name type   required default
excludePattern gws.types.Regex match a pattern against the layer full path no  
level int use layers at this level no 0
names [str…] use these layer names (top-to-bottom order) no  
pattern gws.types.Regex match a pattern against the layer full path no  
uid str unique ID no  

gws.gis.zoom.Config

Zoom levels and resolutions

Properties:

name type   required default
initResolution float initial resolution no  
initScale float initial scale no  
maxResolution float maximal resolution no  
maxScale float maximal scale no  
minResolution float minimal resolution no  
minScale float minimal scale no  
resolutions [float…] allowed resolutions no  
scales [float…] allowed scales no  
uid str unique ID no  

gws.server.types.Config

Server module configuation

Properties:

name type   required default
autoRun str shell command to run before server start no  
log str log path no  
logLevel gws.log.Level logging level no “INFO”
mapproxy gws.server.types.MapproxyConfig bundled Mapproxy module no  
qgis gws.server.types.QgisConfig bundled Qgis module no  
spool gws.server.types.SpoolConfig spool server module no  
timeout gws.types.Duration server timeout no 60
uid str unique ID no  
web gws.server.types.WebConfig web server module no  

gws.server.types.MapproxyConfig

Mapproxy server module

Properties:

name type   required default
enabled bool the module is enabled no true
host str   no “localhost”
port int   no 5000
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

gws.server.types.QgisConfig

Bundled QGIS server module

Properties:

name type   required default
debug int QGIS_DEBUG (env. variable) no 0
enabled bool the module is enabled no true
host str   no “localhost”
legend dict default legend settings no  
maxCacheLayers int MAX_CACHE_LAYERS (env. variable) no 4000
maxRequests int max concurrent requests to this server no 6
port int   no 4000
searchPathsForSVG [gws.types.DirPath…] searchPathsForSVG (ini setting) no  
serverCacheSize int QGIS_SERVER_CACHE_SIZE (env. variable) no 10000000
serverLogLevel int QGIS_SERVER_LOG_LEVEL (env. variable) no 2
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

gws.server.types.SpoolConfig

Spool server module

Properties:

name type   required default
enabled bool the module is enabled no true
jobFrequency gws.types.Duration background jobs checking frequency no 3
monitorFrequency gws.types.Duration filesystem changes check frequency no 30
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

gws.server.types.WebConfig

Web server module

Properties:

name type   required default
enabled bool the module is enabled no true
maxRequestLength int max request length in megabytes no 10
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

gws.types.AccessRuleConfig

Access rights definition for authorization roles

Properties:

name type   required default
role str a role to which this rule applies yes  
type gws.types.AccessType access type (deny or allow) yes  
uid str unique ID no  

gws.types.Crs

CRS code like “EPSG:3857

gws.types.Date

ISO date like “2019-01-30”

gws.types.DirPath

Valid readable directory path on the server

gws.types.Duration

String like “1w 2d 3h 4m 5s” or a number of seconds

gws.types.Extent

An array of 4 elements representing extent coordinates [minx, miny, maxx, maxy]

gws.types.FilePath

Valid readable file path on the server

gws.types.FormatStr

String with {attribute} placeholders

gws.types.Point

Point coordinates [x, y]

gws.types.Regex

Regular expression, as used in Python

gws.types.TemplateQualityLevel

Properties:

name type   required default
dpi int   yes  
name str   yes  

gws.types.Url

Http or https URL

gws.types.ext.auth.provider.Config

One of:

gws.types.ext.db.provider.Config

One of:

gws.web.site.Config

Site (virtual host) configuration

Properties:

name type   required default
assets gws.web.site.DocumentRootConfig assets location and options no  
cors gws.web.site.CorsConfig cors configuration no  
errorPage gws.types.ext.template.Config error page template no  
host str host name no “*”
reversedHost str hostname for reversed rewriting no  
reversedRewrite [gws.web.site.RewriteRule…] reversed rewrite rules no  
rewrite [gws.web.site.RewriteRule…] rewrite rules no  
root gws.web.site.DocumentRootConfig document root location and options yes  
uid str unique ID no  

gws.web.site.CorsConfig

Properties:

name type   required default
allowCredentials bool   no false
allowHeaders [str…]   no  
allowOrigin str   no “*”
uid str unique ID no  

gws.web.site.DocumentRootConfig

Base directory for assets

Properties:

name type   required default
allowMime [str…] allowed mime types no  
denyMime [str…] disallowed mime types (from the standard list) no  
dir gws.types.DirPath directory path yes  
uid str unique ID no  

gws.web.site.RewriteRule

Properties:

name type   required default
match gws.types.Regex expression to match the url against yes  
options dict additional options no  
target str target url with placeholders yes  

gws.common.layer.types.DisplayMode

Layer display mode

One of:

  • “box”
  • “client”
  • “tile”

gws.common.layer.types.ImageFormat

Image format

One of:

  • “png24”
  • “png8”

gws.common.search.provider.ParameterUsage

One of:

  • “allowed”
  • “forbidden”
  • “ignored”
  • “required”

gws.ext.helper.storage.Backend

One of:

  • “sqlite”

gws.ext.helper.storage.Mode

One of:

  • “all”
  • “read”
  • “write”

gws.log.Level

One of:

  • “ALL”
  • “CRITICAL”
  • “DEBUG”
  • “ERROR”
  • “INFO”
  • “NOTSET”
  • “WARN”

gws.types.AccessType

One of:

  • “allow”
  • “deny”

gws.types.AttributeType

One of:

  • “bool”
  • “bytes”
  • “date”
  • “datetime”
  • “float”
  • “geometry”
  • “int”
  • “list”
  • “str”
  • “text”
  • “time”

gws.types.GeometryType

One of:

  • “curve”
  • “geomcollection”
  • “geometry”
  • “linestring”
  • “multicurve”
  • “multilinestring”
  • “multipoint”
  • “multipolygon”
  • “multisurface”
  • “point”
  • “polygon”
  • “polyhedralsurface”
  • “surface”

gws.types.StyleType

One of:

  • “css”
  • “cssSelector”