Connect Loader SDK Quickstart
Last modified: August 05, 2022
This Legacy SDK uses outdated technology that limits your extension opportunities. We've built a new Platform SDK using Python and the latest open-source technology to deliver a vastly improved development experience. Go to Platform SDK to get started!
To create a custom loader for Connect, download and install...
- The latest version of Alteryx Connect.
- The latest Connect Loaders package.
Loader Workflow Guidelines
Adhere to these guidelines for a consistent loader experience:
- Align workflow elements to improve readability.
- Group similar elements, like credentials.
- Check input values for expected patterns, like URLs that contain "http://".
- Use the Input Data tool to connect to the database rather than the Dynamic Input tool to ensure a consistent toolset experience when working with the metadata loaders.
- Create wireless connections from input parameters like credentials, to improve legibility.
- Verify that every loader has sample data to show full capabilities of the connector, including the UI elements to display in Connect.
- Each workflow is in a separate sub-directory that contains the workflow and the related sample data.
Quick Start Examples
- Configuration Files: An example demonstrating how to create and manually upload configuration files to Connect.
- Configuration File Upload Workflow: An example demonstrating how to upload configurations to Connect via the REST API.
- Data Upload Workflow: An example demonstrating the transfer of metadata from Designer to Connect.
Download and install...
- The latest version of Alteryx Connect.
- The latest Connect Loaders package.
Use Alteryx Designer to create a new workflow.
- Use the Connect Json Builder tool to build JSON out of your incoming dataset.
- Use the Connect Output tool to push JSON to Alteryx Connect.