Recipe Documentation

[brian-haskins]

I need to document how recipes function in Workato into Confluence. Does anyone have any suggestions on how they handle the documentation on how their recipe works for external systems? This is done for groups who do not have access to Workato to view what happens in their Recipes or approval through a Change Board when we build out a new process.

The two thoughts I had was taking screenshots and putting them in the Confluence Article or using a Flow chart and copy and paste the comments through each step of the recipe.

[johndpatton]

If you do go that route you can use Page Properties Reports to track approvals, etc...

https://youtu.be/6HgirOyeWcQ

https://confluence.atlassian.com/doc/page-properties-report-macro-186089616.html

[gfraser]

Following this, as I would like to hear people's solutions/suggestions as well! Great Question.

[jblanchett]

I think "automated documentation" of recipes and how they work would be an amazing thing. You can get some basic documentation from the RecipeOps connector and Workato APIs (Trigger Type, Connections Involved, Folder Path, etc), but what's missing is the data mapping. It would be great if Workato could produce an automated document of the integration including the field mapping. "RDEs" or raw data element mapping is required in integration documentation for SOX. Producing these is surely one of the more brutally mundane tasks of all time.

[krishna]

totally agree this is a great question looking forward how other folks are doing this