XMLFeatureMapper

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.

Configuration

Input Ports

Output Ports

Parameters

XML Source

XML Source Type	Determines whether the XML Source will be specified using an XML file or as an attribute value.
XML File	Specifies the XML file to be used as the XML Source.
XML Attribute	Specifies the attribute whose value is the XML Source.

General

Configuration Type, xfMap File, xfMap Script, xfMapAttribute, xfMap File(s), XRS File	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.
Merge Attributes From Input Feature	Setting this parameter to Yes will merge the attributes from the input feature to the output features.
Ignore External DTD	Setting this parameter to Yes instructs the underlying XML parser to disable the loading of an external DTD.
Entity Resolver	By the default this parameter is Enabled and a custom entity resolver is used to resolve external entities such as DTDs. The installed custom entity resolver relies on an URI Map that incoming URIs to resolved URIs. The resolved URIs are usually URLs with local copies of the resource. If an XML document does not have any external entities that need to be resolved, this parameter may be Disabled and the URI Map will not be loaded unnecessarily.

Output Attribute Names

XML Source Name	Name the attribute to contain 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.
XML Source Value	Specifies the value to be used by the attribute specified by the XML Source Name parameter.
Feature Count	Name the attribute to contain the number of features mapped per XML document.
Feature Type	Name the attribute to contain the feature type for the mapped features.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

How to Set Parameter Values

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.

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.

Content Types

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

Table Tools

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.

For more information, see Transformer Parameter Menu Options.

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 all results about the XMLFeatureMapper on the FME Community.