Run aWorkspace
TheRun aWorkspaceaction receives messages from triggers or other actions and runs anFME Formworkspacethat has been uploaded toFME Flow.
To use the contents of the message in theworkspace, specify aworkspacepublished parameter to receive the data. Alternatively, use readers, writers, or transformers that are equipped to receive JSON-formatted messages.
Tip ">
Tip
- Automations can run multipleRun aWorkspaceactions in parallel, depending on availability ofFME Engines. For more control over engine allocation, useQueue Control.
- You can connect multipleworkspaceactions that output a single message to downstream components in your workflow. For more information, seeCombining Messages from Multiple Workspace Actions.
Output Ports
AllRun aWorkspaceactions have success and failure output ports. The success port (✔) can send a message if theworkspacecompletes successfully. The failure port (x) can send a message if theworkspacefails to complete.
Note ">
NoteWhenRetrysettings are configured, the failure port renders with a Retry Configured (⟳) icon.
Additionally, if the specifiedworkspaceis configured withFME FlowAutomations writers, theRun aWorkspaceaction contains output ports corresponding to each writer feature type.
For more information:
Details
- Action: SelectRun aWorkspace.
- Repository: Specify the repository in which theworkspaceresides.
- Workspace: Specify theworkspaceyou want to run.
Parameters
If the specifiedworkspacehas any published parameters, configure the settings you desire when theworkspaceruns.
Note ">
NoteSee alsoWorking with Parameters in Automations Workflows.
Tip ">
TipIf a newer version of theworkspaceis republished toFME Flowwhile the current Run aWorkspaceaction is open, click the Reset and Refresh Parameters button to apply any updates to published parameters.
Output Attributes
See Also
Tip ">
TipTo view the output attributes from upstream components, clickShow Upstream Attributes.
Success and Failure Attributes
Tip ">
TipYou can work with error messages in the following ways:
- View them in theAutomation log.
- Log them in aLog a Messageaction.
- 使用这些额外的operations downstream in your workflow.
| Attribute | Description |
|---|---|
| time | Event time |
| source | Event type |
| error.type | (Failure port only) Error type:
|
| error.message | (Failure port only) Error message |
| 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 |
| job.id | Job ID |
Feature Type Attribute Ouput
Run aWorkspaceactions that referenceworkspaces configured withFME FlowAutomations writers generate a set of output attributes for each writer feature type. Each attribute corresponds to a feature type attribute exposed in the writer. For more information, seeRouting Data from Workspaces.
Advanced
- Job Queue(optional): The queue in which to run the job. The specified queue overrides the queue that would otherwise be assigned based onQueue Controljob routing rules. If not specified, job routing rules apply. To view the queues to which FME Engines are assigned, open theEnginespage.
- 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.
- Skip if Job In Progress如果勾选此项,triggered job does not run if the status of the previously triggered job is still Running or Queued. If a job is skipped, the followingInvalidMessageerror message is output through thefailure port:Job is already in progress; the triggered job was skipped.
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 theFME Flowdefault values.
- Number of attempts: Maximum number of retries, if the action continues to fail.
- Wait between attempts: Time to wait between retries. In conjunction withBackoff multiplier(below), the specified value is the wait time for the first retry.
- Backoff multiplier: Factor by which to increaseWait between attemptson successive retries. For example, a value of2.0doubles the wait time for the next retry.
- Randomization factor: Percentage by which to introduce randomness toWait between attempts. For example, ifWait between attemptsis100 Seconds, andRandomization factoris25, 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 withBackoff multiplier, the specified value is the upper limit for wait time.
Job Statistics
You can view useful information about how aworkspacehas performed from aRun aWorkspaceaction, since the workflow was last started. This information can help you make important decisions about how to run theworkspace, particularly when configuringQueue Control. If the sameworkspaceis referenced from more than oneRun aWorkspaceaction 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 asAverage CPU Time/Average Elapsed Time.
- Average CPU Time: Average total CPU time to run theworkspace. For more information about howCPU Time是测量,看到了吗Completedjobs table.
- Average Elapsed Time: Average total processing time of theworkspace.
- Average Peak Memory Usage: Average peak memory usage by the FME Engine while processing a job. For more information about howPeak Memory Usage是测量,看到了吗Completedjobs table.
- Total Runs: The number of times theworkspacehas run since the workflow was last started.