# Mergin Maps Plugin for QGIS Overview

Mergin Maps plugin for QGIS allows you to work with your Mergin Maps projects in QGIS, whether it's downloading the project to your computer, making changes in the project, seeing the project's status or synchronising changes to the cloud.

To get started, you will need to install and configure the plugin.

Once you have configured the plugin with your Mergin Maps credentials, you should be able to see the following sections under the Mergin Maps in your QGIS Browser panel:

  • My projects lists all projects you have created
  • Shared with me lists the projects that are shared with you (including your organisation projects)
  • Explore lists all the public projects

browser

TIP

To ensure you can use the latest improvements, don't forget to upgrade the plugin periodically!

# Downloading a project in QGIS

  1. Right-click on the project and select Download

  2. Browse to the folder, where you want to save the project and click Select folder

    DANGER

    Do not use shared network drives or cloud storage (such as OneDrive or Google Drive) to store your Mergin Maps projects. It is not supported and can cause errors.

  3. Once the download is completed, you will have the option to open the project in QGIS.

# Local changes

since plugin 2022.4

The changes that you make in the project can be synchronised to the cloud and shared with your coworkers.

It is possible to visualise local changes to see what's changed since the last synchronisation:

  1. Right-click on a layer and select Show Local Changes
    local changes

  2. Changes Viewer opens. The colour-coded changes are listed in the table and shown in the map. Inserts are green, edits orange and deletions red.
    local changes

  3. Changes can be added to the QGIS project as a new layer. Click Add to project and choose one of the options:
    add local changes

  4. A temporary layer will be added to the Layers panel with colour-coded symbology
    add local changes

# Extract local changes (Processing toolbox)

Local changes of a specific layer can also be extracted using the Extract local changes tool in the Processing toolbox.

  1. Navigate to Mergin Maps tools in the Processing toolbox
    processing toolbox

  2. Double click the Extract local changes tool. In the dialog window, enter your project directory and select the input layer. The output local changes layer can be saved as a file or as a temporary file. Click Run.
    extract local changes

  3. The local changes layer is added to the Layers panel
    extract local changes

# Synchronisation in QGIS

Once you are happy with the changes to be uploaded/downloaded, you can synchronise your project and data.

  1. Click on the Synchronise Mergin Maps project icon from the Mergin Maps plugin for QGIS toolbar or right-click on the project in the Browser panel and select Synchronise
    sync icon
    sync icon

  2. This will show the project status: a list of pending changes, warnings, and validation results of your project.
    synchronisation

    Warnings are related to restructuring of a GeoPackage layer (adding/removing a field, adding/removing a layer in a GeoPackage database). Validations can point out missing layers or availability of a layer when working offline.

  3. If you want to inspect the pending changes more thoroughly, you can click on the View changes button to see the local changes.
    view changes

  4. If you want to proceed, click on the Sync button to synchronise your project and data.

WARNING

Project and data synchronisation works in both ways.

All your changes will be uploaded to the server and any pending changes from the server edition of your files will be downloaded and appended to your local files.

When the synchronisation process is completed, your local files and the copy of files on the server will be identical.

# Create report (Processing toolbox)

Create report tool provides an overview of changes in your Mergin Maps project for a range of project versions. The output is a CSV file, which can be opened in QGIS and also in common text and spreadsheets programs.

  1. Navigate to Mergin Maps tools in the Processing toolbox
    processing toolbox

  2. Double click the Create report tool.

    Fill in the parameters in the dialog window. If you want to get the report for a specified range of versions, define also the start and end version.

    Click Run.
    create report

  3. The report is added to the Layers panel.
    view changes

# Create diff (Processing toolbox)

Create diff is a tool that extracts changes made between two versions of a layer in your Mergin Maps project to make it easier to revise changes.

  1. Navigate to Mergin Maps tools in the Processing toolbox
    processing toolbox

  2. Double click the Create diff tool and fill in the parameters in the dialog window. Click Run.
    create diff

  3. The diff layer is added to the Layers panel. Changes are visualised on the map and also in the attribute table of the layer.
    view changes