WorkspaceRunner

Input

This transformer runs the specified workspace for each feature that enters through the Input port. Any published parameters of the specified workspace will be given values as specified in the transformer, or taken from attributes of the feature which enters it.

Succeeded

If the Wait for Job to Complete parameter is set to Yes, then the initiating feature is output through this port if the job successfully completed. If the Wait for Job to Complete parameter is set to No, the initiating feature is output through this port if the request was successfully submitted, though whether or not the workspace completes is unknown in this case.

Failed

If the new FME process could not be spawned, the feature will be output via the Failed port, and the _failure_message attribute will hold the reason for the failure.

Summary

If the Wait For Job to Complete parameter is set to No, and a value is given for the Maximum Number of Concurrent Processes, then the Summary port will output a feature with the attributes _proc_count and _processes{}.

The _proc_count attribute will contain the total number of processes executed by the WorkspaceRunner. The _processes{} attribute is a list of the process Ids. If the Wait For Job to Complete parameter is set to Yes, then Summary features will still have a _proc_count, but will not have a _processes{} attribute.

General

FME Workspace

Browse to select the additional workspace to run, or select an attribute that contains the full name and path of the workspace to run.

Wait for Job to Complete

If this parameter is set to Yes, then the transformer will wait until the workspace has finished running. In this case, the initiating feature is output via the Succeeded port if the job successfully ran to completion.

The initiating feature will be output via the Failed port if the workspace did not run to completion, and will have a _failure_message attribute added to it that contains the error message returned from the FME that ran the workspace.

If this parameter is set to No, the transformer will output the initiating feature as soon as an FME has been spawned off to do the translation. In this case, the initiating feature is output via the Succeeded port if the request was successfully submitted.

Maximum Concurrent FME Processes (1-7)

Each feature that enters the transformer causes an FME process to be launched to execute a workspace. To make maximum use of system resources, FME allows multiple processes to be run simultaneously.

This parameter defines the maximum number of FME processes allowed to run concurrently on a machine; for example if the value is set to 2, then the transformer will - if necessary - start two additional FME processes in order to execute multiple workspaces simultaneously.

However, in order to avoid overloading system resources, there is a limit of 8 concurrent FME processes on a system. The parameter value if set, must be an integer in the range 1-7. If no value is set, then a maximum of 7 concurrent FME processes can be started. Once the limit is reached subsequent workspaces must wait for an FME process to finish before they can be carried out.

The process limit is applied across all running FME processes. For example, if two workspaces are run concurrently, and both workspaces have WorkspaceRunners that will launch three additional concurrent processes each, then the limit of eight concurrent workspace processes is reached (one for each parent workspace and three additional processes each for their child processes).

Workspace Runs per FME Process

FME is able to use a single process to run multiple workspaces consecutively. This saves starting and stopping a new FME process for each workspace and is particularly useful when running workspaces that is performing small tasks. This parameter controls the number of workspaces that a single FME process will execute before shutting down, and is only available if Wait for Job to Complete is set to No.

For example, if this parameter is set to 4, then each FME process will execute four workspaces, one after the other, and then shut down.

Log File Name

Select a method for naming the log file generated upon running the workspace:

Honor Workspace Setting	Use the log file name specified in the Logging > Log File parameter of the selected FME Workspace.
Overwrite with Workspace Path/Name	Name the log file with the path and name of the specified workspace.
Overwrite with Workspace Path/Name and Timestamp	Name the log file with the path and name of the specified workspace and a timestamp of when it was run.

Workspace Parameters

If the specified FME Workspace contains published user parameters, they will be populated and settable here.

How to Set Parameter Values

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.

Content Types

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

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.

WorkspaceRunner

Usage Notes

Configuration

Input Ports

Output Ports

Parameters

Editing Transformer Parameters

FME Community