community
cancel
Showing results for 
Search instead for 
Did you mean: 

Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!

Platform Integration | Delivery Guide

Alteryx
Alteryx

Introduction

 

Use the Delivery Guide to learn how to deliver Alteryx Analytics platform integrations to customers. Within the guide, you can find overviews of delivery methods and links to relevant technical resources.

 

 

 

Alteryx Connect

 

Custom Connect Loaders

Save custom loaders, built using the Connect Loader SDK, directly to the Alteryx Analytics Gallery to make them accessible to Alteryx users.

 

Step Details
1. Create a company branded account on the Alteryx Analytics Gallery using the Sign Up form.
2. Open the custom loader within Alteryx Designer.
3. Confirm that the workflow meta info has been properly completed. Details on Meta Info can be found on the Alteryx Help - Workflow Configuration page.
4.

Confirm that the custom loader properly handles security concerns:

  • Remove test credentials or sensitive test data.
  • Obfuscate the program where applicable.
  • Avoid sending sensitive information over HTTP.
5. Save the workflow to the Alteryx Analytics Gallery. Detailed instructions can be found on the Alteryx Help - Workflow Management page.
6. Open the workflow using the link provided after saving it to the Alteryx Analytics Gallery.
7. Confirm that the details of the custom loader are correctly displayed within the Gallery.
8. Click the Sharing icon and selecting Place in Alteryx Analytics Gallery to make it available to all Alteryx users.


Connect REST API

Please follow your normal software release process as there is not a standardized method to deliver Connect REST API integrations to Alteryx users.

 

 

 

Alteryx Designer

 

Custom Tool

Use the Alteryx Analytics Gallery to make custom tools accessible to Alteryx users.

 

 

Step Details
1. Create a company branded account on the Alteryx Analytics Gallery using the Sign Up form.
2. Package the tool as a YXI file. Detailed instructions can be found on the Developer Help - Package a Tool page.
3. Upload the YXI file to a publicly available online location (e.g. AWS S3, Dropbox, etc.) 
4. Download and update the Example Stub App. Within the App, provide a tool description and link to the YXI file. Follow the App Building Guidelines.
5 Save the app to the Alteryx Analytics Gallery. Detailed instructions can be found on the Alteryx Help - Workflow Management page.
6.  Open the app using the link provided after saving it to the Alteryx Analytics Gallery.
7.  Confirm that the details of the app are correctly displayed within the Alteryx Analytics Gallery.
8.  Click the Sharing icon and selecting Place in Alteryx Analytics Gallery to make it available to all Alteryx users.

 

Note that non-YXI macros can be saved directly to the Gallery.

 

 

 

Alteryx Server

 

Gallery REST API

Please follow your normal software release process as there is not a standardized method to deliver Gallery REST API integrations to Alteryx users.

 

 

 

Alteryx Promote

 

Promote REST API

Please follow your normal software release process as there is not a standardized method to deliver Promote REST API integrations to Alteryx users.

 

Python Client

Please follow your normal software release process as there is not a standardized method to deliver Python Client integrations to Alteryx users.

 

R Client 

Please follow your normal software release process as there is not a standardized method to deliver R Client integrations to Alteryx users.