Adding an example link for a custom tool

[CoreyS]

Hello Alteryx Support,

I’m a Business Analytics Manager at Evernorth. My team and I use Alteryx Designer 2020.2 x64 for daily data preparation + analytic purposes; primarily, the desktop version but also have access to the company Alteryx Server ‘Gallery’ as well. Recently, we ran into a challenge and after asking around we still couldn’t find a solution.

Our Need:

We are seeking a solution to ‘add an example link’ in our custom built macro.

Our Challenge:

We don’t have the proper permissions to save and/or write to the “C:” designated folder location required to host the file as specified within the Alteryx Community help documentation (e.g. outlined below). --> We understand this is an internal IT obstacle that will take time to work out from a corporate data governance perspective, which is why we are seeking Alteryx Support.

At the end of the day, we are reaching out to see if your team can help us understand if there are alternative solutions that we can explore. Making the assumption, that is…that we can’t take the suggested approach in the documentation. See below for details about what we are trying to achieve.

Current macro state (…as viewed by Alteryx Designer users in the user-interfaces top tool panel for viewable macros):

Desired future macro state:

***Help Documentation***

What we currently know: (According to…How to add an example link in the custom tool - Alteryx Community)

Prerequisites

1. Alteryx Designer

Procedure

1. Place the sample workflow in the %ALTERYX_INSTALL%\Alteryx\Samples\%LANG%. A separate folder can be created to store the workflow. An example of a directory: C:\Program Files\Alteryx\Samples\en\MyTest
2. Add in the "Example" tag with "Description" and "File" child tag in the tool configuration file of the custom/user tool.

Example:
 
    <metainfo>

 ...
     
            Open Example
            Path to the workflow
       

... 

Limitations

1. The sample workflow can only exist in %ALTERYX_INSTALL%\Alteryx\Samples\%LANG%. The link will fail  if the file is located in a different path.
2. The sample workflow needs to be distributed separately from the custom tool installation since it has to be stored in %ALTERYX_INSTALL%\Alteryx\Samples\%LANG%.

Thanks for your support and consideration to create a feature enhancement that allows Alteryx Designer users to 'add an example link to their custom tool' without having to go to the C:\ file location in order for it to work!

Respectfully,

Corey

[CristonS]

hi @CoreyS, thank you for that very detailed use case, your idea and feedback are appreciated! This idea will be reviewed and commented on by Alteryx when the necessary criteria are met. 

In the meantime, there might be value in posting this to the Designer discussion forum. I'm sure you've explored all options, but we do have some pretty stellar users who just might be able to suggest alternatives. Just in case : )