Build Semantic Layer Views for Cosmos DB Data in APOS Live Data Gateway

APOS Live Data Gateway (LDG) is a data connection and data transformation solution that enables live data connectivity and expanded data source options for SAP Analytics Cloud and other SAP solutions. When paired with CData Connectors, users can build semantic layer views for live Cosmos DB data, enabling real-time analytics on Cosmos DB just like working with a relational database.

With built-in optimized data processing, the CData Connector offers unmatched performance for interacting with live Cosmos DB data. When you issue complex SQL queries to Cosmos DB, the driver pushes supported SQL operations, like filters and aggregations, directly to Cosmos DB and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Cosmos DB data using native data types.

Download and Install the Connector Files

In order to access Cosmos DB data through the APOS Live Data Gateway, you will need to download the connector files from APOS and install them on the machine hosting the Live Data Gateway. An APOS representative can deliver the necessary files.

• Install the CData DLL file (System.Data.CData.CosmosDB.dll) to the APOS Live Data Gateway installation directory (C:\Program Files\Live Data Gateway\Admin\ by default).
• Install the CData JAR file (cdata.jdbc.cosmosdb.jar) to the ConnectionTest_lib folder in the installation directory (C:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\ by default).
• Install the CData JAR file (cdata.jdbc.cosmosdb.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the Cosmos DB Connection String

Before establishing the connection to Cosmos DB from the APOS Live Data Gateway, you need to configure the Cosmos DB JDBC Connection String.

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, use the connection string designer built into the Cosmos DB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

Fill in the connection properties and copy the connection string to the clipboard.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

• AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
• AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

Your connection string will look similar to the following:

Connecting to Cosmos DB & Creating a Semantic Layer View

After installing the connector files and configuring the connection string, you are ready to connect to Cosmos DB in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.

Configuring the Connection to Cosmos DB

1. Log into your APOS Live Data Gateway Manager
2. If you haven't already, update your APOS LDG license file
   1. Click File -> Configurations
   2. Click on the "..." Menu for the License
   3. Select the license file from the APOS team that includes your CData Connector license
3. In the APOS Live Data Gateway Manager, click "Add"
4. In the APOS Live Data Gateway On the Connection tab, configure the connection:
   • Set Data Source to "Database"
   • Set Database to "CData Drivers"
   • Set Database CData Drivers to "Cosmos DB"
   • Set Connection String to the connection string configured earlier (e.g.: jdbc:CosmosDB:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
   • Set Driver Class to "cdata.jdbc.cosmosdb.CosmosDBDriver" (this should be set by default)
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "cosmosdb")
8. Highlight the newly created connection and click File -> "Approve Users For Web UI"
9. Approve the appropriate DB users to create views and click "Save"

At this point, we are ready to build our semantic layer view in the Live Data Gateway Web UI.

Creating a Semantic Layer View

1. In your browser, navigate to the APOS Live Data Gateway Portal
2. Select a Connection (e.g. "cosmosdb")
3. Since Cosmos DB does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
4. Click "Login"
5. Once connected, click "Semantic Layer" to create a new semantic layer view
6. Click "New Semantic Layer View"
7. Set the Semantic Layer View Prefix and Semantic Layer View Name
8. Click "Step 2"
9. Select the table(s) and column(s) you wish to include in your view
10. Click "Step 3"
11. Select the Measures from the available table columns
12. Click "Step 5" (we skipped the "Extra Dimensions" step)
13. Add any Variable Prompts
14. Click "Step 6"
15. Define any Table Joins
16. Click "Review"
17. Review you semantic layer view and click "Save"

With the Semantic Layer View created, you are ready to access your Cosmos DB data through the APOS Live Data Gateway, enabling real-time data connectivity to Cosmos DB data from SAP Analytics Cloud and other SAP solutions.

More Information & Free Evaluation

Please visit APOS Systems - APOS Solutions - Request Evaluation Software to request evaluation software or email info@apos.com for more information on working with your live Cosmos DB data in APOS Live Data Gateway.