FME Transformers: 2025.0

FMEFlowJobWaiter

Note  This transformer is no longer supported as of FME 2025.0. Use an HTTPCaller to call the relevant REST API directly.

Waits until submitted FME jobs are started or finished by FME Flow.

The list of jobs to wait for is identified by the job IDs of the input features. When a job that the transformer is waiting for starts or completes, it outputs the corresponding feature immediately.

Note  This transformer should not be used if your FME Flow instance has only one engine.

This transformer requires an FME Flow connection.

Configuration

Output Ports

The initiating feature is output via the Output port if the job successfully ran to completion, and will have these attributes added to it:

  • _job_id: the integer ID the server assigned to this job
  • _numFeaturesOutput: the number of features that were output by the job
  • _priority: the priority assigned to the job
  • _requesterHost: the name of the machine through which results are returned
  • _requesterResultPort: the port on the machine through which results are returned
  • _status: job status indicator; if waiting for job to start, it can be SUCCESS or PULLED; if waiting for job to finish, it is SUCCESS
  • _statusMessage: the translation result message
  • _timeFinished: the time the job finished
  • _timeRequested: the time the server received the job request
  • _timeStarted: the time the server started processing the job

All times are in YYYYMMDDhhmmss format.

The feature will be output via the <Rejected> port if the job either did not run to completion, or the server could not be contacted, and will have these attributes added to it:

  • _failure_reason: the reason when unable to wait for a job
  • _http_status_code: the HTTP status code when unable to wait for a job
  • _job_id: the integer ID the server assigned to this job
  • _numFeaturesOutput: the number of features that were output by the job
  • _priority: the priority assigned to the job
  • _requesterHost: the name of the machine through which results are returned
  • _requesterResultPort: the port on the machine through which results are returned
  • _status: job status indicator; it can be ABORTED, FME_FAILURE, or JOB_FAILURE
  • _statusMessage: the error message returned from the server explaining why the request failed
  • _timeFinished: the time the job finished
  • _timeRequested: the time the server received the job request
  • _timeStarted: the time the server started processing the job

All times are in YYYYMMDDhhmmss format.

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.

Wait for Job to

Specifies whether to wait for a job to Complete or Start.

Job ID

The list of jobs to wait for is identified by the job IDs of the input features. When a job that it is waiting for starts or completes, it outputs the corresponding feature immediately.

Polling Interval

The time interval for this transformer to wait between inquiries into the status of each job is specified by the Polling Interval. This is measured in seconds and can be entered as an integer value or an integer attribute.

Note  You should use as large value as possible for this parameter. If it is set too small, it not only impacts the resources on the client, but also on the FME Flow instance responding to each query. For example, if the job is expected to take about 20 minutes, then it is not efficient to set the Polling Interval to a few seconds.

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.

Reference

Processing Behavior

Feature-Based

Feature Holding

No
Dependencies None
Aliases ServerJobWaiter FMEServerJobWaiter
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 FMEFlowJobWaiter 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.