FMEFlowJobSubmitter

Categories

Integrations

Web

Workflows

Submits FME jobs to be run on FME Flow. A job consists of a workspace (housed within a repository on FME Flow) together with values for each of its published parameters.

This transformer submits one job per feature which enters it. Any published parameters of the server workspace will be given values as specified in the transformer, or taken from attributes of the feature which enters it.

The FMEFlowJobSubmitter submits jobs via the FME Flow REST API and does not make use of the transformation services.

This transformer requires an FME Flow connection.

Configuration

Output Ports

Features that submitted the requests to the server and successfully completed. This port is only visible when Wait for Jobs to Complete is Yes.

Features that submitted the requests to the server, but failed to complete successfully. This port is only visible when Wait for Jobs to Complete is Yes.

Features that successfully submitted the requests to the server. This port is only visible when Wait for Jobs to Complete is No.

A single feature which details which jobs were submitted and which succeeded. This feature contains the following list attributes: _submitted_job_ids{}, _succeeded_job_ids{}, and _failed_job_ids{}.

Features that failed to submit the requests to the server.

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.

Submit Jobs

If this parameter is set to In Sequence, the transformer will submit each request as soon as it receives an initiating feature. If Wait for Jobs to Complete is Yes, the transformer will wait for the job to complete before processing the next feature.

Note  A sub-engine process will be spun up to run any child jobs. This Engine will follow the naming convention Engine_<n>@<ID> where <ID> is the Job ID of the parent job and <n> is the name of the Engine the parent is running on.

If this parameter is set to In Parallel, the transformer will wait until all input features are received, then send a set of requests for each unique combination of Repository and Workspace specified. If Wait for Jobs to Complete is Yes, the transformer will wait for all of the submitted jobs from one set of requests to complete before sending the next set.

Note  A minimum of two engines is required to use the FMEFlowJobSubmitterwhen the submission mode is In Parallel and Wait for Jobs to Complete is Yes.

Wait for Jobs to Complete

If this parameter is set to Yes, then the transformer will wait until the job is completely processed by the server before proceeding. In this case, the initiating feature is output via the Succeeded 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 features that were output by the job.
  • _priority: The priority assigned to the job.
  • _requesterHost: The name of the machine hosting FME Workbench that submitted the job.
  • _requesterResultPort: The port on the host machine through which results are returned.
  • _status: Job status indicator; can be SUBMITTED, QUEUED, ABORTED, SUCCESS, FME_FAILURE, JOB_FAILURE or PULLED.
  • _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 Failed port if the job did not run to completion, or to the <Rejected> port if the job could not be submitted, and will have these attributes added to it:

  • _job_failure_type: Holds one of "Connection or Server Problem" or "Translation Failed". If the latter, then the following attributes will also have values; otherwise, they are empty.
  • _numFeaturesOutput: The number features that were output by the job.
  • _priority: The priority assigned to the job.
  • _requesterHost: The name of the machine hosting FME Workbench that submitted the job.
  • _requesterResultPort: The port on the host machine through which results are returned.
  • _job_id: The integer ID the server assigned to this job.
    • Note  _job_id is included only if the job failure is related to an error during translation. If the job did not run due to a connection or server problem, then _job_id is not included.
  • _status: Job status indicator; can be SUBMITTED, QUEUED, ABORTED, SUCCESS, FME_FAILURE, JOB_FAILURE or PULLED.
  • _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.

If this parameter is set to No, the transformer will output the initiating feature as soon as the job is submitted to the server. In this case, the initiating feature is output via the Submitted port if the request was successfully submitted, and only the _job_id attribute will be added to it.  If the server could not be contacted or the job submission otherwise failed, then the feature is output via the <Rejected> port, and the _job_failure_type attribute will hold the "Connection or Server Problem" value.

Repository

Specify the FME Flow repository that contains the workspace you want to run.

Workspace

Specify the workspace to run for each feature that enters the transformer.

Any published parameters of the workspace to be run appear here. For each one, specify the value to pass when the workspace runs. To refresh the parameters from FME Flow, click the refresh icon.

Job Priority

Defines the order in which the job will be executed on the server.

Job Priority is not available when connecting to FME Server 2018.1 or newer.

When connecting to earlier versions of FME Server and while disconnected, this parameter is available. Priority values range from 1 to 200, where:

1 - Highest

100 - Normal

200 - Lowest

Job Queue

If supplied, submits the workspace to the specified Queue to follow the associated Engine Assignment Rules. If left empty, the workspace will be submitted to ‘Default’ Queue, unless the submission mode is In Sequence and Wait for Jobs to Complete equals Yes, in that case, FME uses an internal system queue with the name context-id-<UUID>.

For more information , see Queue Control.

Queued Job Expiry Time

The time, in seconds, after which a job that is waiting in queue does not execute. If the job does not execute before this time is reached, it remains in the queue until it is ready to execute, but execution is not attempted. This directive is useful for time-sensitive jobs that you do not want to run after the specified time is exceeded.

Running Job Expiry Time

The time, in seconds, a job will remain in the running state. This directive ensures that a job does not hang and block an FME Engine indefinitely. The minimum allowable value is 1.

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

Keywords: ServerJobSubmitter