Manual Keys Editor

The Manual Keys Editor allows you to create manual output keys that allow for different types of user input at workspace runtime.

In the editor dialog, the left pane lists all the existing manual keys for the automation. You can use the toolbar icons to perform the following:

  • Add a key: Click the Insert icon (+) and select the type of key you want to add (see Manual Key Types, below). The key is added below the currently-selected key. In the right pane, configure the properties of the key according to its type (see Key Properties (Right Pane), below).
  • Edit a key: Click on one to select it. The key's properties display on the right pane.
  • Change the order of the keys at runtime.
  • Remove a key.

When finished, click OK.

Manual Key Types

Type Creates a Manual Key that allows a user to...
Choice Choose one or more values.
Color Select a color value.
Date Time Enter a date and time.
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.
Geometry

Enter a geometry as a set of spatial coordinates in GeoJSON. When a workspace containing a Geometry manual key runs, 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 in FME Server.

Tip  To handle the JSON data in this key:
  • Use a GeometryReplacer transformer to turn the key 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].

Key Properties (Right Pane)

A short, unique name for the key. This name is used to reference the key in values (for example, $(myIdentifier)) and menus.

The prompt for the key that appears when you run the workspace.

If checked, the workspace does not run unless the user inputs a value. If unchecked, an input value is not required for this key.

These settings depend on the key type you choose.

You can populate the choices to display in a Dropdown, List, or Tree.

Tip  Limit Dropdown to a single selection from a small number of choices. To allow selecting from a large number of choices, use List, and check or uncheck Allow Multiple Selection accordingly.

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:

The choices, when presented, appear like this:

Mouse-over to view:

Choose the default value that will be used.