Run a Dynamic Workspace

The Run a Dynamic Workspace action receives messages from triggers or other actions and runs an FME Desktop workspace that has been uploaded to FME Server. The workspace that runs is determined dynamically based on the values of specified output keys, or expressions, that resolve to an existing named repository and/or workspace on the 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.

The published parameters for a Run a Dynamic Workspace action are pre-defined. All workspaces that run from the same Run a Dynamic Workspace action must have these published parameters in common.

Tip   
  • Automations can run multiple Run a Dynamic Workspace actions in parallel, depending on availability of FME Engines. For more control over engine allocation, use job queues.
  • You can connect multiple workspace actions that output a single message to downstream components in your workflow. For more information, see Combining Messages from Multiple Workspace Actions.

Output Ports

All Run a Dynamic 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.

Action Details

  • Action: Select Run a Dynamic Workspace.
  • Repository:Specify an output key or expression that will resolve to any named repository on the FME Server. Any referenced repository should contain one or more workspaces you want the Run a Dynamic Workspace action to run.

    • Alternatively, specify an existing repository. In this case, only the workspace that runs is determined dynamically, from any workspace that exists in the specified repository.

  • Workspace: Specify an output key or expression that will resolve to any named workspace you want the Run a Dynamic Workspace action to run, and that resides in a referenced Repository.

    • Alternatively, specify an existing workspace name. In this case, only the repository from which to select the specified workspace is determined dynamically.

Parameters

Click Import Parameters to define the published parameters for any workspace that runs as a result of this Run a Dynamic Workspace action to accept. On the Import Parameters dialog, specify a template repository and workspace that contains the applicable parameters, and click OK.

Note  All workspaces that run from the same Run a Dynamic Workspace action must have the same published parameters that were imported from the template in common.

For each published parameter, configure the settings you desire when the workspace runs. For more information, see Working with Parameters in Automations Workflows.

Output Keys

See Also

Tip  To view the output keys from upstream components, click Show Upstream Keys.

Retry

  • Retry on failure: If checked, the automation attempts to run the action again if the initial attempt results in a failure to connect to the specified external resource for message delivery. The manner in which these retries are conducted is based on the remaining settings.
  • Use custom retry settings: If checked, the remaining retry settings are configurable. If not checked, they are set to the FME Server default values.
  • Number of attempts: Maximum number of retries, if the action continues to fail.
  • Wait between attempts: Time to wait between retries. In conjunction with Backoff multiplier (below), the specified value is the wait time for the first retry.
  • Backoff multiplier: Factor by which to increase Wait between attempts on successive retries. For example, a value of 2.0 doubles the wait time for the next retry.
  • Randomization factor: Percentage by which to introduce randomness to Wait between attempts. For example, if Wait between attempts is 100 Seconds, and Randomization factor is 25, the wait time for each retry is randomly selected between 75 and 125 seconds.
  • Maximum wait between attempts: Maximum wait time between retries. In conjunction with Backoff multiplier, the specified value is the upper limit for wait time.