Encodes binary data to text using Base64 or HEX encoding methods. The transformer can convert attributes that contain any type of data. This is useful when a binary file, such as an image, must be included in a text file.
Unlike the TextEncoder transformer, this transformer will not change the character encoding of text attributes. The TextEncoder converts all attribute values to UTF-8 before they are encoded. This transformer simply encodes the attribute using its existing character set.
Parameters
Encoding Type
Identifies the method the transformer will use to encode the attribute: HEX (default) or Base64.
Encode to Different Destination Attributes
With this enabled, destination attributes other than the input attributes may be specified for the encoder output. When disabled, the encoding occurs in place, that is, the values of each attribute are overwritten by the output of the transformer.
Attribute(s) to Encode
A comma seperated list of input attributes. The values of these attributes will be encoded using the selected method.
Destination Attribute(s)
A user-defined comma separated list to store the encoded data which becomes available when Encode to Different Destination Attributes is enabled. The ordering of these attributes follows the ordering of the attributes specified in Attribute(s) to Encode. For example, if in Attribute(s) to Encode we have 'a,b,c' and in Destination Attribute(s) we have 'x,y,z', then the encoding of 'a' will be written to 'x', the encoding of 'b' will be written to 'y', and the encoding of 'c' will be written to 'z'.
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.
How to Set Parameter Values
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.
Content Types
| 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.
Table Tools
|
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.
Transformer History
Selecting HEX as the Encoding Type replaces the HexEncoder transformer, which is now deprecated.
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.
Keywords: HexEncoder