testingEnglish

TABLE OF CONTENTS (../../INDEX.HTML)

USER GUIDE/MANUAL (QGIS TESTING!) (../INDEX.HTML)

Preamble (../preamble/preamble.html)

Conventions (../preamble/conventions.html)

Foreword (../preamble/foreword.html)

Features (../preamble/features.html)

What’s new in QGIS 2.8 (../preamble/whats_new.html)

Getting Started (../introduction/getting_started.html)

QGIS GUI (../introduction/qgis_gui.html)

General Tools (../introduction/general_tools.html)

QGIS Configuration (../introduction/qgis_configuration.html)

Working with Projections (../working_with_projections/working_with_projections.html)

QGIS Browser (../qgis_browser/qgis_browser.html)

Working with Vector Data (../working_with_vector/index.html)

Working with Raster Data (../working_with_raster/index.html)

Working with OGC Data (index.html)

Working with GPS Data (../working_with_gps/index.html)

GRASS GIS Integration (../grass_integration/grass_integration.html)

QGIS processing framework (../processing/index.html)

Processing providers and algorithms (../processing_algs/index.html)

Print Composer (../print_composer/index.html)

Plugins (../plugins/plugins_index.html)

Help and Support (../preamble/help_and_support.html)

Appendix (../appendices/appendices.html)

Literature and Web References (../literature_web/literature_and_web_references.html)

