Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nikaplanet.com/llms.txt

Use this file to discover all available pages before exploring further.

After you have installed the GIS plugin and applied a GeoEngine worker, it appears as a native tool inside your GIS software — no proxy service, no per-worker plugin configuration. This guide shows you how to find and run your workers from QGIS and ArcGIS Pro. If you haven’t applied a worker yet, see Your First Worker: Step-by-Step first.

​
Running in QGIS

​
Step 1: Open the Processing Toolbox

In QGIS, open the Processing menu and click Toolbox, or press Ctrl+Alt+T (⌥+⌘+T on Mac). The Processing Toolbox panel will appear on the right side of the screen.

​
Step 2: Find Your Worker

Expand the GeoEngine provider in the toolbox. Your workers are listed by name. Each worker shows a my-worker (*latest) entry, plus one entry for each applied production local tag (for example my-worker (1.0.0) or my-worker (release-candidate)). Click on any entry to see its description, config hash, and last-applied time in the help panel on the right.

​
Step 3: Fill In Inputs and Run

Double-click a worker entry to open the tool dialog. Fill in the required input parameters:
  • File inputs — use the file selector to browse to a file on your machine; GeoEngine mounts it automatically
  • Folder inputs — select a directory
  • Other inputs (enum, number, boolean, string) — displayed as dropdowns, number fields, checkboxes, or text fields
Click Run. Container logs stream into the QGIS log panel in real time. When the run finishes, output files are automatically added as layers to your QGIS project. Local QGIS executions are stamped in GeoEngine run history with --actor QGIS.

​
Running in ArcGIS Pro

​
Step 1: Open the GeoEngine Toolbox

In ArcGIS Pro, open the Analysis tab and click Tools to open the Geoprocessing pane. Search for GeoEngine in the search bar, or browse to the GeoEngine toolbox in the Toolboxes section of the Catalog pane.

​
Step 2: Find Your Worker

Expand the GeoEngine toolbox. Your applied workers appear as tool entries. The latest entry uses the worker name; tagged production entries include the local tag in brackets, for example my-worker [1.0.0]. Click a tool to see its description and parameters.

​
Step 3: Fill In Inputs and Run

Double-click a worker to open its tool dialog. Fill in the required parameters and click Run. Container logs appear in the Geoprocessing history and messages panel. Output files are added to your ArcGIS Pro map automatically when the run completes. Local ArcGIS Pro executions are stamped in GeoEngine run history with --actor "ArcGIS Pro".

​
Understanding Output

When a worker finishes, GeoEngine returns a structured JSON result: 
{
  "job_id": "01HX4V2Z9B2F4T8H6P9K3N7Q1M",
  "status": "completed",
  "exit_code": 0,
  "files": [
    {
      "name": "output.geojson",
      "path": "/path/to/output/file",
      "size": 123,
      "kind": "output"
    }
  ]
}
  • job_id — the saved run ID; use it with geoengine worker runs show or geoengine worker runs logs when inspecting local run history
  • kind: "output" — a file produced by the worker; automatically added to your GIS view
  • kind: "input" — an input file that was passed in; also shown in the GIS so you can compare input and output side by side
If a run fails, the exit code and any error messages from the container appear in the GIS messages panel.

​
Cancelling a Run

You can cancel a running worker at any time using the cancel button in the GIS progress dialog. Cancellation terminates the GeoEngine subprocess, which in turn stops and removes the Docker container immediately.

​
Refreshing the Worker List

The plugin reads the worker list fresh each time the toolbox is opened. If you apply a new worker or a new version and it doesn’t appear in your GIS yet, close and reopen the Processing Toolbox (QGIS) or Geoprocessing pane (ArcGIS Pro) to trigger a refresh.