Logger

Categories

Workflows

Logs each feature to the translation log at the specified severity. All attributes and geometry of the feature will be output.

Limits can be placed on both the number of features that will be logged, and the number of coordinates that will be logged per feature.

Input Ports

Features to be logged.

Output Ports

All logged Input features are output to this port unchanged.

Parameters

General

The maximum times for this logger to log features or messages.

Note: The Workbench parameter Max Features to Log takes precedence over this transformer parameter.

The level the feature and message should appear in the log. The Log window shows Information as black, Warning as blue and Error as red.

The setting indicates the logging level only and does not affect execution. Thus, if Error is chosen, even though the message is logged as ‘error’, the translation will not stop.

Whether or not to log features with the message and whether or not to record.

If Log Only is selected, the message and feature will be logged to the log only.

If Log and Record is selected, in addition to being logged, the feature will also be recorded in an FFS file. The log message and severity will appear as an attribute on the feature. The FFS file will be located in the same directory as the log and named <workspacename>_log.ffs.

If Message Only is selected, the log message will be logged but not the feature.

If logging features, this parameter specifies the number of coordinates to be logged. If a feature has more than the maximum allowed coordinates, then only a set of coordinates at the beginning and end of the feature will be logged.

If you enter -1, all coordinates will be logged. If any other value is specified, only the first <maxCoords> coordinates will be logged.

The Feature Type Override text will set the feature type of the feature just prior to it being logged. This setting is most useful to control the feature type of the features in the recorded FFS file.

If this parameter is left blank, the feature type is constructed from the transformer's name and output port. This can be useful to determine the origin of features when there are multiple Loggers in a workspace.

If present, a message that is logged before each feature is logged.

Usage Notes

  • An alternate way to see the attributes and geometries of features is to route them into an Inspector transformer, which will display them in the FME Data Inspector.
  • The Logged port should be used to guarantee that the features are logged before they are further processed. If a Logger does not output features, the logging may occur after other transformers have completed. The logging may not even take place if the workspace terminates early.
  • Null values will be logged as "is <null>", whereas strings whose content is "<null>" will be logged as "has value '<null>'".
  • To quickly attach Logger transformers: right-click on one or more selected reader feature types and choose Connect Loggers.

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.

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.

Dialog Options - Tables

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.

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 samples and information about this transformer on the FME Community.

Keywords: raster grid band channel palette lookup LUT colormap log describe dump lumberjack Lumberjack