Recorder

Saves a copy of all the features that enter to a disk file. This disk file can later be "played back" in the subsequent workspace by using the Player, or viewed using the FME Data Inspector.

Configuration

Parameters

General

Output Feature Store File

Specifies the output .ffs file.

Password

Provides a level of password protection for the created file. Before the file can be read, the password will have to be reentered.

Create Spatial Index

If set to Yes, creates and outputs a spatial and feature index for each feature store. The index has the same base name as the FFS file, but will have an .fsi extension. Spatial Indexes are needed if the FFS file is later used as the source for spatial queries or feature types by the FFS reader.

Note If a spatial index is created, Compression Method and Compression Level are ignored; to allow for efficient random access, a non-compressed .ffs file is output.

Compression

Compression Method

LZ4 (fastest) (default) – Uses a fast algorithm to reduce the size of the recording. Results in larger file sizes than Zstandard compression.
Zstandard – Reduces the size of the recording with a general-purpose algorithm. Compression Level is used to determine the tradeoff between writing speed and file size.
None – Does not reduce the size of the recording.

Note Compression is best suited for sequential access; to allow for efficient random access for spatial operations, it is disabled and set to None if Create Spatial Index set to Yes.

Compression Level

Reduces the size of the output recording.

Higher numbers mean more compression and smaller output files; and additional CPU is expended to create files.

Note Compression is best suited for sequential access and is disabled if Create Spatial Index set to Yes to allow for efficient random access for spatial operations.

Store Scanned Schema

When this option is set to Yes, schemas will be recorded and stored in the output FFS file. If it is set to No (default), schemas will not be passed along to the output file.

Store Scanned Metadata

Metadata includes feature types, geometry types, feature count, and extents.

Yes: Additional metadata will be recorded and stored in the output FFS file.
No (default): Metadata will not be stored in the output file.

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	Yes when Recording Mode is Record
Dependencies	None
Aliases
History

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 Recorder 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.