General Discussions

Discuss any topics that are not product-specific here.

How to Develop Alteryx Custom Tool using AYX Python SDK v2

Kong
8 - Asteroid

Hi,

 

Alteryx has released a new SDK v2 to incorporate with the modern technology to help develop the Alteryx custom tool to further expand its capability.  With this new tools, I have developed prototypes on QVD Input Tool and QVD Output Tool (link).

 

This post I would like to share a bit the method on how to develop the Alteryx custom tools in term of my experience.  The general steps include:

1. Setup Minicoda3

2. Active the environment

3. Install AYX Python SDK, AYX Plugin CLI

4. Initialize the AYX Plugin workspace.

5. Install NodeJS

6. Create the AYX plugin

7. Modify the backend code and the front end code.

8. Package the AYX plugin

9. Deploy and Use.

 

If you would like to go into details, please reference to my blog post for the step-by-step guide.

https://kongsoncheung.blogspot.com/2023/08/how-to-develop-alteryx-custom-to.html

 

Let's share and discuss. :-)  And let's learn and improve together.

3 REPLIES 3
stevediaz
7 - Meteor

Hello

Thank you for sharing your experience in developing Alteryx custom tools with the new SDK v2. It's great to see how Alteryx is evolving to incorporate modern technology and expand its capabilities.

Your outlined steps provide a helpful guide for those interested in creating custom tools for Alteryx, and your blog post with the step-by-step guide is a valuable resource for those looking to dive deeper into this process. Sharing knowledge and experiences like this is a great way to learn and improve collectively. If anyone is interested in developing custom tools for Alteryx, your blog post is a valuable reference.

This is very helpful. https://community.alteryx.com/t5/Alteryx-Designer-Desktop-Discussions/QVD-Reader-and-Writer-Tools/m-...CCSP Course

 

Thank you.

Kong
8 - Asteroid

Thank you.  Really happy that it can help.  Technology is interesting and should improve together.

Sangini
7 - Meteor

Hello,

Developing an Alteryx Custom Tool using the AYX Python SDK v2 involves a few steps.

--> First, install the Alteryx Designer and the Python SDK.
--> Then, create a new Python tool in Alteryx Designer.

--> Use the AYX Python SDK to define the tool's configuration, inputs, and outputs.

--> Write the Python code for your tool's functionality.

--> Test your tool in Alteryx Designer, and once it works well, save and share it as a workflow.
--> This allows others to use your custom tool in Alteryx.

--> The AYX Python SDK v2 makes it easier to create customized tools, enhancing the functionality of Alteryx for specific tasks.

I hope this will help you. 

https://community.alteryx.com/t5/forums/replypage/board-id/general-discussions/message-id/9840python 

Regards.
@Sangini 

 
 
Labels