FME Form: 2024.1

Exporting Custom Transformers

The best way to share a transformer is to export it and distribute it just like any other file.

Transformer files are saved as .fmx files in the following default locations:

  • Windows: C:\Users\<user>\Documents\FME\Transformers
  • Linux: ~/.fme/Transformers
  • OSX: ~/Library/Application Support/FME/Transformers

You can change the default location.

Tip  To determine the file path of a custom transformer, locate it in the Transformer Gallery, and right-click. Select either Open Containing Folder or Edit. If Edit is selected, the transformer opens in a new instance of FME Workbench, and the file path displays beside the transformer name, in the title bar at top.

Export as Custom Transformer

  1. Open or create a custom transformer.
  2. On the workspace canvas, click the tab that contains the custom transformer.
  3. Select File > Export as Custom Transformer.

The Export as Custom Transformer dialog opens.

Use the default name that appears in this field, or type a new name. If you specify a duplicate name, you will be prompted to confirm the file replacement.

You can assign an existing category to the transformer, create a new one, or leave the field blank. If you leave the field blank, the transformer will be listed only in the All category of the Transformer Gallery.

The insert mode for the transformer determines how it is used in the workspace. When a transformer is embedded in a workspace, all of its properties are also copied to the workspace. However, you can also choose to link to the transformer, which is useful if you frequently update the transformer and you use it in many different workspaces. You can always change the default insert behavior after the custom transformer is exported. For more information, see Embedding or Linking a Custom Transformer.

Linked by Default: The default insert mode is Linked but you can still Embed the transformer.

Linked Always: If the transformer will be frequently updated, you might want to select this option so that updates in a shared folder can be more easily controlled.

Note  Remember that when you link to a transformer, and you move or share the workspace to which it is linked, you must also move or send the transformer separately. If you open a workspace containing a link to a custom transformer that is not installed on your system, you will see an error. This is not always easy to spot, since custom transformers can be embedded inside one another. Either way, you will need to obtain any missing custom transformers to run the workspace properly.

Embedded by Default: The default insert mode is Embedded but you can still choose to Link the transformer.

Embedded Always: The transformer will be embedded into the workspace. This option is useful if the transformer is not part of a larger workflow, and will not be shared or reused.

(Optional) Enter a password that users must provide before they can use the custom transformer.

You might want to change the location for sharing purposes but to use the transformer in a workspace, it must reside in the default location.

Note  FME Workbench cannot use transformers if they are stored outside the default location on your local drive. Transformers that are not stored here will not be listed in the Transformer Gallery.

After defining the parameters for the exported transformer, click the OK button in the Export as Custom Transformer dialog.

A second FME Workbench application will start, and the transformer appears on the new canvas. The title bar will display the transformer name and location. The transformer name is now stored in the Transformer Gallery either in the category specified above, or in the All folder.

What can I do after I export a Custom Transformer?

  • Select a linked transformer from the Transformer Gallery, and include it any number of times.
  • Share it with other users.
  • Create multiple versions of a linked transformer.

See also