To create user parameters and manage existing ones, open the User Parameters dialog. From the Navigator, right-click on the User Parameters icon, and select Manage User Parameters. Alternatively, from the menu, select Tools > Manage User Parameters.
In the User Parameters dialog, the left pane lists all the existing user parameters for the workspace. (They are also listed in the User Parameters section of the Navigator.) You can click and drag on the parameters or use the toolbar icons to perform the following:
When finished, click OK.
To view how the parameters display at runtime, click Preview.
| Parameter Type | Creates a Parameter to... |
|---|---|
| Choice | Choose one or more values. |
| Color | Select a color value. |
| Datetime | Enter a date and time. For information about output formats, see Standard FME Date and Time Format. |
| File/URL | Choose the names and paths of existing files or folders, an output file or folder, or a URL. |
| Message | Display a message at runtime. |
| Number | Enter an integer or floating-point number. The number can be bounded or unbounded based on the specified Configuration. |
| Password | Enter a password. |
| Text | Enter a text string. |
| Yes/No | Select or unselect a checkbox. |
| Attribute Name | Choose names of feature type attributes, or items from a comma-delimited or space-delimited attribute list. Choices only populate in the context of a reference to the user parameter in the workspace, such as when the Attributes parameter of a StringReplacer transformer references an Attribute Name user parameter. |
| Coordinate System | Choose a coordinate system. |
| Database Connection | Choose a database connection. |
| Geometry | Enter a geometry as a set of spatial coordinates in GeoJSON. When a workspace containing a Geometry published parameter is run from FME Flow, an interface is available for displaying the specified coordinates on a map and specifying the desired geometry. For more information, see Using the Geometry Parameter. Tip To handle the JSON data returned by this parameter: Use a GeometryReplacer transformer to turn the parameter value into a real geometry. Specify GeoJSON as the GeometryEncoding. Use a JSONExtractor transformer to extract the coordinate values. For example, to extract X/Y coordinate values to a point feature, specify json["coordinates"][0] and json["coordinates"][1]. |
| Reprojection File | Choose a grid shift file for reprojecting data. |
| Web Connection | Choose a web connection. |
| Advanced > Scripted Selection | Access a callback method in a Python module that returns values available for selection and which may be obtained remotely, such as from a web service. Scripted selection parameters are useful in configuring *Connector transformers to access resources (for example, the Folder parameter of the GoogleDriveConnector transformer). For more information about using Python with scripted selection parameters, see the FME Packages SDK Guide. |
| Advanced > Scripted Value | Access a Python script that assigns the value of a parameter to the workspace at runtime. |
A short, unique name for the parameter (or group box). This name is used to reference the parameter in values (for example, $(myIdentifier)) and menus.
The prompt for the parameter (or group box) that appears when you run the workspace.
If checked, the parameter is created as a published parameter. If unchecked, the parameter is created as a private parameter.
For more information, see Working with User Parameters.
If checked, the workspace does not run unless the user inputs a value. If unchecked, an input value is not required for this parameter.
This setting controls whether the end user can select an attribute to provide values to a parameter. If checked, the user cannot specify an attribute value for the value of the parameter. If unchecked, FME determines if the user can specify an attribute value for the value of the parameter, in addition to any values allowed by the parameter type. FME determines whether the parameter allows specifying an attribute value based on the parameter referencing the user parameter.
The parameters required in this field depend on the parameter type you choose.
You can populate the choices to display in a Dropdown, List, or Tree.
If Tree is selected, specify a Tree Node Delimiter for the nodes of the tree. Then specify the Choices, using the delimiter to indicate under which node to place the value.
For example, this configuration uses a comma to delimit building choices by building site:
Mouse-over to view:
When the parameter is published, the choices appear like this:
Mouse-over to view:
Choice List Delimiter: If List or Tree is specified, you can choose the delimiter that separates multiple values as they are selected for display in the parameter values prompt at runtime. The default delimiter is a space. Values that contain spaces are wrapped in double quotes.
You can configure the following parameters if Geometry Encoding is GeoJSON:
If the selected item on the left pane is a group box, and not an individual parameter, you can configure the following:
The parameter specified in the If clause must be a type that allows specifying a single value, such as a Yes/No parameter, a specified Text string, or a Choice parameter that does not Allow Multiple Selection.
If Published is checked, you can check this setting to control the visibility of the parameter (or group box) based on the value of one or more parameters that are provided at runtime prior to this parameter. The visibility of the parameter depends on whether the value of the previous parameter specified in an If or Else If clause meets the condition relative to a specified value.
|
Operator |
Description |
|---|---|
| Is | Equals |
|
Is Not |
Does not equal |
|
Is Empty |
Left Value is null, missing, or empty. |
|
Is Not Empty |
Left Value is not null, missing, or empty. |
|
Contains |
Tests that Right Value occurs somewhere in Left Value. |
|
Does Not Contain |
Tests that Right Value does not occur anywhere in Left Value. |
|
Matches RegEx |
Tests that Left Value matches a string pattern described by a regular expression in Right Value. |
|
Is Enabled |
The state of Left Value is enabled. |
|
Is Not Enabled |
The state of Left Value is disabled. |
|
< |
Less than |
|
<= |
Less than or equal to |
|
> |
Greater than |
|
>= |
Greater than or equal to |
The parameter specified in the If (or each Else If) clause must be a type that allows specifying a single value, such as a Yes/No parameter, a specified Text string, or a Choice parameter that does not Allow Multiple Selection.
For more information, see Controlling the Visibility of Published Parameters.
Choose the default value that will be used.
To edit the default value of a user parameter
Select the parameter, right-click, and select Edit Value. Alternatively, double-click on the parameter.
To edit the default value of multiple user parameters
Right-click on User Parameters, or any single user parameter, and select Edit User Parameter Default Values.
To remove a user parameter
Select a parameter, right-click, and select Delete.
To apply the value of a user parameter to one or more other parameters
Select the parameter, right-click, and select Apply to.