|
1 | 1 | # Get started with flows |
2 | 2 |
|
3 | | -A **flow** defines the sequence of steps a user goes through during a specific interaction with your application. {{product_name}} supports building fully customizable flows for, |
| 3 | +A **flow** defines the sequence of steps a user goes through during a specific interaction with your application. {{product_name}} supports building fully customizable builds for the following flows. |
4 | 4 |
|
5 | 5 | - Self-registration |
6 | 6 | - Password recovery |
| 7 | +- Invited user registration |
7 | 8 |
|
8 | 9 | This guide introduces the **Flow Builder**, a visual environment with all the necessary elements to build flows that meet both security requirements and user experience goals. |
9 | 10 |
|
10 | | -## Enter the flow builder |
| 11 | +## Access the flow builder |
11 | 12 |
|
12 | | -## Enable a flow |
13 | | - |
14 | | -{{product_name}} provides default sequences for every flow in the flow builder. You can design and refine your customized flow at your own pace, keeping it disabled until you’re ready to share it. While your customized flow is disabled, users continue to experience the default flow. Once enabled, your users will seamlessly change to the customized experience you’ve created. |
15 | | - |
16 | | -To enable a flow, |
| 13 | +You can access the flow builder by following the steps below: |
17 | 14 |
|
18 | 15 | 1. On the {{product_name}} Console, go to **Flows**. |
19 | 16 |
|
20 | | -2. Select the flow you want to enable. |
| 17 | +2. Click on the card corresponding to the flow you want to build. |
21 | 18 |
|
22 | | -3. On the top-right corner of the screen, turn the toggle ON to enable the flow. |
23 | | - |
24 | | -!!! Note |
25 | | - |
26 | | - If you disable a customized flow, your users will automatically continue with the default experience until you’re ready to publish it again. |
| 19 | +3. [Build the flow](#build-a-flow) and [enable](#enable-a-flow) it. |
27 | 20 |
|
28 | 21 | ## Build a flow |
29 | 22 |
|
30 | | -The **Flow builder** provides all the building blocks you need to create seamless user journeys. To get started, go to **Flows** in the {{product_name}} Console and select the flow you want to customize. |
| 23 | +The **Flow builder** provides all the building blocks you need to create seamless user journeys. For a selected flow, you can start building it using one of the methods below and use [flow elements](#reference-flow-elements) to customize it to your requirements. |
31 | 24 |
|
32 | | -You can begin building in one of the following ways: |
| 25 | +{% if product_name == "Asgardeo" %} |
33 | 26 |
|
34 | 27 | ### Generate with AI |
35 | 28 |
|
36 | 29 | The **Generate with AI** feature converts plain-language instructions into a complete flow, allowing you to start quickly and customize components as needed. |
37 | 30 |
|
38 | 31 | {: width="auto" style="display: block; margin: 0;"} |
39 | 32 |
|
40 | | -### Use Starter Templates |
| 33 | +{% endif %} |
| 34 | + |
| 35 | +### Use a starter template |
41 | 36 |
|
42 | 37 | Starter templates give you a quick start with predefined flows that are easily customizable. Click the `+` button next to a template to add it to the flow. |
43 | 38 |
|
44 | 39 | {: width="auto" style="display: block; margin: 0;"} |
45 | 40 |
|
46 | | -### Build from Scratch |
| 41 | +### Build from scratch |
47 | 42 |
|
48 | 43 | Begin with a blank canvas and use the drag-and-drop interface to add steps, widgets, and components. This option gives you full control over the sequence, UI elements, and logic in the flow. |
49 | 44 |
|
50 | 45 | {: width="auto" style="display: block; margin: 0;"} |
51 | 46 |
|
52 | | -## Flow Elements |
| 47 | +## Enable a flow |
| 48 | + |
| 49 | +{{product_name}} provides default sequences for every flow in the flow builder. You can design and refine your customized flow at your own pace, keeping it disabled until you’re ready to share it. While your customized flow is disabled, users continue to experience the default flow. Once enabled, your users will seamlessly change to the customized experience you’ve created. |
| 50 | + |
| 51 | +To enable a flow, |
| 52 | + |
| 53 | +1. On the {{product_name}} Console, go to **Flows**. |
| 54 | + |
| 55 | +2. Select the flow you want to enable. |
53 | 56 |
|
54 | | -Flows are made up of different types of elements that work together to create the user journey. These elements let you control the structure, functionality, and appearance of each step in the flow. |
| 57 | +3. On the top-right corner of the screen, turn the toggle ON to enable the flow. |
| 58 | + |
| 59 | +!!! Note |
| 60 | + |
| 61 | + If you disable a customized flow, your users will automatically continue with the default experience until you’re ready to publish it again. |
| 62 | + |
| 63 | +## Reference: Flow elements |
| 64 | + |
| 65 | +Flow elements work together to create the user journey. They define the structure, functionality, and appearance of each step in the flow. |
55 | 66 |
|
56 | 67 | ### Widgets |
57 | 68 |
|
58 | | -Widgets are reusable components that enhance the flow. Drag and drop widgets into your desired `view` to build a flow. |
| 69 | +Widgets are reusable components that enhance the flow. Drag and drop widgets into your desired view to build a flow. |
59 | 70 |
|
60 | 71 | {: width="auto" style="display: block; margin: 0;"} |
61 | 72 |
|
62 | 73 | ### Steps |
63 | 74 |
|
64 | | -Steps are the core building blocks of a flow. Drag and drop steps to create a multi‑step user journeys. |
| 75 | +Steps are the core building blocks of a flow. Drag and drop steps to create a multi‑step user journey. |
65 | 76 |
|
66 | 77 | {: width="auto" style="display: block; margin: 0;"} |
67 | 78 |
|
68 | 79 | ### Components |
69 | 80 |
|
70 | | -Components are atomic UI elements added to steps. Drag and drop components inside a step. |
| 81 | +Components are atomic UI elements that you can add to a step. Drag and drop components inside a step. |
71 | 82 |
|
72 | 83 | !!! Note |
73 | | - Field components such as **Text Inputs**, **Email Inputs**, etc. have the following constraints: |
74 | | - - They must be added inside a **Form** component. |
75 | | - - They must be mapped to a user attribute. Do this by clicking the pencil icon on the element action panel and selecting the relevant attribute from the `Attribute` dropdown. Only attributes set to display on the respective user profile in the [Attribute Configurations]({{base_path}}/guides/users/attributes/manage-attributes) will be available for mapping. |
| 84 | + |
| 85 | + Field components such as **Text Input** and **Email Input** etc. have the following contraints: |
| 86 | + |
| 87 | + - Only a **Form** component can contain them. |
| 88 | + |
| 89 | + - Must map to a user attribute. To do so, |
| 90 | + |
| 91 | + - Click the pencil icon on the element action panel. |
| 92 | + |
| 93 | + - From the **Attribute** dropdown, select the relevant attribute. Only attributes **displayed in user profiles** are available for mapping. Learn how to [display attributes in user profiles]({{base_path}}/guides/users/attributes/manage-attributes/#configure-attributes). |
76 | 94 |
|
77 | 95 | {: width="auto" style="display: block; margin: 0;"} |
0 commit comments