Konfigurationsreferenz

Dieser Abschnitt beschreibt formal die GBD WebSuite Konfiguration, bei der es sich um eine geschachtelte Key-Value-Struktur handelt. Die keys sind immer Zeichenketten, die values sollten zu einem der unten aufgeführten Typen gehören.

Die Top-Level-Konfiguration ist vom Typ ApplicationConfig.

Basis Typen

Grundlegende Datentypen, wie sie in der Sprache Python verwendet werden.

str

String, muss in der UTF-8 Kodierung sein

bool

Boolean true or false

int

Integer Nummer

float

Gleitkommerzahl

dict

Generisches Schlüssel-Wert-Objekt

[T…]

Liste (Array) von Elementen vom Typ T

Spezial Typen

Die Werte dieser Typen sind Zeichenketten und Zahlen, die mit einer speziellen Semantik versehen sind.

crsref

KBS code wie “EPSG:3857”

dirpath

gueltiger lesbarer Verzeichnispfad auf dem Server

duration

Zeichenfolge wie ‘1w 2d 3h 4m 5s’ oder eine ganze Anzahl Sekunden

filepath

gueltiger lesbarer Dateipfad auf dem Server

formatstr

Text mit {attribute} Platzhaltern

regex

regulaerer Ausdruck, wie er in Python verwendet wird

url

http oder https URL

ApplicationConfig

Hauptkonfiguration der GBD WebSuite

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Standardzugriffsmodus

nein

api

ApiConfig

system-wide server actions

nein

auth

AuthConfig

Autorisierungsmethoden und -optionen

nein

client

ClientConfig

GBD WebSuite Client Konfiguration

nein

csv

CsvConfig

csv format options

nein

db

ApplicationDbConfig

Datenbankkonfiguration

nein

fonts

ApplicationFontConfig

fonts configuration

nein

locale

str

Standardsprache fuer alle Projekte

nein

“en_CA”

projectDirs

[dirpath…]

Verzeichnisse mit zusaetzlichen Projekten

nein

projectPaths

[filepath…]

zusaetzliche Projektpfade

nein

projects

[ProjectConfig…]

Projektkonfigurationen

nein

seeding

ApplicationSeedingConfig

Konfiguration für Seeding-Jobs

nein

server

ServerConfig

Server Engine-Optionen

nein

storage

StorageConfig

storage configuration

nein

timeZone

str

Zeitzone für diesen Server

nein

“UTC”

web

ApplicationWebConfig

Webserver-Konfiguration

nein

AccessRuleConfig

Zugriffsrechte definition for authorization roles

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

role

str

Liste der Rollen, fuer die diese Regel gilt

ja

type

AccessType

Zugriffstyp (deny oder allow)

ja

ActionAlkisBuchungConfig

Access to the Grundbuch (register) information

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

access rights

ja

ActionAlkisCSVExportConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

dataModel

[dict…]

ja

ActionAlkisConfig

Flurstückssuche

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

alkisSchema

str

Schema, in dem ALKIS-Tabellen gespeichert sind, muss lesbar sein

nein

“public”

buchung

ActionAlkisBuchungConfig

access to the Grundbuch (register) information

nein

csvExport

ActionAlkisCSVExportConfig

nein

db

str

Datenbank (PostGIS) Provider-ID

nein

disableApi

bool

disable external access to this extension

nein

false

eigentuemer

ActionAlkisEigentuemerConfig

access to the Eigentümer (owner) information

nein

excludeGemarkung

[str…]

Gemarkung (AU) IDs, die von der Suche ausgeschlossen werden sollen

nein

featureFormat

FormatConfig

Vorlage für Flurstück-Details auf dem Bildschirm

nein

indexSchema

str

Schema zum Speichern der internen Indizes der GBD WebSuite, muss beschreibbar sein

nein

“gws”

limit

int

Suchergebnisse begrenzen

nein

100

printTemplate

TemplateConfig

Vorlage für gedruckte Flurstück-Details

nein

type

str

“alkis”

ja

ui

ActionAlkisUiConfig

ui options

nein

ActionAlkisEigentuemerConfig

