Alteryx Designer

Definitive answers from Designer experts.

Tool Mastery | Comment


Comment.pngThis article is part of the Tool Mastery Series, a compilation of Knowledge Base contributions to introduce diverse working examples for Designer Tools. Here we’ll delve into uses of the Comment Tool on our way to mastering the Alteryx Designer:


Now everyone loves to talk about their workflow masterpieces, however, the notion of documenting them doesn't always hold the same appeal. The Comment Tool would be happy to help and can make documenting and structuring your workflow easy and straight forward.  Whether you want to include images, text descriptions or categorize parts of your workflow, the Comment Tool can act as a great refresher when revisiting workflows and make it far more intuitive for work colleagues to follow along. This article provides a few examples on how.


  • The Comment Tool will allow you to jot down notes, explain processes and share external references such as website links, internal Sharepoints etc. 

  • Within Excel color coding particular functions such as calculations, V-Lookups and Pivot Tables is common. Within the Comment Tool you have the ability of adding color to the comment box, as well as adding annotations so it clear to see what processes are being performed as you move along your workflow. 


  • When adding a comment box it will as default appear in front of the tool icons however, you can use the functionality of 'send to back' for the icons to appear in front of the icons themselves (right click on the comment box). 

Comment 2.png


  • Some additional functionality within the comment box tool includes shaping the box, color of the text, alignment of the text, and specifying a background image. 
  • Adding an image to the comment box can be very useful when helping users visualize how a tool can be configured. 

Pic 3.png


By now, you should have expert-level proficiency with the Comment Tool! If you can think of a use case we left out, feel free to use the comments section below! Consider yourself a Tool Master already? Let us know at if you’d like your creative tool uses to be featured in the Tool Mastery Series.


Stay tuned with our latest posts every Tool Tuesday by following Alteryx on Twitter! If you want to master all the Designer tools, consider subscribing for email notifications.

Alteryx Partner

Thanks for the introduction @JordanB! Can you upload a video to the comment tool?

7 - Meteor
Can i update comment tool dynamically while running the workflow?

Hi @vinothdeva


I don't believe this is possible after some research and attempt within the designer. What is the use case and potentially I could suggest a workaround.





5 - Atom

Great article, the image functionality is great to know about. 

9 - Comet

I keep seeing two comment boxes side by side that look like one, with a vertical border removed. How do I remove the border to achieve this look?


Edit: No sooner had I asked the question than I figured out the answer for myself.  One enlarged comment box with a border and a smaller comment box on top of it with no border. #Cheats!

7 - Meteor

Did anyone found a way to lock the comments so you can work in your workflow without selecting it all the time?

5 - Atom

@tonyp  Can you share how you managed to turn off borders for a comment box? I don't see the setting.

9 - Comet

Hey @MDeck, it's not very obvious but you need to set the shape to none in the comment tool config panel.  You can only set it to none after you've entered some text (or changed the background colour), so that it doesn't get lost in your workflow.