FME Transformers: 2024.1

Transformer Parameter Menu Options

Most transformer parameters are now integrated so that the options can be easily configured with other elements in the workspace.

This means that the parameters can be set, changed, published or unpublished, set to an attribute value, or linked to another parameter. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers.

Note  It's important to remember that you can still use a transformer with its default values, as long as there are no required parameters (red-shaded fields). The parameter menu allows easy access more advanced settings.

Accessing the Parameter Menu

The options that will appear for a transformer depend on the type of transformer that you are using. If the transformer supports it, the menu displays after you open the transformer properties and click the parameter menu button on the right side. This menu will usually display different options for each transformer parameter. The most common parameters are described below.

Common Menu Options

These menu choices are available in most transformers:

Menu Choice Available Description

User Parameter

For all parameters except transformer name and new attribute names

This will set the value of the parameter to a user, system, FME Flow, or FME deployment parameter.

There are three ways you can set to a parameter:

Clear Value

Always

Clears all values and returns the parameter to an empty state.

For choice parameters, Clear Value will take you back to the drop-down list.

Attribute Value

If the parameter can take the value of an existing attribute from the input feature

Set a parameter value to the value of an existing attribute.

Even if the parameter takes only a simple Yes/No value, you might want to ensure that you carry this value through to other transformer parameters without having to explicitly set them.

Add Annotation

Parameters in any top-level transformer parameter dialog (does not include parameters in sub-dialogs)

Allows you to annotate a parameter setting. Annotations can provide useful information about the reasons for parameter settings.

Edit Annotation

Parameters with existing annotations

Opens the Annotation Editor for updating an existing parameter annotation.

Delete Annotation

Parameters with existing annotations

Removes a parameter annotation.

Other Menu Options

Some parameter menu choices that appear depend on the transformer parameter type. Because each transformer parameter is unique, the associated parameter menu is also unique.

The table below lists some of the more common transformer-specific options:

Menu Choice Description

Change Selection

Opens a dialog that allows you to choose multiple list items. For example, all transformer Group By parameters display this menu choice.

Select Attribute

Select an attribute from the list.

Choose Font

In transformers that include font definitions, this menu choice displays the font chooser dialog.

Open Arithmetic Editor

Opens a dialog that allows you to input an arithmetic equation, such as “1+2”, that will be evaluated at runtime.

Open Text Editor

Opens the text editor.

Edit Selection

Opens a dialog to select resources that are generally accessed remotely, such as from a web connection.

Open Advanced Selection Editor

Opens the Advanced Selection Editor.

Open Regex Editor

Opens a Regular Expression Editor.

Select Color

For any parameters that accept color definitions, this menu choice opens a color picker specific to the operating system.

Select Coordinate System

For any parameters that accept coordinate system definitions, this menu choice opens the Coordinate System Gallery.

Select Folder/Source Filename/Dataset File/Image/FME Workspace

Opens a folder/file browser in transformer parameters that require folders or files as input.

Select Format

Allows you to select the format of a reader or writer.

Select Raster

Opens a dialog that allows you to select raster bands and palettes.

Select XML.

When selected in transformers that work with XML files, provides the option of opening a file browser or specifying an attribute.

Set Geometry

Opens a dialog that allows you to define geometry.

Function Return

Parameter is set to the value returned by a function.

Conditional Value

Opens the Parameter Condition Definition dialog.

Stop Translation

If the value cannot be set automatically, the translation is stopped.

No Action

The value of the attribute is left ‘as is’ without being modified.

Null

The parameter is assigned a value of null.