Documenting Flows

Unknown · November 2023

Documenting Flows

Unknown · November 2023

I am looking to document my Flows. It would detail out the steps used in it, an image of the Flow, and any other relevant information. Do we have any in-app way to accomplish this? It will take a lot of time if I have to do it manually.

Unknown · November 2023

You can use the Generate Report For Folder Id step found through Flow management → Utilities to achieve this.

The step takes in a Designer Folder ID as input and then generates a detailed report for the Folder. The Report includes Flow/Rule Previews, list of steps used in the Flow, the inputs and outputs for various steps.

I have attached a sample File.

Let me know if this suits your requirements.

Unknown · November 2023

Thank you. This is perfect.

Is there a way to get all folders for a specific folder ID so I can iterate through to generate the reports for all folders instead of having to manually input every folders ID?

Unknown · November 2023

You can use the [url=https://documentation.decisions.com/docs/retrieving-entities-with-the-fetch-entities-flow-step]Fetch Entities[/url] step having type Folder and set its entity Folder Id to the parents folderID, then loop the list passing each folder ID into the step using the [url=https://documentation.decisions.com/docs/processing-lists-of-items-with-the-foreach-step]ForEach [/url]step. This would generate a Report for all Folders within your parent folder.

Unknown · November 2023

Has anyone using the tool found a good way to document the HOW and the WHY of their flows?

I.e. If I were a brand new employee taking over a large flow - would there be a place where documentation/change log explanations can be placed so that a flow builder can document each step or section of steps of their flows to make it easier for a new person coming in to understand the flow?

Anyone doing anything that is working for them?

Documenting Flows

Comments

Howdy, Stranger!

Categories