FMEFlowLogFileRetriever

Categories

Integrations

Web

Workflows

Accesses the translation log for a specified FME Flow-run translation.

The translation log to access is identified by the job ID input parameter.

This transformer requires an FME Flow connection.

Configuration

Output Ports

The initiating feature is output via the Succeeded port if the translation log was successfully retrieved for the specified job ID, and will have these attributes added to it:

  • _log_attr: the contents of the translation log for the specified job

The feature will be output via the Failed port if the translation log was not successfully retrieved for the specified job ID, and will have these attributes added to it:

  • _job_failure_type: contains the reason for the translation log retrieval failure
  • _log_attr: the contents of the translation log for the specified job, obtained before an error occurred

Parameters

Connection

You can connect to FME Flow in one of the following ways:

Specify a web connection to FME Flow. Web connections can be reused in multiple workspaces, and connection parameters are hidden in the workspace. For more information, see Using Web Connections.

SAML Authentication

SAML (Security Assertion Markup Language) authentication is not available for these FME Flow transformers:

See SAML Configuration and Automations for more information and alternatives.

When checked, you must specify the connection parameters to FME Flow manually. The connection parameters are visible in the workspace. To connect, specify:

Enter a URL to access FME Flow. You may need to contact your System Administrator for the URL.

Provide your FME Flow credentials.

Note  You can click the Status hyperlink to ensure that the FME Flow connection has been successfully established.

Job ID

This parameter is the job ID of the translation log that is to be requested.

Retrieved Log

Name the attribute to contain the translation log.

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 all results about the FMEFlowLogFileRetriever on the FME Community.