Access to the Eigentümer (owner) information

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

access rights

ja

controlMode

bool

restricted mode enabled

nein

false

controlRules

[str…]

list of regular expression for the restricted input control

nein

logTable

str

data access protocol table name

nein

ActionAlkisUiConfig

Flurstückssuche UI configuration.

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

autoSpatialSearch

bool

activate spatial search after submit

nein

false

export

bool

export function enabled

nein

false

gemarkungListMode

str

combined = “gemarkung(gemeinde)”, plain = only “gemarkung”

nein

“combined”

pick

bool

pick mode enabled

nein

false

searchSelection

bool

search in selection enabled

nein

false

searchSpatial

bool

spatial search enabled

nein

false

select

bool

select mode enabled

nein

false

ActionAssetConfig

Asset (dynamische HTML) Aktion)

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“asset”

ja

ActionAuthConfig

Autorisierungsaktion

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“auth”

ja

ActionDimensionConfig

Dimension action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

layers

[str…]

target layer uids

nein

pixelTolerance

int

pixel tolerance

nein

10

type

str

“dimension”

ja

ActionDproconConfig

D-Procon action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

alkisSchema

str

schema where ALKIS tables are stored, must be readable

nein

“public”

cacheTime

duration

nein

“24h”

crs

crsref

nein

dataTable

SqlTableConfig

table to store consolidated results

ja

dataTablePattern

str

pattern for result tables to consolidate

ja

db

str

nein

indexSchema

str

schema to store gws internal indexes, must be writable

nein

“gws”

infoTitle

str

nein

requestTable

SqlTableConfig

table to store outgoing requests

ja

requestUrl

url

ja

type

str

“dprocon”

ja

ActionEditConfig

feature edit action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“edit”

ja

ActionGekosConfig

GekoS action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

crs

crsref

CRS for gekos data

nein

db

str

database provider uid

nein

instances

[str…]

gek-online instances

nein

params

dict

additional parameters for gek-online calls

ja

position

ActionGekosPositionConfig

position correction for points

nein

table

SqlTableConfig

sql table configuration

ja

type

str

“gekos”

ja

url

url

gek-online base url

ja

ActionGekosPositionConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

angle

int

angle for points repelling

nein

0

distance

int

radius for points repelling

nein

0

offsetX

int

x-offset for points

ja

offsetY

int

y-offset for points

ja

ActionMapConfig

map rendering action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“map”

ja

ActionOwsConfig

OWS server action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

templates

ActionOwsTemplatesConfig

nein

type

str

“ows”

ja

ActionOwsTemplatesConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

wmsGetCapabilities

TemplateConfig

nein

ActionPrinterConfig

Druckaktion

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“printer”

ja

ActionProjectConfig

Projektaktion

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“project”

ja

ActionRemoteadminConfig

Remote-Administratoraktion

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

passwordFile

str

path to the password file

nein

“/gws-var/.remoteadmin”

type

str

“remoteadmin”

ja

ActionSearchConfig

Suchaktion

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

limit

int

search results limit

nein

1000

pixelTolerance

int

Pixeltoleranz für Geometriesuche

nein

5

type

str

“search”

ja

ActionStorageConfig

Storage action

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

type

str

“storage”

ja

ApiConfig

Server actions

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

default access mode

nein

actions

[ActionConfig…]

available actions

nein

ApplicationDbConfig

Datenbankkonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

providers

[DbProviderConfig…]

ja

ApplicationFontConfig

Fonts configuration.

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

dir

dirpath

directory with custom fonts

ja

ApplicationSSLConfig

SSL configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

crt

filepath

crt file location

ja

key

filepath

key file location

ja

ApplicationSeedingConfig

Seeding-Optionen

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

concurrency

int

Anzahl gleichzeitiger Seeding-Jobs

nein

1

maxTime

duration

max. Zeit für einen Seeding Job

nein

600

ApplicationWebConfig

Web server configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

sites

[WebSiteConfig…]

configured sites

nein

ssl

ApplicationSSLConfig

ssl configuration

nein

AttributeConfig

Attributkonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

name

str

Interner Name

nein

title

str

Titel

nein

type

str

Typ

nein

AuthConfig

Authentifizierungs- und Autorisierungsoptionen

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

cookie

AuthCookieConfig

Parameter für Sitzungscookies

nein

httpEnabled

bool

HTTP-Autorisierung aktiviert

nein

true

httpsOnly

bool

HTTP-Autorisierung nur über SSL

nein

false

providers

[AuthProviderConfig…]

Autorisierungsanbieter

ja

session

AuthSessionConfig

Sitzungskonfiguration

nein

AuthCookieConfig

Parameter für Sitzungscookies

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

name

str

Name für den Cookie

nein

“auth”

path

str

Cookie-Pfad

nein

“/”

AuthProviderFileConfig

dateibasierter Autorisierungsanbieter

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

path

filepath

Pfad zur JSON-Datei des Benutzers

ja

type

str

“file”

ja

AuthProviderLdapConfig

LDAP-Autorisierungsanbieter

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

activeDirectory

bool

wahr, wenn der LDAP-Server Active Directory ist

nein

true

bindDN

str

BIND DN

ja

bindPassword

str

BIND Passwort

ja

displayNameFormat

formatstr

Format für den Anzeigenamen des Benutzers

nein

“{dn}”

timeout

duration

LDAP-Server-Timeout

nein

30

type

str

“ldap”

ja

url

str

LDAP-Server-URL “ldap://host:port/baseDN?searchAttribute

ja

users

[AuthProviderLdapUserSpec…]

map LDAP filters to gws roles

ja

AuthProviderLdapUserSpec

Map LDAP filters to authorization roles

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

matches

str

LDAP filter the account has to match

nein

memberOf

str

LDAP group the account has to be a member of

nein

roles

[str…]

gws role names

ja

AuthSessionConfig

Sitzungskonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

heartBeat

bool

Sitzungen automatisch aktualisieren

nein

false

lifeTime

duration

Sitzungslebenszeit

nein

1200

storage

str

Sitzungs-Speicher-Engine

nein

“sqlite”

ClientConfig

Element der Client-Benutzeroberflaeche

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

addElements

[ClientElementConfig…]

add elements to the parent element list

nein

elements

[ClientElementConfig…]

Kindelemente dieses Elements

nein

options

dict

Optionen für dieses Element

nein

removeElements

[ClientElementConfig…]

remove elements from the parent element list

nein

ClientElementConfig

GWS client UI element configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

access rights

nein

after

str

insert after this tag

nein

before

str

insert before this tag

nein

tag

str

element tag

ja

CsvConfig

CSV export settings

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

decimal

str

nein

“.”

delimiter

str

field delimiter

nein

“,”

encoding

str

encoding for CSV files

nein

“utf8”

quote

str

quote sign

nein

“”“

quoteAll

bool

quote all fields

nein

false

DbProviderPostgresConfig

Postgres/Postgis database provider

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

database

str

database name

nein

host

str

database host

nein

“localhost”

password

str

password

ja

port

int

database port

nein

5432

timeout

duration

query timeout

nein

0

type

str

“postgres”

ja

uid

str

unique id

ja

user

str

username

ja

DocumentRootConfig

Asset-Basisverzeichniskonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

allowMime

[str…]

erlaubte Mime-Typen

nein

denyMime

[str…]

nicht erlaubte Mime-Typen (von Standardliste)

nein

dir

dirpath

Verzeichnispfad

ja

Extent

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

FormatConfig

Objektformat

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

category

TemplateConfig

Objektkategorie

nein

dataModel

[AttributeConfig…]

attribute metadata

nein

description

TemplateConfig

Vorlage fuer Objektbeschreibung

nein

label

TemplateConfig

Objektbeschriftung in der Karte

nein

teaser

TemplateConfig

Vorlage fuer Objekt-Teaser (Kurzbeschreibungen)

nein

title

TemplateConfig

Objekttitel

nein

LayerCacheConfig

Cache configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

enabled

bool

cache is enabled

nein

false

maxAge

duration

cache max. age

nein

“7d”

maxLevel

int

max. zoom level to cache

nein

1

LayerClientOptions

