Prepare, Blend, and Analyze IBM Cloud Object Storage Data in Alteryx Designer (Connect AI)

Alteryx is a software platform that allows people to work with data more easily. When paired with CData Connect AI, Alteryx provides instant access to IBM Cloud Object Storage data from your data automation processes. This article demonstrates how to connect to IBM Cloud Object Storage using Connect AI and work with IBM Cloud Object Storage data in Alteryx.

CData Connect AI offers a dedicated SQL Server interface for IBM Cloud Object Storage, facilitating data querying without the need for data replication to a native database. With built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, straight to IBM Cloud Object Storage. This harnesses server-side processing to rapidly retrieve the desired IBM Cloud Object Storage data.

Configure IBM Cloud Object Storage Connectivity for Alteryx

Connectivity to IBM Cloud Object Storage from Alteryx is made possible through CData Connect AI. To work with IBM Cloud Object Storage data from Alteryx, we start by creating and configuring a IBM Cloud Object Storage connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "IBM Cloud Object Storage" from the Add Connection panel

3. Enter the necessary authentication properties to connect to IBM Cloud Object Storage.

   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.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add IBM Cloud Object Storage Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to IBM Cloud Object Storage data from Alteryx.

Connect to IBM Cloud Object Storage from Alteryx

To establish a connection from Alteryx Desktop to the CData Connect AI Virtual SQL Server, follow these steps:

1. Set up an account in Alteryx.
2. Drag and drop a new Input Data tool onto the workflow.
3. While the Input Data tool is selected, click Set Up a Connection in the navigation panel. A Data connections dialog appears.
4. Click Data sources. Select Microsoft SQL Server > **Quick connect.
5. In the Connection Manager dialog, click New.
6. In the New Data Source dialog, enter the following information:
   • Data Source Name: Microsoft SQL Server ODBC DSN-less.
   • Driver: select ODBC Driver 18 for SQL Server from the drop-down list.
   • Server: tds.cdata.com,14333
   • Database: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, IBMCloudObjectStorage1).
   
7. Click Save. Then click Connect Credential.
8. In Connections, enter the following:
   • Authentication Method: select Username and password.
   • Credential: select Create New Credential.
   • Credential Name: enter a name to identify the credential.
   • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
   • Password: enter the PAT you generated on the Settings page.
9. Click Test Connection. If successful, click Create and link.
10. Connect with your credentials.
11. In the wizard that opens, drag and drop the table to be queried in the Query Builder box. Select the fields by checking the boxes that you want to include in your query. Where possible, the complex queries generated by the filters and aggregations will be pushed down to your data source, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the connector.
12. To further customize the dataset, you can open the SQL Editor and modify the query manually, adding clauses, aggregations, and other operations to ensure that you are retrieving exactly the data desired.
    
13. With the query defined, you are ready to work with your data in Alteryx Designer.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!