Dynamic Service Values
Allows the parameter to launch a dialog to browse and select values provided by a python module. Refer to Dynamic choices using Scripted Selection for information on how the parameter configuration and python module interact.
Specification
| key | type | required | default value | description |
|---|---|---|---|---|
| serviceName | string | no | n/a | The name of the service to browse. |
| selection | array\[objects, containers, noRoot] |
yes | n/a | A list containing 0-1 instances of each of the strings 'objects', 'containers', and 'noRoot'. |
| nameMatchesId | boolean | no | false |
If true the value(s) chosen can be freely edited by the user, otherwise values can only change by updating the selection in the dialog. |
| saveObjectID | boolean | no | true |
If true the parameter value will be the service-specific object ID. If false the parameter value will be the FME URL used as a reader dataset to download contents, the serviceName field also needs to be specified as it is the host portion of the FME URL. |
| showSearch | boolean | no | true |
If true the search bar will appear in the web as a filesystem browser. |
| configuration | array<dictionary> | no | n/a | A list of dictionaries specifying named values either by constant or by parameter reference. |
| module | string | no | serviceName with spaces removed and lowercased |
The name of the python module to use. |
| itemIcon | path | no | n/a | Path to the image to be used as the icon to be shown next to items in the browser. If not specified, the icon will be the default file icon. If specified but left empty, there will be no icon. Icon path must be relative to the FME root folder for installed transformers, to the .fmx folder for packages, or to a resource path if icon is compiled in. |
| containerIcon | path | no | n/a | Path to an image to use as the icon for containers in the browser. If not specified, the icon will be the default folder icon. Behaves analogously to itemIcon. |
configuration
| key | type | required | description |
|---|---|---|---|
| name | string | yes | The name of the configuration item. |
| value | string ({parameter} ok) | yes | The value of the configuration item. |
({parameter} ok)
If a property is labelled with ({parameter} ok), the value can be either a constant (string) or a reference to another parameter, in the form of a dictionary mapping the key "parameter" to the name of the referenced parameter, e.g. { "parameter" : "MY_PARAM" }
Example
{
}