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

real number

dict

generic key-value object

[ Type ]

list (array) of elements of type Type

gws.common.api.Config

Server actions

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

actions

[ gws.types.ext.action.Config ]

available actions

no

uid

str

unique ID

no

gws.common.application.Config

Main application configuration

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

api

gws.common.api.Config

system-wide server actions

no

auth

gws.common.auth.Config

authorization methods and options

no

client

gws.common.client.Config

gws client configuration

no

db

gws.common.application.DbConfig

database configuration

no

developer

dict

developer options

no

fonts

gws.common.application.FontConfig

fonts configuration

no

helpers

[ gws.types.ext.helper.Config ]

helpers configurations

no

locales

[ str ]

default locales for all projects

no

meta

gws.common.metadata.Config

application metadata

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

uid

str

unique ID

no

web

gws.common.application.WebConfig

webserver configuration

no

gws.common.application.DbConfig

Database configuration

Properties:

name

type

required

default

providers

[ gws.types.ext.db.provider.Config ]

database providers

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 bundle location

yes

key

gws.types.FilePath

key file location

yes

uid

str

unique ID

no

gws.common.application.SeedingConfig

Cache 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.Config

Authentication and authorization options

Properties:

name

type

required

default

methods

[ gws.types.ext.auth.method.Config ]

authorization methods

no

providers

[ gws.types.ext.auth.provider.Config ]

authorization providers

yes

sessionLifeTime

gws.types.Duration

session life time

no

1200

sessionStorage

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.Access ]

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.Access ]

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.CustomConfig

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

applyTo

gws.gis.source.LayerFilter

source layers this configuration applies to

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

no

legend

gws.common.layer.types.LegendConfig

legend configuration

no

meta

gws.common.metadata.Config

layer meta data

no

opacity

float

layer opacity

no

order

int

layer order

no

ows

gws.common.layer.types.OwsConfig

OWS services options

no

search

gws.common.search.Config

layer search configuration

no

templates

[ gws.types.ext.template.Config ]

client templates

no

title

str

layer title

no

uid

str

unique ID

no

zoom

gws.gis.zoom.Config

layer resolutions and scales

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.DisplayMode

Layer display mode

One of:

  • "box"

  • "client"

  • "tile"

gws.common.layer.types.EditConfig

Edit access for a layer

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

filter

str

sql filter for features

no

uid

str

unique ID

no

gws.common.layer.types.FlattenConfig

Layer hierarchy flattening

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.ImageFormat

Image format

One of:

  • "png24"

  • "png8"

gws.common.layer.types.LegendConfig

Layer legend confuguration.

Properties:

name

type

required

default

enabled

bool

the legend is enabled

no

true

options

dict

provider-dependent legend options

no

path

gws.types.FilePath

path of the legend image

no

template

gws.types.ext.template.Config

template for an HTML legend

no

uid

str

unique ID

no

url

gws.types.Url

url of the legend image

no

gws.common.layer.types.OwsConfig

OWS services confuguration

Properties:

name

type

required

default

enabledServices

gws.common.layer.types.OwsEnabledServicesConfig

enabled OWS services

no

enabled

bool

enable this layer for ows services

no

true

featureName

str

feature name for ows services

no

name

str

layer name for ows services

no

uid

str

unique ID

no

gws.common.layer.types.OwsEnabledServicesConfig

Configuration for enabled OWS services

Properties:

name

type

required

default

pattern

gws.types.Regex

pattern for enabled service uids

no

uid

str

unique ID

no

uids

[ str ]

enabled services uids

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"

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

map extent

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

authorityIdentifier

str

no

authorityName

str

no

authorityUrl

gws.types.Url

no

catalogCitationUid

str

catalog citation identifier

no

catalogUid

str

catalog identifier

no

contact

gws.common.metadata.ContactConfig

contact information

no

dateBegin

gws.types.Date

temporal extent begin

no

dateCreated

gws.types.Date

publication date

no

dateEnd

gws.types.Date

temporal extent end

no

dateUpdated

gws.types.Date

modification date

no

fees

str

no

image

gws.types.Url

image (logo) url

no

insipreKeywords

[ gws.common.metadata.MetaInspireMandatoryKeyword ]

no

insipreMandatoryKeyword

gws.common.metadata.MetaInspireMandatoryKeyword

no

inspireDegreeOfConformity

gws.common.metadata.MetaInspireDegreeOfConformity

no

inspireResourceType

gws.common.metadata.MetaInspireResourceType

no

inspireSpatialDataServiceType

gws.common.metadata.MetaInspireSpatialDataServiceType

no

inspireSpatialScope

gws.common.metadata.MetaInspireSpatialScope

no

inspireTheme

gws.common.metadata.MetaInspireTheme

no

isoMaintenanceFrequencyCode

gws.common.metadata.MetaIsoMaintenanceFrequencyCode

no

isoQualityConformance

[ gws.common.metadata.MetaIsoQualityConformance ]

no

isoQualityLineage

