Consume DB2 OData Feeds in SAP Lumira

You can use the CData API Server to create data visualizations based on DB2 data in SAP Lumira. The API Server enables connectivity to live data: dashboards and reports can be refreshed on demand. This article shows how to create a chart that is always up to date.

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure DB2 OData services:

Connect to DB2

To work with DB2 data from SAP Lumira, we start by creating and configuring a DB2 connection. Follow the steps below to configure the API Server to connect to DB2 data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the DB2 connection. 👁 Selecting a data source (SQLite is shown)
   
3. Enter the necessary authentication properties to connect to DB2.

   Set the following properties to connect to DB2:

   • Server: Set this to the name of the server running DB2.
   • Port: Set this to the port the DB2 server is listening on.
   • Database: Set this to the name of the DB2 database.
   • User: Set this to the username of a user allowed to access the database.
   • Password: Set this to the password of a user allowed to access the database.

   You will also need to install the corresponding DB2 driver:

   • Windows: Install the IBM Data Server Provider for .NET.

     On Windows, installing the IBM Data Server Provider is sufficient, as the installation registers it in the machine.config.

   • Java: Install the IBM Data Server Driver for JDBC.

     In the Java version, place the IBM Data Server Driver JAR in the www\WEB-INF\lib\ folder for this application.

   👁 Connecting to a datasource (SQLite is shown)
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your DB2 data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User. 👁 Configure a new user
   
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page: 👁 API Server user settings
   

Creating API Endpoints for DB2

Having created a user, you are ready to create API endpoints for the DB2 tables:

1. First, navigate to the API page and then click Add Table . 👁 Add tables
   
2. Select the connection you wish to access and click Next. 👁 Select the connection (SQLite is shown)
   
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm. 👁 Adding tables from the connection (SQLite is shown)
   

Gather the OData Url

Having configured a connection to DB2 data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

Connect to DB2 from SAP Lumira

Follow the steps below to retrieve DB2 data into SAP Lumira. You can execute an SQL query or use the UI.

1. In SAP Lumira, click File -> New -> Query with SQL. The Add New Dataset dialog is displayed.
2. Expand the Generic section and click the Generic OData 2.0 Connector option.
3. In the Service Root URI box, enter the OData endpoint of the API Server. This URL will resemble the following:

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

4. In the User Name and Password boxes, enter the username and authtoken of an API user. These credentials will be used in HTTP Basic authentication. 👁 The OData endpoint and HTTP Basic authentication configured for an API user.
   

5. Select entities in the tree or enter an SQL query. This article imports DB2 Orders entities.

   👁 Available entities for import. (Salesforce is shown.)
   

6. When you click Connect, SAP Lumira will generate the corresponding OData request and load the results into memory. You can then use any of the data processing tools available in SAP Lumira, such as filters, aggregates, and summary functions.

   👁 Tables of DB2 data to be imported into SAP Lumira. (Salesforce Accounts are shown.)
   

Create Data Visualizations

After you have imported the data, you can create data visualizations in the Visualize room. Follow the steps below to create a basic chart.

1. In the Measures and Dimensions pane, drag measures and dimensions onto the x-axis and y-axis fields in the Visualization Tools pane. SAP Lumira automatically detects dimensions and measures from the metadata service of the API Server.

   By default, the SUM function is applied to all measures. Click the gear icon next to a measure to change the default summary.

2. In the Visualization Tools pane, select the chart type.
3. In the Chart Canvas pane, apply filters, sort by measures, add rankings, and update the chart with the current DB2 data. 👁 A basic line chart. (Salesforce is shown.)