Folder Aware Flow Behavior

Last Updated: 03/27/2018 Introduced in Version: 3.5

This document demonstrates how to use Folder Aware Flow behavior.

In this tutorial, we will use Folder Aware Flow Behavior to create a Page that can be used on different Folders to display Comments that live in that Folder.

We begin in the Designer Folder and click Create Flow on the Folder Actions Panel.

 

We Name our Flow and select Create,  the Flow Designer will open. In the Properties panel under Settings > Behavior Type select Folder Aware Flow Behavior.

 

In the Flow Designer, we add a Fetch Entities step from the Integrations > All Integrations > Entity Framework category.

 

Next, we configure the Fetch Entities step. In the Entity Fetch Definition section for the Type Name we select Comment.

 

Then, for the FolderId Input to this step we Select Value of FolderId input to our Flow.

Note: FolderId and PageName inputs are presented in our Flow because of the Folder Aware Flow Behavior.

 

On the Results Outcome from the Fetch Entities step, we add a Show Form step from Favorite Steps category.

 

In the resulting window, we Name our Form and click Create to proceed to the Form Designer.

 

When designing our Form, we will use a Simple List Box component from the Data category of the Form Controls to display our Comments. We configure the Simple List Box component’s Input Data Type to String. When finished, we can save our Form and close Form Designer.

 

Back in the Flow Designer, we connect the Done outcome from the Form to the End step, and No Results outcome from the Fetch Entities step to the Form step. Then, we select our Form step on the workspace to set it up. Click Show Mapping Editor from the Form’s action menu.

 

In the Mapping Editor, we are using the Comment Name string list from the EntityResults as an input to our List Box on the Form. Save and close Mapping Editor.

 

This completes our Folder Aware Flow. We can save the Flow and close Flow Designer.

 

Back in the Designer Folder, we click All > Manage > Page > Add Page.

 

Then, we Name the Page and click OK to proceed to the Page Designer.

 

Our Page is designed to have only a Flow Run Part component. We search for the component and drag it to the workspace.

 

Then, we locate Properties > Flow Info  and using Flow ID picker select our Get Comments Flow that we built previously in this tutorial.

 

This completes our Page design. We save and close Page Designer. Next, we are going to apply our Page to couple of Folders with Comments. In our Designer Folder, we Add two Designer Folders within our main Designer Folder.  Add Comment 1 and Comment 2 to Folder With Comments and Comment A and Comment B to Second Folder. We can do this by navigating to the folder’s Action Menu > Add > Entity > Comment.

 

Then, we can name the first comment and click OK to save. Repeat this process for the remaining comments.

 

We right click the the first designer subfolder to bring up its Action Menu and navigate to Manage > Page > Add Page.

 

We define our Page Name and using the Page picker, we select our Page.

Click PICK to Save and continue.

 

 

To test, we navigate back to the one of the Designer Folders Folder With Comments, and select Display Comments Page from the view bar up top. On the Page, we can see that our Flow is running and displaying comment names for this Folder.

 

 

Additional Resources