Alteryx Designer Discussions

Find answers, ask questions, and share expertise about Alteryx Designer.

Auto documentation

Payalpavas
5 - Atom

Hi all,

I have created a workflow which is quite lengthy and now I want to document it, so just wanted to know is there any way by it can be done automatically.

I also have searched in regard to this in community and found that this can be done by installing some tools, but the problem is that my company doesn't allow any external tool to be installed in company provided laptop.

So is there any way by which it can be done without installing any external tools.

Your help would be really appreciated.

5 REPLIES 5
jamielaird
14 - Magnetar

Hi @Payalpavas ,

 

I guess that means you can't use @levsol's solution, which would be my recommendation if you could install external tools.

 

https://community.alteryx.com/t5/Engine-Works/Auto-Documentation/ba-p/545827?lightbox-message-images...

 

One alternative would be to extract information from the workflow XML, which you can do by opening a YXMD file in any text editor. The key information will be in the <node> elements which each represent a tool in your workflow. The XML fields will vary from tool to tool but in the example below you can see this is for a Formula tool, and the underlying formula is shown:

 

jamielaird_0-1615220811803.png

 

This won't be a very quick solution but if you need something in code format for compliance reasons, the XML is the way to go.

Payalpavas
5 - Atom

Thank you @jamielaird for such quick response.

But l want to document my workflow in pdf format only not in XML format. Is it possible?

echuong1
Alteryx Alumni (Retired)

There are third-party solutions that offer this, but nothing built out by Alteryx directly.

 

Capitalize offers a Audit Reporting, but this is an additional service:

https://capitalizeconsulting.com/audit-reporting-in-wam/ 

cbaragao
5 - Atom

I made a CSS file. Then I opened YXMD to XML, referenced the style sheet. Alteryx could post a defined CSS file externally, reference it in the YXMD, and conceivable Designer could generate a styled output showing auto-documentation without having to look at third party solutions of building your own workflows.

 

Other nice-to-have:

 

  • Outcomes of each step: There should be a way to append workflow outcomes to the annotations or include in the documentation output.
    • E.G. "1283 records joined left, 400 joined right, etc."
amtraker1777
6 - Meteoroid

Alteryx needs to invest time and resources into developing its own Auto Documentation tool instead of relying on a third party or placing the burden on the user.  The average user should not need to know how to parse out an XML file to get basic information output to a log file.  I am forced to take screenshots along the way which is extremely time consuming.  I would want to know the following: the tool being used, the tables being used as input, record counts, input/output parameters, etc.  The same information that any auditor would need to ensure they can reach the same conclusion I did.  We have been using ACL for over a decade and it offers a built-in log file that contains everything an auditor would need and can be output in various formats (HTML, WordPad, Text, etc.).

 

Another idea could be to offer a read-only Designer client that would allow anyone to view the project, but not make any changes to it.  This would allow them to more easily follow the workflow from start to finish.

Labels