XMLFormatter

Input features that contain the XML document information.

If a feature is successfully formatted, it will be output through this port.

If a feature does not have a well-formed XML document, it will be output through this port.

Selecting from the list enables that selection's corresponding parameter:

• Attribute with XML Text: Choose the attribute that contains XML Text.
• XML Filename: Browse to the XML file.

Select the desired formatting of the XML input:

• None: No formatting is performed
• Pretty-Print XML: XML elements will be formatted by adding indentations and new lines for improved readability. Any white spaces between the start tag and end tag will be preserved.
• Linearize: All XML contents will be put on a single line.

Select the desired whitespace handling for XML Formatting:

Preserve all whitespace: all whitespace are considered significant and will be preserved as much as possible

Remove excess whitespace: excess whitespace will be removed, lines containing only whitespace characters, from the start tag to the first non-whitespace character and from the last non-whitespace character to the end tag.

As defined by xsi:schemaLocation: whitespace in the XML document is either significant or insignificant as defined by the schema in the xsi:schemaLocation attribute.

As defined by an external schema: whitespace in the XML document is either significant or insignificant as defined by an external schema file.

When enabled, pick an external schema file to be used to determine the significance of whitespace in the XML document.

Specifies the indentation size. The valid values are the numbers 0 to 9, with 1 being the default.

By default the Tab character is used to pretty-print the indentations; set this to Yes substitutes the Tab character with a Space. The size of a single indentation is controlled by the Indent Size parameter.

By default, the text within a tag is left untouched. If this parameter is set to Yes, the text will be pretty printed. If a tag contains both a text value element and another nested tag element, the second of either the text value or nested tag will not be pretty printed. The example below shows a block of XML code on the left along with its pretty printed output on the right.

When set to Yes, this parameter removes all comments within the XML input.

When set to Yes, this parameter removes the xml header (text declaration).

When set to Yes, this parameter removes elements that have no attributes and contain no content between the Start and End Tag.

For example,

<example> </example>

will be removed, however

<example property=”empty”/>

will not since it contains an attribute.

When set to Yes, this parameter creates an empty tag for elements that have no content between the Start and End Tag.

For example,

<example property=”empty> <example>

will be collapsed into

<example property=”empty”/>

Remove redundant and extraneous namespace declarations. For example, the following XML document that has redundant namespace declarations:

<root>

<f:element1 xmlns:f="http://www.w3schools.com/example">

<f:element2 xmlns:f=" http://www.w3schools.com/example"> some text </f:element2>

<f:element3 xmlns:f=" http://www.w3schools.com/example"> some text </f:element3>

</f:element1>

</root>

Selecting Yes for this parameter will return the following results:

<root>

<f:element1 xmlns:f="http://www.w3schools.com/example">

<f:element2> some text </f:element2>

<f:element3> some text </f:element3>

</f:element1>

</root>

When set to Yes, this parameter removes all embedded xsi:schemalocation attribute from all elements that are not the root element.

The XML features that have been successfully processed can be output to a feature attribute by specifying an attribute name in the Attribute to contain XML output parameter, or to a file by specifying the path to the file in theXML Output File parameter.

Specify an encoding for the XML output. If not specified, UTF-8 is used.

Features with at least one warning or error will be output through the Failed port with a new list attribute added to the features.

 If the default _xml_error is the list name, the elements of the list attribute contain the following:

Note: List attributes are not accessible from the output schema in Workbench unless they are first processed using a transformer that operates on them, such as ListExploder or ListConcatenator. Alternatively, AttributeExposer can be used.

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.

Note: Not all tools are available in all transformers.