Load Metadata from an Alteryx Server Gallery

Version:
2019.4
Last modified: April 02, 2020

Use the Alteryx Loader to upload Gallery workflows and Alteryx Insights metadata to Alteryx Connect.

Review Loader Requirements

  • The Alteryx Connect Loaders must be installed on the machine where Alteryx Server is installed. To install the loaders:

    1. Download the loaders installer. For compatibility, the Loaders installer version must match the Alteryx Connect version.
    2. Run the installer as an administrator.
  • Alteryx Predictive Tools with R must be installed. See Predictive Analytics.
  • An Alteryx Server Gallery must be accessible by the workflow. For more information, see the Alteryx Server Help for Administrators.
  • Enable the Admin API and obtain the Admin API Key and Secret:
    1. Log in to the Gallery as a Curator.
    2. Go to Settings and click the Keys tab.
    3. Enable the Admin API.
    4. Copy the Key and Secret.
  • Workflows/Macros/Apps should be published to the Gallery.

For lineage requirements, see Maintain Data Lineage.

Open the Loader

  1. Open Alteryx Designer.
  2. Click Help > Sample Workflows > Alteryx Connect Metadata Loaders > Alteryx Loader > Alteryx Loader.

Run the App

  1. Click Run as Analytic App Run as analytic app button.
  2. In the Alteryx Gallery tab:
    • Type the Gallery API URL
      http://<machinename>/gallery/api/admin/v1
    • Enter the Gallery API Key and Secret.
    • In Search, optionally type any search text to limit results.
  3. In the Alteryx Connect tab, type the URL for your Alteryx Connect instance and your credentials. 
    https://yourcompany.alteryxconnect.com

  4. Before running the app, click Copy button and save the app configuration to the following directory:
    C:\ProgramData\Alteryx\AlteryxConnect\Alteryx_Loader\
    The .yxwv app values file is used for scheduling the loader to run in the Gallery. See Schedule Metadata Loaders.
  5. Click Finish to run the app.
    • If the run succeeds, "Success" appears in the App Results window.
    • If the run fails, a "There were Errors" message appears.

    Depending on how much metadata is being imported, the app can take a long time to run.

View the Metadata

  1. Go to the Alteryx Connect URL and log in.
  2. From the main menu, click Data Sources.
  3. Select a folder to view its contents.
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.