OneDrive Input Tool

Use the OneDrive Input tool to read files stored in a OneDrive instance into Designer. Go to Microsoft OneDrive to learn about known limitations. More information about Microsoft OneDrive can be found on the Microsoft OneDrive documentation site.

To maintain full functionality of the OneDrive data connector, note compatibility with Designer.

Important

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

Sign In to OneDrive

The OAuth method is used for authentication, so you can either use the default Alteryx application by selecting Sign in via Internet Browser or you can provide your own API application by selecting Provide authentication information. Go to Microsoft OneDrive for more information on how to create an 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 Service Principal after you select Provide 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.

OneDrive Input 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.

Select a Data Source

OneDrive Input reads individual files or multiple files of the same type. You can select a folder to read all the files of the same type in that folder and its subfolders and you can define the files with wildcards.

  1. Select which files to display in the Files to display dropdown menu. Options are Personal Files, Recent, and Shared with me.
  2. Select the folder the file in the file tree or search for it by its name. You can also enter the file path in the File Path field.

    Tip

    When you select a file, the file format is detected automatically. If you select a folder, you need to select the file type of the files you want to read in the Options tab. You can define the file path with wildcards. For example “.../*2020.xlsx” for all .xlsx files ending with '2020'.

  3. If you want to process a file of a file type which OneDrive Input doesn’t support or if you want to keep an offline copy of a file, select Download file locally for later processing and choose the location to save the file. Default location is %TEMP%.

Select a File Format

The file format is detected automatically when you select a file. To read multiple files from a folder and its subfolders, you need to manually select the file type in the Options tab.

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.
  • Select the First row contains field names check 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 Propagate field immediately to the next tool 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.

CSV

  • Use Max Field Length to set the maximum length of each field, allowing 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.
  • Select the First row contains field names check 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 Propagate field immediately to the next tool 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 Propagate field immediately to the next tool 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.