Client-Optionen für einen Layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

exclusive

bool

Es ist jeweils nur eines der untergeordneten Elemente dieses Layers sichtbar

nein

false

expanded

bool

Der Layer wird in der Listenansicht erweitert

nein

false

listed

bool

Der Layer wird in dieser Listenansicht angezeigt

nein

true

selected

bool

Der Layer ist anfangs ausgewaehlt

nein

false

unfolded

bool

Der Layer wird nicht aufgelistet, seine untergeordneten Elemente jedoch

nein

false

visible

bool

Der Layer ist anfangs sichtbar

nein

true

LayerEditConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

ja

LayerFlattenConfig

Flatten the layer hierarchy.

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

level

int

flatten level

ja

useGroups

bool

use group names (true) or image layer names (false)

nein

false

LayerGridConfig

Grid configuration for caches and tiled data

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

metaBuffer

int

pixel buffer

nein

0

metaSize

int

number of meta-tiles to fetch

nein

0

origin

str

position of the first tile (nw or sw)

nein

“nw”

tileSize

int

tile size

nein

256

LayerGroupConfig

Gruppenlayer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

layers

[LayerConfig…]

Layer in dieser Gruppe

ja

legend

LayerLegendConfig

legend configuration

nein

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

search

SearchConfig

Layer-Suchkonfiguration

nein

title

str

Layertitel

nein

type

str

“group”

ja

uid

str

Eindeutige Layer-ID

nein

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerLegendConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

enabled

bool

nein

true

url

url

nein

LayerOsmConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

legend

LayerLegendConfig

legend configuration

nein

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

search

SearchConfig

Layer-Suchkonfiguration

nein

title

str

Layertitel

nein

type

str

“osm”

ja

uid

str

Eindeutige Layer-ID

nein

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerQgisConfig

automatische QGIS-Layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

cache

LayerCacheConfig

Cache-Konfiguration

nein

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

directRender

[str…]

QGIS providers that should be rendered directly

nein

directSearch

[str…]

QGIS providers that should be searched directly

nein

display

LayerDisplayMode

layer display mode

nein

“box”

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

flatten

LayerFlattenConfig

flatten the layer hierarchy

nein

grid

LayerGridConfig

Rasterkonfiguration

nein

imageFormat

LayerImageFormat

image format

nein

“png8”

legend

LayerLegendConfig

legend configuration

nein

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

path

filepath

path to a qgs project file

ja

search

SearchConfig

Layer-Suchkonfiguration

nein

sourceLayers

SourceLayerFilterConfig

Zu verwendende Quelllayer

nein

title

str

Layertitel

nein

type

str

“qgis”

ja

uid

str

Eindeutige Layer-ID

nein

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerQgiswmsConfig

WMS layer from a Qgis project

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

cache

LayerCacheConfig

Cache-Konfiguration

nein

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

display

str

nein

“box”

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

grid

LayerGridConfig

Rasterkonfiguration

nein

imageFormat

LayerImageFormat

image format

nein

“png8”

legend

LayerLegendConfig

legend configuration

nein

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

path

filepath

qgis project path

ja

search

SearchConfig

Layer-Suchkonfiguration

nein

sourceLayers

SourceLayerFilterConfig

source layers to use

nein

title

str

Layertitel

nein

type

str

“qgiswms”

ja

uid

str

Eindeutige Layer-ID

nein

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerSqlConfig

SQL-based layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

dataModel

[AttributeConfig…]

nein

db

str

database provider uid

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

edit

LayerEditConfig

editing permissions

nein

editStyle

StyleProps

style for features being edited

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

legend

LayerLegendConfig

legend configuration

nein

loadingStrategy

str

loading strategy for features (‘all’, ‘bbox’)

nein

“all”

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

search

SearchConfig

Layer-Suchkonfiguration

nein

style

StyleProps

style for features

nein

table

SqlTableConfig

sql table configuration

ja

title

str

Layertitel

nein

type

str

“sql”

ja

uid

str

Eindeutige Layer-ID

nein

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerTileConfig

Titel-Layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

cache

LayerCacheConfig