gws.common.metadata.MetaIsoQualityLineage

no

isoRestrictionCode

gws.common.metadata.MetaIsoRestrictionCode

no

isoScopeName

str

ISO-19139 scope name

no

isoScope

gws.common.metadata.MetaIsoScope

ISO-19139 scope code

no

isoSpatialRepresentationType

gws.common.metadata.MetaIsoSpatialRepresentationType

ISO-19139 spatial type

no

isoTopicCategory

gws.common.metadata.MetaIsoTopicCategory

ISO-19139 topic category

no

keywords

[ str ]

keywords

no

[]

language

str

object language

no

license

str

no

links

[ gws.common.metadata.LinkConfig ]

additional links

no

[]

name

str

object internal name

no

serviceUrl

gws.types.Url

service url

no

title

str

object title

no

uid

str

unique ID

no

urlFormat

str

metadata url mime type

no

urlType

str

metadata url type like “TC211”

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

formatName

str

link format

no

formatVersion

str

link format version

no

function

gws.common.metadata.MetaIsoOnLineFunction

ISO-19115 function

no

scheme

str

link scheme

no

uid

str

unique ID

no

url

gws.types.Url

link url

yes

gws.common.metadata.MetaInspireDegreeOfConformity

Inspire degreeOfConformity, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "conformant"

  • "notConformant"

  • "notEvaluated"

gws.common.metadata.MetaInspireMandatoryKeyword

Inspire keyword, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "chainDefinitionService"

  • "comEncodingService"

  • "comGeographicCompressionService"

  • "comGeographicFormatConversionService"

  • "comMessagingService"

  • "comRemoteFileAndExecutableManagement"

  • "comService"

  • "comTransferService"

  • "humanCatalogueViewer"

  • "humanChainDefinitionEditor"

  • "humanFeatureGeneralizationEditor"

  • "humanGeographicDataStructureViewer"

  • "humanGeographicFeatureEditor"

  • "humanGeographicSpreadsheetViewer"

  • "humanGeographicSymbolEditor"

  • "humanGeographicViewer"

  • "humanInteractionService"

  • "humanServiceEditor"

  • "humanWorkflowEnactmentManager"

  • "infoCatalogueService"

  • "infoCoverageAccessService"

  • "infoFeatureAccessService"

  • "infoFeatureTypeService"

  • "infoGazetteerService"

  • "infoManagementService"

  • "infoMapAccessService"

  • "infoOrderHandlingService"

  • "infoProductAccessService"

  • "infoRegistryService"

  • "infoSensorDescriptionService"

  • "infoStandingOrderService"

  • "metadataGeographicAnnotationService"

  • "metadataProcessingService"

  • "metadataStatisticalCalculationService"

  • "spatialCoordinateConversionService"

  • "spatialCoordinateTransformationService"

  • "spatialCoverageVectorConversionService"

  • "spatialDimensionMeasurementService"

  • "spatialFeatureGeneralizationService"

  • "spatialFeatureManipulationService"

  • "spatialFeatureMatchingService"

  • "spatialImageCoordinateConversionService"

  • "spatialImageGeometryModelConversionService"

  • "spatialOrthorectificationService"

  • "spatialPositioningService"

  • "spatialProcessingService"

  • "spatialProximityAnalysisService"

  • "spatialRectificationService"

  • "spatialRouteDeterminationService"

  • "spatialSamplingService"

  • "spatialSensorGeometryModelAdjustmentService"

  • "spatialSubsettingService"

  • "spatialTilingChangeService"

  • "subscriptionService"

  • "taskManagementService"

  • "temporalProcessingService"

  • "temporalProximityAnalysisService"

  • "temporalReferenceSystemTransformationService"

  • "temporalSamplingService"

  • "temporalSubsettingService"

  • "thematicChangeDetectionService"

  • "thematicClassificationService"

  • "thematicFeatureGeneralizationService"

  • "thematicGeocodingService"

  • "thematicGeographicInformationExtractionService"

  • "thematicGeoparsingService"

  • "thematicGoparameterCalculationService"

  • "thematicImageManipulationService"

  • "thematicImageProcessingService"

  • "thematicImageSynthesisService"

  • "thematicImageUnderstandingService"

  • "thematicMultibandImageManipulationService"

  • "thematicObjectDetectionService"

  • "thematicProcessingService"

  • "thematicReducedResolutionGenerationService"

  • "thematicSpatialCountingService"

  • "thematicSubsettingService"

  • "workflowEnactmentService"

gws.common.metadata.MetaInspireResourceType

Inspire resourceType, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "dataset"

  • "series"

  • "service"

gws.common.metadata.MetaInspireSpatialDataServiceType

Inspire spatialDataServiceType, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "discovery"

  • "download"

  • "invoke"

  • "other"

  • "transformation"

  • "view"

gws.common.metadata.MetaInspireSpatialScope

Inspire spatialScope, see https://inspire.ec.europa.eu/metadata-codelist/SpatialScope