USER GUIDE/MANUAL PDF’S (HTTP://DOCS.QGIS.ORG/TESTING/PDF/)

PYQGIS COOKBOOK (QGIS TESTING!) (../../PYQGIS_DEVELOPER_COOKBOOK/INDEX.HTML)

DOCUMENTATION GUIDELINES (../../DOCUMENTATION_GUIDELINES/INDEX.HTML)

A GENTLE INTRODUCTION IN GIS (../../GENTLE_GIS_INTRODUCTION/INDEX.HTML)

TRAININGS MANUAL (../../TRAINING_MANUAL/INDEX.HTML)

Docs for ‘QGIS testing’. Visit http://docs.qgis.org/2.8 for QGIS 2.8 docs and translations.

QGIS as OGC Data ServerQGIS Server is an open source WMS 1.3, WFS 1.0.0 and WCS 1 1.1.1 implementation that, in addition,implements advanced cartographic features for thematic mapping. The QGIS Server is a FastCGI/CGI(Common Gateway Interface) application written in C++ that works together with a web server (e.g.,Apache, Lighttpd). It has Python plugin support allowing for fast and efficient development anddeployment of new features. The original development of QGIS Server was funded by the EU projectsOrchestra, Sany and the city of Uster in Switzerland.

QGIS Server uses QGIS as back end for the GIS logic and for map rendering. Furthermore, the Qt libraryis used for graphics and for platform­independent C++ programming. In contrast to other WMS software,the QGIS Server uses cartographic rules as a configuration language, both for the server configurationand for the user­defined cartographic rules.

As QGIS desktop and QGIS Server use the same visualization libraries, the maps that are published onthe web look the same as in desktop GIS.

In the following sections, we will provide a sample configuration to set up a QGIS Server onDebian/Ubuntu Linux. For user contributed installation instructions on other platforms or distributions, werecommend to read one of the following URLs:

http://hub.qgis.org/projects/quantum­gis/wiki/QGIS_Server_Tutorial(http://hub.qgis.org/projects/quantum­gis/wiki/QGIS_Server_Tutorial)http://linfiniti.com/2010/08/qgis­mapserver­a­wms­server­for­the­masses/(http://linfiniti.com/2010/08/qgis­mapserver­a­wms­server­for­the­masses/)http://www.itopen.it/qgis­server­python­plugins­ubuntu­setup/ (http://www.itopen.it/qgis­server­python­plugins­ubuntu­setup/)

QGIS Server installation on Debian/UbuntuAt this point, we will give a short and simple sample installation how­to for a minimal working configurationusing Apache2 on Debian Squeeze (or with negligible variations on Ubuntu 14.04). Many other OSsprovide packages for QGIS Server, too. If you have to build it all from source, please refer to the URLsabove.

Firstly, add the following debian GIS repository by adding the following repository:

$ cat /etc/apt/sources.list.d/debian­gis.list

deb http://qgis.org/debian trusty main

deb­src http://qgis.org/debian trusty main

$ # Add keys

$ sudo gpg ­­recv­key DD45F6C3

$ sudo gpg ­­export ­­armor DD45F6C3 | sudo apt­key add ­

$ # Update package list

$ sudo apt­get update && sudo apt­get upgrade

Now, install QGIS Server:

$ sudo apt­get install qgis­server python­qgis

Installation of a HelloWorld example plugin for testing the servers. You create a directory to hold serverplugins. This will be specified in the virtual host configuration and passed on to the server through anenvironment variable:

$ sudo mkdir ­p /opt/qgis­server/plugins

$ cd /opt/qgis­server/plugins

$ sudo wget https://github.com/elpaso/qgis­helloserver/archive/master.zip

$ # In case unzip was not installed before:

$ sudo apt­get install unzip

$ sudo unzip master.zip

$ sudo mv qgis­helloserver­master HelloServer

Install the Apache server in a separate virtual host listening on port 80. Enable the rewrite module to passHTTP BASIC auth headers:

$ sudo a2enmod rewrite

$ cat /etc/apache2/conf­available/qgis­server­port.conf

Listen 80

$ sudo a2enconf qgis­server­port

This is the virtual host configuration, stored in /etc/apache2/sites­available/001­qgis­server.conf :

<VirtualHost *:80>

ServerAdmin webmaster@localhost

DocumentRoot /var/www/html

ErrorLog $APACHE_LOG_DIR/qgis­server­error.log

CustomLog $APACHE_LOG_DIR/qgis­server­access.log combined

# Longer timeout for WPS... default = 40

FcgidIOTimeout 120

FcgidInitialEnv LC_ALL "en_US.UTF­8"

FcgidInitialEnv PYTHONIOENCODING UTF­8

FcgidInitialEnv LANG "en_US.UTF­8"

FcgidInitialEnv QGIS_DEBUG 1

FcgidInitialEnv QGIS_SERVER_LOG_FILE /tmp/qgis­000.log

FcgidInitialEnv QGIS_SERVER_LOG_LEVEL 0

FcgidInitialEnv QGIS_PLUGINPATH "/opt/qgis­server/plugins"

# Needed for QGIS HelloServer plugin HTTP BASIC auth

<IfModule mod_fcgid.c>

RewriteEngine on

RewriteCond %HTTP:Authorization .

RewriteRule .* ­ [E=HTTP_AUTHORIZATION:%HTTP:Authorization]

</IfModule>

ScriptAlias /cgi­bin/ /usr/lib/cgi­bin/

<Directory "/usr/lib/cgi­bin">

AllowOverride All

Options +ExecCGI ­MultiViews +FollowSymLinks

# for apache2 > 2.4

Require all granted

#Allow from all

</Directory>

</VirtualHost>

Now enable the virtual host and restart Apache:

$ sudo a2ensite 001­qgis­server

$ sudo service apache2 restart

Test the server with the HelloWorld plugin:

$ wget ­q ­O ­ "http://localhost/cgi­bin/qgis_mapserv.fcgi?SERVICE=HELLO"

HelloServer!

You can have a look at the default GetCpabilities of the QGIS server at:http://localhost/cgi­bin/qgis_mapserv.fcgi?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetCapabilities

Tip

If you work with a feature that has many nodes then modifying and adding a new feature will fail. In thiscase it is possible to insert the following code into the 001­qgis­server.conf file:

<IfModule mod_fcgid.c>

FcgidMaxRequestLen 26214400

FcgidConnectTimeout 60

</IfModule>

Creating a WMS/WFS/WCS server from aQGIS projectTo provide a new QGIS Server WMS, WFS or WCS, we have to create a QGIS project file with somedata. Here, we use the ‘Alaska’ shapefile from the QGIS sample dataset. Define the colors and styles ofthe layers in QGIS and the project CRS, if not already defined.

Figure Server 2:

Definitions for a QGIS Server WMS/WFS/WCS project (KDE)

Then, go to the OWS Server menu of the Project ‣ Project Properties dialog and provide someinformation about the OWS in the fields under Service Capabilities . This will appear in theGetCapabilities response of the WMS, WFS or WCS. If you don’t check

(../../../_images/checkbox.png) Service capabilities , QGIS Server will use the information given in thewms_metadata.xml file located in the cgi­bin folder.

WMS capabilitiesIn the WMS capabilities section, you can define the extent advertised in the WMS GetCapabilitiesresponse by entering the minimum and maximum X and Y values in the fields under Advertised extent .Clicking Use Current Canvas Extent sets these values to the extent currently displayed in the QGISmap canvas. By checking (../../../_images/checkbox.png) CRS restrictions , you can restrict in whichcoordinate reference systems (CRS) QGIS Server will offer to render maps. Use the (../../../_images/mActionSignPlus.png) button below to select those CRS from the Coordinate ReferenceSystem Selector, or click Used to add the CRS used in the QGIS project to the list.

If you have print composers defined in your project, they will be listed in the GetCapabilities response, andthey can be used by the GetPrint request to create prints, using one of the print composer layouts as atemplate. This is a QGIS­specific extension to the WMS 1.3.0 specification. If you want to exclude anyprint composer from being published by the WMS, check (../../../_images/checkbox.png) Excludecomposers and click the (../../../_images/mActionSignPlus.png) button below. Then, select a printcomposer from the Select print composer dialog in order to add it to the excluded composers list.

If you want to exclude any layer or layer group from being published by the WMS, check (../../../_images/checkbox.png) Exclude Layers and click the (../../../_images/mActionSignPlus.png)button below. This opens the Select restricted layers and groups dialog, which allows you to choosethe layers and groups that you don’t want to be published. Use the Shift or Ctrl key if you want toselect multiple entries at once.

You can receive requested GetFeatureInfo as plain text, XML and GML. Default is XML, text or GMLformat depends the output format chosen for the GetFeatureInfo request.

If you wish, you can check (../../../_images/checkbox.png) Add geometry to feature response . Thiswill include in the GetFeatureInfo response the geometries of the features in a text format. If you wantQGIS Server to advertise specific request URLs in the WMS GetCapabilities response, enter thecorresponding URL in the Advertised URL field. Furthermore, you can restrict the maximum size of themaps returned by the GetMap request by entering the maximum width and height into the respectivefields under Maximums for GetMap request .

If one of your layers uses the Map Tip display (i.e. to show text using expressions) this will be listed insidethe GetFeatureInfo output. If the layer uses a Value Map for one of his attributes, also this information willbe shown in the GetFeatureInfo output.

QGIS support the following request for WMS service:

GetCapabilitiesGetMapGetFeatureInfoGetLegendGraphic (SLD profile)DescribeLayer (SLD profile)

GetStyles (custom QGIS profile)

WFS capabilitiesIn the WFS capabilities area, you can select the layers that you want to publish as WFS, and specify ifthey will allow the update, insert and delete operations. If you enter a URL in the Advertised URL fieldof the WFS capabilities section, QGIS Server will advertise this specific URL in the WFSGetCapabilities response.

QGIS support the following request for WFS service:

GetCapabilitiesDescribeFeatureTypeGetFeatureTransaction

WCS capabilitiesIn the WCS capabilities area, you can select the layers that you want to publish as WCS. If you enter aURL in the Advertised URL field of the WCS capabilities section, QGIS Server will advertise thisspecific URL in the WCS GetCapabilities response.

Now, save the session in a project file alaska.qgs . To provide the project as a WMS/WFS, we create anew folder /usr/lib/cgi­bin/project with admin privileges and add the project file alaska.qgs and acopy of the qgis_mapserv.fcgi file ­ that’s all.

Now we test our project WMS, WFS and WCS. Add the WMS, WFS and WCS as described in LoadingWMS/WMTS Layers (ogc_client_support.html#ogc­wms­layers), WFS and WFS­T Client(ogc_client_support.html#ogc­wfs) and WCS Client (ogc_client_support.html#ogc­wcs) to QGIS and loadthe data. The URL is:

http://localhost/cgi­bin/project/qgis_mapserv.fcgi

QGIS support the following request for WCS service:

GetCapabilitiesDescribeCoverageGetCoverage

Fine tuning your OWS

For vector layers, the Fields menu of the Layer ‣ Properties dialog allows you to define for eachattribute if it will be published or not. By default, all the attributes are published by your WMS and WFS. Ifyou want a specific attribute not to be published, uncheck the corresponding checkbox in the WMS orWFS column.

You can overlay watermarks over the maps produced by your WMS by adding text annotations or SVGannotations to the project file. See section Annotation Tools in General Tools(../introduction/general_tools.html#general­tools) for instructions on creating annotations. For annotationsto be displayed as watermarks on the WMS output, the Fixed map position check box in theAnnotation text dialog must be unchecked. This can be accessed by double clicking the annotationwhile one of the annotation tools is active. For SVG annotations, you will need either to set the project tosave absolute paths (in the General menu of the Project ‣ Project Properties dialog) or to manuallymodify the path to the SVG image in a way that it represents a valid relative path.

Server configuration and supportedparametersQGIS Server supports some vendor parameters and requests that greatly enhance the possibility tocustomise it behavior. The following paragraphs list the vendor parameters and the environment variablessupported by the server.

Extra parameters supported by all request typesFILE_NAME parameter: if set, the server response will be sent to the client as a file attachment withthe specified file name.

MAP parameter: Similar to MapServer, the MAP parameter can be used to specify the path to theQGIS project file. You can specify an absolute path or a path relative to the location of the serverexecutable ( qgis_mapserv.fcgi ). If not specified, QGIS Server searches for .qgs files in the directorywhere the server executable is located.

Example:

http://localhost/cgi­bin/qgis_mapserv.fcgi?\

REQUEST=GetMap&MAP=/home/qgis/mymap.qgs&...

Note

You can define a QGIS_PROJECT_FILE as an environment variable to tell server executable where tofind the QGIS project file. This variable will be the location where QGIS will look for the project file. If notdefined it will use the MAP parameter in the request and finally look at the server executable directory.

Extra parameters supported by the WMS GetMaprequestIn the WMS GetMap request, QGIS Server accepts a couple of extra parameters in addition to thestandard parameters according to the OCG WMS 1.3.0 specification:

DPI parameter: The DPI parameter can be used to specify the requested output resolution.

Example:

http://localhost/cgi­bin/qgis_mapserv.fcgi?REQUEST=GetMap&DPI=300&...

OPACITIES parameter: Opacity can be set on layer or group level. Allowed values range from 0 (fullytransparent) to 255 (fully opaque).

Example:

http://localhost/cgi­bin/qgis_mapserv.fcgi?\

REQUEST=GetMap&LAYERS=mylayer1,mylayer2&OPACITIES=125,200&...

FILTER parameter: (Available in QGIS 1.8 and above). Subsets of layerscan be selected with the FILTER parameter. Syntax is basically the same as for the QGIS subsetstring. However, there are some restrictions to avoid SQL injections into databases via QGIS server:

Text strings need to be enclosed with quotes (single quotes for strings, double quote for attributes)A space between each word / special character is mandatory Allowed Keywords and specialcharacters are ‘AND’,’OR’,’IN’,’=’,’<’,’>=’,’>’,’>=’,’!=*,’(‘,’)’ Semicolons in string expressions are notallowed

Example:

http://myserver.com/cgi/qgis_mapserv.fcgi?REQUEST=GetMap&LAYERS=mylayer1,myl

ayer2&FILTER=mylayer1:"OBJECTID" = 3;mylayer2:'text' = 'blabla'&....

Note

It is possible to make attribute searches via GetFeatureInfo and leave away the X/Y parameter if aFILTER is there. QGIS server then returns info about the matching features and generates a combinedbounding box in the xml output

SELECTION parameter: (Available in QGIS 1.8 and above)Vector features can be selected by passing comma separated lists with feature ids in GetMap andGetPrint.

Example:

http://myserver.com/cgi/qgis_mapserv.fcgi?REQUEST=GetMap&LAYERS=mylayer1,myl

ayer2&SELECTION=mylayer1:3,6,9;mylayer2:1,5,6&...

GetPrint requestQGIS server has the capability to create print composer output as pdf or pixel format. Print composerwindows in the published project are used as templates. In the GetPrint request, the client has thepossibility to specify parameters of the contained composer maps and labels.

Example:

The published project has two composer maps. In the GetCapabilities response, they are listed aspossible print templates:

<WMS_Capabilities>

...

<ComposerTemplates xsi:type="wms:_ExtendedCapabilities">

<ComposerTemplate width="297" height="210" name="Druckzusammenstellung 1">

<ComposerMap width="171" height="133" name="map0"/>

<ComposerMap width="49" height="46" name="map1"/></ComposerTemplate>

</ComposerTemplates>

...

</WMS_Capabilities>

The client has now the information to request a print output:

http://myserver.com/cgi/qgis_mapserv.fcgi?...&REQUEST=GetPrint&TEMPLATE=Druckzusa

mmenstellung 1&map0:EXTENT=xmin,ymin,xmax,ymax&map0:ROTATION=45&FORMAT=pdf&DPI=30

0

Parameters in the GetPrint request are:

<map_id>:EXTENT gives the extent for a composer map as xmin,ymin,xmax,ymax.<map_id>:ROTATION map rotation in degrees<map_id>:GRID_INTERVAL_X, <map_id>:GRID_INTERVAL_Y Grid line density for a composer mapin x­ and y­direction<map_id>:SCALE Sets a mapscale to a composer map. This is useful to ensure scale based visibilityof layers and labels even if client and server may have different algorithms to calculate the scaledenominator<map_id>:LAYERS, <map_id>:STYLES possibility to give layer and styles list for composer map(useful in case of overview maps which should have only a subset of layers)

GetLegendGraphics requestSeveral additional parameters are available to change the size of the legend elements:

BOXSPACE space between legend frame and content (mm)LAYERSPACE versical space between layers (mm)LAYERTITLESPACE vertical space between layer title and following items (mm)SYMBOLSPACE vertical space between symbol and following item (mm)ICONLABELSPACE horizontal space between symbol and label text (mm)SYMBOLWIDTH width of the symbol preview (mm)SYMBOLHEIGHT height of the symbol preview (mm)

These parameters change the font properties for layer titles and item labels

LAYERFONTFAMILY / ITEMFONTFAMILY font family for layer title / item textLAYERFONTBOLD / ITEMFONTBOLD ‘TRUE’ to use a bold fontLAYERFONTSIZE / ITEMFONTSIZE Font size in pointLAYERFONTITALIC / ITEMFONTITALIC ‘TRUE’ to use italic fontLAYERFONTCOLOR / ITEMFONTCOLOR Hex color code (e.g. #FF0000 for red)LAYERTITLE / RULELABEL (from QGIS 2.4) set them to ‘FALSE’ to get only the legend graphicswithout labels

Contest based legend. These parameters let the client request a legend showing only the symbols for thefeatures falling into the requested area

BBOX the geographical area for which the legend should be builtCRS / SRS the coordinate reference system adopted to define the BBOX coordinatesWIDTH / HEIGHT if set these should match those defined for the GetMap request, to let QGIS Serverscale symbols according to the map view image size.

Contest based legend features are based on the UMN MapServer implementation:(http://www.mapserver.org/development/rfc/ms­rfc­101.html)

GetProjectSettings requestThis request type works similar as GetCapabilities, but it is more specific to QGIS Server and allows fora client to read additional information which is not available in the GetCapabilities output:

initial visibility of layersinformation about vector attributes and their edit typesinformation about layer order and drawing orderlist of layers published in WFS

DXF ExportStarting with QGIS 2.11 (QGIS master as of 2015­07) it is now possible to export layers in the DXF formatusing the GetMap Request. Only layers that have read access in the WFS service are exported in theDXF format. Here is a valid REQUEST and a documentation of the available parameters:

http://your.server.address/wms/liegenschaftsentwaesserung/abwasser_werkplan?SERVI

CE=WMS&VERSION=1.3.0&REQUEST=GetMap&LAYERS=Haltungen,Normschacht,Spezialbauwerk

e&STYLES=&CRS=EPSG%3A21781&BBOX=696136.28844801,245797.12108743,696318.91114315,2

45939.25832905&WIDTH=1042&HEIGHT=811&FORMAT=application/dxf&FORMAT_OPTIONS=MODE:S

YMBOLLAYERSYMBOLOGY;SCALE:250&FILE_NAME=werkplan_abwasser.dxf

Parameters:

FORMAT=application/dxfFILE_NAME=yoursuggested_file_name_for_download.dxfFORMAT_OPTIONS=see options below, key:value pairs separated by Semicolon

FORMAT_OPTIONS Parameters:

SCALE:scale to be used for symbology rules, filters and styles (not an actual scaling of the data ­ dataremains in the original scale)MODE:NOSYMBOLOGY|FEATURESYMBOLOGY|SYMBOLLAYERSYMBOLOGY corresponds tothe three export options offered in the QGIS Desktop DXF export dialogueLAYERSATTRIBUTES:yourcolumn_with_values_to_be_used_for_dxf_layernames ­ if not specified,the original QGIS layer names are used

QGIS Server loggingTo log requests send to server, set the following environment variables:

QGIS_SERVER_LOG_FILE: Specify path and filename. Make sure that server has properpermissions for writing to file. File should be created automatically, just send some requests to server.If it’s not there, check permissions.

QGIS_SERVER_LOG_LEVEL: Specify desired log level. Available values are:

0 INFO (log all requests),1 WARNING,2 CRITICAL (log just critical errors, suitable for production purposes).

Example:

SetEnv QGIS_SERVER_LOG_FILE /var/tmp/qgislog.txt

SetEnv QGIS_SERVER_LOG_LEVEL 0

Note

When using Fcgid module use FcgidInitialEnv instead of SetEnv!Server logging is enabled also if executable is compiled in release mode.

Environment variablesYou can configure some aspects of QGIS server by setting environment variables. For example, to setQGIS server on Apache to use /path/to/config/QGIS/QGIS2.ini settings file, add to Apache config:

SetEnv QGIS_OPTIONS_PATH "/path/to/config/"

or, if using fcgi:

FcgidInitialEnv QGIS_OPTIONS_PATH "/path/to/config/"

This is a list of the variables supported by QGIS server:

QGIS_OPTIONS_PATH: Specifies the path to directory with settings. It works the same ways asQGIS application –optionspath option. It is looking for settings file in<QGIS_OPTIONS_PATH>/QGIS/QGIS2.ini.QUERY_STRING: The query string, normally passed by the web server, this variable can be usefulwhile testing QGIS server binary from the command lineQGIS_PROJECT_FILE: the .qgs project file, normally passed as a parameter in the query string, youcan also set it as an environment variable (for example by using mod_rewrite Apache moduleQGIS_SERVER_LOG_FILE: Specify path and filename. Make sure that server has properpermissions for writing to file. File should be created automatically, just send some requests to server.If it’s not there, check permissions.QGIS_SERVER_LOG_LEVEL: Specify desired log level. Available values are:MAX_CACHE_LAYERS: Specify the maximum number o cached layers (default: 100)DISPLAY: This is used to pass (fake) X server display number (needed on Unix­like systems)QGIS_PLUGINPATH: Useful if you are using Python plugins for the server, this sets the folder that issearched for Python plugins

(http://twitter.com/qgis) (https://www.facebook.com/pages/QGIS­Quantum­GIS­/298112000235096)

(http://plus.google.com/communities/114776597176808981624) (http://github.com/qgis/)

(http://www.qgis.org/en/site/getinvolved/about.html)

If not stated otherwise, all content is licensed under Creative Commons Attribution­ShareAlike 3.0 licence (CC BY­SA)

(http://creativecommons.org/licenses/by­sa/3.0/)

Select graphics from The Noun Project collection (http://thenounproject.com)

Textual error, missing text or you know better: fix me (https://github.com/qgis/QGIS­

Documentation/edit/master/source/docs/user_manual/working_with_ogc/ogc_server_support.rst)