Start Free Trial

Alteryx Designer Desktop Discussions

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

Workflow documentation

DeeSC
5 - Atom

Hi, I am looking out for ways to automatically extract the documentation of the workflow built.

I require a columnar extraction as follows 

'Tool ID', 'Tool Type' , 'Input/Output' , ' Columns/Fields used', ' Name of file for input/ output' etc

 

I have tried linking with Python, XML Parse but its not giving me the desired output

6 REPLIES 6
GrowthNatives
8 - Asteroid

Hi @DeeSC ,

Yes, it’s possible to extract workflow documentation in a structured (columnar) format from an Alteryx .yxmd file using XML parsing — this is exactly how tools like Workflow Admin Manager (WAM) and metadata macros work.

 

Here’s a step-by-step approach:

  1. Read the Workflow File: Use the Input Data Tool to load the .yxmd file as text (set file type to "Flat ASCII").
  2. Use the XML Parse Tool: Configure the tool to parse at the path 
/AlteryxDocument/Nodes/Node
​

3. Extract Key Attributes

  • Use Select or Formula tools to extract:
    • Tool ID: from <Node ToolID="...">

    • Tool Type: from <GuiSettings Plugin="...">

    • File Name: from <Configuration><File value="...">

    • Field Names: from <Properties> or <Field name="...">

4. Use Regex Tool:

  • To extract embedded attributes (e.g., file paths or field names), use Regex patterns like: 
File="([^"]+)"
Field="([^"]+)"
Plugin="([^"]+)"
​

 

 


Hope this solution helps you make the most of Power BI! If it did, click 'Mark as Solution' to help others find the right answers

💡Found it helpful? Show some love with kudos 👍 as your support keeps our community thriving!

🚀Let’s keep building smarter, data-driven solutions together! 🚀 [Explore More] 

ntakeda
12 - Quasar

I haven't used it myself, but I think it’s probably possible with Alteryx Copilot.

https://help.alteryx.com/aac/en/alteryx-copilot.html#marketplace-download

caltang
17 - Castor
17 - Castor

This is a great plug for my article: https://community.alteryx.com/t5/Engine-Works/AI-Meets-Alteryx-Exploring-XML-Automation-and-Insights...

 

In it, it details how you can extract the information with any LLM of your choice. :) 

 

Hope this helps @DeeSC 

Calvin Tang
Alteryx ACE
https://www.linkedin.com/in/calvintangkw/
terry10
12 - Quasar

I use the Workflow XML parser:  https://help.alteryx.com/current/en/designer/tools/parse/workflow-xml-parser-tool.html

 

Point the Blob Input tool at the .yxmd or .yxmc file of your workflow, convert the blob to a string, then connect to the Workflow XML parser.  

Screenshot 2025-05-19 192947.png

csh8428
11 - Bolide

@terry10 how do you have the blob convert tool configured?

terry10
12 - Quasar

@csh8428 

 

Sorry for my delayed reply.

  

terry10_0-1753897243595.png

 

Labels
Top Solution Authors