community
cancel
Showing results for 
Search instead for 
Did you mean: 

Alteryx Knowledge Base

Definitive answers from Designer experts.

Create a help file/link for your custom Applications and/or Macros

Alteryx
Alteryx
Created on

Question

Have you ever wanted your own help page for your custom macros or applications?

Answer

If you create your own macros or applications and send them to other who aren’t as familiar with your project, or if you just need a refresher from time to time, you may try and access the help menu only to be greeted by the general Alteryx macros/apps pages:

 

Macro Workflows Page

Analytics App Workflows Page

 

You can actually create your own help pages/files that can be accessed how you would normally access the Alteryx Help Menu for any "out of the box" tool that comes with the Designer.

 

Using your favorite text editor (Microsoft Word, for example), you can create your help file with any instructions or graphics that you feel would be helpful to the end users who may need to access a help file. Once you are done, you can save this in any file format that your (or your users') machine is able to open, as well as any location those users would be able to access (a network drive for example).

 

In your application or macro’s Interface Designer Properties, there is an option to add the path of a file or hyperlink to your newly created help file.

InterfaceDesigner.JPG

 

 

For an example I created the following help file as a .docx, .pdf, and .htm file type. Each other these files open in their respective default programs.

 

Word:

Word.JPG

 

PDF:

PDF.JPG

 

HTM:

HTM.JPG

Comments
Asteroid

Might be a dumb question but does the hyperlinked help show up in the gallery window?  I mean will some button show up or is there a help link I'm just not seeing?  This function totally fits my needs but only if there is an easy way to get at it on the gallery website.

 

Thanks

Atom

I have the same question.

Meteoroid

I have the same question.  I see the help on the app on the desktop, but nothing when posted to my gallery.