AttributeEncoder
Encodes the values of the specified attributes to the desired encoding. If the incoming attribute is Null, the type of the attribute will be set to the desired encoding but the output value will be Null.
Typical Uses
- Converting attributes to a known encoding type
How does it work?
The AttributeEncoder receives any type of feature. Once connected, you may choose All Attributes or choose Selected Attributes for encoding. A wide variety of encoding types is available, including multiple languages, Unicode types, ISO types, and more.
You may either convert and mark the attributes with the new encoding (using the Honor Encoding option for Incoming Attributes), or simply mark them without conversion (Use Bytes for Incoming Attributes).
Usage Notes
- Unless a scenario requires re-encoding (or encoding definition) within the workspace, consider using the encoding parameters in your readers and writers instead of the AttributeEncoder.
Configuration
Input Ports
Features with attributes to be encoded.
Output Ports
Features with encoded attributes.
Parameters
Encode |
All Attributes: Encode the value of all attributes except fme_ attributes. Selected Attributes: Specify a list of attributes to encode. |
Selected Attributes | The subset of attributes for which you want the value encoded. |
Destination Encoding | The desired encoding for the attributes. |
Incoming Attribute |
Honor Encoding: The value of the attribute is converted to the desired encoding based on the current attribute encoding. Use Bytes: No conversion will be done and the bytes in the attribute value will just be marked with the desired encoding. If the Destination Encoding is Binary (fme-binary), the transformer will produce the same result for both Honor Encoding and Use Bytes. |
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 - whether entered directly in a parameter or constructed using one of the editors.
These functions manipulate and format strings. | |
A set of control characters is available in the Text Editor. | |
Math functions are available in both editors. | |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
FME and workspace-specific parameters may be used. | |
Working with User Parameters | Create your own editable parameters. |
Reference
Processing Behavior |
|
Feature Holding |
No |
Dependencies | None |
FME Licensing Level | FME Base Edition and above |
Aliases | |
History | |
Categories |
FME Knowledge Center
The FME Knowledge Center 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 AttributeEncoder on the FME Knowledge Center.
Examples may contain information licensed under the Open Government Licence – Vancouver