on 08-15-2016 05:32 PM - edited on 07-27-2021 11:37 PM by APIUserOpsDM
Have you ever wanted your own help page for your custom macros or applications?
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:
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 ahelp 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.
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:
PDF:
HTM:
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
I have the same question.
I have the same question. I see the help on the app on the desktop, but nothing when posted to my gallery.
+1
One fix for this is to have the help file saved as a page on the gallery (done via admin portal) and then add a link via interface designer. Not ideal but works.
Same question. I dont see any button or place on gallery where user can see that help.
Same question. I dont see any button or place on gallery where user can see that help.
This option is only available in designer, you will see the help page before running the app.
If you want to show a link on the gallery page, you need to include a link in the interface designer, as below: