Run a Workspace

The Run a Workspace action receives messages from triggers or other actions and runs an FME Desktop workspace that has been uploaded to FME Server.

To use the contents of the message in the workspace, specify a workspace published parameter to receive the data. Alternatively, use readers, writers, or transformers that are equipped to receive JSON-formatted messages.

Tip: Automations can run multiple Run a Workspace actions in parallel, depending on availability of FME Engines. For more control over engine allocation, use Queue Control.

Output Ports

All Run a Workspace actions have success and failure output ports. The success port () can send a message if the workspace completes successfully. The failure port (x) can send a message if the workspace fails to complete.

Note: When Retry settings are configured, the failure port renders with a Retry Configured (⟳) icon.

Additionally, if the specified workspace is configured with FME Server Automations writers, the Run a Workspace action contains output ports corresponding to each writer feature type.

For more information:

Details

  • Action: Select Run a Workspace.
  • Repository: Specify the repository in which the workspace resides.
  • Workspace: Specify the workspace you want to run.

Parameters

If the specified workspace has any published parameters, configure the settings you desire when the workspace runs.

Note: See also Working with Parameters in Automations Workflows.

Tip: If a newer version of the workspace is republished to FME Server while the current Run a Workspace action is open, click the Reset and Refresh Parameters button to apply any updates to published parameters.

Output Keys

Advanced

Retry

Job Statistics

You can view useful information about how a workspace has performed from a Run a Workspace action, since the workflow was last started. This information can help you make important decisions about how to run the workspace, particularly when configuring Queue Control. If the same workspace is referenced from more than one Run a Workspace action in the workflow, Job Statistics applies only to the selected action. Statistics are reset each time the workflow is started.

  • Average % CPU: Average percentage of processing time that is recorded as CPU time, calculated as Average CPU Time / Average Elapsed Time.
  • Average CPU Time: Average CPU time to run the workspace.
  • Average Elapsed Time: Average total processing time of the workspace.
  • Average Peak Memory Usage: Average maximum memory the workspace required while processing.
  • Total Runs: The number of times the workspace has run since the workflow was last started.