<title>QWC OGC Service</title>

QWC OGC Service

Type: object

JSON Schema

Type: stringFormat: uri Default: "https://raw.githubusercontent.com/qwc-services/qwc-ogc-service/master/schemas/qwc-ogc-service.json"

Reference to JSON schema of this config

Service name

Type: const
Specific value: "ogc"

Config options

Type: object
No Additional Properties

Type: string

Data service URL (external) for constructing attachment urls in GetFeatureInfo responses. Default: /api/v1/data/

Type: string

Default HTML info template. Default: null

Type: string

Path to the default HTML info template. Default: null

Type: string

Default base URL for WMS/WFS requests. Default: http://localhost:8001/ows

Type: string

Path where custom info templates are store. Default: /info_templates/

Type: string

Default base URL for OGC API requests. Default: http://localhost:8001/wfs3

Type: string

If qgs_resources are placed in tenant specific subdirs, set this property to the respective subdir path portion. Default: <empty>

Type: array of string

Login verification URL for requests with basic auth. Example: http://qwc-auth-service:9090/verify_login. Default: null

No Additional Items

Each item of this array must be:

Type: string

URL to auth service, used for login redirects. Default: /auth/

Type: number

Network timeout for requests forwarded to the QGIS Server, in seconds. Default: 30

Type: string

Name of the GET parameter through which the active QWC user will be sent to QGIS Server, to be used i.e. in plugins. Default: QWC_USERNAME

Type: boolean

Whether to enforce authentication before processing requests. Default: false

Type: array of string

Optional: List of paths that will be accessible without a JWT identity, if auth_required is set. Default: []

No Additional Items

Each item of this array must be:

Type: number

The maximum limit for OGC API Features requests. Default: 10000. Must be less or equal the QGIS Server QGIS_SERVER_API_WFS3_MAX_LIMIT Env-Var value (which defaults to 10000).

Type: string

The marker SLD template

Type: object

Optional: Marker parameter definitions

Each additional property must conform to the following schema

Type: object
No Additional Properties

Type: string or number

Default value

Type: string

Parameter type (number, color, string)

Type: object

Optional: List of extra WFS formats allowed (and their content type) in OUTPUTFORMAT parameter ; but data will be unfiltered.

Each additional property must conform to the following schema

Type: string

Type: number

Default font size for GetLegendGraphic request. Default: null

Type: string

Path to legend images (required if using legend_image). Default: /legends/

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

Name of field to inject into print params.

Type: string

Value of field to inject into print params. May contain $username$, which will be replaced with the current user name.

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

SQL Query. May contain $username$, which will be replaced with the current user name.

Type: array of string

Names of params to inject into the print params, in order of the values returned by the query.

No Additional Items

Each item of this array must be:

Type: string

Optional QGIS project name postfix, to use a different project when printing. Default: ``

Type: boolean

Whether to transform image URLs to inline images in feature info responses. Default: true

Type: boolean

Whether to skip empty feature attributes in feature info responses. Default: false

Type: boolean

Whether to order attributes in GetFeatureInfo responses according to order in the resource definition, rather than the order returned by the QGIS Server. Default: false

Type: object

Conversion rules for feature info date attribute values.

No Additional Properties

Type: string

The parse format string, passed to datetime.strptime. Example: %Y-%m-%d.

Type: string

The result format string which which to format the datetime object. Example: %d.%m.%Y.

Resources

Type: object

WMS services

Type: array of object
No Additional Items

Each item of this array must be:

WMS service

Type: object

WMS service with nested layers and group layers

No Additional Properties

Type: string

WMS service name

Type: string

WMS service title

Type: string

Custom WMS URL if different from default_qgis_server_url

Type: object

Custom OnlineResources shown in GetCapabilities

No Additional Properties

Type: string

Default public base URL for OnlineResources

Type: string

Public base URL for FeatureInfo OnlineResources

Type: string

Public base URL for Legend OnlineResources

Type: string

Public base URL for editConfig OnlineResource


Root layer of WMS (layer or group layer)

WMS Layer

Type: object

Single layer

No Additional Properties

Type: string

WMS layer name

Type: const

Layer type

Specific value: "layer"

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

Formatting expression for converting attribute values

Type: string

Formatting expression for converting attribute values, in Base64 encoding

JSON attribute aliases

Type: array of object

Aliases for attributes in JSON values of type list

No Additional Items

Each item of this array must be:

Info template


Type: object

Info template for WMS GetFeatureInfo

No Additional Properties

Type: string

Custom WMS URL if different from default_qgis_server_url

Type: string

Inline HTML template for info result

Type: string

Inline HTML template for info result, in Base64 encoding

Type: string

Path to HTML template for info result

Type: object

Info template for DB Query

No Additional Properties

Type: object

The following properties are required:

  • type
  • db_url
  • sql
Type: object

The following properties are required:

  • type
  • db_url
  • sql_base64

Type: string Default: "_fid_"

Feature ID column name

Type: string Default: "wkt_geom"

Feature WKT geometry column name

Type: string Default: "bbox"

Feature BBOX column name

Type: string

HTML template for info result, in Base64 encoding

Type: string

Path to HTML template for info result

Type: object

Info template using WMS GetFeatureInfo

No Additional Properties

Type: string

HTML template for info result, in Base64 encoding

Type: string

Path to HTML template for info result.

Display field

Type: string

Show value of this attribute in feature result header

Feature report

Type: string

Name of corresponding feature report

Type: boolean

Whether this layer is queryable

Type: integer

Custom base opacity from 0-100 (Hidden sublayers only)

Type: array of string

Edit layers below this level

No Additional Items

Each item of this array must be:

Type: string

Legend image path relative to 'legendimagespath'

Type: string

Legend image in Base64 encoding

WMS Group Layer

Type: object

Group layer with nested sublayers

No Additional Properties

Type: string

WMS group layer name

Type: const

Layer type

Specific value: "layergroup"

Type: boolean

Hide sublayers of this group layer if set, to make the group layer look like a regular layer (Facade layer)

Type: array of string

Edit layers below this level

No Additional Items

Each item of this array must be:

Type: boolean

Whether the resource should be hidden from the landing page

Type: string

Custom WMS URL for printing, e.g. if using a separate QGIS project.

Type: array of string

Available print templates

No Additional Items

Each item of this array must be:

Type: number

Default font size for GetLegendGraphic request

Type: array of string

Internal layer names used for printing and raster export of background and external layers

No Additional Items

Each item of this array must be:

WFS services

Type: array of object
No Additional Items

Each item of this array must be:

WFS service

Type: object

WFS service with list of layers

No Additional Properties

Type: string

WFS service name

Type: string

WFS service title

Type: string

Custom WFS URL if different from default_qgis_server_url

Type: string

Custom OnlineResource shown in GetCapabilities

Type: array

List of WFS layers

No Additional Items

Each item of this array must be:

WFS Layer

Type: object

Single layer

No Additional Properties

Type: string

WFS layer name

Type: array of object
No Additional Items

Each item of this array must be:

Type: boolean

Whether the resource should be hidden from the landing page