Using the OneDrive Connection Manager

The OneDrive Connection Manager is an SSIS connection manager component that can be used to establish connections with OneDrive.

To add a OneDrive connection to your SSIS package, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection.." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "OneDrive" item to add the new OneDrive connection manager.

new connection

add OneDrive connection manager

The OneDrive Connection Manager contains the following three pages which configures how you want to connect to OneDrive.

  • General
  • Advanced Settings
  • More Info 

General page

The General page on the OneDrive Connection Manager allows you to specify general settings for the connection.

OneDrive Connection Manager

Generate New Token File

This button will open a dialog in order to generate a new Token File

OneDrive Connection Manager

  • App Type
    • KingswaySoft: The Connection Manager will use the Client Id and Secret that is provided by KingswaySoft for your convenience when setting up the connection, it should NEVER be used for production purpose.
    • My Own App: Selecting this option will allow you to use your own Client ID and Secret to connect to OneDrive.
  • Client ID: The Client Id option allows you to specify the unique ID which identifies the application making the request.
  • Client Secret: The Client Secret option allows you to specify the client secret belonging to your app.
  • Redirect URI: The Redirect Url option allows you to specify the Redirect Url which was assigned to your app.
  • Use Default Browser to Sign In: When this option is checked the Sign In and Authorize button will open your default web browser in order to complete the OAuth authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire OAuth authentication process inside of the toolkit.
  • Sign In and Authorize: This button allows you to login to the service endpoint and authorize your app to generate a token.
  • Signed In Account Details
    • Account ID: Displays the OneDrive Account ID which the token file will belong to.
    • Account Name: Displays the OneDrive Account Name which the token file will belong to.
    • Account Type: Displays the OneDrive Account Type which the token file will belong to.
  • Password: This option allows you to assign a new password for the token file which will be created.
Path to Token File

This option allows you to specify the path to the token file on the file system.

Token File Password

This option allows you to specify the password of the selected token file.

Token File Details
  • Account ID: Displays the OneDrive Account ID which the token file was created with.
  • Account Name: Displays the OneDrive Account Name which the token file was created with.
  • Account Type: Displays the OneDrive Account Type which the token file was created with.
  • App Type: Displays the client application Type which the token file was created with.
  • App Client ID: Displays the client application ID which the token file was created with.
Impersonate As

This option allows you to impersonate the connection as a different user by providing a User Principle Name or UserId. However, in order to access other users' OneDrive account, the OneDrive business user has to be an Office Global Admin. The Global Admin user needs to enable OneDrive access for the user in Office 365 Admin portal.

Test Connection

After all the connection information has been provided, you may click the Test Connection button to test if the connection settings entered are valid.

Advanced Settings

The Advanced Settings page on the OneDrive Connection Manager allows you to specify some advanced and optional settings for the connection.

OneDrive Connection Manager

Proxy Mode (since v3.0)

Proxy Mode option allows to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword;  (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.

Upload Chunk Size (since v6.0)

The Upload Chunk Size option allows you to specify the size of the file content to be divided to upload large file sequentially.

Retry on Intermittent Errors

This is an option designed to help recover from possible intermittent outages or disruption of service. It prevents the integration process from stopping due to temporary issues. Enabling this option will allow service calls to be retried upon certain types of failure. A service call may be retried up to 3 times before an exception is fired. Retries occur after 0 seconds, 15 seconds, and 60 seconds.

Warning: We have designed our retry feature carefully such that the retry should only occur when it is deemed safe to do so; however, in some occasions such retry service calls could result in the creation of duplicate data.

More Info page

The More Info page shows some basic information about the toolkit. In this page, you can find the version information of the toolkit.

OneDrive Connection Manager