FME Flow Connector

FME Flow Connector

Run FME Flow workspaces directly from QGIS — export layers, transform data, and load results back into your map or simply process and forget in FME Flow.

Version V0.0.1 QGIS 4.0+ FME Flow REST API v3 & v4

Requirements

  • QGIS 4.0 or later with the FME Flow Connector plugin installed.
  • FME Flow server reachable from your machine (local network or hosted). Supports REST API v3 (FME Flow 2025 and earlier) and REST API v4 (FME Flow 2025.1+, including 2026).
  • An API token with permission to list repositories, submit jobs, and access shared resources is required.
  • An FME workspace published to FME Flow with Job Submitter enabled.
  • Input and output published parameters configured for GeoJSON datasets (see FME Workspace Setup).
Tip: Use the server root URL (e.g. http://your-fme-server). On connect, the plugin automatically detects which REST API your server exposes — /fmeapiv4 (v4) or /fmerest/v3 (v3). You do not need to add the API path to the URL yourself.

How It Works

The main dialog communicates with FME Flow using this pipeline:

QGIS vector layer Export GeoJSON (EPSG:4326) Upload to FME shared resources Submit job via Job Submitter Poll until complete (Return mode) Download result GeoJSON (Return mode) Load as QGIS layer

Run modes

On the Parameters tab, choose how the plugin handles the job result after FME Flow finishes:

Mode Behaviour
Process and Return data to QGIS (default) Submit via Job Submitter, wait for completion, download the output GeoJSON from shared resources, and load it into your QGIS project.
Process Layer in FME Flow Only Submit via Job Submitter, wait for completion, and notify you when the job finishes. No result is downloaded and no layer is added to QGIS — output stays wherever your workspace writes it (database, file share, email, etc.).

Your run mode choice is saved in QSettings (FMEFlowV2/run_mode) and restored each time you open the dialog.

NOTE — Registered services list: The list of services shown on the Parameters tab is for information purposes only. It displays which FME Flow services the workspace is registered with (e.g. Job Submitter, Data Streaming, Data Download). Regardless of that list, the plugin always submits jobs using Job Submitter via the REST API (v3 or v4, detected automatically on connect). If you try to run a workspace that is not registered with Job Submitter, the plugin shows a warning and does not submit the job.

REST API compatibility

The Plugin supports both FME Flow REST API v4 and v3. On connect it will detect which version is available and the information will be saved per server in QSettings so the next connection reuses it. Use the Re-detect button next to Connect to clear the saved version and probe the server again.

API FME Flow versions Base path
v4 2025.1, 2026+ (current) /fmeapiv4
v3 2025 and earlier /fmerest/v3
Step What happens
Export The selected QGIS layer is written to GeoJSON and reprojected to WGS 84 (EPSG:4326).
Upload The GeoJSON file is uploaded to $(FME_SHAREDRESOURCE_DATA)/qgis_fme_connector/ on FME Flow.
Submit A job is submitted via the Job Submitter service using the detected REST API (v4: POST /jobs; v3: POST /transformations/submit/{repository}/{workspace}).
Output In Process and Return mode, the workspace writes its result to a known output path; the plugin downloads it and adds it to the QGIS project. In Process Layer in FME Flow Only mode, this download step is skipped.

Main Dialog

Open the dialog from the FMETools toolbar or FME Platform Connectors → FME Flow Connector. The window title shows FME Flow Connector V0.0.1.

Dark / Light mode

Use the theme toggle in the top bar to switch between dark and light UI. Your preference is saved automatically.

Layer picker

Select the active vector layer in the top-right combo box. It is exported and sent to FME Flow when you run a workspace.

Step-by-step

  1. Connect — Enter your FME Flow server URL and API token, then click Connect. Repositories and workspaces load in the left sidebar. Use Re-detect (next to Connect) to clear the saved REST API version for this server and connect again.
  2. Select a workspace — Click a workspace in the tree. Registered services, run mode, parameters, and workspace details appear in the main panel.
  3. Choose run mode — On the Parameters tab, select Process and Return data to QGIS (default) or Process Layer in FME Flow Only. Your choice is remembered between sessions.
  4. Configure parameters — Fill in any published parameters your workspace requires. The registered services list above is informational only — runs always use Job Submitter.
  5. Choose output (optional) — In return mode, leave the output path blank to load the result as a scratch layer, or set a file path to save the GeoJSON locally. The output field is disabled in Process Layer in FME Flow Only mode.
  6. Run — Click ▶ Run Workspace (return mode) or ▶ Submit to FME Flow (process only). Progress and log messages appear on the Output Log tab. In return mode, the result layer is added to your QGIS project when complete.

Tabs

  • Parameters — Registered services (informational), run mode, published parameters, and optional output file path.
  • Details — Workspace metadata from FME Flow (author, build, datasets).
  • History — Recent run times, workspace names, and status.
  • Output Log — Step-by-step execution log including job ID and status updates.
  • Documentation — This user guide, embedded in the dialog (includes developer information).

FME Workspace Setup

Your FME workspace must be configured to work with the connector's upload/download pipeline. A template workspace is available in the project repository.

Published parameters

  • Input — A GeoJSON source parameter (commonly SourceDataset_GEOJSON) receives the uploaded file path from shared resources.
  • Output — A GeoJSON destination parameter (DestDataset_GEOJSON) must write to the path provided by the plugin: $(FME_SHAREDRESOURCE_DATA)/qgis_fme_connector/output_*.geojson

FME Flow registration

  • Publish the workspace to a repository on FME Flow.
  • Register it with the Job Submitter service.
  • Ensure the API token has access to shared resources (FME_SHAREDRESOURCE_DATA).
Important: The workspace must write its output GeoJSON to the DestDataset_GEOJSON published parameter. If the output path is hard-coded elsewhere, the plugin will not be able to download the result.

Troubleshooting

Connection failed

  • Verify the server URL is reachable in a browser.
  • Check the API token is valid and not expired.
  • Confirm firewall rules allow HTTPS/HTTP to FME Flow.
  • On FME Flow 2026+, ensure v4 is available at /fmeapiv4/docs/index.html. A 404 on /fmerest/v3 is expected — the plugin falls back to v4 automatically.
  • Repositories such as Dashboards or Automations Exercises contain no runnable workspaces — the plugin skips them silently instead of failing the whole connection.

Job submitted but no output layer

  • If you selected Process Layer in FME Flow Only, no layer is expected — check the Output Log for the completion message.
  • In Process and Return mode, check the Output Log for download errors.
  • Ensure the FME workspace writes to DestDataset_GEOJSON.
  • Verify the output file exists on FME Flow shared resources under qgis_fme_connector/.

Upload or submit errors

  • Confirm the token can write to FME_SHAREDRESOURCE_DATA.
  • Check that the workspace is registered with Job Submitter.
  • Review published parameter names — the plugin auto-detects the GeoJSON input parameter.

Current Version

The plugin current version V0.0.1 (experimental)

About

FME Flow Connector logo

FME Flow Connector

Developed by GIS Innovation Sdn Bhd

www.GIS.com.my