XMLFlattener
Flattens content of XML element(s) into feature attributes.
This transformer provides a quick and easy way to output any content or attributes of an XML element as feature attributes by specifying the element name or path. Optionally, the XML attributes from the ancestors of the specified elements can be fetched as FME attributes as well.
The XMLFlattener does not currently support multiple matches, so for generation of multiple features from the source XML, please use the XMLFragmenter.
Configuration
Input Ports
Input features that contain the XML document information.
Output Ports
Each feature will contain attributes that are flattened from the XML element(s).
Parameters
XML Source Type, XML File, XML Attribute |
Selecting from the list enables that selection's corresponding parameter:
|
Elements to Match |
This parameter specifies which elements to flatten. The Flatten Paths are whitespace-separated xfMap match expressions or each expression can be specified on a new line. For more information, see the FME Readers/Writers manual: XML (Extensible Markup Language) Reader/Writer > xfMap. Type directly in the text box or click the browse button to display the editor or select Set to Attribute Value to pick a feature attribute containing the element expressions. The Feature Paths are whitespace-separated xfMap match expressions. For more information, see the FME Readers/Writers manual: XML (Extensible Markup Language) Reader/Writer > xfMap. Example: input.xml <shiporder> <orderperson>John Smith</orderperson> <shipto> <name>Ola Nordmann</name> <address>Langgt 23</address> <city>4000 Stavanger</city> <country>Norway</country> </shipto> <item id="1" status=”pending”> <title>Empire Burlesque</title> <note>Special Edition</note> <quantity>1</quantity> <price>10.90</price> </item> <item id="2" status=”shipped”> <title>Hide your heart</title> <quantity>1</quantity> <price>9.90</price> </item> </shiporder> This table lists some Flatten Paths xfMap expressions shown in the above example.
|
Elements as XML Fragments |
This parameter can be specified to extract the children of the matched elements as xml fragments. For example, If Elements to Match is shipto and Elements As XML Fragments is set to country , then the output feature has an extra attribute "xml_fragment_country{0}" with its value set to "<country>Norway</country>" |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Flatten Options |
The Options button opens the XML Flatten Options dialog. These options control how the content of the elements are to be mapped as feature attributes. The default view is Basic mode, where several options are listed:
The Advanced button opens the Advanced Editor, which provides additional options for customizing the feature attributes. The functionality of each option is described in the table below. The options here allow customization of the attributes and attribute lists of the matched XML subtree that will be added to FME Features.
All the options have more detailed examples and descriptions in the FME Readers/Writers manual: XML (Extensible Markup Language) Reader/Writer. |
Attributes to Expose |
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.
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.
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.
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
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:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
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.