10.13. Manage external map layers

10.13.1. About external map layers

You can customize GIS by including map layers from various sources and combine them with your own data in DHIS2. DHIS2 supports common map service formats such as Web Map Service (WMS), Tile Map Service (TMS) and XYZ tiles.

10.13.2. Create an external map layer

[Note]Note

DHIS 2 only supports the Web Mercator projection (EPSG:3857) so make sure that the external service supports this projection.

Table 10.20. External map layer objects in the Maintenance app

Object type

Available functions

External map layer

Create, edit, clone, delete, show details and translate


  1. Open the Maintenance app and click Other > External map layer.

  2. Click the add button.

  3. In the Name field, type a name that describes the content of the external map layer.

    This is the name you'll see in the GIS app.

  4. (Optional) In the Code field, assign a code.

  5. Select a Map service format.

    DHIS2 supports three common map service formats:

    • Web Map Service (WMS)

      Image format: PNG format allows layers to be transparent, JPG format offers better compression and is often faster to load.

      Layers: A WMS can contain several individual layers, and you can specify which you want to include (comma separated). Refer to the WMS GetCapabilities document to see the available layers.

    • Tile Map Service (TMS)

    • XYZ tiles (can also be used for WMTS)

  6. Enter the URL to the map service.

    [Note]Note

    XYZ and TMS URLs must contain placeholders {}, for example: http://{s}.tile.osm.org/{z}/{x}/{y}.png.

  7. (Optional) Enter Source of the map layers. The field can contain HTML tags if you want to link to the source.

    When you use an external map service it is important to highlight where the data comes from.

  8. Select a Placement:

    • Bottom - basemap: places the external map layer above other DHIS2 base maps but below the thematic map layers.

    • Top - overlay: places the external map layer above the thematic map layers but below facility and event data layers.

  9. (Optional) Add a legend.

    You can add a legend in two ways:

    • Select a predefined Legend to describe the colors of the map layer.

      [Tip]Tip

      Click Add new to create legends that you're missing. In the form that opens, create the legends you need. When you're done, click Refresh values.

    • Enter a link to an external image legend in Legend image URL.

      These are often provided for WMS. See under LegendURL in the WMS GetCapabilites document.

  10. Click Save.

10.13.3. Edit metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to edit.

  2. In the object list, click the options menu and select Edit.

  3. Modify the options you want.

  4. Click Save.

10.13.4. Clone metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to clone.

  2. In the object list, click the options menu and select Clone.

  3. Modify the options you want.

  4. Click Save.

10.13.5. Delete metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to delete.

  2. In the object list, click the options menu and select Delete.

  3. Click Confirm.

10.13.6. Display details of metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to view.

  2. In the object list, click the options menu and select Show details.

10.13.7. Translate metadata objects

  1. Open the Maintenance app and find the type of metadata object you want to translate.

  2. In the object list, click the options menu and select Translate.

  3. Select a locale.

  4. Type a Name, Short name and Description.

  5. Click Save.