One of:

  • "european"

  • "global_"

  • "local"

  • "national"

  • "regional"

gws.common.metadata.MetaInspireTheme

Inspire theme, see http://inspire.ec.europa.eu/theme/

One of:

  • "ac"

  • "ad"

  • "af"

  • "am"

  • "au"

  • "br"

  • "bu"

  • "cp"

  • "ef"

  • "el"

  • "er"

  • "ge"

  • "gg"

  • "gn"

  • "hb"

  • "hh"

  • "hy"

  • "lc"

  • "lu"

  • "mf"

  • "mr"

  • "nz"

  • "of"

  • "oi"

  • "pd"

  • "pf"

  • "ps"

  • "rs"

  • "sd"

  • "so"

  • "sr"

  • "su"

  • "tn"

  • "us"

gws.common.metadata.MetaIsoMaintenanceFrequencyCode

ISO-19139 MD_MaintenanceFrequencyCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "annually"

  • "asNeeded"

  • "biannually"

  • "continual"

  • "daily"

  • "fortnightly"

  • "irregular"

  • "monthly"

  • "notPlanned"

  • "quarterly"

  • "unknown"

  • "weekly"

gws.common.metadata.MetaIsoOnLineFunction

ISO-19139 CI_OnLineFunctionCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "download"

  • "information"

  • "offlineAccess"

  • "order"

  • "search"

gws.common.metadata.MetaIsoQualityConformance

Properties:

name

type

required

default

explanation

str

no

qualityPass

bool

yes

specificationDate

str

yes

specificationTitle

str

yes

gws.common.metadata.MetaIsoQualityLineage

Properties:

name

type

required

default

sourceScale

int

yes

source

str

yes

statement

str

yes

gws.common.metadata.MetaIsoRestrictionCode

ISO-19139 MD_RestrictionCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "copyright"

  • "intellectualPropertyRights"

  • "license"

  • "otherRestrictions"

  • "patent"

  • "patentPending"

  • "restricted"

  • "trademark"

gws.common.metadata.MetaIsoScope

ISO-19139 MD/MX_ScopeCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "attribute"

  • "attributeType"

  • "collectionHardware"

  • "collectionSession"

  • "dataset"

  • "dimensionGroup"

  • "feature"

  • "featureType"

  • "fieldSession"

  • "initiative"

  • "model"

  • "nonGeographicDataset"

  • "otherAggregate"

  • "platformSeries"

  • "productionSeries"

  • "propertyType"

  • "sensor"

  • "sensorSeries"

  • "series"

  • "service"

  • "software"

  • "stereomate"

  • "tile"

  • "transferAggregate"

gws.common.metadata.MetaIsoSpatialRepresentationType

ISO-19139 MD_SpatialRepresentationTypeCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "grid"

  • "stereoModel"

  • "textTable"

  • "tin"

  • "vector"

  • "video"

gws.common.metadata.MetaIsoTopicCategory

ISO-19139 MD_TopicCategoryCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "biota"

  • "boundaries"

  • "climatologyMeteorologyAtmosphere"

  • "economy"

  • "elevation"

  • "environment"

  • "farming"

  • "geoscientificInformation"

  • "health"

  • "imageryBaseMapsEarthCover"

  • "inlandWaters"

  • "intelligenceMilitary"

  • "location"

  • "oceans"

  • "planningCadastre"

  • "society"

  • "structure"

  • "transportation"

  • "utilitiesCommunication"

gws.common.model.AttributeEditor

Properties:

name

type

required

default

accept

str

no

items

en_configref_gws_types_Any

no

max

float

no

min

float

no

multiple

bool

no

pattern

gws.types.Regex

no

type

str

yes

gws.common.model.AttributeValidator

Properties:

name

type

required

default

attribute

str

no

max

float

no

message

str

yes

min

float

no

pattern

gws.types.Regex

no

type

str

yes

gws.common.model.Config

Data model

Properties:

name

type

required

default

crs

gws.types.Crs

CRS for this model

no

geometryType

gws.types.GeometryType

specific geometry type

no

rules

[ gws.common.model.ModelRule ]

attribute conversion rules

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

editor

gws.common.model.AttributeEditor

no

expression

str

attribute conversion expression

no

format

gws.types.FormatStr

attribute formatter

no

name

str

target attribute name

no

source

str

source attribute name

no

title

str

target attribute title

no

type

gws.types.AttributeType

target attribute type

no

"str"

validators

[ gws.common.model.AttributeValidator ]

no

value

str

constant value

no

gws.common.printer.Config

Printer configuration

Properties:

name

type

required

default

templates

[ gws.types.ext.template.Config ]

print templates

yes

uid

str

unique ID

no

gws.common.project.Config

Project configuration

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

locales

[ str ]

project locales

no

map

gws.common.map.Config

Map configuration

no

meta

gws.common.metadata.Config

project metadata

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

templates

[ gws.types.ext.template.Config ]

project info templates

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 ]

search prodivers

no

gws.common.search.provider.SearchSpatialContext

