Overview
This node integrates with the Temporal workflow orchestration system to manage workflows. Specifically, the 'Start Workflow' operation allows users to initiate a new workflow either synchronously (waiting for completion and result) or asynchronously (starting and returning immediately). This is useful for automating complex processes, running background jobs, or orchestrating microservices. For example, a user can start a data processing workflow with specific input parameters and choose whether to wait for the workflow to finish or continue immediately.
Use Case Examples
- Starting a data processing workflow synchronously to get the result immediately.
- Starting a notification workflow asynchronously to trigger an email without waiting for completion.
Properties
| Name | Meaning |
|---|---|
| Execution Mode | Determines whether the workflow execution waits for completion (synchronous) or returns immediately after starting (asynchronous). |
| Workflow Type | Specifies the type or name of the workflow to start. |
| Workflow ID Prefix | Optional prefix added to the generated workflow ID to help identify or categorize workflows. |
| Task Queue | The task queue name that the workflow will use for execution. |
| Input | JSON input data passed to the workflow at start. |
Output
JSON
workflowId- The unique identifier of the started workflow.queryName- (If applicable) The name of the query executed on the workflow.result- The result returned from the workflow execution or query.signalName- (If applicable) The name of the signal sent to the workflow.handle- (If applicable) The handle or description of the workflow after signaling.
Dependencies
- Temporal workflow service API
- An API key credential for authentication
Troubleshooting
- Ensure the Temporal service address and API key credentials are correctly configured; connection failures will prevent workflow operations.
- If the workflow type or task queue is incorrect or missing, the workflow will fail to start.
- JSON input must be valid; malformed JSON will cause errors when parsing input.
- For synchronous execution, long-running workflows may cause timeouts or delays; consider using asynchronous mode if immediate response is needed.
Links
- Temporal Documentation - Official documentation for the Temporal workflow orchestration platform.