There are different ways to create user parameters:
The method you choose determines the fields that show in the Add/Edit Parameter dialog. The configurable fields in the dialog are described following the table.
User Parameter Type | Description | Add/Edit Parameter Dialog |
---|---|---|
To add a new user parameter that has no existing properties |
Right-click the User Parameters icon in the Navigator, and click Add Parameter. This is a new parameter, so you will have to fill in all required fields. Click OK to add the parameter to the workspace. |
![]() |
To create a user parameter from an existing workspace parameter |
Right-click a Workspace Parameter in the Navigator, and click Create User Parameter. Most fields are already filled in based on the parameter's existing information. You can edit the fields; however, changing the Type is not recommended. Click OK to add the parameter to the workspace. |
![]() |
To create a user parameter from an existing transformer parameter (Navigator) |
Right-click a Transformer parameter in the Navigator, and click Create User Parameter. Most fields are already filled in based on the parameter's existing information. You can edit the fields; however, changing the Type is not recommended. Click OK to add the parameter to the transformer. |
![]() |
To create a user parameter from an existing transformer parameter (Transformer Parameters dialog) |
Click the menu You can edit all the fields. Click OK to add the parameter to the transformer. |
![]() |
Attribute Name: Creates a parameter for choosing a feature type attribute.
Choice: Creates a parameter that allows you to choose one of x values (for example, a or b or c...).
Choice (Multiple): Creates a parameter that allows you to choose from multiple values (for example, a and b and c....).
Choice or Text: Enter a text string or select one from a pick-list.
Choice with Alias: Similar to Choice, but allows you to map a user-friendly display value (alias) to an actual value. Choice with Alias is useful when actual values have little meaning or may be misunderstood by the user. For example, you can display a full format name but alias it to an abbreviated format name or file extension.
Choice with Alias (Multiple): Similar to Choice with Alias but you can map multiple values to the same alias. For example, you might want to display Park but alias this to Recreation Center, Community Pool, and Playground).
Color Picker: Creates a parameter for changing the FME color value.
Coordinate System Name: Creates a parameter for choosing a coordinate system.
Filename (Existing and Output): Creates a parameter for choosing the name and path of an existing file, or the output file.
Float: Creates a parameter for choosing a floating point number.
Folder (Existing and Output): Creates a parameter that allows you to choose the name (and path) of an existing folder, or an output folder.
Integer: Creates a parameter for choosing an integer.
Password: Creates a parameter for entering a password.
Scripted (Python): Creates a parameter from a Python script (Private parameter only).
Scripted (Tcl): Creates a parameter from a Tcl script (Private parameter only).
Slider: Creates a bounded numeric value.
Text: Creates a parameter for entering a text string.
Text (Multiline): Opens an editor to enter a multi-line text string. The first line will show in the parameter but to edit the text, you must open the editor.
Enter a name. This will appear under the Published Parameters icon in the Navigator pane.
If you uncheck this box, the parameter will be created as a Private parameter. See About Parameters.
Flagging the parameter as Optional means that an input value is not required for this parameter. If a parameter is not Optional, the workspace will not run unless the user inputs a value.
Enter the prompt that will appear when you run the workspace.
The parameters required in this field are dependent on the Parameter Type you choose. Click the browse button beside the parameter to see the applicable configuration choices. For example, you can:
Choose the default value that will be used.
All user parameters will be listed in the User Parameters section of the Navigator.
Tip: To quickly change a value only, double-click on a Parameter.
Note: If you filter the list by keyword, the list will dynamically update as you enter the keyword – clicking OK will close the dialog.