TextEncoder

Encodes a text string using URL, Unicode, XML, HTML, Base64, HEX, or Octal methods.

URL (Percent Encoding)

This encoding is used to ensure that a string is valid for inclusion in a URL. All characters that are not a letter, digit, dash, period, underscore or tilde will be encoded. The TextEncoder converts a plain text string, such as black & white into its encoded form black%20%26%20white.

Unicode

Non-ASCII characters are encoded in an ASCII string. All characters with standard ASCII representations are not encoded. The TextEncoder encodes in any of these representations:

Surrogate Pairs: Any code point in the range U+0000 to U+FFFF encodes as \uXXXX. For code points greater, the encoding takes the form of a surrogate pair \uXXXX\uXXXX according to the UTF-16 encoding scheme.
ECMAScript 6: All code points encode as \{XX...X}, where there may be 4-6 hexadecimal digits contained within the braces. This is the Unicode escape sequence convention according to ECMAScript 6.
ECMAScript 6 (Large Code Points Only): Any code point in the range U+0000 to U+FFFF encodes as \uXXXX. All code points outside of this range encode as \{XX...X}.
Python: Any code point in the range U+0000 to U+FFFF encodes as \uXXXX, and any code point greater encodes as \UXXXXXXXX. This is the Python convention.

XML

This encoding is used to ensure strings are acceptable for use in an XML document. Characters that have syntactic meaning in XML are escaped, using the following mapping:

Character	Encoded Value
<	<
>	>
"	"
&	&
'	'

In addition, the XML encoding allows for any character to be represented using the decimal or hexadecimal representation of its Unicode code point. The TextEncoder will convert a text string, such as black & white into its XML representation, black & white.

HTML

This encoding is an extension of the XML encoding. The HTML encoding includes many characters which cannot be represented using a simple Latin character set, such as ♪, ± or ∞. The TextEncoder will convert a text string, such as this ± that into its HTML representation, this &plusm; that.

Base64

Base64 encoding is a method of storing arbitrary data as an ASCII string. When this method is selected, the TextEncoder will convert a UTF-8 text string into a string of ASCII characters. Note that attributes will be converted to UTF-8 before they are encoded to Base64. If this is undesirable, consider using the BinaryEncoder, as it will not change the character encoding of attribute values

HEX

HEX encoding is another method used to store arbitrary data as an ASCII string. HEX encoded data is not as compact as Base64 encoded data. When this method is selected, the TextEncoder will convert a UTF-8 text string into a string of ASCII characters. Note that attributes will be converted to UTF-8 before they are HEX encoded. If this is undesirable, consider using the BinaryEncoder, as it will not change the character encoding of attribute values.

Octal

Octal encoding is another method used to store arbitrary data as an ASCII string. Octal encoded data is not as compact as HEX or Base64 encoded data. Each byte of data is represented by 3 encoded characters. When this method is selected, the TextEncoder will convert a UTF-8 text string into a string of ASCII characters. Note that attributes will be converted to UTF-8 before they are Octal encoded. If this is undesirable, consider using the BinaryEncoder, as it will not change the character encoding of attribute values.

Configuration

Parameters

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 has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.

Search for all results about the TextEncoder on the FME Community.

Keywords: URLEncoder decode encode

Encoding Type	Identifies the method the transformer will use to encode the attribute.
String to Encode	The value of this attribute will be encoded using the selected method.