Temporal icon

Temporal

Basic Example Node

Overview

This node interacts with Temporal workflows, allowing users to start workflows, query running workflows, send signals to workflows, get the status of workflows, and retrieve workflow results. It is useful for automating and managing workflow executions in Temporal, such as triggering workflows with specific inputs, querying workflow state, or signaling workflows to change their behavior.

Use Case Examples

  1. Starting a new workflow with specific input data and task queue.
  2. Querying a running workflow by its ID to retrieve current state or data.
  3. Sending a signal to a workflow to trigger an event or update.
  4. Getting the status or result of a workflow execution.

Properties

Name Meaning
Workflow ID The ID of the workflow to query, signal, get status, or get result for.
Query Name The name of the query to execute on the running workflow.
Query Arguments JSON arguments to pass to the query method of the workflow.

Output

JSON

  • workflowId - The ID of the workflow involved in the operation.
  • queryName - The name of the query executed (for query operation).
  • result - The result returned from the query or workflow result retrieval.

Dependencies

  • @temporalio/client
  • nanoid

Troubleshooting

  • Ensure the workflow ID provided exists and is correct to avoid errors when querying or signaling.
  • Verify that the query name matches a valid query defined in the workflow to prevent query failures.
  • Check that JSON arguments for queries or signals are correctly formatted to avoid parsing errors.
  • Make sure the Temporal server address and API key credentials are correctly configured for connection.

Discussion