The importance of comments in Alteryx #TipWeek - DAY 2

by Simona Loffredo

Tipweek DAY 2 – I have decided to write about some simple but very useful feature in Alteryx I have started to use at DS2 from week 5:

  1. annotations
  2. comment tool
  3. container tool

I find them very important in order to document the workflow both for yourself (it will be easier to remember and explain it) and for the client (he will be able to understand what you have done step by step easily).

1.ANNOTATIONS

Every tool has the option to add the annotation and I find it really useful to track what the tool is doing (see example below)

 

annotation2

Clicking on the left side, where the configuration of the tool is, on the icon “annotation” (the one in blue borders in the figure below), it is possible to add the annotation:

Annotation

I have discovered this feature, I did not notice before. It is possible to place the annotation on the top of the tool just ticking “Place Annotation on the Top”:

annotation3

2. COMMENT TOOL

Comment tools are part of Documentation tools.

documents tool

Below an example on how you can configure it, putting the comment into text, selecting your shape and font, text and background colour:

comment1

and below the result:

comment2

Below some examples of usage I have made of them:

  • DIVIDE THE WORKFLOW IN DIFFERENT SECTIONS HIGHLITING THEM AND COMMENTING

Box comment

  • SHOW THE STEPS/ EVOLUTION OF A WORKFLOW

box comment2

  • HIGHLIGHT OUTPUTS THROUGH COMMENTS AND GIVING INSTRUCTION (BLUE LEGEND)

Box comment3

 

ATTENTION: If you are using a comment tool on a workflow, do not forget to send it to the back otherwise it will cover it.

 

3. CONTAINER TOOL

Also part of the Documentation tools. You can put inside it a worklow or one or more tools.

Below an example where I put inside a workflow:

container tool1

If you click on the small triangle on the right side it will show what it contains:

container tool2]

I find it really useful for space optimization.

How to configure it? Below the settings, insert the “title” into Caption and, if you want, it is possible to customize text & background colour and border.

container tool settings

I hope you find it useful.

A presto!

Avatar

Simona Loffredo

When use what? - PART 6 - Rank_Unique can solve your problems!

2 mins read

Thu 17 Mar 2016

A smart way to investigate your data in Alteryx

4 mins read

Fri 04 Mar 2016

Filtering with multiple datasources - Part 2

2 mins read

Sat 27 Feb 2016

Filtering with multiple datasources - Part 1

2 mins read

Fri 26 Feb 2016