QGIS-FME Form Connector Algorithm
The QGIS-FME Form Algorithm transforms the way you use FME within QGIS. Unlike its parent plugin (QGIS-FME Form Connector), this algorithm is specifically designed for the QGIS Processing Framework, enabling:
Think of it as your FME workspace runner that fits perfectly into QGIS's processing ecosystem.
It includes a default FME workspace (template) to help you get started. The template can be customized to the users needs. The workspace is located in the plugin folder directory under "FME Workspace/QGISFMEFormConnectorTemplate.fmw" or you can download it below:
The plugin can be downloaded from the official repository, QGIS plugins or directly from QGIS plugin manager (QGIS manual).
A zip file of the current release is also available in GitHub repository where the sourcecode is also available here .
QGIS-FME Form Connector Algorithm has been developed using QGIS 3.34 and tested in FME 2024 and above.
Key Features:
• Seamless integration with QGIS Model Designer.
• Automated workflow creation.
• Batch processing capabilities.
• Python script generation.
To install the QGIS-FME Form Connector Algorithm plugin:
1. Open QGIS.
2. Navigate to Plugins > Manage and Install Plugins...
3. Select All tab.
4. Search for QGIS-FME Form Connector Algorithm.
5. Click Install Plugin.
6. Restart QGIS if prompted.
Note: The plugin requires a valid FME installation on your system.
After installation, the plugin can be accessed through:
• The algorithm automatically appears in Toolbox (Processing Toolbox > QGIS-FME Platform Algorithms > QGIS-FME Form Connector Algorithm).
Before using the plugin, ensure you have:
- • FME Desktop installed (2020 or newer recommended).
-
• Set up your FME executable path (one-time setup).
- • 💡 Pro Tip: Save your FME executable path using the "Save" button - it will be remembered for future uses.
-
• Access to FME workspaces (.fmw files).
- • Default .fmw workspace filename is “QGISFMEFormConnectorTemplate.fmw”.
- • Appropriate permissions to execute FME commands.
1. File Browser Panel (Left):
• Directory navigation tree.
• Address bar for direct path entry.
• Up directory button.
• Workspace file list.
2. Workspace Information Panel (Left):
• Workspace details and metadata.
• Parameter table for customization.
• Source and destination dataset configuration.
3. Command Execution Panel (Right):
• Command preview.
• Execute button.
• Output console.
• Progress indicator.
• Status messages.
Selecting a Workspace:
1. Use the file browser to navigate to your FME workspace directory.
2. Click on an .fmw file to select it.
3. The workspace details will automatically load in the left panel.
The plugin will automatically:
• Parse the workspace to identify parameters.
• Display source and destination dataset information.
• Generate a command line preview.
Workspace Compatibility:
The plugin works best with FME workspaces that:
• Have clearly defined published parameters.
• Use standard reader/writer formats.
• Include appropriate error handling.
The parameter table allows you to customize how the FME workspace will execute:
1. Required Parameters:
• FME Executable: Path to fme.exe on your system.
• Workspace: Path to the selected .fmw file.
• Source Dataset: Input data path.
• Destination Dataset: Output data path.
2. Custom Parameters:
• Additional parameters defined in the FME workspace.
• Values can be edited directly in the table cells value.
3. Filename Generation:
The plugin automatically generates standardized filenames for input and output datasets using the format:
YYYYMMDD_xxxxx_line2_[input/output].geojson.
To run an FME workspace:
1. Ensure all required parameters are configured.
2. Review the command in the command preview box.
3. Click the "Execute Command" button.
4. Monitor progress in the status area.
During execution:
• The progress bar shows completion percentage.
• The console displays real-time output from FME.
• Status messages indicate current operation.
Execution Options:
• Load output as scratch layer: Loads the output directly into QGIS memory. (a temporary layer)
• Load output as a GeoJSON layer: Loads the output as a layer from a physical GeoJSON layer
After successful execution, the plugin offers several options for handling the output:
Output Status Indicators:
• Green: Successful execution.
• Red: Error occurred.
• Yellow: Warning or partial success.
Common Issues and Solutions:
1. FME Not Found:
• Ensure FME is properly installed.
• Verify the path to fme.exe is correct.
• Check that FME version is compatible.
2. Workspace Errors:
• Confirm the workspace runs correctly in FME Workbench.
• Check for missing published parameters.
• Verify reader/writer formats are supported.
3. Parameter Problems:
• Ensure required parameters have valid values.
• Check file paths for spaces or special characters.
• Verify input data exists and is accessible.
4. Execution Failures:
• Review the console output for specific error messages.
• Check system permissions for file access.
• Verify sufficient disk space for output.