Skip to main content

Load Metadata from Amazon S3

Use the S3 Loader to upload metadata to Alteryx Connect for data files (such as .yxdb, .csv, .xlsx, .xls) in a specified Amazon S3 bucket.

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.

The JavaScript tool must be installed. For more information, search for "JavaScript tool" in the Alteryx Community.

Open the Loader

  1. Open Alteryx Designer.

  2. Select Help > Sample Workflows > Alteryx Connect Metadata Loaders > S3 Loader > S3 Loader.

Run the App

  1. Select Run as Analytic App

    Run as analytic app button

    .

  2. In the Amazon S3 tab:

    • Type the AWS Access Key and AWS Secret Key.

      Use the AWS Management Console to manage access keys of IAM users.

    • Type the AWS Bucket name.

    • In Files to load, type a comma-separated list of file types to load.

    • Optionally, you can specify the following parameters:

      • To load the tags, check the Load tags box.

      • You can define your own metadata in S3. To load the user defined metadata, check the Load user defined metadata box.

      • To get a pre-signed URL that is valid for 7 days, check the Load download link box. This URL is also used for the Open button. You can check the Data profiling (takes more time) boxto enable you to download files on the disk and perform data profiling.

  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, select Save button and save the app configuration to the following directory:

    C:\ProgramData\Alteryx\AlteryxConnect\S3_Loader\

    The .yxwv app values file is used for scheduling the loader to run in the Gallery. See Schedule Metadata Loaders.

  5. Select Finish to run the app.

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

    • If the run succeeds, "Success" appears in the App Results window.

    • If the run fails, a "There were Errors" message appears.

View the Metadata

  1. Go to the Alteryx Connect URL and log in.

  2. From the main menu, select Data Sources > Files > Amazon S3 > your-bucket-name.

  3. Select a folder to view its contents.

In this section: