AYX Python SDK Example Tools

Last modified: February 16, 2022

V1 of AYX Python SDK is only compatible with Alteryx Designer versions 2021.2 and 2021.3. For the best experience, and to ensure compatibility with the most recent versions of Designer, please use version 2 of AYX Python SDK.

To learn more about version 2 of the AYX Python SDK, go to Changes and Improvements to Python SDK in v2.0.0.

These are example tools created using version 2 the AYX Python SDK. When the tools are installed, they display in the SDK Examples tool category in Alteryx Designer.

Back-end Tools

These examples demonstrate back-end tools and are the same as the template tools available via the CLI. The user interface of the Input Tool example is interactive but please note that the other user interfaces in these examples are not interactive.

Engine Compatibility

The AYX Python SDK requires that the AMP Engine is enabled.

V2 Example Tools

Download All Example Tools

You can download a single YXI file that contains all of the example tools, or download the tools individually via the download links below.

Conversion Passthrough Tool

An example single-input-single-output tool. This tool takes an Arrow Table from the input anchor, converts it into a Pandas DataFrame, and then converts it back again before it writes it to the output anchor. You can download and install this example in Alteryx Designer.

DCM Input Tool

An example input tool that connects to DCM via the UI window. You can download and install this example in Alteryx Designer. For more about this tool, go to DCM Input Example Tool.

Input Tool

An example input tool that generates and sends 3 rows of dummy data. You can download and install this example in Alteryx Designer.

Multi Connection Tool

An example multi-input-multi-output tool. The input anchor can take in any number of connections but only provides 5 output anchors. The tool passes the first 4 inputs through to the corresponding output anchors, then performs a union operation on the rest, and writes those to the fifth output anchor. You can download and install this example in Alteryx Designer.

Multiple Input Tool

An example multi-input tool. This tool takes in data from 2 input anchors and then performs a simple union operation on the 2 sets before it writes them to the output anchor. You can download and install this example in Alteryx Designer.

Multiple Output Tool

An example multi-output tool. This tool expects a single integer field named "Value", which it uses to filter the rows into 2 output streams. The top anchor corresponds to odd values and the bottom anchor corresponds to even values.You can download and install this example in Alteryx Designer.

Optional Tool

An example optional input tool. When there is an input provided, the tool acts as a passthrough tool and takes data from the input anchor and writes it to the output anchor. When there is no input provided, the tool generates data instead. Note: There is a known bug in optional tools that causes them to run twice from start to finish and duplicate rows in the process. You can download and install this example in Alteryx Designer.

Output Tool

An example output tool. This tool takes an input data table and outputs information about the table's metadata to Designer's Results window. You can download and install this example in Alteryx Designer.

Passthrough Tool

An example single-input-single-output tool. This tool takes data from the input anchor and, without changing it, writes it to the output anchor. You can download and install this example in Alteryx Designer.

V1 Example Tools

V1 of AYX Python SDK is only compatible with Alteryx Designer versions 2021.2 and 2021.3. For the best experience, and to ensure compatibility with the most recent versions of Designer, please use version 2 of AYX Python SDK.

To learn more about version 2 of the AYX Python SDK, go to Changes and Improvements to Python SDK in v2.0.0.

 Python Input Tool

This tool writes hard-coded values to the output anchor for use in a workflow. You can download and install this example in Alteryx Designer.

 Python Multiple Input Tool

This tool joins 2 data sources by record position. You can download and install this example in Alteryx Designer.

 Python Output Tool

This tool displays the results of the output anchor. You can download and install this example in Alteryx Designer.

 Python Single Input Single Output Tool

This passthrough tool writes incoming data to the output anchor. You can download and install this example in Alteryx Designer.

 Python Multi Connection Tool

This tool has a single input anchor that can receive multiple connections. The tool maps each of these input connections to an output anchor based on the order in which the input connections were connected. You can download and install this example in Alteryx Designer.

Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.