The Workflow Documenter

Documenting Alteryx Workflows

Alteryx is a powerful data analytics tool that allows users to blend, cleanse, and analyze data from multiple sources. However, as workflows become more complex, it can become challenging to keep track of all the different steps involved in a given workflow. That's where The Workflow Documenter comes in.

Send a request

What is The Workflow Documenter?

The Workflow Documenter is a tool designed to help users document their Alteryx workflows. The tool generates documentation based on the tools used in the workflow, including a high-level graphical overview of the process and a detailed description of each step involved.


The documentation generated by The Workflow Documenter can be helpful for a variety of purposes, including:

  • Faster documentation creation to facilitate audits
  • Communicating the process to other (e.g. non Alteryx) team members
  • Troubleshooting errors
  • Auto documenting bases on your tool configurations
  • Motivate users to make use of the documentation options that Alteryx offers
  • Ensuring compliance with development standards


In addition, the output generated by The Workflow Documenter can be loaded into the data management tool Aphinit.

Save Time

Be compliant

Get in control

Facilitate knowledge transfer

How does The Workflow Documenter work?

The Workflow Documenter works by analyzing an Alteryx workflow and generating a report that gives you a precise description of the tools that are used in the workflow. The tool identifies each step in the workflow and provides information about these steps, including the name of the tool used, the inputs and outputs of the tool, and any configuration settings that were used.


Over 66 of the most used tools are described based on their actual configuration in your Alteryx Designer workflow.


The report generated by The Workflow Documenter can be exported in a variety of formats, including MS Word, PDF and HTML. This makes it easy to share the documentation with others or store it in a document management system.


The Workflow Documenter will be delivered as an Alteryx macro that analyzes one workflow at a time.


Note that the AI based Workflow Summary of Alteryx is able to generate a readable description in the meta information of the workflow. After adding this, you can use the Workflow Documenter to create a detailed report that contains this description.


Bonus: to use The Workflow Documenter you do not need to install other tools than Alteryx Designer!

What output is generated?

  • General info about the workflow

    The first page offers info about Workflow type, version of Alteryx Designer used, description from the workflow meta info, used constants, chained applications, configured events.

  • Is a user interface configured?

    In case a user can interact via a user interface with an Alteryx app, this user interface is described and also the connection with the workflow tools is described.

  • All tools used in the workflow are described

    Alle tools are described with their connection to  other tools (via toolnumbers) both from and to tools.  

  • Comprehensive description of 66 tools with their configuration

    Often a tool in Alteryx has a plethora of configuration options. For 66 tools most of the options are described. The list of available tools:

    • In/Out (7): Browse, DateTimeNow, Directory, Input Data, MapInput, Output data, Text Input. 
    • Preparation Tools (14): AutoField, Data Cleansing, Filter, Formula, Generate Rows, MultiField Formula, MultiRow Formula, RecordID, Sample, Select , Select Records, Sort, Tile, Unique.
    • Join Tools (6): Append Fields, Find Replace, Join, Join Multiple, Make Group , Union. 
    • Parse tools (4): DateTime, RegEx, Text to Columns, XML Parse. 
    • Transform Tools (6): Count Records, Cross Tab, Running Total, Summarize, Transpose, Weighted Average. 
    • Connectors (1): Amazon S3 Download. 
    • Spatial (4): Trade Area, Create Points, Distance, Spatial Info
    • Interface (2): Macro Input, Macro Output
    • Reporting (9):  Email, Image, Interactive Chart, Layout, Report Footer, Report Header, Report Text, Table, Render
    • Documentation (2): Comment, Tool Container 
    • Developer (11): Blob Convert, Blob Input, Blob Output, Detour, Detour End, Download, Dynamic Rename, Dynamic Select, FieldInfo, Message,  Python

  • Input files and their fields (if available)

    All used inputfiles of the workflow are identified and added in a numbered list (based on the position on the canvas). If available you will be provided with a list of file names, sheetnames, columns, field types and their size.

  • Basic statistics

    Some basic statistics are provided like number of each tool used,  tools per container, enabled/disabled tools

Fill in the form to get an example output or ask for a quote

Contact us any time

Contact Us

Share by: