BulkAttributeRenamer

Renames attributes by adding or removing prefixes or suffixes, or replacing text using regular expressions or character strings. This transformer is useful if you need to quickly rename all (or many) of your attributes.

Jump to Configuration

Typical Uses

Rename multiple attributes to match a naming convention
Add prefixes or suffixes to attribute names
Remove prefixes or suffixes from attribute names
Change the case of attribute names
Replace a string in attribute names

How does it work?

The BulkAttributeRenamer lets you select either all attributes or specific ones, and then choose a renaming method. All attributes on features that enter the transformer are modified according to your selections.

If the renaming process results in an empty attribute name, that attribute will be removed - for example, removing a suffix where the suffix itself is the whole attribute name.

The values of attributes are unchanged.

Examples

Usage Notes

This transformer is specifically for changes to attribute names. To change attribute values use the StringReplacer or AttributeManager transformers.
Use the AttributeManager to rename individual attributes, with the option of supplying a default value if the original attribute was not present.
Use the StringCaseChanger to change the case of attribute values (not names).
If Rename All attributes is chosen, unexposed format attributes may also be renamed, which may produce unexpected results. Consider using Selected Attributes and the attribute pick list for finer control.

Configuration

Input Ports

Output Ports

Parameters

General

Action

Select the type of renaming you want to do to the attributes chosen above. Options include:

Add String Prefix	The string input for the String parameter will be prepended to (added to the beginning of) all chosen attributes
Add String Suffix	The string input for the String parameter will be appended to (added to the end of) all chosen attributes
Remove Prefix String	Chosen attributes that start with the character sequence input for String parameter will be truncated to exclude the starting string character sequence
Remove Suffix String	Chosen attributes that end with the character sequence input for String parameter will be truncated to exclude the ending string character sequence
Regular Expression Replace	The regular expression input for the Text To Find parameter will be replaced in chosen attributes with the character sequence input for the String parameter
String Replace	The character sequence input for the Text To Find parameter will be replaced in chosen attributes with the character sequence input for the String parameter
Change Case	Chosen attributes will have their case changed according to the Case Change Type parameter

Mode

Whether or not the original attribute names should be kept in addition to the new ones.

Rename	Default mode - renames attributes as defined in your selections.
Keep Original Attributes	Creates a duplicate set of attributes with the new names as defined, and appends it to the current attributes. Values are duplicated as well.

Text To Find

When using the Regular Expression Replace or String Replace actions, enter the item you would like to replace here. The replacement string goes in the String parameter.

If the Action parameter is set to Regular Expression Replace, the Regular Expression Editor will be available in the Text To Find parameter menu.

Case Sensitive

Indicate whether or not the comparison should be case-sensitive.

String

The character sequence to prepend, remove, append, or use as replacement string.

Case Change Type

For use with the Change Case action.

UPPERCASE	Changes attributes to uppercase characters
lowercase	Changes attributes to lowercase characters
Title case	Changes the first character in the string to its Unicode title case variant (or to uppercase if there is no title case variant) and the rest of the string lowercase
Full Title Case	Converts the first letter of each word, rather than just the first letter in the string. Full Title Case will ignore parentheses if they start the string or follow whitespace, and will treat hyphens (-) and underscores (_) as whitespace characters

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
Feature Holding	No
Dependencies	None
Aliases
History	Replaces the AttributePrefixer and the AttributeExpressionRenamer

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 all results about the BulkAttributeRenamer 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.