AttributeCreator

Adds attributes to features, optionally assigning values. Values may reference adjacent features.

Jump to Configuration

Typical Uses

Creating a single new feature with attributes
Add a new attribute to a feature and assign it a value
Add a new empty attribute to a feature for use elsewhere in the workspace
Unmelting (reverse melting) data

How does it work?

The AttributeCreator adds new attributes to a new or existing feature, optionally setting value and type.

New attributes are added at the top. Duplicate names are not identified, and are not added more than once.

Optional Input Port

This transformer has two modes, depending on whether a connector is attached to the Input port or not:

Input-driven: When input features are connected, the transformer runs once for each feature it receives in the Input port.
Run Once: When no input features are connected, the transformer runs one time and outputs a single new feature.

Examples

Advanced Example: Using Multiple Feature Attribute Support

Adjacent Feature Attributes are accessed under Advanced: Attribute Value Handling. When turned on, you can specify a number of features preceding and following the current feature to reference in calculating new values.

Suppose we are given the dataset below:

ID	Latitude	Longitude
0	49.1640	-123.061
1	49.1643	-123.063
2	49.1642	-123.062
3	49.1642	-123.064

If the Number of Prior Features and Number of Subsequent Features parameters are both set to 2, then when the first feature is read, the AttributeCreator has access to the following features:

Feature Reference	ID	Latitude	Longitude
feature[-2]	<missing>	<missing>	<missing>
feature[-1]	<missing>	<missing>	<missing>
current feature	0	49.1640	-123.061
feature[+1]	1	49.1643	-123.063
feature[+2]	2	49.1642	-123.062

Note that some attributes are missing because no features exist prior to the first feature.

After the second feature is read, the window of prior and subsequent features available to the AttributeCreator shifts to produce the following:

Feature Reference	ID	Latitude	Longitude
feature[-2]	<missing>	<missing>	<missing>
feature[-1]	0	49.1640	-123.061
current feature	1	49.1643	-123.063
feature[+1]	2	49.1642	-123.062
feature[+2]	3	49.1642	-123.064

This statement would calculate the average latitude of the two preceding features:

Calculations referencing adjacent features can be created in the Arithmetic Editor and the Text Editor. These editors will list the attributes of the currently processed feature first, then the prior features, then the subsequent features.

Usage Notes

Consider using the AttributeManager instead.
To melt data, see the AttributeExploder (alias Melter).

Configuration

Input Ports

Output Ports

Parameters

Advanced: Attribute Value Handling

Substitute Missing, Null, and Empty by

Specifies the desired behavior when the referenced attribute does not exist, has a null value, or has an empty string value.

Such attributes can be thought of as unresolved attributes. For example, since there are no features prior to the first input feature, the AttributeManager will fail to resolve the value of feature[-1].AttrName for the first input feature.

If this parameter is set to No Substitution, the AttributeManager will resolve all unresolved attributes with an empty string if they are used in a larger expression. If the unresolved attribute is assigned directly and is not part of a larger expression, then the Output Attribute will be unresolved in the same way. For example, if B is missing, and A is set to @Value(B), then A will be missing as well. But if A is set to "B = @Value(B)", A will have the value of "B = ".

As another example, if the value of feature[+2] is the empty string and Default Value is specified, then the empty string will be treated as an unresolved attribute, and will be resolved as the value specified under Default Value.

If this parameter is set to Closest Adjacent Feature, then the unresolved attributes will be resolved as the corresponding attribute of the closest feature, if such a feature exists. When looking for closest features, features with unresolved attributes are skipped. If a prior or subsequent feature has unresolved attributes, it is possible that the current feature is used to resolve the missing attributes.

For example, if the value of feature[-2].AttrName is unresolved, then to resolve the value of feature[-2].AttrName the AttributeManager will look at the closest features to feature[-2], alternating between features prior to and subsequent to feature[-2]. It will first look at feature[-3].AttrName, followed by feature[-1].AttrName if needed, and then feature[-4].AttrName if needed, until all prior and subsequent features specified have been exhausted.

If the attribute remains unresolved within the specified prior and subsequent features, then it will be resolved as the value specified in the Default Value parameter.

Default Value

This parameter specifies the value used to resolve unresolved attributes in these cases:

Substitute Missing, Null and Empty by: is set to Default Value
Substitute Missing, Null and Empty by: is set to Closest Adjacent Feature and a value is not found in within the number of prior and subsequent features specified.

Enable Adjacent Feature Attributes

When enabled, you may set an attribute value (in the Attribute Actions table) based on the attributes of features prior or subsequent to the current feature by referencing them as follows:

Attributes of prior features are referenced as feature[-1].AttrName, feature[-2].AttrName, and so forth.
Attributes of subsequent features are referenced as feature[+1].AttrName, feature[+2].AttrName, and so forth.
Attributes of the currently processed feature are accessed directly without a prefix, such as AttrName.

When retrieving the value of a prior feature, any changes made by the AttributeManager to that feature will take effect.

Number of Prior Features

This parameter specifies the maximum number of prior features that can be referenced by the AttributeManager.

If Multiple Feature Attribute Support is enabled, this must be a value from 0 to 100.

As additional features must be read for each feature processed, defining only the maximum number of features needed to be retrieved will improve performance.

