WorkspaceRunner

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.

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.

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.

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.

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

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.  

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).

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.