How to enable "Choose Tool Version" on my Alteryx Designer plugin
- Subscribe to RSS Feed
- Mark Topic as New
- Mark Topic as Read
- Float this Topic for Current User
- Bookmark
- Subscribe
- Mute
- Printer Friendly Page
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Notify Moderator
Hello everyone,
I am currently working on making a plugin for Alteryx Designer and I have different versions for this plugin. My plan is trying to enable users to be able to switch between different versions of my plugin by installing all of them into Alteryx Designer and use the feature "Choose Tool Version". The screenshot attached is what SharePoint Input can do with "Choose Tool Version", and I want to achieve the same thing with my plugin as well.
I wonder how I can achieve this feature since when I right click on my plugin in Alteryx, I cannot see the "Choose Tool Version" like what we can see in the screenshot of SharePoint Input. Is there anything I have to setup first to enable this feature? Thank you.
- Labels:
-
Custom Tools
-
Developer
-
Python
-
SDK
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Notify Moderator
Hello @bb8000 , do you know what version of the SDK you are using? Are you using the V2 Python SDK?
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Notify Moderator
Assuming you are using the latest Python SDK, I would recommend you utilize the AYX Plugin CLI (https://community.alteryx.com/t5/SDK-Resources/AYX-Plugin-CLI-Command-Overview/ta-p/1127602). The easy way to accomplish this using the CLI is in the same workspace you use create-ayx-plugin and ensure the tool-name parameter matches exactly and then give different version numbers.
If you're successful, you should see your tools/plugins install to C:\Users\<Your User>\AppData\Roaming\Alteryx\Tools with the naming conversion <Tool Name>_#_#_# and the resulting config.xml within the tool/plugin folder should have the same version number corresponding with ToolVersion Value and ToolVersion.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Notify Moderator
Hello Michellef,
Thank you for your response! I have read the article you mentioned and seems like create-ayx-plugin is for generating a new plugin's codebase. However, my codebase has already set up and I have using designer-install to install and test it many times. I am just trying to enable the "Choose Tool Version" to my tool, so I wonder if there is a way for me to do that without generating a new codebase by using create-ayx-plugin. Thank you!
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Notify Moderator
Hello Michellef,
I tried using the solution you provided, but it gave me an error that a tool with that name already existed in my workspace. Could you please help me regarding this issue? I want a same tool, but different version so I typed in the exact same name as instructed but I ended up with that error. Thank you!
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Notify Moderator
Hi! Sorry for the delay in reply due to Thanksgiving holiday absence. I inquired with some colleagues and they tell me that versioning support was made available with SDK v2.3.0 and onwards. Do you know if you are at least utilizing AYX Python SDK v2.3.0? You could try manually updating the versions in some of the XML and JSON files. Specifically, ayx_workspace.json, <ToolName_#_#_#>Config.xml, and manifest.json.
If you continue to run into errors, could you please share the specific error message(s)?
Thanks!