This site uses different types of cookies, including analytics and functional cookies (its own and from other sites). To change your cookie settings or find out more, click here. If you continue browsing our website, you accept these cookies.

Learn more
I AGREE
Reject
community Alteryx IO Alteryx.com
alteryx Community

Alteryx IO Resources

Explore these resources to customize and extend the power of Alteryx with SDKs, APIs, and more.

FAQ

Frequently asked questions for the Platform SDK and CLI.
View full article
0 Replies 111 Views 4 likes

Learn how to scaffold the basic Plugin code.

Developer Step 101: Learn how to scaffold the basic Plugin via CLI.  
View full article
0 Replies 94 Views 0 likes

Create a Simple Filter Tool with a UI

In this guide, we use the Python SDK, UI-SDK, and Plugin CLI to create a tool uses custom UI Components.
View full article
0 Replies 152 Views 4 likes

AYX Plugin CLI Command Overview

This CLI provides a single mechanism to guide you through the entire development process, from scaffolding to packaging.  
View full article
0 Replies 118 Views 0 likes

Learn how to scaffold the basic Plugin Workspace.

Developer Step 101: Learn how to scaffold a Plugin Workspace via CLI.  
View full article
0 Replies 117 Views 0 likes

Test Client

Maximize development cycles by testing your tools ahead of time without Designer.    
View full article
0 Replies 112 Views 0 likes

Alteryx Test Client Installation

This document describes how to install the Alteryx SDK CLI that you can use to test extensions.
View full article
0 Replies 83 Views 0 likes

Extensibility Best Practices

Learn Platform SDK and CLI best practices.
View full article
0 Replies 123 Views 4 likes

Lifecycle of a Plugin

Overview of the lifecycle of a Plugin in Alteryx Designer during “Workflow” runs and “Update Only” runs.    
View full article
0 Replies 81 Views 0 likes

Alteryx Platform SDK V2 and CLI Setup

This page describes how to install the Alteryx Platform SDK and Alteryx Plugin CLI.    
View full article
0 Replies 59 Views 0 likes

Tool Configurations

This document describes the basics of custom tool configurations in the backend.  
View full article
0 Replies 64 Views 0 likes

Python Embeddable Distribution (PED)

Understand the basics of the SDK Python Embeddable Distribution (PED).  
View full article
0 Replies 57 Views 0 likes

Python 3rd-party Dependencies

Learn how to add 3rd-party packages and using 3rd-party packages in Plugin code.  
View full article
0 Replies 46 Views 0 likes

Example Tools Descriptions

List of common example tools and their descriptions.
View full article
0 Replies 38 Views 0 likes

Virtual Environments

Learn how to create isolated development environments.    
View full article
0 Replies 43 Views 0 likes

Distance Matrix Weather Tool

In this guide, we use the Alteryx Python SDK and Alteryx Plugin CLI to create a tool that connects directly to 2 Public APIs and gathers the weather forecast for, and distance to, nearby cities.  
View full article
0 Replies 81 Views 0 likes

DCM Input Example Tool

The DCM Input Tool demonstrates how to use available DCM utility functions within the SDK.  
View full article
0 Replies 83 Views 0 likes

Plugins Testing: Unit Test Scaffolding Overview

Learn how to scaffold and write unit test for your custom tools built by the Platform SDK.  Pytest is a unit testing framework intended to test the Python code you write.
View full article
0 Replies 135 Views 0 likes

Metadata Management Utility Functions

Learn how to manage metadata manually.  Metadata is a set of data used to describe the input or output data of a Python SDK plugin. 
View full article
0 Replies 146 Views 4 likes

Danceable Lyrics

In this guide, we use the Alteryx Python SDK and Alteryx Plugin CLI to create a tool that connects directly to a set of data files and determines the most "danceable" songs that contain a set of lyrics. 
View full article
0 Replies 118 Views 0 likes

Differences Between the New and Old Python SDKs

Understand the differences and compatibility constraints between Platform SDK v1 and Platform SDK v2.    
View full article
0 Replies 80 Views 0 likes