FME Transformers: 2024.1

Categories
Workflows

Workflows

Related Transformers
Recorder
Categories
Workflows

Workflows

Related Transformers
Recorder

Player

Retrieves features stored in an FME Feature Store (FFS) file and outputs them into the workspace.

FME Feature Store files can be created with the Recorder transformer, or with the FME Feature Store writer. See the FME Feature Store Reader/Writer chapter in the FME Readers and Writers manual for more details on this format.

Features in an FFS file are stored along with a feature type string. The saved feature type will depend on the way the features were written to the FFS file.

  • If the features originate from a Recorder, this string will be __RECORDED__, unless a Feature Type Attribute was specified in that transformer.
  • If the features were created by the FFS writer, the string will be the name of the destination feature type to which the features were routed.

Configuration

Parameters

Playback At End

  • Yes: The player will execute after all reader features have been processed.
  • No: The feature is created immediately before the first reader feature is processed.

Input Feature Store File

Type or select the FME Feature Store (*.ffs) file to be played back.

Password

The optional password must be provided if the FME Feature Store file being read was produced with a password. The player will fail if the password does not match the password used to create the file.

Max Features to Read

The maximum number of features to read from the Input Feature Store File.

Attributes to Expose

Exposes attributes so they can be used elsewhere in the workspace.

Attribute names may be entered directly or provided in the Enter Values for Attributes to Expose dialog accessed via the ellipsis button, where data type may also be specified.

For more information on exposed and unexposed attributes, see Understanding Feature Types and Attributes.

This is useful if you know the attributes for the recorded features.

Recorded Feature Type Attribute

The saved feature type of each feature will be stored in the Recorded Feature Type Attribute, if one is specified.

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.

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.

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.

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.

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 Player on the FME Community.