Number of Subsequent Features

This parameter specifies the maximum number of subsequent features that can be referenced by the AttributeManager.

If Multiple Feature Attribute Support is enabled, this must be a value from 0 to 100.

As additional features must be read for each feature processed, defining only the maximum number of features needed to be retrieved will improve performance.

New Attributes

This table specifies the new attributes to be created.

Output Attribute

Enter the name of the new attribute.

Names may also be assigned using expressions or the context menu to retrieve existing attribute values, User Parameters, or assign conditional values.

Value

New attributes can be left without a value for use elsewhere, or you can set new values here by clicking in the appropriate row and:

Entering a new constant value
Entering an expression
Selecting another attribute to copy values from
Using any of the available tools in the drop-down context menu to create expressions, formulas, conditional values, and more. The ellipses button will open the Text Editor, and the arrow button provides further options on the context menu.

See Defining Values below for detailed information on using these options.

Type

Specify the attribute's data type. The ellipses button will open an Attribute Type Definition dialog, which can assist with setting Type, Width, and Precision (where necessary).

The attribute is tagged with the specified Type information, but type limitations are not enforced on values at this point, and so mismatches between type and value are possible. Type may be enforced elsewhere in the workspace, such as in writers or by using an AttributeValidator or Tester to check values against type.

Available data types include:

Type	Description	Range (if applicable)	fme_data_type
binary(width)	Binary stores fixed-length binary data. Width defines the size, in bytes.		fme_binary(width)
binarybuffer	Binary buffer stores unbounded (of any size) binary data.		fme_binarybuffer
buffer	Buffer stores unbounded (of any length) character strings.		fme_buffer
char(width)	Character stores fixed-length string data. Width defines the maximum number of characters that can be stored. No padding is required for strings shorter than this width - they may be of any length up to the defined width.		fme_char(width)
date	Date store dates as character strings with the format YYYYMMDD. See Standard FME Date/Time Format.		fme_date
datetime	Date/Time stores dates as character strings with the format [Date][Time], as in: YYYYMMDDHHMMSS.FFF The [Time] component may be formatted with or without fractional seconds, and with or without a UTC offset. See Standard FME Date/Time Format.		fme_datetime
int16	Integer, 16-bit stores signed integers in 2 bytes (16 bits) of space.	-32768 to 32767	fme_int16
int32	Integer, 32-bit stores signed integers in 4 bytes (32 bits) of space.	-2147483648 to 2147483647	fme_int32
int64	Integer, 64-bit stores signed integers in 8 bytes (64 bits) of space.	-9,223,372,036,854,775,808 to 9,223,372,036,854,775,807	fme_int64
int8	Integer, 8-bit stores signed integers in 1 byte (8 bits) of space.	-128 to 127	fme_int8
json	JSON stores unbounded strings formatted in JSON (JavaScript Object Notation).		fme_json
logical	Logical stores TRUE/FALSE data, which may be any of: An integer value of 1 (true) or 0 (false) Any string that begins with "t" or "y" (true), or "f" or "n" (false), or NULL.		fme_boolean
number(width, precision)	Number stores single and double precision floating point values. Width is the total number of characters allocated to the field, including the decimal point. Precision controls the precision of the data and is the number of digits to the right of the decimal.		fme_decimal(width,decimal)
real32	Real32 stores floating-point numeric data that occupies 4 bytes (32 bits) in standard IEEE floating-point format. There is no ability to specify the precision and width of the field.	3.4E +/- 38 (7 digits)	fme_real32
real64	Real64 stores floating-point numeric data that occupies 8 bytes (64 bits) in standard IEEE floating-point format. There is no ability to specify the precision and width of the field.	1.7E +/- 308 (15 digits)	fme_real64
time	Time store times as character strings with the basic format YYYYMMDDHHMMSS.FFF They may be formatted with or without fractional seconds, and with or without a UTC offset. See Standard FME Date/Time Format.		fme_time
uint16	Unsigned integer, 16-bit stores integers greater than or equal to 0 in 2 bytes (16 bits) of space.	0 to 65535	fme_uint16
uint32	Unsigned integer, 32-bit stores integers greater than or equal to 0 in 4 bytes (32 bits) of space.	0 to 4294967295	fme_uint32
uint64	Unsigned integer, 64-bit stores integers greater than or equal to 0 in 8 bytes (64 bits) of space.	0 to 18,446,744,073,709,551,616	fme_uint64
uint8	Unsigned integer, 8-bit stores integers greater than or equal to 0 in 1 byte (8 bits) of space.	0 to 255	fme_uint8
varbinary(width)	Variable-length binary data. Width defines the maximum size, in bytes.		fme_varbinary(width)
varchar(width)	Variable character fields store variable length strings. Width controls the maximum number of characters that can be stored by the field. These are often used to optimize storage.		fme_varchar(width)
xml	XML stores unbounded strings formatted as XML(Extensible Markup Language).		fme_xml

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.

Reference

Processing Behavior	Feature-Based Exception: Enable Adjacent Feature Attributes
Feature Holding	No
Dependencies	None
Aliases	AttributeSetter NullAttributeCreator UnMelter
History

FME Online Resources

The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.

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

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.