Close Form

Controlled node

Overview

The Close Form node closes the currently displayed form page in the UI. When triggered, it sets the runtime form page state to null, effectively hiding or closing the active form interface. This node is typically used at the end of a form workflow or when you need to dismiss the form UI after completing an action.

This node works in conjunction with the Load Form Page node, which displays specific form pages. While Load Form Page sets the active page, Close Form clears it entirely.

Inputs

Input	Type	Description	Default
Run	Event	Fires when the node starts running and closes the form.	-

Outputs

Output	Type	Description
Done	Event	Fires when the form has been closed and the runtime state has been updated.

Runtime Behavior and Defaults

When the Close Form node receives a run event, it performs the following actions:

1. Writes null to the runtime state key formPageId
2. Triggers the done event once the state update is complete

This effectively removes the active form page from the UI, returning the user to a blank state or the underlying application context. The node does not require any data inputs and produces no data outputs—its sole purpose is to manage the form UI visibility state.

Form State Management

The form page state is stored in the workflow's runtime data under runtimeState/formPageId. Setting this to null (as this node does) is the standard way to close forms in Intellectible. To reopen a form, use the Load Form Page node with a specific page identifier.

Example Usage

Closing a Form After Submission

A common pattern is to close the form after processing user input:

1. Create a form with a Button element that triggers an event (e.g., submitForm)
2. Use a Form Event node to listen for submitForm
3. Process the form data (e.g., save to database, send email)
4. Connect the final step to the Close Form node's run input
5. The done output can then trigger additional cleanup or navigate to another workflow

[Form Event: submitForm] 
    → [Process Data] 
    → [Close Form: run] 
    → [Close Form: done] 
    → [Show Success Message]

Conditional Form Closing

You can also use Close Form in conditional flows:

[Form Event: buttonClicked]
    → [If: test="shouldClose"]
        → [True] → [Close Form: run]
        → [False] → [Load Form Page: nextPage]

In this example, clicking a button either closes the form entirely or navigates to the next page based on some condition.