One of:

  • "map"

  • "view"

gws.common.style.Config

Feature style

Properties:

name

type

required

default

name

str

style name

no

text

str

raw style content

no

type

gws.types.StyleType

style type

yes

uid

str

unique ID

no

values

dict

style values

no

gws.ext.action.alkisgeocoder.Config

ALKIS Geocoder action.

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

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.Access ]

access rights

no

uid

str

unique ID

no

gws.ext.action.alkissearch.Config

Flurstücksuche (cadaster parlcels search) action

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

helper

str

ALKIS helper uid

no

limit

int

search results limit

no

100

printTemplate

gws.types.ext.template.Config

template for printed Flurstueck details

no

templates

[ gws.types.ext.template.Config ]

templates for on-screen 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.Access ]

access rights

no

controlMode

bool

restricted mode enabled

no

false

controlRules

[ str ]

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.UiBblattSearchMode

One of:

  • "any"

  • "end"

  • "exact"

  • "start"

gws.ext.action.alkissearch.UiConfig

Flurstücksuche UI configuration.

Properties:

name

type

required

default

autoSpatialSearch

bool

activate spatial search after submit

no

false

bblattSearchMode

gws.ext.action.alkissearch.UiBblattSearchMode

buchungsblatt search mode

no

"any"

gemarkungListMode

gws.ext.action.alkissearch.UiGemarkungListMode

gemarkung list mode

no

"combined"

searchSelection

bool

search in selection enabled

no

false

searchSpatial

bool

spatial search enabled

no

false

strasseListMode

gws.ext.action.alkissearch.UiStrasseListMode

strasse list entry format

no

"plain"

strasseSearchMode

gws.ext.action.alkissearch.UiStrasseSearchMode

strasse search mode

no

"start"

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.alkissearch.UiGemarkungListMode

One of:

  • "combined"

  • "none"

  • "plain"

  • "tree"

gws.ext.action.alkissearch.UiStrasseListMode

One of:

  • "plain"

  • "withGemarkung"

  • "withGemarkungIfRepeated"

  • "withGemeinde"

  • "withGemeindeIfRepeated"

gws.ext.action.alkissearch.UiStrasseSearchMode

One of:

  • "any"

  • "start"

gws.ext.action.asset.Config

Asset generation action

Properties:

name

type

required

default

access

[ gws.types.Access ]

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.Access ]

access rights

no

type

str

object type

yes

uid

str

unique ID

no

gws.ext.action.bplan.AdministrativeUnitConfig

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

name

str

yes

uid

str

yes

gws.ext.action.bplan.Config

Construction plans management action

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

adminMode

bool

no

false

administrativeUnits

[ gws.ext.action.bplan.AdministrativeUnitConfig ]

Administrative Units

yes

crs

gws.types.Crs

CRS for the bplan data

yes

dataDir

gws.types.DirPath

data directory

yes

db

str

database provider ID

no

emailFrom

str

no

emailServerHost

str

no

emailSubject

str

no

emailTo

str

no

exportDataModel

gws.common.model.Config

data model for csv export

no

groupLayerUid

str

uid of the B-Plan group layer

yes

imageQuality

int

palette size for optimized images

no

24

metaTable

gws.common.db.SqlTableConfig

meta table configuration

yes

planTable

gws.common.db.SqlTableConfig

plan table configuration

yes

planTypes

[ gws.ext.action.bplan.PlanTypeConfig ]

Plan Types

yes

templates

[ gws.types.ext.template.Config ]

templates

yes

type

str

object type

yes

uid

str

unique ID

no

uploadChunkSize

int

upload chunk size in mb

no

10

gws.ext.action.bplan.PlanTypeConfig

Properties:

name

type

required

default

color

str

yes

name

str

yes

srcName

str

yes

uid

str

yes

gws.ext.action.collector.CollectionPrototypeConfig

Properties:

name

type

required

default

collectionTable

gws.common.db.SqlTableConfig

sql table configuration

yes

dataModel

gws.common.model.Config

no

db

str

database provider uid

no

documentTable

gws.common.db.SqlTableConfig

sql table configuration

yes

itemTable

gws.common.db.SqlTableConfig

sql table configuration

yes

items

[ gws.ext.action.collector.ItemPrototypeConfig ]

yes

linkColumn

str

no

"collection_id"

name

str

yes

showWhere

str

extra condition to show collections

no

style

gws.common.style.Config

style for collection center point

no

type

str

yes

uid

str

unique ID

no

gws.ext.action.collector.Config

Collection editor action

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

collections

[ gws.ext.action.collector.CollectionPrototypeConfig ]

yes

type

str

object type

yes

uid

str

unique ID

no

gws.ext.action.collector.ItemPrototypeConfig

Properties:

name

type

required

default

dataModel

gws.common.model.Config

yes

icon

str

no

name

str

yes

style

gws.common.style.Config

style for features

no

type

str

yes

uid

str

unique ID

no

gws.ext.action.dimension.Config

Dimension action

