Skip to content

Transformer Internal Only

  • canvasProperties [;]* See Canvas Properties section below
  • dynamicInputPorts Special input tags, that never end up in the mapping file but are there for the benefit of the view. These tag names can have spaces, hence are FMEParsableText encoded. There can be no link made to these tags, rather the process of making a link to this tag will invoke a custom behaviour that is to be determined by the transformer. Mostly this is used to create new ports whose definition is based on the schema from the incoming link. (See InlineQuerier or MaptextLabeller transformers)

Deprecated - for backwards compatibility only

  • multiProcess value should specify the name of the group by parameter for use when doing the multiprocess. This feature is deprecated.
  • nukersRequired Default is no. When set to yes, this forces the OUTPUT clause to always be written out, and clean up any features that will come out. Only required for certain factories that require an OUTPUT clause, or for an transformer that does its work on the OUTPUT clause of a TeeFactory.
  • listActions LIST_ACTIONS indicate how to deal with a some specific list situations. See ListAction section for more details
  • parameterLookup is only used if a parameter has a choice list and requires additional lookups. Its value is a dictionary keyed on parameter names, with values which are a list of related lookup strings, of the form "<paramLookupName> [choice1%choice2%choice3]". If present, the order of choices must match the order in the choice listing. An empty choice list for a lookup in this dictionary indicates that <paramLookupName> is the name of transformer parameter from an older workspaces, which held the display for this parameter's value.

listAction Details

List actions can take any of the following forms and may be repeated multiple times one for each list parameter. They indicate how the output attributes are generated from the list attribute. The following actions are supported.

  • BUILD_ALL [TRANS_LIST] Makes a list (of name specified in parameter list_parm) adding incoming attributes to the list based on the [TRANS_LIST] specification
  • EXPLODE [TRANS_LIST] explodes the list in list_parm into its elements.
  • **REMOVE removes all list attributes specified in
  • KEEP removes all list attributes except those specified in

TRANS_LIST specifies the transfer of list attributes from input to output and has the format: OUTPUT1:INPUT1[INCLUDE_ATTRS:parmName] OUTPUT2:INPUT2[INCLUDE_ATTRS:parmName] ... If TRANS_LIST is empty, every output takes from every input. If INCLUDE_ATTRS is specified, only the attributes indicated in parmName are transferred.

canvasProperties Details

NOTE: This is for Internal Use Only at this time since use requires knowledge of the c++ code. Value of this tag is expected to be space delimited string with one or more of ;.

Following properties are currently supported:

  • SHOW_IN_NAVBAR;[Yes|No] If its value is set to No (default is Yes if not specified) then the transformer node won't show in the navbar except when performing workspace search.
  • EXCLUDE_ACTIONS; <List of actions to exclude from context menu> Value is a comma delimited list of action names to exclude from node's context menu.
  • OPEN_FOLDER;PATH,[,FORMAT,<macro>][,SUPPORTS_IF,<cond>] Requires PATH parameter and optionally a FORMAT can be specified. When FORMAT is specified then the context menu will be disabled under certain circumstances where PATH is not a valid file system path. Formats with dataset type (formats.db) of DATABASE, ODBC and NONE will cause the context menu option to be disabled
  • INSPECT;FORMAT,<macro>,DATASET,<macro>,RUNTIME_MACROS,<macro>[,COORDSYS,<macro>,FEATURE_TYPES,<macro>][,SUPPORTS_IF,<cond>] Expected value for FORMAT is the format short name (formats.db). DATASET is expected to be a valid file system path name. RUNTIME_MACROS is a comma delimited SDF encoded string of parameters as name-value pairs
  • BANNER_NAME;\<image base name> Configure transformer node's appearance and behaviour on the canvas and navbar. The transformer banner is generally fixed to use a standard image whose base name is set to 'banner_xformer'. In some rare cases where we want to have custom banner image, it can be specified using BANNER_NAME property. Currently if this tag is set then we assume the following:
    • Input and Output ports are hidden, that means the input and output ports (triangles) will show up at the banner level
    • Node is not editable
    • Node will not have any visible text item

SUPPORTS_IF: valid for INSPECT and OPEN_FOLDER - indicates a condition which must be met for the inspect or open folder to be supported. Current syntax supports form PARMNAME=VAL only which would mean the open/inspect is only supported when PARMNAME is equal to VAL