Sub Flow Return Node

Nodes and Palette Options > Detailed Node Descriptions > Sub Flow Return Node

	Sub Flow Return Node

Type

Application Item (sub flow) node

Purpose

Sub flows are used for invoking another callflow in the project. Large projects may be broken up into multiple, smaller callflow files which are invoked by other project callflows using the Sub Flow node.

The Sub Return Node is the return point from a sub flow, returning control back to the call flow (called the sub flow). This is similar to the Return Node from the main call flow, but the sub flow return does not allow items (such as output parameters) to be added to it like the main flow Return node does.

There are two other parts or nodes to a sub flow multiple call flow feature:

Sub Flow Begin Node - This is the entry point for a sub call flow. Somewhat like the AppRoot/Start node for the main call flow, but the Begin node cannot be edited and does not allow items to be added to it like the AppRoot.

Sub Flow Reference Node - This defines a reference to a sub flow that has been defined in the project (). A sub flow can be referenced multiple times within a call flow.

Behavior

Contents of sub flows are hidden to other flows (that is, "black boxes"). You cannot use a "goto" to go to other nodes in other flows.

Properties

Name - Enter a name that reflects the central purpose of the node. Use naming conventions for Java components. See Naming Java Components.

Flow Name - Name of the main flow that the Sub flow is associated with.

Comments - Enter any comment you want to add as a reminder or description of the purpose or content of the node. You can leave this field blank.

Default Node Structure (Node Detail Editor Flow)

There is no default flow in the node editor for this node.