Properties:

name

type

required

default

access

[ gws.types.Access ]

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 connector action

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

cacheTime

gws.types.Duration

request cache life time

no

"24h"

dataTableName

str

table to store consolidated results

yes

dataTablePattern

str

pattern for result tables to consolidate

yes

gemeindeFilter

[ str ]

gemeinde (AU) ids to keep in the index

no

infoTitle

str

information box title

no

requestTableName

str

table to store outgoing requests

yes

requestUrl

gws.types.Url

main program url, with the placholder {REQUEST_ID}

yes

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

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.Access ]

access rights

no

type

str

object type

yes

uid

str

unique ID

no

gws.ext.action.fs.Config

File system action

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

root

gws.types.DirPath

file system root

yes

type

str

object type

yes

uid

str

unique ID

no

gws.ext.action.fsinfo.Config

FSInfo action

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

dataTable

gws.common.db.SqlTableConfig

yes

db

str

database provider uid

no

documentTable

gws.common.db.SqlTableConfig

yes

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

access rights

no

crs

gws.types.Crs

CRS for gekos data

no

db

str

database provider uid

no

position

gws.ext.action.gekos.PositionConfig

position correction for points

no

sources

[ gws.ext.action.gekos.SourceConfig ]

gek-online instances

no

table

gws.common.db.SqlTableConfig

sql table configuration

yes

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

type

str

object type

yes

uid

str

unique ID

no

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.gekos.SourceConfig

Properties:

name

type

required

default

instance

str

instance name for this source

yes

params

dict

additional parameters for gek-online calls

yes

uid

str

unique ID

no

url

gws.types.Url

gek-online base url

yes

gws.ext.action.georisks.Config

Georisks action

Properties:

name

type

required

default

access

[ gws.types.Access ]

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.Access ]

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.Access ]

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.Access ]

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.Access ]

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.Access ]

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.Access ]

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.Access ]

access rights

no

db

str

database provider uid

no

tables

[ gws.ext.action.tabedit.TableConfig ]

yes

type

str

object type

yes

uid

str

unique ID

no

gws.ext.action.tabedit.TableConfig

Properties:

name

type

required

default

dataModel

gws.common.model.Config

table data model

no

sort

str

sort expression

no

table

gws.common.db.SqlTableConfig

sql table configuration

yes

title

str

no

uid

str

unique ID

no

widths

[ int ]

column widths, 0 to exclude

no

withAdd

bool

use the ‘add’ button

no

withFilter

bool

use filter boxes

no

gws.ext.auth.method.basic.Config

HTTP-basic authorization options

Properties:

name

type

required

default

secure

bool

use only with SSL

no

true

type

str

object type

yes

uid

str

unique ID

no

gws.ext.auth.method.web.Config

Web-based authorization options

Properties:

name

type

required

default

cookieName

str

name for the cookie

no

"auth"

cookiePath

str

cookie path

no

"/"

secure

bool

use only with SSL

no

true

type

str

object type

yes

uid

str

unique ID

no

gws.ext.auth.provider.file.Config

File-based authorization provider

Properties:

name

type

required

default

allowedMethods

[ str ]

allowed authorization methods

no

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

allowedMethods

[ str ]

allowed authorization methods

no

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 ]

role names

yes

gws.ext.auth.provider.postgres.Config

Postgres authorization provider

Properties:

name

type

required

default

allowedMethods

[ str ]

allowed authorization methods

no

authSql

str

sql statement for login check

yes

db

str

database provider ID

no

type

str

object type

yes

uidSql

str

sql statement for fetching user data

yes

uid

str

unique ID

no

gws.ext.db.provider.postgres.Config

Postgres/Postgis database provider

Properties:

name

type

required

default

connectTimeout

gws.types.Duration

connect 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

no

"public"

db

str

database provider ID

no

excludeGemarkung

[ str ]

Gemarkung (Administrative Unit) IDs to exclude from search

no

indexSchema

str

schema to store GWS internal indexes

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.Access ]

access rights

no

groups

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

export groups

no

uid

str

unique ID

no

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

Export group configuration

Properties:

name

type

required

default

buchung

bool

include Grundbuch (register) data

no

false

dataModel

gws.common.model.Config

data model for this group

no

eigentuemer

bool

include Eigentuemer (owner) data

no

false

title

str

title for this group

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

quoteAll

bool

quote all fields

no

false

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.Backend

One of:

  • "sqlite"

gws.ext.helper.storage.Config

Storage helper

Properties:

name

type

required

default

backend

gws.ext.helper.storage.Backend

backend type

yes

path

str

path to the storage file

no

permissions

[ gws.ext.helper.storage.PermissionRule ]

permission rules

no

type

str

object type

yes

uid

str

unique ID

no

gws.ext.helper.storage.Mode

One of:

  • "all"

  • "read"

  • "write"

gws.ext.helper.storage.PermissionRule

Permission rule for a storage category

Properties:

name

type

required

default

access

[ gws.types.Access ]

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.helper.xml.Config

