akr8527 / fme-dotnetsdk

DotNet SDK to execute .NET modules in FME Workbench workflows

FME-DotNetSDK

DotNet SDK enables to execute .NET modules in FME Workbench workflows.

The FME-DotNet SDK provides a C++/CLI DLL to develop FME transformers for the FME platform using .NET code. You can easily develop any .NET assembly in order to implement your own specific funcionality. These assemblies can be integrated in FME Workbench workflows as usual, and by using any combination of them.

If you need to use the Microsoft .NET platform, or develop fast FME Transformers (The .NET assemblies run much faster than equivalent python-based FME Transformers), this is your SDK!

The C++/CLI DLL provides a set of classes, to reference in your own .NET assembly, which you can use to read and create the features managed in the current running FME workflow. You can read all attributes of the features from input data sources and write new features to output as you need. These classes act as a simple wrapper from original C++ classes in the FME Plug-in SDK that FME plaftorm provides. This SDK has been succesfully tested for 2015, 2016 and 2017 versions and both x86 and x64 architectures.

You have to create two components, the .NET assembly, of course, and its FME transformer definition file (.FMX) to describe your new Custom Transformer.

How to build

1. Download and install the FME Plug-in SDK.
2. Set the environment variable FME_HOME to the location of your FME installation with installed FME SDK.
3. Open the solution file in root folder and build your desired architecture (x86 or x64).

The C++/CLI project defines an additional include directory to folder where the FME Plug-in SDK is located. If the build fails check whether you followed step 2.

If you don't want to build the SDK, you can copy the desired binary from Redist folder.

How to deploy

Copy the FMEDotNetWrapperFactory.dll file to your FME plugins folder (e.g. %PROGRAMFILES%\FME\FME2017\plugins). Now, you can create, execute and debug your own Custom Transformer with .NET code!

How to develop

The SDK provides some .NET Custom Transformer samples for you can learn to use it.

• HelloWorld: A very simple HelloWorld Custom Transformer. It only reads all attributes from input features, and then returns them to output.
• DotNetCaller: Provides a Custom Transformer to execute .NET modules using the SDK. It allows to configure the .NET assembly to run and the parameters to inject.
• SingleTester: Implements a new Tester Transformer using .NET. It is much faster than other equivalent Transformers.