VOOZH about

URL: https://www.cdata.com/kb/tech/ibmcloudobjectstorage-odata-slingshotapp.rst

⇱ Analyze IBM Cloud Object Storage Data in Slingshot with CData API Server

Analyze IBM Cloud Object Storage Data in Slingshot with CData API Server

👁 Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Use the CData API Server to build an OData API on top of IBM Cloud Object Storage data and visualize the live Data in Slingshot (formerly Reveal BI) for seamless insights.

Slingshot (formerly known as Reveal BI) is a data-driven work management suite that brings together analytics, team and project coordination, content sharing, and communication in a single platform. With CData API Server, you can generate OData APIs for live IBM Cloud Object Storage data that are seamlessly consumable within Slingshot.

In this guide, we'll walk you through a step-by-step process to generate OData endpoints for IBM Cloud Object Storage using CData API Server, and bring those endpoints into Slingshot to create real-time dashboards and streamline data analysis.

Let's begin!

Prerequisites

  1. CData API Server: Download a free trial from here.
  2. Slingshot Account and App: Log in or sign up and download from here.
  3. An active IBM Cloud Object Storage account containing your data.

Overview

Here's an overview of the steps:

  1. Install the CData API Server, configure a connection to the IBM Cloud Object Storage, and generate OData API endpoints for IBM Cloud Object Storage data within the API Server for use in Slingshot.
  2. Connect these endpoints in Slingshot to build interactive dashboards and perform real-time analysis.

Step 1: Install, Configure, and Connect CData API Server to IBM Cloud Object Storage

1.1 Install the API Server

If you haven't already, download and install the CData API Server. Follow the installation wizard to complete the setup for your machine.

Once installed, you can start the server in the following ways:

  • Windows: CData API Server runs as a service by default. Ensure the service is running, then open http://localhost:8080/ in your browser to access the API Server admin console.
  • Linux/Mac: You can run the server manually or as a service. To start it manually, navigate to the installation directory and run java -jar apiserver.jar
  • Alternatively, run service.sh with root privileges to set up API Server as a Linux system service.

1.2 Enable CORS

If the Slingshot app and API Server are hosted on different domains, CORS (Cross-Origin Resource Sharing) must be enabled to allow cross-domain communication. To enable CORS in the API Server:

  1. Go to Settings and click the icon to edit CORS settings.
  2. Enable Cross-Origin Resource Sharing (CORS).
  3. Enable Allow all domains without '*' to accept any origin.
  4. In Access-Control-Allow-Origin, enter your IBM Cloud Object Storage origin domain or use * to allow all domains. This is suitable for public APIs.
  5. Enable Access-Control-Allow-Credentials to allow cookies and auth headers.
  6. In Access-Control-Allow-Methods, enter GET, PUT, POST, OPTIONS.
  7. In Access-Control-Allow-Headers, enter Authorization, Content-Type.
  8. Set Access-Control-Max-Age (default: 3600 seconds) to cache preflight requests.
  9. Click Save.
👁 Enable CORS Settings in the CData API Server

1.3 Configure the IBM Cloud Object Storage Connection in API Server

  1. Go to Settings and click Add Connection in the top-right.
  2. Select IBM Cloud Object Storage. If it's not visible, toggle off Only Installed to view all connectors.
  3. Click Install Connector to auto-install. For manual setup, choose Manual Install and upload the ZIP file.
  4. Once installed, click IBM Cloud Object Storage again to open its connection settings and configure using the details below.

    5. 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

    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.
  5. Click Save & Test to validate and complete the connection setup.
👁 Adding a Connection in the CData API Server (Salesforce is Shown)

1.4. Add and Configure Users

To allow secure access to the OData endpoints, you need to create and configure users in the CData API Server. Each user will have authentication credentials and role-based access control, ensuring that only authorized users can query the connected data.

  1. Go to Users from the navigation pane, then click Add User in the top-right corner.
  2. Enter a Username and set a secure Password for the user.
  3. Select a Role:
    • Admin: Full access to all features including settings and connections.
    • Query: Limited to data access via API endpoints (suitable for Slingshot use).
  4. (Optional) Configure rate limits:
    • Requests Per Hour: Number of allowed API calls per hour (default: 1000).
    • Max Concurrent Requests: Number of parallel API requests allowed (default: 10).
  5. Define Privileges for the user:
    • GET: Allows data retrieval.
    • POST: Allows creation of new records.
    • PUT, MERGE, PATCH: Allows updates to existing records.
    • DELETE: Allows deletion of records.
  6. Click Add User to save and activate the user account.