XML settings

Properties:

name

type

required

default

namespaces

[ gws.ext.helper.xml.NamespaceConfig ]

custom namespaces

no

type

str

object type

yes

uid

str

unique ID

no

gws.ext.helper.xml.NamespaceConfig

XML namespace configuration

Properties:

name

type

required

default

name

str

namespace name

yes

schemaLocation

gws.types.Url

namespace schema location

no

uri

gws.types.Url

namespace uri

yes

gws.ext.layer.geojson.Config

GeoJson layer

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"client"

editDataModel

gws.common.model.Config

data model for input data

no

editStyle

gws.common.style.Config

style for features being edited

no

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

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

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"box"

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

ows

gws.common.layer.types.OwsConfig

OWS services options

no

search

gws.common.search.Config

layer search configuration

no

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"client"

editDataModel

gws.common.model.Config

data model for input data

no

editStyle

gws.common.style.Config

style for features being edited

no

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

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

templates

[ gws.types.ext.template.Config ]

client templates

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.qgis.Config

QGIS Project layer

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

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

excludeLayers

gws.gis.source.LayerFilter

source layers to exclude

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

no

flattenLayers

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"

layerConfig

[ gws.common.layer.CustomConfig ]

custom configurations for specific layers

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

order

int

layer order

no

ows

gws.common.layer.types.OwsConfig

OWS services options

no

path

gws.types.FilePath

path to a qgs project file

yes

rootLayers

gws.gis.source.LayerFilter

source layers to use as roots

no

search

gws.common.search.Config

layer search configuration

no

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"box"

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

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.LayerFilter

source layers to use

no

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"tile"

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

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

templates

[ gws.types.ext.template.Config ]

client templates

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

tileSize

int

tile size

no

256

gws.ext.layer.wfs.Config

WFS layer

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"client"

editDataModel

gws.common.model.Config

data model for input data

no

editStyle

gws.common.style.Config

style for features being edited

no

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

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.LayerFilter

source layers to use

no

style

gws.common.style.Config

style for features

no

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"box"

edit

gws.common.layer.types.EditConfig

editing permissions

no

excludeLayers

gws.gis.source.LayerFilter

source layers to exclude

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

no

flattenLayers

gws.common.layer.types.FlattenConfig

flatten the layer hierarchy

no

getCapabilitiesParams

dict

additional parameters for GetCapabilities requests

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

layerConfig

[ gws.common.layer.CustomConfig ]

custom configurations for specific layers

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

order

int

layer order

no

ows

gws.common.layer.types.OwsConfig

OWS services options

no

rootLayers

gws.gis.source.LayerFilter

source layers to use as roots

no

search

gws.common.search.Config

layer search configuration

no

templates

[ gws.types.ext.template.Config ]

client templates

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.wmsflat.Config

WMS Flat layer

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"box"

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

no

getCapabilitiesParams

dict

additional parameters for GetCapabilities requests

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

order

int

layer order

no

ows

gws.common.layer.types.OwsConfig

OWS services options

no

search

gws.common.search.Config

layer search configuration

no

sourceLayers

gws.gis.source.LayerFilter

source layers to use

no

templates

[ gws.types.ext.template.Config ]

client templates

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.wmstree.Config

WMS layer

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"box"

edit

gws.common.layer.types.EditConfig

editing permissions

no

excludeLayers

gws.gis.source.LayerFilter

source layers to exclude

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

no

flattenLayers

gws.common.layer.types.FlattenConfig

flatten the layer hierarchy

no

getCapabilitiesParams

dict

additional parameters for GetCapabilities requests

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

layerConfig

[ gws.common.layer.CustomConfig ]

custom configurations for specific layers

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

order

int

layer order

no

ows

gws.common.layer.types.OwsConfig

OWS services options

no

rootLayers

gws.gis.source.LayerFilter

source layers to use as roots

no

search

gws.common.search.Config

layer search configuration

no

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

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

display

gws.common.layer.types.DisplayMode

layer display mode

no

"tile"

edit

gws.common.layer.types.EditConfig

editing permissions

no

extentBuffer

int

extent buffer

no

extent

gws.types.Extent

layer extent

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

order

int

layer order

no

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

templates

[ gws.types.ext.template.Config ]

client templates

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.Access ]

access rights

no

forceFeatureName

str

no

meta

gws.common.metadata.Config

service metadata

no

name

str

service name

no

profile

gws.ext.ows.service.csw.Profile

metadata profile

no

"ISO"

root

str

root layer uid

no

strictParams

bool

strict parameter parsing

no

false

supportedCrs

[ gws.types.Crs ]

supported CRS for this service

no

templates

[ gws.types.ext.template.Config ]

service XML templates

no

type

str

object type

yes

uid

str

unique ID

no

updateSequence

str

service update sequence

no

withInspireMeta

bool

use INSPIRE Metadata

no

false

gws.ext.ows.service.csw.Profile

One of:

  • "DCMI"

  • "ISO"

