Skip to main content

SharepointFiles SharePoint Input Tool

Use the SharePoint Input tool to read data from your CSV, XLSX, and YXDB files as well as lists from your SharePoint site.

Important

This tool is not automatically installed with Designer. To use this tool, download it from the Alteryx Marketplace.

In SharePoint tools version 2.2.0, we renamed SharePoint Files Input to SharePoint Input.

In SharePoint tools version 2.2.0, we also temporarily removed support for SharePoint On-Premise (version 2013 and 2016). In SharePoint version 2.3.0, we re-enabled the support for SharePoint On-Premise.

SharePoint Files Input version 2.0.1 also contains lists reading functionality which was a standalone data connector. See Designer Compatibility with Data Connectors to maintain full functionality of the SharePoint connector.

Sign In to SharePoint

The OAuth method is used for authentication, so you can either use the default Alteryx application via Sign in via Internet Browser or you can provide your own API application via Connect to URL with Client ID and Secret, Tenant ID. See the Custom API Application Setup for the information on how to create your own API application.

You can use the default Alteryx application (Sign in via Internet Browser) to schedule workflows for up to 6 months. However, if you select Use as service principal (app-only authentication) after you select Connect to URL with Client ID and Secret, Tenant ID, you can set the expiration of the token according to your company policy and the scheduled workflows won’t be associated to a single user. This is convenient, for example, if a user leaves the company and their account is disabled, causing workflows to not run.

Warning

SharePoint Files Input version 2.0.1 requires Client Secret even when connecting with Client ID and Secret, Tenant ID without using as service principal. Contact your administrator to request the secret which is a Secret Value, not Secret ID.

The available authentication methods are the same for both Files and Lists but they differ for SharePoint versions. Additionally, you need to enter a SharePoint URL at the site level to read the lists:

  • SharePoint 365 (Cloud)

    • Browser Sign In as a User (OAuth)

    • App Sign In (Use Service Principal)

  • SharePoint 2013, 2016 (On-Premise)

    • Windows Account

If you’d like to authenticate using GCC High tenant or Custom tenant, use DCM and select the appropriate technology. To find the correct URL, go to Sign in to Power BI for US government.DCM - Designer

SharePoint Files

Select a File

  1. Optionally, if you have access to multiple Geo tenants, select which to access.

  2. Select a site.

  3. Select a document library.

  4. Select a file in the tree view or enter a file path.

  5. You have these options how to handle the file:

    • Read Data from Files: Read the data and pass it to other tools through the output anchor.

    • Download file locally for later processing: Process a file of a file type that SharePoint Input doesn’t support or download an offline copy of the file. Choose the location to save the file. The default location is %TEMP%.

    • Read Only List of Full Paths: Read only a list of paths and pass it to other tools through the output anchor.

Note

You can also insert (press Ctrl+V and Enter) the path of your file to File Path via the Copy Link button on the SharePoint site.

Configure the Tool

The file format is detected automatically when you select a file.

XLSX

  • Data Range options specify which sheets contain the data. Options are All Sheets, Sheet Names, Sheet Numbers, Named Range, or Import only the list of sheet names.

  • Check the First row contains field names box to set the first row of data as column headers.

  • Use Start data on line to select which line to start the import.

  • Select Code Page to determine the encoding of the data.

  • Select the Enable dry run all fields to a connected tool without the need to run the workflow.

  • Use Attach Metadata to select the metadata to attach to every row of the input.

CSV

  • Use Max Field Length to set the maximum length of each field. This gives you control over string cut-off.

  • Use Field Delimiter to select a field delimiter between fields. Options are Comma, Semicolon, Tab, Pipe, Space, or Custom delimiter.

  • Check the First row contains field names box to set the first row of data as column headers.

  • Use Start Data on Line to select which line to start the import.

  • Use Quote Character to select a format of the quote. Options are None, Single Quote, Double Quote, or Custom.

  • Select Code Page to determine the encoding of the data.

  • Select the Enable dry run to propagate all fields to a connected tool without the need to run the workflow.

  • Use Attach Metadata to select the metadata to attach to every row of the input.

YXDB

  • Select the Enable dry run to propagate all fields to a connected tool without the need to run the workflow.

  • Use Attach Metadata to select the metadata to attach to every row of the input.

SharePoint Lists

Select Data

  1. Select a list.

  2. Optionally, select a view.

Configure the Tool

  • Extract values of linked items: Check the box to automatically extract values of linked items.

  • Record limit: Enter the number of records you want to read.

  • Propagate field immediately to the next tool: Check the box to pass the values to a connected tool without the need to run the workflow.

In this section: