Import IBM Cloud Object Storage Data into Microsoft Power Query

The API Server, when paired with the ADO.NET Provider for IBM Cloud Object Storage (or any of 200+ other ADO.NET Providers), enables you to use Web services to connect to and query IBM Cloud Object Storage data. This article details how to import an OData feed of IBM Cloud Object Storage data into Microsoft Power Query.

Set Up the API Server

Follow the steps below to begin producing secure IBM Cloud Object Storage OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to IBM Cloud Object Storage

After you deploy the API Server and the ADO.NET Provider for IBM Cloud Object Storage, provide authentication values and other connection properties needed to connect to IBM Cloud Object Storage by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Register a New Instance of Cloud Object Storage

If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

1. Log in to your IBM Cloud account.
2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

Connecting using OAuth Authentication

There are certain connection properties you need to set before you can connect. You can obtain these as follows:

API Key

To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

1. Log in to your IBM Cloud account.
2. Navigate to the Platform API Keys page.
3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

Cloud Object Storage CRN

If you have multiple accounts, specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

• Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
• Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

Connecting to Data

You can now set the following to connect to data:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• ApiKey: Set this to your API key which was noted during setup.
• CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

When you connect, the connector completes the OAuth process.

1. Extracts the access token and authenticates requests.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

You can then choose the IBM Cloud Object Storage entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Connect to IBM Cloud Object Storage Data from Power Query

Follow the steps below to import tables that can be refreshed on demand:

1. Configure the API Server to use a version of the OData protocol that is recognized by Power Query. In the API Server administration console, click Settings -> Server and change the value of the Default Version property to 3.0.

2. From the ribbon in Excel, click Power Query -> From Other Data Sources -> From OData Feed, and enter the OData URL:

   https://your-server:8032/api.rsc

3. In the next step of the wizard, define authentication credentials and set privacy levels. Select Basic authentication and enter the credentials for a user authorized to make requests. Specify the Username field and enter the user's authtoken in the Password field.

   To change the authentication scheme that Power Query will use, click Power Query -> Data Source Settings. Select the OData feed from the list and then click Edit Credential. Select the privacy level from the menu on the Data Source Settings page.

   

4. You can now access IBM Cloud Object Storage data in Power Query. In the Navigator expand the node for the OData feed, right-click a table, and click Edit to open the Query Editor. This will display the table data.