👁 Adding a User in the CData API Server

Once a user is created, an Authtoken is automatically generated. This token can be used in API requests as a secure authentication method in place of the password.

You can also refresh the Authtoken, disable it, or set expiration rules (e.g., number of days until expiry) by enabling the Token Expiration option in the user settings.

👁 Authtoken Settings for the Added User in CData API Server

1.5. Add Tables for the Endpoint

To make your data available to Slingshot via OData, you need to expose your desired tables through the API Server:

  1. In the CData API Server, go to API from the left navigation, then click Add Table at the top-right.
  2. Select the IBM Cloud Object Storage connection you configured earlier, then click Next.
  3. Browse available entities and schema by expanding the Tables section. Select individual tables or click the TABLE NAME checkbox on top to select all tables. Then, click Confirm.
👁 Adding Tables for API Endpoint in CData API Server

1.6. Access and Use Endpoints in Slingshot

Now that your API is configured, Slingshot can connect to the OData endpoints to visualize live data. Use the following endpoint URL formats to access your API resources:

Endpoint   URL
Entity List http://address:port/api.rsc/
Table Metadata (e.g., albums) http://address:port/api.rsc/albums/$metadata?@json
Table Data (e.g., albums) http://address:port/api.rsc/albums

These OData endpoints can now be consumed directly in Slingshot by creating a new data source using the URL. Slingshot supports OData, so once connected, you can build dashboards and visualizations using live data from IBM Cloud Object Storage.

For custom queries and filtered visualizations in Slingshot, append standard OData query parameters like $select, $filter, $orderby, $top, and $skip to your requests.


Step 2: Connect IBM Cloud Object Storage Endpoints in Slingshot to Analyze Data

Now that your OData API is ready, it's time to bring it into Slingshot and start analyzing your live IBM Cloud Object Storage data.

2.1 Add the OData Endpoint as a Data Source

  1. Log in to your Slingshot account using the desktop app or by visiting https://my.slingshotapp.io/.
  2. Navigate to My Analytics on the left panel. Click Data Source on top, then click Data Source at the top-right.
    3. 👁 Slingshot App Dashboard
  3. Search for OData Feed and select it from the results.
    4. 👁 Select OData Feed
  4. In the URL field, enter the OData endpoint URL from your CData API Server. You can find it by navigating to API > View Endpoints in the top-right corner of the CData API Server dashboard.
  5. Click on Credentials, then select the Credential button from the drop-down.
    6. 👁 Add Credentials in Slingshot
  6. Enter your Username and either the Password or the Auth Token of the user created in the CData API Server. Click Add, then click Add Data Source to finish.
    7. 👁 Configure Authentication
  7. Click the connected OData Feed, select the desired table, and click Select Data to start analyzing.
    8. 👁 Select OData Table

2.2 Analyze Data

Now that your OData feed is connected and available in Slingshot, you can start creating visualizations to explore and analyze your data in real-time.

For our example, let's build a simple Grid visualization.

  1. Click on the Column drag-out panel, then select Grid.
    2. 👁 Selecting Grid View from Column Panel
  2. Drag and drop the desired columns from your table into the Grid. Slingshot will automatically create a live data view using those fields.
    3. 👁 Live Grid Visualization with Selected Columns

Similarly, you can create different visualizations like charts, tables, or pivot views by selecting the appropriate components from the panel. Just drag, drop, and configure as needed to explore your data from multiple angles.

You can also play with your data further by applying filters, sorting values, or grouping rows as needed. The possibilities are vast to tailor your dashboard exactly how you want it — powered by live IBM Cloud Object Storage data, connected data from your OData feed.

Try the CData API Server for 30 Days Free

The CData API Server offers the fastest way to build REST APIs from 270+ live data sources — with a no/low-code, plug-and-play approach that's ready for real-time app integrations!

Start your free trial and connect instantly with tools like Slingshot. Simplify how your team accesses and interacts with data today.