Data Return

Terminates a workflow branch and returns a typed data payload to the calling system or user interface.

Purpose

Use this completion node to define what structured data the workflow sends back when it finishes. The return type determines how the payload is interpreted by the receiving system — options range from simple messages and JSON strings to file bytes, search results, and Configurator-specific viewer data. Every workflow branch that should produce an output must end with a Data Return node.

Inputs

Field	Type	Required	Description
Return Object Type	Dropdown	Yes	The category of data to return. Determines which additional fields are shown. Options: Basic Message, Search Results, File Return, Json Return, AEC Model Ids, Configurator Iteration, Configurator Initial Value.
Search Results	Text	No	The search result payload to return. Visible when Return Object Type is Search Results.
Results	Text	No	The data value to return. Used for File Return (file path), Json Return (JSON string), AEC Model Ids, and Configurator Initial Value.
ViewerDwf	Text	No	Path to the DWF viewer file. Visible when Return Object Type is Configurator Iteration.
Parameters	Key-Value Pairs	No	Dictionary of parameters returned from a Process Configuration node. Visible when Return Object Type is Configurator Iteration.
Renders	List	No	File paths to rendered images for the Configurator viewer. Visible when Return Object Type is Configurator Iteration.
Message Return	Text	No	An optional message to accompany the workflow result, used for logging or user feedback.

Visibility Rules

Return Object Type is always visible. All other fields except Message Return are conditional based on the selected Return Object Type value.

Outputs

This task performs an action and does not produce output variables.