XMLFeatureMapper

Categories

Format Specific

Web

Constructs features from XML documents via xfMaps.

The XMLFeatureMapper uses a set of rules to map XML data into FME features. These mapping rules are defined in xfMap documents. See the XML reader documentation for more information regarding the xfMap.

Input Ports

This transformer accepts any feature.

Output Ports

These are the features that are extracted from the XML source document via the specified xfMap.

Features with and invalid input document or xfMap document are output at this port.

Parameters

Determines whether the XML Source will be specified using an XML file or as an attribute value.

Specifies the XML file to be used as the XML Source.

Specifies the attribute whose value is the XML Source.

Single xfMap file/Embedded xfMap script/Attribute with xfMap script: The xfMap document may be specified as a single xfMap file, embedded within the transformer, or as the value of a feature attribute.

Multiple xfMaps files: Multiple xfMap files may be specified to map the same source XML document.

XRS file: An XRS (XML Reader Switch) File allows the XMLFeatureMapper to automatically configure itself to read "known" XML datasets without the need to specify in advance the appropriate xfMap(s). If no xfMap and no XRS are specified for this transformer, then the default XRS document is used. The default XRS document is named xrs.xml, and it is located in the xml/xrs subfolder of the FME installation folder. For more information regarding the XRS, see the XML Reader documentation in Workbench Help > FME Readers and Writers Reference.

Specifies the name for the attribute whose default value is the file path of the XML document or an empty string if the XML document was specified wholly as an attribute value; the XML Source Value parameter can be used to override these default values.

Specifies the value to be used by the attribute specified by the XML Source Name parameter.

Sets the name for the attribute that enumerates the features mapped per XML document.

Sets the name for the attribute to store the feature type for the mapped features.

Setting this parameter to Yes will merge the attributes from the input feature to the output features.

Exposes any attributes so they can be used by other transformers. Type directly in the text box or click the browse button to display the editor and add attributes there.

Editing Transformer Parameters

Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Dialog Options - Tables

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for samples and information about this transformer on the FME Community.