Skip to main content

Auto Insights Uploader Tool

Run your workflow with the Auto Insights Uploader tool to view your dataset insights instantly in Alteryx Auto Insights. This tool takes a copy of the data that is transformed in Designer and loads it into Auto Insights for you.

System Requirements

  • Alteryx Designer 2021.2+

  • AMP Engine

  • An Alteryx Marketplace account to download updates for the tool.

  • An active Alteryx Auto Insights account with an Administrator or Organization Admin Role. Contact your IT Admin to request changes to your Roles.Roles

  • For tool version 1.214x, you must have Alteryx Data Connection Manager (DCM) enabled. To enable DCM in Designer, go to Options > User Settings > Edit User Settings > DCM. Check the boxes Override DCM System Settings and Enable DCM. For Access to SDK dropdown, set it to AllowAll.

Upgrade Considerations

  • To avoid workflow errors, uninstall any previous versions of the tool. See uninstall steps at the end of this article.

  • Designer 2021.4.1—We recommend upgrading from 2021.4.1 to the latest version of Designer as there are stability issues with this version.

Download

This tool is included with Designer 2022.1 as well as 2022.3 and above, however, it is recommended that all Designer users download and install the latest version of the Auto Insights Uploader tool. Other versions require you to download the tool from Alteryx Marketplace - make sure you download the version that is compatible with your version of Designer.

Note

Alteryx Analytics Cloud—Version v1.8.xxx of the Auto Insights Uploader tool or newer is required to upload to Auto Insights in Alteryx Analytics Cloud.

*While this tool is compatible with Alteryx Designer and Server 2022.2-FIPS, Auto Insights, and the Auto Insights Uploader tool are not FIPS compliant.

Install

Download and install the latest compatible version of the Uploader tool for your version of Designer.

  1. Download the relevant Uploader tool installation file from Alteryx Marketplace.

  2. Select and hold (right-click) on the Designer app. Select Run as administrator.

  3. In Designer, select File > Open Workflow > Browse.

  4. Find the Auto Insights Uploader YXI that's compatible with your version of Designer, and select Open. The tool installer displays.

  5. Select Install for all users.

  6. Select Install.

Configure Designer Versions 2021.2 and 2021.3

