Alteryx IO Discussions

Customize and extend the power of Alteryx with SDKs, APIs, custom tools, and more.
SOLVED

How do I change the Help button URL for a Custom Tool?

mkhtran
9 - Comet

Custom tools seem to point to https://help.alteryx.com/developer-help by default, but I would like for it to point to a help page of my own for this tool. I didn't see anything regarding it on the Tool Configurations documentation.

 

263125852-70c2c769-db65-42e1-9b68-b2ee7a80fc77.png

May be related to How to add Help Button Link to Macro? but I need this for my custom tool and not macro.

2 REPLIES 2
JarrodT
Alteryx
Alteryx

Hi @mkhtran, you can modify that in the {toolName}Config.xml file. Before building the tool, modify the XML file in the workspace\configuration\{ToolName} folder. 

The line is:

<GuiSettings Html="index.html" Icon="toolIcon.png" SDKVersion="10.1" Help="https://help.alteryx.com/current/designer/ToolNameHere">
aneeshnazar
Alteryx
Alteryx

@mkhtran You should be able to edit the "help_url" key in ayx_workspace.json (under ["tools"][<name of your tool>]["configuration"]["help_url"]) and change the URL from there. This will automatically change it in the config.xml as well