community
cancel
Showing results for 
Search instead for 
Did you mean: 

Alteryx Knowledge Base

Definitive answers from Designer experts.
Upgrade Alteryx Designer in 10 Steps

Debating whether or not to upgrade to the latest version of Alteryx Designer?

LEARN MORE

Tool Mastery | One Drive

Alteryx
Alteryx
Created on

One Drive_output.pngOne Drive_input.png

This article is part of the Tool Mastery Series, a compilation of Knowledge Base contributions to introduce diverse working examples for Designer Tools. Here we’ll delve into uses of the OneDrive Tools on our way to mastering the Alteryx Designer:

 

OneDrive is a file hosting and synchronization service operated by Microsoft. You can connect to a OneDrive instance in Alteryx with the OneDrive Input tool and the OneDrive Output tool.

 

The OneDrive tools do not come installed standard with Alteryx. To install them, you can find them here, or by searching for “OneDrive” in the Alteryx Gallery.

 

Connecting to OneDrive:

 

There are two different modes for authentication depending on whether the OneDrive account you'd like to connect to is Personal or for Business. For either form of authentication, you will have to register a new application with Microsoft and create a Client ID. If the account type is business, you will also need to generate a secret key.

 

How to Create a Microsoft App: 

 

1. Go to the Microsoft Application Registration Portal.

2. When prompted, sign in with your account credentials.

3. Find My applications and click Add an app:

 

MicrosoftAddAnApp.png   

 

 

4. Enter your app's name and click Create

.OneDriveRegisterYourApp.png

 

5. Once the app is created, an application ID will automatically be created. This is the Client ID that is used in Alteryx to log into the app.

 

6. If you are using the application for a OneDrive Business account (organization account) you will need to generate a password. This will be entered as well as the Client ID                   when logging in from the OneDrive tool in Alteryx:

ApplicationSecrets.png

 

7. Next, you will need to choose the platform that the app will be using to connect. Choose Web:

 

AddPlatform.png

 

 

8. Once the platform is added, the configuration options for the platform will appear. Make sure the checkbox for “Allow Implicit Flow” is selected and use the standard Microsoft redirect URL for the Redirect URL. The Logout URL is not necessary for this application:

 

Platforms.png

 

9. After you have created the platform, you will have to set permissions for the application. There are at least two delegated permissions required to use the tool (Files.ReadWrite, and offline_access). You can add and remove permissions by selecting the “Add” button. This will show a list of permissions that you can then check if you wish to grant them to the application.

 

GraphPermissions.png

 

Note* You can achieve necessary permission for the application by selecting other permissions as well. The permissions listed above are the bare minimum for the Alteryx tool to access OneDrive. 

 

 

After this is complete, you have everything necessary to log into the OneDrive tool in Alteryx. You can save the application and exit the portal. Another guide for creating these credentials can be found here, as well as in the Alteryx Microsoft Application Setup Help Documentation. Additional information can also be found on the Microsoft Website.

 

 

Logging in to the OneDrive tools in Alteryx:

 

Personal: For OneDrive Personal Accounts, you will only need to enter a Client ID:

 

OneDrivePersonalCred.png

 

Business: For OneDrive Business Accounts, you will need both a Client ID as well as a Secret Key that is associated with the application:

 

OneDriveBusinessCred.png

 

Authentication:

 

Once you provide the application credentials, A new window will pop up, and you will be prompted to log in to an account that has access to the OneDrive:

 

OneDriveAuth.png

 

Note* You will have to provide authentication for both OneDrive Input and Output tools, even if you are using them in the same workflow.

 

Once you complete the authentication, the configuration window for the tool will appear.

 

Configuring the OneDrive Input Tool:

 

The OneDrive input tool will allow you to choose multiple specifications for the file you wish to pull in:

 

OneDriveInputConfig2.png

 

 

 

Once you have made all of your selections, run the workflow to pull in the file from OneDrive.

 

 

Configuring the OneDrive Output Tool:

 

 

OneDriveOutputConfig.png

 

Once you have made all the selections that you wish, run the workflow to write data into OneDrive.

 

Troubleshooting:

 

"We're unable to complete your request" error after logging in:
UnableToCompleteYourRequest.png

-This usually means that you have entered your Client ID or Application Secret incorrectly. Makes sure that you have entered them correctly. 

-Also be sure that you have permissions to access the OneDrive.

_______________________________________________________________________________________________________________________

 

Error when reading in JSON: “list index out of range”

onedrivejson.png

Check to make sure that JSON formatting within the files is correct.

 

By now, you should have expert-level proficiency with the OneDrive Input and Output tools! If you can think of a use case we left out, feel free to use the comments section below! Consider yourself a Tool Master already? Let us know at community@alteryx.com if you’d like your creative tool uses to be featured in the Tool Mastery Series.

  

Stay tuned with our latest posts every Tool Tuesday by following Alteryx on Twitter! If you want to master all the Designer tools, consider subscribing for email notifications.