The Auto Insights Uploader Tool v1.x.213 is only compatible with Designer versions 2021.2 and 2021.3.

  1. In Alteryx Designer, go to the In/Out tool category.

  2. Drag the Auto Insights Uploader tool onto the canvas.

  3. In the configuration panel, enter the Host (for example, https://us1.alteryxcloud.com/auto-insights/), then select Connect. Note: To find and copy your Host, sign in to Auto Insights and then select your Profile icon >Account Settings>API Tokens. SelectCopy next to your host. Paste into Designer.

    Host on API Tokens page

  4. Under API Token, select Click here to log in and create your Access Key/Secret. A sign-in window displays.

  5. Sign in to your Auto Insights account, then select Create Token.

  6. Paste your Access Key and Secret into the Configuration panel, then select Verify.

  7. Enter a Dataset Name or select a dataset from the dropdown, then select Save.

Now you’re ready to build your workflow.

Configure Designer Versions 2021.4 and Newer

There are 2 versions of the Auto Insights Uploader Tool compatible with Designer versions 2021.4 and newer. Uploader v1.x.214 is compatible with Designer versions 2021.4 and 2022.1, while Uploader v1.x.223 is compatible with Designer versions 2022.2 and 2022.3. These share the same configuration instructions.

  1. In Alteryx Designer, go to the In/Out tool category.

  2. Drag the Auto Insights Uploader tool onto the canvas.

  3. In the Configuration panel, select Set up a Connection. Connection Manager opens.

  4. Select + Add Data Source.

  5. Enter a Data Source Name and Host (for example, https://us1.alteryxcloud.com/auto-insights). Note: To find and copy your Host, sign in to Auto Insights and select your Profile icon > Account Settings > API Tokens. Select Copy next to your host. Paste into Designer.

    Host on API Tokens page

  6. Select Save.

  7. Select + Connect Credential.

  8. From the Authentication Method dropdown, select API Token.

  9. Check the Allow connection for SDK checkbox.

  10. From the Credential dropdown, select Create New Credential.

  11. Enter Credential Name.

  12. Enter your Access Key and Secret from your Auto Insights Account Settings. Learn more in the Auto Insights API Tokens article.Auto Insights API Tokens

  13. Select Create and Link.

  14. Select Connect.

  15. Check that your connection displays in the Configuration Panel.

    Auto Insight Connection

  16. Enter a Dataset Name or select a dataset from the dropdown.

Build and Run Your Workflow

  1. Add the Auto Insights Uploader tool as an output in your workflow.

    Note

    The Auto Insights Uploader tool only runs with AMP Engine. To use AMP Engine, go to the Workflow - Configuration panel > Runtime. Check the box Use AMP Engine.

  2. Run your workflow to upload your dataset to Auto Insights. Go to the Dataset Requirements article for more information.

  3. To launch Auto Insights and view your dataset insights, select Launch Auto Insights at the bottom of the tool's configuration panel.

An example workflow with Auto Insights Uploader

Update Your Dataset

Select the updated data source as Input in your workflow to update your dataset. Then rerun the workflow with the dataset you want to update selected in the Auto Insights Uploader configuration.

Use Auto Insights Uploader with Server

You can save and schedule your workflows that use the AI Uploader tool to Alteryx Server versions 2021.4+ to automate the end-to-end analytics journey from data to automated insights.

Server Requirements

  • Server 2021.4+

  • AMP Engine Enabled

  • DCM Enabled

  • SDK Support Tools set to allow

  • For 2021.4.1 and 2021.4.2, you have to install the Auto Insights Uploader tool on Server. See the Install Custom Toolsarticle for details. The basic steps are:

    1. Remote desktop into Server.

    2. Run Designer as Administrator.

    3. Install the Auto Insights Uploader tool YXI.

To Use the AI Uploader Tool With Alteryx Server

  1. Sync your credentials from Designer with Server. Go to Designer > File > Manage Connections to open Connection Manager. Then select Synchronize in the menu.

  2. Go to Alteryx Server > DCM Data Sources.

  3. Find your data source, then select the 3-dot menu > Edit. Check the box for Allow connection for SDK. Select Save and Link.

  4. Save your workflow to Server. In Designer, select File > Save As > Alteryx Server.

  5. In Server, either run the workflow manually or configure it to run on a schedule.

  6. (Optional) Set up an email notification for workflow failure. See the steps to do so in this Community article.

Uninstall

To avoid workflow errors, you have to uninstall any bundled or installed versions of the Uploader tool before installing a new version.

To remove the bundled Uploader…

  1. Close Alteryx Designer.

  2. Open File Explorer.

  3. Go to C:\Program Files\Alteryx\bin\HtmlPlugins

  4. Delete AutoInsightsUploader.

  5. Open Windows Explorer. Enter %USERPROFILE%\.shiv into the search bar. The full path on your workstation displays. Right-click and delete the entire .shiv folder.

To uninstall for 1 user…

  1. Close Alteryx Designer.

  2. Open File Explorer.

  3. Go to C:\Users\YOUR_ID\AppData\Roaming\Alteryx\Tools\

  4. Delete AutoInsightsUploader.

  5. Open Windows Explorer. Enter %USERPROFILE%\.shiv into the search bar. The full path on your workstation displays. Right-click and delete the entire .shiv folder.

Uninstall for all users…

  1. Close Alteryx Designer.

  2. Open File Explorer.

  3. Go to C:\ProgramData\Alteryx\Tools

  4. Delete AutoInsightsUploader.

  5. Open Windows Explorer. Enter %USERPROFILE%\.shiv into the search bar. The full path on your workstation displays. Right-click and delete the entire .shiv folder.

In this section: