Use the CData ODBC Driver for Bitbucket from SharePoint Excel Services

The CData ODBC Driver for Bitbucket can be accessed using the built-in data access tools in Excel. This article demonstrates how to use the CData ODBC Driver for Bitbucket to connect to Bitbucket data from Excel spreadsheets in on-premises editions of SharePoint.

Connect to Bitbucket as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

• Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
• Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

Authenticating to Bitbucket

Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Creating a custom OAuth application

From your Bitbucket account:

1. Go to Settings (the gear icon) and select Workspace Settings.
2. In the Apps and Features section, select OAuth Consumers.
3. Click Add Consumer.
4. Enter a name and description for your custom application.
5. Set the callback URL:
   • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
   • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
6. If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
8. To save the new custom application, click Save.
9. After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.

Configure Excel Services

Once the ODBC DSN is configured, you can configure Excel Services to use the DSN to connect. To do this, you will need to set up the OLE DB provider as a trusted data source. You will also want to decide if you want to use a Secure Store Service to enable single sign-on functionality with the ODBC driver. If you prefer, you can use the Excel Services Unattended account and skip to step 3 below.

1. First, set up a secure store application to use single sign-on. In SharePoint Central Administration, go to Application Management -> Manage Service Applications. Select your secure store service application or create a new one. Click Manage on the Edit menu to begin editing the application.
2. Create a new target application. You will be able to set the list of users who have access to this application. After the application is created, you will need to set the credentials on the application so that you can use this later for single sign-on.
3. Navigate to Application Management -> Manage Service Applications in SharePoint Central Administration. Select the Excel Services application used by your organization or create one if it does not already exist. Click Manage. If you create a new app, check the option to add the service application's proxy to the farm's default proxy list.
4. Click on Trusted Data Providers and add a new trusted provider. Set 'MSDASQL.1' for the Provider ID and leave the type as 'OLE DB'. Click OK to add this new provider to the list of trusted providers.

Connect to and Import Bitbucket Data in Excel

After you have enabled and secured access to the DSN, you can access the data source from the ribbon in Excel.

1. In an Excel spreadsheet, open the Data tab and click From Other Sources -> From Data Connection Wizard.
2. Select 'Other/Advanced' for the type and on the next screen, select the 'Microsoft OLE DB Provider for ODBC Drivers'. On the Connection tab, select CData Bitbucket Sys, the system DSN. The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from SharePoint.
3. Select the table you would like to connect to.
4. On the last step of the wizard, click the 'Authentication Settings' button. Select the 'Use a stored account' and enter the name of the secure store target application you created earlier. Or, if you want to use the Unattended Service Account, select None.
5. After you finish the wizard, the data is imported into the spreadsheet. You can now update and save Bitbucket data directly in SharePoint.