gws.ext.ows.service.wcs.Config

WCS Service configuration

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

forceFeatureName

str

no

meta

gws.common.metadata.Config

service metadata

no

name

str

service name

no

root

str

root layer uid

no

strictParams

bool

strict parameter parsing

no

false

supportedCrs

[ gws.types.Crs ]

supported CRS for this service

no

templates

[ gws.types.ext.template.Config ]

service XML templates

no

type

str

object type

yes

uid

str

unique ID

no

updateSequence

str

service update sequence

no

withInspireMeta

bool

use INSPIRE Metadata

no

false

gws.ext.ows.service.wfs.Config

WFS Service configuration

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

forceFeatureName

str

no

meta

gws.common.metadata.Config

service metadata

no

name

str

service name

no

root

str

root layer uid

no

strictParams

bool

strict parameter parsing

no

false

supportedCrs

[ gws.types.Crs ]

supported CRS for this service

no

templates

[ gws.types.ext.template.Config ]

service XML templates

no

type

str

object type

yes

uid

str

unique ID

no

updateSequence

str

service update sequence

no

withInspireMeta

bool

use INSPIRE Metadata

no

false

gws.ext.ows.service.wms.Config

WMS Service configuration

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

forceFeatureName

str

no

meta

gws.common.metadata.Config

service metadata

no

name

str

service name

no

root

str

root layer uid

no

strictParams

bool

strict parameter parsing

no

false

supportedCrs

[ gws.types.Crs ]

supported CRS for this service

no

templates

[ gws.types.ext.template.Config ]

service XML templates

no

type

str

object type

yes

uid

str

unique ID

no

updateSequence

str

service update sequence

no

withInspireMeta

bool

use INSPIRE Metadata

no

false

gws.ext.ows.service.wmts.Config

WMTS Service configuration

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

forceFeatureName

str

no

meta

gws.common.metadata.Config

service metadata

no

name

str

service name

no

root

str

root layer uid

no

strictParams

bool

strict parameter parsing

no

false

supportedCrs

[ gws.types.Crs ]

supported CRS for this service

no

templates

[ gws.types.ext.template.Config ]

service XML templates

no

type

str

object type

yes

uid

str

unique ID

no

updateSequence

str

service update sequence

no

withInspireMeta

bool

use INSPIRE Metadata

no

false

gws.ext.search.provider.nominatim.Config

Nominatim (OSM) search provider

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

country

str

country to limit the search

no

dataModel

gws.common.model.Config

feature data model

no

defaultContext

gws.common.search.provider.SearchSpatialContext

default spatial context

no

"map"

language

str

language to return the results in

no

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

title

str

provider title

no

tolerance

str

tolerance, in pixels or map units

no

"10px"

type

str

object type

yes

uid

str

unique ID

no

withGeometry

bool

enable geometry search

no

true

withKeyword

bool

enable keyword search

no

true

gws.ext.search.provider.postgres.Config

Postgres search

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

dataModel

gws.common.model.Config

feature data model

no

db

str

database provider uid

no

defaultContext

gws.common.search.provider.SearchSpatialContext

default spatial context

no

"map"

sort

str

sort expression

no

table

gws.common.db.SqlTableConfig

sql table configuration

yes

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

title

str

provider title

no

tolerance

str

tolerance, in pixels or map units

no

"10px"

type

str

object type

yes

uid

str

unique ID

no

withGeometry

bool

enable geometry search

no

true

withKeyword

bool

enable keyword search

no

true

gws.ext.search.provider.qgispostgres.Config

Qgis/Postgres automatic search provider

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

dataModel

gws.common.model.Config

feature data model

no

dataSource

dict

qgis data source

yes

defaultContext

gws.common.search.provider.SearchSpatialContext

default spatial context

no

"map"

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

title

str

provider title

no

tolerance

str

tolerance, in pixels or map units

no

"10px"

type

str

object type

yes

uid

str

unique ID

no

withGeometry

bool

enable geometry search

no

true

withKeyword

bool

enable keyword search

no

true

gws.ext.search.provider.qgiswms.Config

Qgis/Postgres automatic search provider

Properties:

name

type

required

default

access

[ gws.types.Access ]

access rights

no

dataModel

gws.common.model.Config

feature data model

no

defaultContext

gws.common.search.provider.SearchSpatialContext

default spatial context

no

"map"

path

gws.types.FilePath

project path

yes

sourceLayers

gws.gis.source.LayerFilter

source layers to use

no

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

title

str

provider title

no

tolerance

str

tolerance, in pixels or map units

no

"10px"

type

str

object type

yes

uid

str

unique ID

no

withGeometry

bool

enable geometry search

no

true

withKeyword

bool

enable keyword search

no

true

gws.ext.search.provider.wfs.Config

WFS search

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

gws.common.search.provider.SearchSpatialContext

default spatial context

no

"map"

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.LayerFilter

source layers to use

no

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

title

str

provider title

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

bool

enable geometry search

no

true

withKeyword

bool

enable keyword search

no

true

gws.ext.search.provider.wms.Config

WMS search

Properties:

name

type

required

default

access

[ gws.types.Access ]

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

gws.common.search.provider.SearchSpatialContext

default spatial context

no

"map"

getCapabilitiesParams

dict

additional parameters for GetCapabilities requests

no

getMapParams

dict

additional parameters for GetMap requests

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.LayerFilter

source layers to use

no

templates

[ gws.types.ext.template.Config ]

feature formatting templates

no

title

str

provider title

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

bool

enable geometry search

no

true

withKeyword

bool

enable keyword search

no

true

gws.ext.template.html.Config

HTML template

Properties:

name

type

required

default

dataModel

gws.common.model.Config

user-editable template attributes

no

mimeTypes

[ str ]

mime types this template can generate

no

path

gws.types.FilePath

path to a template file

no

qualityLevels

[ gws.types.TemplateQualityLevel ]

quality levels supported by the template

no

subject

str

template purpose

no

text

str

template content

no

title

str

template title

no

type

str

object 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

mimeTypes

[ str ]

mime types this template can generate

no

path

gws.types.FilePath

yes

qualityLevels

[ gws.types.TemplateQualityLevel ]

quality levels supported by the template

no

subject

str

template purpose

no

text

str

template content

no

title

str

template title

no

type

str

object 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

mimeTypes

[ str ]

mime types this template can generate

no

path

gws.types.FilePath

path to a template file

no

qualityLevels

[ gws.types.TemplateQualityLevel ]

quality levels supported by the template

no

subject

str

template purpose

no

text

str

template content

no

title

str

template title

no

type

str

object 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

mimeTypes

[ str ]

mime types this template can generate

no

path

gws.types.FilePath

path to a template file

no

qualityLevels

[ gws.types.TemplateQualityLevel ]

quality levels supported by the template

no

subject

str

template purpose

no

text

str

template content

no

title

str

template title

no

type

str

object type

yes

uid

str

unique ID

no

gws.gis.source.LayerFilter

Source layer filter

Properties:

name

type

required

default

level

int

match only layers at this level

no

0

names

[ str ]

match these layer names (top-to-bottom order)

no

pattern

gws.types.Regex

match layers whose full path matches a pattern

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.log.Level

One of:

  • "ALL"

  • "CRITICAL"

  • "DEBUG"

  • "ERROR"

  • "INFO"

  • "NOTSET"

  • "WARN"

gws.server.types.Config

Server module configuation

Properties:

name

type

required

default

autoRun

str

shell command to run before server start

no

logLevel

gws.log.Level

logging level

no

"INFO"

log

str

log path

no

mapproxy

gws.server.types.MapproxyConfig

bundled Mapproxy module

no

monitor

gws.server.types.MonitorConfig

monitor configuation

no

qgis

gws.server.types.QgisConfig

bundled Qgis module

no

spool

gws.server.types.SpoolConfig

spool server module

no

timeZone

str

timezone for this server

no

"UTC"

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

host to run the module on

no

"localhost"

port

int

port number

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.MonitorConfig

Properties:

name

type

required

default

enabled

bool

the module is enabled

no

true

frequency

gws.types.Duration

filesystem changes check frequency

no

30

ignore

[ gws.types.Regex ]

ignore paths that match these regexes

no

uid

str

unique ID

no

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

host to run the module on

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

port number

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

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.Access

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.AccessType

One of:

  • "allow"

  • "deny"

gws.types.AttributeType

One of:

  • "bool"

  • "bytes"

  • "date"

  • "datetime"

  • "float"

  • "floatlist"

  • "geometry"

  • "int"

  • "intlist"

  • "str"

  • "strlist"

  • "text"

  • "time"

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.GeometryType

One of:

  • "curve"

  • "geomcollection"

  • "geometry"

  • "linestring"

  • "multicurve"

  • "multilinestring"

  • "multipoint"

  • "multipolygon"

  • "multisurface"

  • "point"

  • "polygon"

  • "polyhedralsurface"

  • "surface"

gws.types.Point

Point coordinates [x, y]

gws.types.Regex

Regular expression, as used in Python

gws.types.StyleType

One of:

  • "css"

  • "cssSelector"

gws.types.TemplateQualityLevel

Properties:

name

type

required

default

dpi

int

yes

name

str

yes

gws.types.Url

Http or https URL

gws.types.ext.action.Config

One of:

gws.types.ext.auth.method.Config

One of:

gws.types.ext.auth.provider.Config

One of:

gws.types.ext.db.provider.Config

One of:

gws.types.ext.helper.Config

One of:

gws.types.ext.layer.Config

One of:

gws.types.ext.ows.service.Config

One of:

gws.types.ext.search.provider.Config

One of:

gws.types.ext.template.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

Access-Control-Allow-Credentials header

no

false

allowHeaders

[ str ]

Access-Control-Allow-Headers header

no

allowOrigin

str

Access-Control-Allow-Origin header

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