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.
The Run a Workspace action has two 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.
Action 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.
Output Keys
See Also
| Key | Description |
|---|---|
| time | Event time |
| source | Event type |
| job.id | Job ID |
| job.timeSubmitted | Time submitted |
| job.timeStarted | Time started |
| job.timeFinished | Time finished |
| job.status | Job status |
| job.statusMessage | Job status message |
| job.log | Job log |
| job.repository | Repository |
| job.workspace | Workspace |
Advanced
- Job Queue (optional): The job queue in which to run the job. The specified queue overrides the queue of the repository to which the workspace belongs. If not specified, the job is placed in the job queue of the repository.
- Queued Job Expiry Time (optional): The length of time 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 (optional): The time a job will remain in the running state. This directive is used to ensure that a job does not hang and block an FME Engine indefinitely. The minimum allowable value is 1.
- Run Until Cancelled (optional): If checked, the job runs continuously, even after a server shutdown or crash, until it is explicitly canceled.