<title>QWC OGC Service</title>
QWC OGC Service
Type: objectJSON 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: constSpecific value:
"ogc"
Config options
Type: objectNo Additional Properties
Data service URL (external) for constructing attachment urls in GetFeatureInfo responses. Default: /api/v1/data/
Default HTML info template. Default: null
Path to the default HTML info template. Default: null
Default base URL for WMS/WFS requests. Default: http://localhost:8001/ows
Path where custom info templates are store. Default: /info_templates/
Default base URL for OGC API requests. Default: http://localhost:8001/wfs3
If qgs_resources are placed in tenant specific subdirs, set this property to the respective subdir path portion. Default: <empty>
Login verification URL for requests with basic auth. Example: http://qwc-auth-service:9090/verify_login. Default: null
Each item of this array must be:
URL to auth service, used for login redirects. Default: /auth/
Network timeout for requests forwarded to the QGIS Server, in seconds. Default: 30
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
Whether to enforce authentication before processing requests. Default: false
Optional: List of paths that will be accessible without a JWT identity, if auth_required is set. Default: []
Each item of this array must be:
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).
The marker SLD template
Optional: Marker parameter definitions
Each additional property must conform to the following schema
Type: objectNo Additional Properties
Default value
Parameter type (number, color, string)
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: stringDefault font size for GetLegendGraphic request. Default: null
Path to legend images (required if using legend_image). Default: /legends/
No Additional Items
Each item of this array must be:
No Additional Properties
Name of field to inject into print params.
Value of field to inject into print params. May contain $username$, which will be replaced with the current user name.
No Additional Items
Each item of this array must be:
No Additional Properties
DB url
SQL Query. May contain $username$, which will be replaced with the current user name.
Names of params to inject into the print params, in order of the values returned by the query.
No Additional ItemsEach item of this array must be:
Optional QGIS project name postfix, to use a different project when printing. Default: ``
Whether to transform image URLs to inline images in feature info responses. Default: true
Whether to skip empty feature attributes in feature info responses. Default: false
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
Conversion rules for feature info date attribute values.
No Additional PropertiesThe parse format string, passed to datetime.strptime. Example: %Y-%m-%d.
The result format string which which to format the datetime object. Example: %d.%m.%Y.
The link text to use for URLs transformed to hyperlinks in info HTML output. You can use \1 to refer to the link itself. Default: \1.
Resources
Type: objectWMS services
Type: array of objectNo Additional Items
Each item of this array must be:
WMS service
Type: objectWMS service with nested layers and group layers
No Additional PropertiesWMS service name
WMS service title
Custom WMS URL if different from default_qgis_server_url
Custom OnlineResources shown in GetCapabilities
No Additional PropertiesDefault public base URL for OnlineResources
Public base URL for FeatureInfo OnlineResources
Public base URL for Legend OnlineResources
Public base URL for editConfig OnlineResource
Root layer of WMS (layer or group layer)
WMS Layer
Type: objectSingle layer
No Additional PropertiesWMS layer name
Layer type
Specific value:"layer"
Layer title
No Additional Items
Each item of this array must be:
No Additional Properties
Attribute name
Formatting expression for converting attribute values
Formatting expression for converting attribute values, in Base64 encoding
JSON attribute aliases
Type: array of objectAliases for attributes in JSON values of type list
No Additional ItemsEach item of this array must be:
No Additional Properties
Attribute name in JSON value
Alias for attribute in JSON value
Info template
Info template for WMS GetFeatureInfo
No Additional PropertiesSpecific value:
"wms"
Custom WMS URL if different from default_qgis_server_url
Inline HTML template for info result
Inline HTML template for info result, in Base64 encoding
Path to HTML template for info result
Info template for DB Query
No Additional PropertiesThe following properties are required:
- type
- db_url
- sql
The following properties are required:
- type
- db_url
- sql_base64
Specific value:
"sql"
Database connection string
Query SQL
Feature ID column name
Feature WKT geometry column name
Feature BBOX column name
Query SQL in Base64 encoding
HTML template for info result
HTML template for info result, in Base64 encoding
Path to HTML template for info result
Info template using WMS GetFeatureInfo
No Additional PropertiesSpecific value:
"module"
Custom info module name
HTML template for info result
HTML template for info result, in Base64 encoding
Path to HTML template for info result.
Display field
Type: stringShow value of this attribute in feature result header
Feature report
Type: stringName of corresponding feature report
Whether this layer is queryable
Custom base opacity from 0-100 (Hidden sublayers only)
Edit layers below this level
No Additional ItemsEach item of this array must be:
Legend image path relative to 'legendimagespath'
Legend image in Base64 encoding
WMS Group Layer
Type: objectGroup layer with nested sublayers
No Additional PropertiesWMS group layer name
Layer type
Specific value:"layergroup"
Group title
Sublayers of this group layer (layers or group layers)
No Additional ItemsEach item of this array must be:
Hide sublayers of this group layer if set, to make the group layer look like a regular layer (Facade layer)
Edit layers below this level
No Additional ItemsEach item of this array must be:
Custom WMS URL for printing, e.g. if using a separate QGIS project.
Available print templates
No Additional ItemsEach item of this array must be:
Default font size for GetLegendGraphic request
Internal layer names used for printing and raster export of background and external layers
No Additional ItemsEach item of this array must be:
WFS services
Type: array of objectNo Additional Items
Each item of this array must be:
WFS service
Type: objectWFS service with list of layers
No Additional PropertiesWFS service name
WFS service title
Custom WFS URL if different from default_qgis_server_url
Custom OnlineResource shown in GetCapabilities
List of WFS layers
No Additional ItemsEach item of this array must be:
WFS Layer
Type: objectSingle layer
No Additional PropertiesWFS layer name
No Additional Items
Each item of this array must be:
No Additional Properties
Attribute name