OneDrive Output Tool

Use the OneDrive Output tool to write files from Designer to OneDrive. 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.

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 Output 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 File

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.
3. Use Existing File Action in the Options tab to select the handling of an existing file.
   • Rename: The Rename option will rename the file (appending a unique number to the end of the filename.)
   • Overwrite: Overwrite option will delete the existing file and write the new file contents.
   • Overwrite Sheet: The Overwrite Sheet option rewrites the selected sheets and makes no changes to other sheets.
   • Append: Append option will add the new data to the existing file.
   • Abort: When Abort is selected, the file will not upload if there is another file with the same name.

Add a Folder

1. Navigate to the folder where you want to add a folder.
2. Click Add Folder.
3. Select By Name and type the name of the new folder. Designer adds the folder without the need to run the workflow.
4. Select By Field to add multiple folders based on a specified field from the data.
5. Enter the name of the new files in the File Name field.

   Important

   The File Name field requires the file name including the file type extension.

6. Run the workflow to add the folders.

Add a File

1. Navigate to the folder where you want to add a file.
2. Click Add File.
3. Select By Name and enter the name of the new file.

   Note

   The File Name field requires the file name including the file type extension.

4. Select By Field to add multiple files based on a specified field from the data.
5. Run the workflow to add the file.

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 By Sheet Name and By Field. OneDrive Output excludes the field from the written data. You can keep it by selecting Keep Field in Output.

  Warning

  If you select the By Field option, multiple sheets will be created and named based on the value selected in Select Field.

• Enter the cell in Start in cell to specify the start of data output.
• Select Write headers to include headers in the output data.
• Select Code Page to determine the encoding of the data.

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 Write headers to include headers in the output data.
• 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.

YXDB

No options.