diff --git a/docs/3. Product Features/03. Flows/1. Flow Overview.md b/docs/3. Product Features/03. Flows/1. Flow Overview.md index da2d36eeb..46c453efc 100644 --- a/docs/3. Product Features/03. Flows/1. Flow Overview.md +++ b/docs/3. Product Features/03. Flows/1. Flow Overview.md @@ -1,11 +1,13 @@ > ### **2 minute read                                                                                                                           `Beginner`** ## Flow Listing Page -You will be taken to the `Flow Listing Page` on clicking the `Flows` tab in the Left Panel. All the Flows created will be listed here. + +You will be taken to the `Flow Listing Page` on clicking the `Flows` tab in the Left Panel. All the Flows created will be listed here. ## Flow Listing Page Buttons -1. **Configure -** The CTA buttons in `Flow Editor page` on clicking `Configure` are as follows : +1. **Configure -** The CTA buttons in `Flow Editor page` on clicking `Configure` are as follows : + - **Save as Draft** : This lets you save a draft of the flow you just configured. This lets you save the progress whenever you make changes to a flow before publishing it. This will be helpful for testing out the changes you make in a flow. - **Publish** : By publishing a flow, you will be able to make a flow public. Anyone who prompts your chatbot with the correct keyword will be able to access your flow. @@ -14,46 +16,45 @@ You will be taken to the `Flow Listing Page` on clicking the `Flows` tab in the - **Revision History** : Version Control in Glific is enabled through Revision History. It creates a list of versions based on the changes you've made to a flow. If in case you end up having a faulty flow, you will always be able to go back and revert it to the last working version/ any version of your liking. - - **Reset Flow Counts** : The reset flow counts will refresh the node and the tracking of how many times a node was triggered for users. + - **Reset Flow Counts** : The reset flow counts will refresh the node and the tracking of how many times a node was triggered for users. +2. **Make a copy** : This will help you to duplicate a particular flow. +3. **Export & Import Flow** : This feature will help you when you want to transfer some flow from one particular BOT to another. Read more details [here](https://glific.github.io/docs/docs/Product%20Features/Others/Import%20&%20Export%20Flows/) -2. **Make a copy** : This will help you to duplicate a particular flow. -3. **Export & Import Flow** : This feature will help you when you want to transfer some flow from one particular BOT to another. Read more details [here](https://glific.github.io/docs/docs/Product%20Features/Others/Import%20&%20Export%20Flows/) +4. **Edit** : - **Name & Keywords** : Assign any unique name and keyword to the flow. -4. **Edit** : - - **Name & Keywords** : Assign any unique name and keyword to the flow. + - **Ignore Keywords** :Once it is enabled, this feature restricts beneficiaries from entering any other flow apart from the active one, using keywords from another flow. You can read more about this [here](https://glific.github.io/docs/docs/Product%20Features/Others/Keywords/#ignore-keywords) - - **Ignore Keywords** :Once it is enabled, this feature restricts beneficiaries from entering any other flow apart from the active one, using keywords from another flow. You can read more about this [here](https://glific.github.io/docs/docs/Product%20Features/Others/Keywords/#ignore-keywords) + - **is active?** : It is crucial to activate the flow. - - **is active?** : It is crucial to activate the flow. + - **is pinned?** : will pin your flow so that it appears at the top of the Flow section for easy visibility - - **is pinned?** : will pin your flow so that it appears at the top of the Flow section for easy visibility + - **Run this flow in the background + Background Flows** : Sometimes, you might need to send automated messages alongside the usual flows or manual interactions. For instance, you may want to send weekly or bi-monthly updates while also allowing daily interactions with the bot. In such cases, you can plan these activities separately in the background while keeping the other flows unchanged. - - **Run this flow in the background + Background Flows** : Sometimes, you might need to send automated messages alongside the usual flows or manual interactions. For instance, you may want to send weekly or bi-monthly updates while also allowing daily interactions with the bot. In such cases, you can plan these activities separately in the background while keeping the other flows unchanged. -Read more [here](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Background%20Flows/) + Read more [here](https://glific.github.io/docs/docs/Product%20Features/Flows/Others/Background%20Flows/) - - **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). - This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. -It lets the flow continue without checking if those result fields were expected. +- **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. It lets the flow continue without checking if those result fields were expected. - -6. **Delete** : The delete option will completely remove/ erase that particular flow from the flow list +- **Skip Validation** : Check this box while sending results that are generated dynamically (not pre-defined in the flow). + This is helpful while using the [resume Flow API](https://api.glific.com/#89f5f6e6-9bdc-48c2-96c5-ad8c1f7a834b) and the flow doesn’t already have those results set up. + It lets the flow continue without checking if those result fields were expected. +5. **Delete** : The delete option will completely remove/ erase that particular flow from the flow list ## Create Flow : - After selecting `+ Create Flow` you will get two option : - - 1) `Create from Scratch` - This will directly lead to the page for creating a new flow. +After selecting `+ Create Flow` you will get two option : + +1. `Create from Scratch` - This will directly lead to the page for creating a new flow. + +2. `Create from Template` - This will take to a page listing pre-designed "Template flows” that can be reused. - 2) `Create from Template` - This will take to a page listing pre-designed "Template flows” that can be reused. - image Under `Actions`, there are two buttons: `View it` and `Use it`. -1) **View It** +1. **View It** a) Clicking `View it` will navigate to the flow details page, where one can see the flow name, keyword, description,etc. @@ -61,12 +62,12 @@ b) All buttons except `View` will be disabled, as this flow is meant for review image -c) Clicking `View` will take you to the flow details page, where you can see each node and its purpose, along with explanations of their - importance and use on sticky notes. +c) Clicking `View` will take you to the flow details page, where you can see each node and its purpose, along with explanations of their +importance and use on sticky notes. image -2) **Use It** +2. **Use It** a) Clicking `Use it` will create a copy of the same template flow, allowing you to enter a name, keyword, description, and other details according to your preference. @@ -74,7 +75,6 @@ b) Simply click on `Configure`, make any necessary edits to the flow, and then p c) After publishing the flow, it will appear in the active flows section. - image ## Filter Option: Active, Inactive and Template Flows @@ -83,9 +83,28 @@ c) After publishing the flow, it will appear in the active flows section. - The Template flows can be reused but not altered. - image +- The upwards arrow will give the information on the descending order of the flows created, last published. + +## Make sure flow is not interrupted if contact sends any keyword in between the flow. +Select the `Ignore Keyword` check box from edit flow screen to make sure the flow should not be interrupted in between if user sends keyword of another flow. -- The upwards arrow will give the information on the descending order of the flows created, last published. +image + +## Make a flow inactive + +You can inactivate a flow, which is not in use. This will prevent the flow from executing if a user enters keyword mapped to it. + +- Go to the Flows screen from the left panel. + +- Click on Edit icon next to the flow. + +image + +- Uncheck the is active check box. + +- Click on SAVE button + +image