Cache-Konfiguration

nein

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

display

LayerDisplayMode

layer display mode

nein

“tile”

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

grid

LayerGridConfig

Rasterkonfiguration

nein

imageFormat

LayerImageFormat

image format

nein

“png8”

legend

LayerLegendConfig

legend configuration

nein

maxRequests

int

max concurrent requests to this source

nein

0

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

search

SearchConfig

Layer-Suchkonfiguration

nein

service

LayerTileServiceConfig

service configuration

nein

title

str

Layertitel

nein

type

str

“tile”

ja

uid

str

Eindeutige Layer-ID

nein

url

url

rest url with placeholders {x}, {y} and {z}

ja

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerTileServiceConfig

Tile service configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

crs

crsref

service CRS

nein

“EPSG:3857”

extent

Extent

service extent

nein

origin

str

position of the first tile (nw or sw)

nein

“nw”

tileSize

int

tile size

nein

256

LayerWfsConfig

WFS layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

capsCacheMaxAge

duration

max cache age for capabilities documents

nein

“1d”

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

dataModel

[AttributeConfig…]

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

edit

LayerEditConfig

editing permissions

nein

editStyle

StyleProps

style for features being edited

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

invertAxis

[crsref…]

projections that have an inverted axis (yx)

nein

legend

LayerLegendConfig

legend configuration

nein

loadingStrategy

str

loading strategy for features (‘all’, ‘bbox’)

nein

“all”

maxRequests

int

max concurrent requests to this source

nein

0

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

search

SearchConfig

Layer-Suchkonfiguration

nein

sourceLayers

SourceLayerFilterConfig

source layers to use

nein

style

StyleProps

style for features

nein

title

str

Layertitel

nein

type

str

“wfs”

ja

uid

str

Eindeutige Layer-ID

nein

url

url

service url

ja

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerWmsConfig

WMS layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

cache

LayerCacheConfig

Cache-Konfiguration

nein

capsCacheMaxAge

duration

max cache age for capabilities documents

nein

“1d”

capsLayersBottomUp

bool

layers are listed from bottom to top in the GetCapabilities document

nein

false

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

display

LayerDisplayMode

layer display mode

nein

“box”

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

getMapParams

dict

additional parameters for GetMap requests

nein

grid

LayerGridConfig

Rasterkonfiguration

nein

imageFormat

LayerImageFormat

image format

nein

“png8”

invertAxis

[crsref…]

projections that have an inverted axis (yx)

nein

legend

LayerLegendConfig

legend configuration

nein

maxRequests

int

max concurrent requests to this source

nein

0

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

search

SearchConfig

Layer-Suchkonfiguration

nein

sourceLayers

SourceLayerFilterConfig

source layers to use

nein

title

str

Layertitel

nein

type

str

“wms”

ja

uid

str

Eindeutige Layer-ID

nein

url

url

service url

ja

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

LayerWmtsConfig

WMTS layer

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

cache

LayerCacheConfig

Cache-Konfiguration

nein

capsCacheMaxAge

duration

max cache age for capabilities documents

nein

“1d”

clientOptions

LayerClientOptions

Optionen für die Layeranzeige im Client

nein

description

TemplateConfig

Vorlage für die Layerbeschreibung

nein

display

LayerDisplayMode

layer display mode

nein

“tile”

edit

LayerEditConfig

editing permissions

nein

extent

Extent

Layerausmasse

nein

extentBuffer

int

extent buffer

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

grid

LayerGridConfig

Rasterkonfiguration

nein

imageFormat

LayerImageFormat

image format

nein

“png8”

legend

LayerLegendConfig

legend configuration

nein

maxRequests

int

max concurrent requests to this source

nein

0

meta

MetaConfig

Layermetadaten

nein

opacity

float

Layertransparenz

nein

1

params

dict

query string parameters

nein

search

SearchConfig

Layer-Suchkonfiguration

nein

sourceLayer

str

WMTS layer name

nein

sourceStyle

str

WMTS style name

nein

“default”

title

str

Layertitel

nein

type

str

“wmts”

ja

uid

str

Eindeutige Layer-ID

