Refresh Sub-Workflow Properties v2

Refresh a Sub-Workflow Step after the child Workflow's published Parameters or Returns change. The designer loads the current published template and merges its contract into the existing Step.

Before refreshing

  1. Update and test the child Workflow.
  2. Save it so the changed contract is published.
  3. Open the parent Workflow in the Environment where you are designing it.
  4. Confirm that the Sub-Workflow Step's WorkflowKey points to the intended child.

Refresh the Step

  1. Open the parent Workflow.
  2. Open the Sub-Workflow Step's context menu.
  3. Click Refresh Properties.
  4. Review any schema-change decisions, then click Confirm. Click Cancel to abandon the refresh.
  5. Wait for the refresh result alert and review every Parameter, Return, and connection on the Step.

Merge behavior

The designer uses the current WorkflowKey value to choose the child, even if the Step's older TemplateKey points elsewhere.

Refresh proposes changes to the contract and applies your confirmed decisions. It can:

  • Add new Parameters and Returns from the child template.
  • Remove fields no longer present in that published contract.
  • Preserve compatible existing Value and Expression mappings by name.
  • Recursively merge compatible nested Properties.
  • Keep the Step name, description, and child Steps.
  • Replace the WorkflowKey and Connection-key fields with values supplied by the refreshed template.

Refresh creates one undo snapshot only when the Step actually changes. Use Undo if the merged result is not appropriate. A no-change refresh reports that the Properties are already up to date and does not consume an undo step.

Alerts

The action can report:

Alert Meaning
Sub-Workflow Properties refreshed. The contract changed and the merged Step was applied.
Sub-Workflow Properties are already up to date. The refreshed contract produced no authored change.
Missing configuration The Step has no usable Node, Method, template, or WorkflowKey.
Unable to refresh The current template could not be retrieved or applied.
Disabled warning The selected child Workflow is disabled in the current Environment. The contract can still refresh, but the call cannot run until the child is enabled.

See Call a Sub-Workflow and Workflow validation.

See also