You are leaving our main website to go to our chinese website hosted in China. For legal reasons there will not be any links pointing back to the main website.

Go to chinese website
Logo - Keyrus
Logo - Keyrus
  • Playbook
  • Services
  • Insights
  • Partners
  • Careers
  • About us
    Company purpose
    Innovation & Technologies
    Committed Keyrus
    Regulatory compliance
    Investors
    Management team
    Brands
    Locations

Blog post

Documentation generator for Alteryx workflows

By Lev Solomovich

This blog post can also be found at the Alteryx Community Engine Works Blog.

Say someone built an Alteryx workflow at your company. What does it do exactly? How does it work? Can you trace it step by step? And just how did they configure these pieces? 

As data analysts and engineers, we take it for granted that we can readily convey our understanding of data flows to other analysts and engineers. As business drivers and decision makers, our business rules, processes, and decision criteria are clear to us and our teams. 

But as business and data teams become ever more integrated to adapt to accelerating business needs, our requirements and processes grow ever more complex.  

As a result, what once was an innocent question born of curiosity grows into an ever more cumbersome task, making you ask, "What does this workflow do, exactly?"

Enter the world of documentation. Being a data consultant, I frequently see the same theme play out. Users love building Alteryx solutions, but they often face business situations like these:

  • They need to be able to onboard new users and make sure they can support processes developed by existing and off-boarded users.

  • They need to assure compliance and audit teams that everything they build is auditable and reproducible.

  • They need engineering to work with them to access the data.

  • They need to build confidence with engineering teams that they can build and manage their own automated processes.

  • Alternatively, they should be able to sketch out tested and verified designs that they can easily hand to engineering teams (who will then manage implementation).

Whatever the specific situation, the users need to be able to quickly build documentation in parallel with developing and iterating on their workflows. 

When we developed an auto-documentation utility for Alteryx workflows originally, we had positive feedback, but there were a few consistent shortcomings inhibiting adoption:

  • It did not support workflows with containers

  • It did not provide an order of tools (the document would not be helpful in rebuilding a workflow)

  • It did not provide enough details about the configurations of various tools to reproduce the workflow

In addition, we saw a recurring need for sketching images of workflows for easy reassembly. Never the ones to shy away from a challenge, we took it upon ourselves to rebuild the documentation utility from the ground up to address these needs.

Enter the latest and greatest in workflow auto-documentation, the Auto Documenter version 2. Simply click Run to get a download link.

Check out a sample of the outputs: 

  • Read the full documentation here for installation and usage instructions.

  • Check out our demo video. 

  • Check out our other public projects on our Gitlab

  • Contact us directly for additional feature requests and support 

whatsapptwitter
linkedinfacebookworkplace
newsletter.svg

Never miss an insight

Stay updated on the latest articles, events, and more

Your email address is only used to send you the Keyrus newsletter and for commercial prospecting purposes. You can use the link in our emails to opt-out at any time. Learn more about the management of your data and your rights.

Continue reading

Press release

Keyrus named amongst Top B2B Companies on Clutch

December 12, 2022

The Keyrus team is excited to announce that we’ve been named one of the top 1000 companies on Clutch’s platform in 2022! This is the second year that Keyrus has been recognized by Clutch as a top company and B2B leader. 

Webinar

PDF Parsing with Alteryx Intelligence Suite

December 1, 2022

In 20 minutes, we’ll teach you how to use Alteryx Intelligence Suite to eliminate common problems and inefficiencies in accessing data from .pdf files. In the past, you’d need to run custom Python and complex parsing logic to get any usable data from a pdf. Now, you can parse PDFs with out-of-the-box features in Alteryx Intelligence Suite.

Webinar

Modern Cloud Analytics in Action: Keyrus and Red Ventures

November 11, 2022

The cloud offers new opportunities to save you time and money, allowing you to shift focus from maintaining growing servers and upgrading infrastructure to making your data work for you and the success of your business. Watch the webinar and Q&A to learn how AWS, Tableau, and Keyrus worked together to help Red Ventures migrate to a powerful cloud BI tool that created new pathways for success and a modern data culture.

Event

Pharma/Biotech GTN Summit 2022

October 27, 2022

Keyrus & Anaplan Sponsor Life Science Gross-to-Net (GTN) Summit

Press release

Keyrus Achieves AWS Data and Analytics Competency Status

October 6, 2022

Keyrus achieved Amazon Web Services (AWS) Data and Analytics Competency. To receive the designation, AWS Partners must possess deep AWS expertise and deliver solutions seamlessly on AWS.

Webinar

Live Webinar: Lessons on workforce capacity planning and optimization from Optum (UnitedHealthcare)

October 19, 2022

Wednesday, November 9th, 2022 @ 12:00PM Central Time (US and Canada)

Webinar

Tableau Embedded Analytics: Optimizing insights from Salesforce data

September 20, 2022

Want to optimize your visual analytics in Salesforce? You need the right tools. Tableau Embedded Analytics can be used to help you build and visualize reports in Salesforce.

Success story

How C&S Wholesale Grocers maximized ROI with an analytics center of excellence

September 7, 2022

C&S Wholesale Grocers worked with Keyrus and Alteryx to implement an analytics center of excellence to help them efficiently and effectively achieve business objectives, maximize return on investment (ROI), and standardize best practices.

Success story

Implementing a cloud security automation tool at a global consulting firm

September 2, 2022

Keyrus partnered with a consulting firm to build an in-house cloud security solution that would automate their verification processes and keep their information safe.

Success story

Leveraging Salesforce to improve operations at Pajama Program

July 25, 2022

Keyrus partnered with Pajama Program, a nonprofit organization, to review their Salesforce architecture and improve overall operations.

Logo - Keyrus
New York City

252 West 37th st., Suite 1400 New York, NY 10018

Phone:+1 646 664 4872

LinkedInInstagram
PlaybookServicesInsightsPartnersCareersAbout us
Company purposeInnovation & TechnologiesCommitted KeyrusRegulatory complianceInvestorsManagement teamBrandsLocations
Legal notice & Terms of use
Privacy policy
Data protection