nein

url

url

service url

ja

zoom

ZoomConfig

Layeraufloesungen und Massstaebe

nein

MapConfig

Kartenkonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

center

Point

Kartenmitte

nein

coordinatePrecision

int

precision for coordinates

nein

crs

crsref

KBS fuer diese Karte

nein

“EPSG:3857”

extent

Extent

Layerausmasse

ja

extentBuffer

int

extent buffer

nein

layers

[LayerConfig…]

Sammlung von Layern fuer diese Karte

ja

title

str

Kartentitel

nein

uid

str

Eindeutige ID

nein

zoom

ZoomConfig

Kartenmassstaebe und Aufloesungen

nein

MetaConfig

Object metadata configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

abstract

str

object abstract description

nein

attribution

str

attribution (copyright) string

nein

contact

MetaContactConfig

contact information

nein

image

url

image (logo) url

nein

images

dict

further images

nein

keywords

[str…]

keywords

nein

[]

name

str

object internal name

nein

title

str

object title

nein

url

url

object metadata url

nein

MetaContactConfig

Object metadata configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

address

str

nein

area

str

nein

city

str

nein

country

str

nein

email

str

nein

fax

str

nein

organization

str

nein

person

str

nein

phone

str

nein

position

str

nein

zip

str

nein

Point

Point coordinates [x, y]

PrinterConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

templates

[TemplateConfig…]

ja

ProjectConfig

Projektkonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

api

ApiConfig

project-specific actions

nein

assets

DocumentRootConfig

projektspezifische Anlagemoeglichkeiten

nein

client

ClientConfig

Projektspezifische GBD WebSuite Client Konfiguration

nein

description

TemplateConfig

Vorlage fuer die Projektbeschreibung

nein

locale

str

Projektsprache

nein

map

MapConfig

Kartenkonfiguration

nein

meta

MetaConfig

project metadata

nein

multi

regex

true, wenn dies eine Multiprojektvorlage ist

nein

overviewMap

MapConfig

Uebersicht Kartenkonfiguration

nein

printer

PrinterConfig

Druckkonfiguration

nein

search

SearchConfig

Projektweite Suchkonfiguration

nein

title

str

Projekttitel

nein

uid

str

Eindeutige ID

nein

SearchConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

enabled

bool

search is enabled

nein

true

providers

[SearchProviderConfig…]

list of search prodivers

nein

SearchProviderNominatimConfig

nominatim (OSM) Suchanbieter

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

country

str

Land, um die Suche einzuschraenken

nein

defaultContext

str

Standardmaeßiger raeumlicher Kontext

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

language

str

Sprache der Ergebnisseausgabe

nein

title

str

Titel der Suchergebnisse

nein

type

str

“nominatim”

ja

uid

str

unique ID

nein

SearchProviderQgispostgresConfig

Qgis/Postgres automatic search provider

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

defaultContext

str

Standardmaeßiger raeumlicher Kontext

nein

ds

dict

qgis data source

ja

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

title

str

Titel der Suchergebnisse

nein

type

str

“qgispostgres”

ja

uid

str

unique ID

nein

SearchProviderQgiswmsConfig

Qgis/WMS automatic search provider

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

defaultContext

str

Standardmaeßiger raeumlicher Kontext

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

path

filepath

project path

ja

sourceLayers

SourceLayerFilterConfig

source layers to use

nein

title

str

Titel der Suchergebnisse

nein

type

str

“qgiswms”

ja

uid

str

unique ID

nein

SearchProviderSqlConfig

Datenbankbasierte Suche

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

db

str

Datenbankanbieter UID

nein

defaultContext

str

Standardmaeßiger raeumlicher Kontext

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

geometryRequired

bool

nein

false

keywordRequired

bool

nein

false

sort

str

Sortierausdruck

nein

table

SqlTableConfig

SQL-Tabellenkonfiguration

ja

title

str

Titel der Suchergebnisse

nein

type

str

“sql”

ja

uid

str

unique ID

nein

SearchProviderWfsConfig

WMS search

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

capsCacheMaxAge

duration

max cache age for capabilities documents

nein

“1d”

defaultContext

str

Standardmaeßiger raeumlicher Kontext

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

invertAxis

[crsref…]

projections that have an inverted axis (yx)

nein

maxRequests

int

max concurrent requests to this source

nein

0

sourceLayers

SourceLayerFilterConfig

source layers to use

nein

title

str

Titel der Suchergebnisse

nein

type

str

“wfs”

ja

uid

str

unique ID

nein

url

url

service url

ja

SearchProviderWmsConfig

WMS-basierte Suche

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

access

[AccessRuleConfig…]

Zugriffsrechte

nein

capsCacheMaxAge

duration

max cache age for capabilities documents

nein

“1d”

capsLayersBottomUp

bool

layers are listed from bottom to top in the GetCapabilities document

nein

false

defaultContext

str

Standardmaeßiger raeumlicher Kontext

nein

featureFormat

FormatConfig

Objekt-Formatierungsoptionen

nein

invertAxis

[crsref…]

projections that have an inverted axis (yx)

nein

maxRequests

int

max concurrent requests to this source

nein

0

sourceLayers

SourceLayerFilterConfig

source layers to use

nein

title

str

Titel der Suchergebnisse

nein

type

str

“wms”

ja

uid

str

unique ID

nein

url

url

service url

ja

ServerConfig

Servermodul-Konfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

autoRun

str

shell command to run before server start

nein

logLevel

LogLevel

Protokollierungsstufe

nein

“INFO”

mapproxy

ServerMapproxyConfig

gebuendeltes Mapproxy-Modul

nein

qgis

ServerQgisConfig

gebuendeltes QGIS-Modul

nein

spool

ServerSpoolConfig

Spool-Server-Modul

nein

timeout

duration

Server-Timeout

nein

60

web

ServerWebConfig

Webserver-Modul

nein

ServerMapproxyConfig

Mapproxy-Server-Modul

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

enabled

bool

Das Modul ist aktiviert

nein

true

host

str

nein

“localhost”

port

int

nein

5000

threads

int

Anzahl der Threads fuer dieses Modul

nein

0

workers

int

Anzahl der Worker fuer dieses Modul

nein

4

ServerQgisConfig

Enthaltenes QGIS-Servermodul

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

debug

int

QGIS_DEBUG (Umgebungsvariable)

nein

0

enabled

bool

Das Modul ist aktiviert

nein

true

host

str

nein

“localhost”

legend

dict

default legend settings

nein

maxCacheLayers

int

MAX_CACHE_LAYERS (Umgebungsvariable)

nein

4000

maxRequests

int

max gleichzeitige Requests an diesen Server

nein

6

port

int

nein

4000

searchPathsForSVG

[dirpath…]

searchPathsForSVG (Ini-Einstellung)

nein

serverCacheSize

int

QGIS_SERVER_CACHE_SIZE (Umgebungsvariable)

nein

10000000

serverLogLevel

int

QGIS_SERVER_LOG_LEVEL (Umgebungsvariable)

nein

2

threads

int

Anzahl der Threads fuer dieses Modul

nein

0

workers

int

Anzahl der Worker fuer dieses Modul

nein

4

ServerSpoolConfig

Spool-Server-Modul

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

enabled

bool

Das Modul ist aktiviert

nein

true

jobFrequency

duration

Haeufigkeit von Hintergrundjobs

nein

3

monitorFrequency

duration

Dateisystemaenderungen ueberpruefen die Haeufigkeit

nein

30

threads

int

Anzahl der Threads fuer dieses Modul

nein

0

workers

int

Anzahl der Worker fuer dieses Modul

nein

4

ServerWebConfig

Webserver-Modul

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

enabled

bool

Das Modul ist aktiviert

nein

true

threads

int

Anzahl der Threads fuer dieses Modul

nein

0

workers

int

Anzahl der Worker fuer dieses Modul

nein

4

SourceLayerFilterConfig

Layerfilter

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

level

int

use layers at this level

nein

0

names

[str…]

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

nein

pattern

regex

match a pattern against the layer full path

nein

SqlTableConfig

SQL Datenbanktabelle

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

geometryColumn

