The Open Modal Action The Open Modal Action

The Open Modal Action

Elliot Fiske Elliot Fiske

Overview

The Open Modal Action is used to open a Web Flow as a modal. When a Web Flow is opened as a modal, the user must finish the modal Flow before returning to the screen that opened it. This is useful for creating confirmation screens, or for creating a flow where the user can fill out information and then easily return to where they were in the App.

open-modal.gif

Use Cases

  • A modal where the user must confirm their action to continue.
  • A modal to ensure the user to accept Terms & Conditions before continuing.
  • Allow the user to escalate to an agent from anywhere in the App by clicking on the App header. To learn how to create and customize your App's header, read Creating an App Header.
  • Allow the user to create or edit data in a list. For instance, in the GIF below, a modal opens when the user presses the Edit Info button, which allows them to edit their car information.

open-modal-example.gif

Action Properties

Web Flow

The Web Flow that will be used as the content for the modal. Web Flows can be created and managed in the App Builder.

Inputs

If the selected Web Flow has Variables, these fields specify their initial values. This makes it possible to send custom data to the opened modal.

To learn how to create Variables at different scopes, read Variable Scopes. The only Variables that can be set by the Open Web Modal Action are ones at the Activity Group scope level.

Output

The Web Flow opened by the Open Web Modal Action must use the Close Web Modal Action to close. When the Close Web Modal Action is called, its Return Value will be sent to Output.

If the Close Web Modal Action runs with Is Successful unchecked, the Return Value will be NULL.

Further Reading

To learn more about Web Flows, read Web Flows.

If the user should go to a new Web Flow without coming back to the current one, the Go To Web Flow Action will work.

To learn how to use Airscript to work with data, read Airscript Quick Start.

Add comment

Article is closed for comments.