Skip to main content

Child Workflows - Ruby SDK

This page shows how to do the following:

Start a Child Workflow Execution​

A Child Workflow Execution is a Workflow Execution that is scheduled from within another Workflow using a Child Workflow API.

When using a Child Workflow API, Child Workflow related Events (StartChildWorkflowExecutionInitiated, ChildWorkflowExecutionStarted, ChildWorkflowExecutionCompleted, etc...) are logged in the Workflow Execution Event History. The Child Workflow needs to have an Abandon Parent Close Policy set in the Child Workflow Options.

You should block progress on the Parent Workflow until the ChildWorkflowExecutionStarted Event is logged to the Event History to ensure the Child Workflow Execution has started. If the Parent makes the ExecuteChildWorkflow call and then immediately completes, the Child Workflow Execution doesn't start. In Ruby, you can make sure your Child Workflow started by awaiting start_child_workflow.

To spawn a Child Workflow Execution in Ruby, use the execute_child_workflow method which starts the Child Workflow and waits for completion or use the start_child_workflow method to start a Child Workflow and return its handle. This is useful if you want to do something after it has only started, or to get the Workflow/Run ID, or to be able to signal it while running.

note

execute_child_workflow is a helper method for start_child_workflow(...).result.

Temporalio::Workflow.execute_child_workflow(MyChildWorkflow, 'my-workflow-arg')

Set a Parent Close Policy​

A Parent Close Policy determines what happens to a Child Workflow Execution if its Parent changes to a Closed status (Completed, Failed, or Timed Out).

The default Parent Close Policy option is set to terminate the Child Workflow Execution.

Set the parent_close_policy parameter for execute_child_workflow or start_child_workflow to specify the behavior of the Child Workflow when the Parent Workflow closes.

Temporalio::Workflow.execute_child_workflow(
  MyChildWorkflow,
  'my-workflow-arg',
  parent_close_policy: Temporalio::Workflow::ParentClosePolicy::ABANDON
)