str

Name der Geometriespalte

nein

keyColumn

str

Name der Primary-Key-Spalte

nein

name

str

Tabellenname

ja

searchColumn

str

Spalte, nach der gesucht werden soll

nein

StorageSqliteConfig

Sqlite-based storage

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

path

str

nein

type

str

“sqlite”

ja

StyleProps

Objektstil

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

content

dict

CSS Regeln

nein

text

str

raw style content

nein

type

str

Stiltyp (“css”)

ja

TemplateConfig

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

dataModel

[AttributeConfig…]

Vom Benutzer editierbare Vorlagenattribute

nein

path

filepath

Pfad zu einer Vorlagendatei

nein

qualityLevels

[TemplateQualityLevel…]

Liste der von der Vorlage unterstützten Qualitätsstufen

nein

text

str

Vorlageninhalt

nein

title

str

Vorlagentitel

nein

type

str

Vorlagentyp

ja

uid

str

unique id

nein

TemplateHtmlConfig

HTML Vorlage

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

dataModel

[AttributeConfig…]

Vom Benutzer editierbare Vorlagenattribute

nein

path

filepath

Pfad zu einer Vorlagendatei

nein

qualityLevels

[TemplateQualityLevel…]

Liste der von der Vorlage unterstützten Qualitätsstufen

nein

text

str

Vorlageninhalt

nein

title

str

Vorlagentitel

nein

type

str

“html”

ja

uid

str

unique id

nein

TemplateQgisConfig

QGIS Drucktemplate

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

dataModel

[AttributeConfig…]

Vom Benutzer editierbare Vorlagenattribute

nein

path

filepath

ja

qualityLevels

[TemplateQualityLevel…]

Liste der von der Vorlage unterstützten Qualitätsstufen

nein

text

str

Vorlageninhalt

nein

title

str

Vorlagentitel

nein

type

str

“qgis”

ja

uid

str

unique id

nein

TemplateQualityLevel

benannte Qualitaetsstufe fuer Vorlagen

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

dpi

int

DPI-Wert

ja

name

str

Levelname

nein

WebSiteConfig

Site (virtual host) configuration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

assets

DocumentRootConfig

assets location and options

nein

cors

WebSiteCorsConfig

cors configuration

nein

errorPage

TemplateConfig

error page template

nein

host

str

host name

nein

“*”

reversedRewrite

[WebSiteRewriteRule…]

reversed rewrite rules

nein

reversedUrl

str

base url for reversed addresses

nein

rewrite

[WebSiteRewriteRule…]

rewrite rules

nein

root

DocumentRootConfig

document root location and options

ja

WebSiteCorsConfig

CORS options

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

allowCredentials

bool

nein

false

allowHeaders

[str…]

nein

allowOrigin

str

nein

“*”

enabled

bool

nein

false

WebSiteRewriteRule

Rewrite rule

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

match

regex

expression to match the url against

ja

options

dict

additional options

nein

target

str

target url with placeholders

ja

ZoomConfig

Zoom- und Aufloesungskonfiguration

Eigenschaften:

Name

Typ

Erforderlich

Defaultwert

initResolution

float

Ausgangsaufloesung

nein

initScale

float

Ausgangsmassstab

nein

maxResolution

float

maximale Aufloesung

nein

maxScale

float

maximaler Massstab

nein

minResolution

float

Minimale Aufloesung

nein

minScale

float

Minimaler Massstab

nein

resolutions

[float…]

Erlaubte Aufloesungen

nein

scales

[float…]

Erlaubte Massstaebe

nein

AccessType

Einer von:

  • “allow”

  • “deny”

AuthProviderConfig

Einer von:

DbProviderConfig

Einer von:

LayerDisplayMode

Layer display mode

Einer von:

  • “box”

  • “tile”

LayerImageFormat

Image format

Einer von:

  • “png24”

  • “png8”

LogLevel

Einer von:

  • “ALL”

  • “CRITICAL”

  • “DEBUG”

  • “ERROR”

  • “INFO”

  • “NOTSET”

  • “WARN”

StorageConfig

Einer von:

TemplateConfig

Einer von: