Configuration File Upload Workflow

Last modified: July 08, 2021

This example workflow demonstrates how to push configuration files from Designer to Alteryx Connect via the REST API.

To complete this workflow, you will need...

  • Connect v2 Server
  • Designer and the Connect v2 Tools

This workflow assumes you have created the county.xml and load-alteryx-counties.xml configuration files in the Configuration Workflow.

In Designer

Download or create this workflow by following the steps below.

  1. Open a new workflow and drag an Input Text tool onto the canvas.
  2. Configure the Input Text tool:

    Text Input tool configured with the column "ConfigFilePath" and value "C:\Temp\Configs.zip" followed by column "ConfigFileName" and value "Configs.zip"

  3. Add and connect a Blob tool.
  4. Configure the tool:

    • Modify File Name By: Replacing Entire Path With Field
    • Using This Field: ConfigFilePath
  5. Add and connect a Formula tool.
  6. Configure the tool to have 7 output columns:

    Output Column Formula Expression
    ConnectURL A Connect URL, like 'https://qo.semanta.cloud'
    APIBaseULR

    [ConnectURL] + '/rest/1/admin/'

    APIUploadURI [APIBaseULR] + 'upload'
    Content-Type 'application/octet-stream' 
    X-File-Name [ConfigFileName] 
    xf3-login 'admin' 
    xf3-password 'Conn3ct!' 
  7. Add and connect a Download tool.
  8. Configure the tool:
    • On the Basic tab:
      • Field: APIUploadURI
    • On the Headers tab:
      • Select Content-Type, X-File-Name, xf3-login, and xf3-password, then click Add.
    • On the Payload tab:
      • Take Query String/Body from Field: Blob
  9. Add and connect a Browse tool.
  10. Run the workflow to load the configs.zip into Connect.

    Final workflow for file upload to Connect

In Connect

Unzip the configs.zip archive to process the files individually and register the configurations. This can take several minutes depending on the number of archived configurations.

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.