Build Semantic Layer Views for Vercel 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 Vercel data, enabling real-time analytics on Vercel just like working with a relational database.
With built-in optimized data processing, the CData Connector offers unmatched performance for interacting with live Vercel data. When you issue complex SQL queries to Vercel, the driver pushes supported SQL operations, like filters and aggregations, directly to Vercel 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 Vercel data using native data types.
Download and Install the Connector Files
In order to access Vercel 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.API.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.api.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.api.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)
Configuring the Vercel Connection String
Before establishing the connection to Vercel from the APOS Live Data Gateway, you need to configure the Vercel JDBC Connection String.
Built-in Connection String Designer
For assistance in constructing the JDBC Connection String, use the connection string designer built into the Vercel JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jar
Fill in the connection properties and copy the connection string to the clipboard.
Using API Key Authentication
Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.
To obtain a personal access token:
- Log into your Vercel account at https://vercel.com/
- Navigate to Account Settings > Tokens.
- Click Create Token, enter a name and expiration, and click Create.
- Copy the generated token (it will only be shown once).
After obtaining your token, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Vercel personal access token or OAuth access token.
Example Connection String
Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
Working with Teams
Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.
Connecting to Vercel
Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.
Your connection string will look similar to the following:
jdbc:API:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
Connecting to Vercel & Creating a Semantic Layer View
After installing the connector files and configuring the connection string, you are ready to connect to Vercel in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.
Configuring the Connection to Vercel
- Log into your APOS Live Data Gateway Manager
- If you haven't already, update your APOS LDG license file
- Click File -> Configurations
- Click on the "..." Menu for the License
- Select the license file from the APOS team that includes your CData Connector license
- In the APOS Live Data Gateway Manager, click "Add"
- 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 "Vercel"
- Set Connection String to the connection string configured earlier (e.g.:
jdbc:API:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
- Set Driver Class to "cdata.jdbc.api.APIDriver" (this should be set by default)
- Click Test Connection
- Click Save
- Give your connection a unique prefix (e.g. "api")
- Highlight the newly created connection and click File -> "Approve Users For Web UI"
- 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
- In your browser, navigate to the APOS Live Data Gateway Portal
- Select a Connection (e.g. "api")
- Since Vercel does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
- Click "Login"
- Once connected, click "Semantic Layer" to create a new semantic layer view
- Click "New Semantic Layer View"
- Set the Semantic Layer View Prefix and Semantic Layer View Name
- Click "Step 2"
- Select the table(s) and column(s) you wish to include in your view
- Click "Step 3"
- Select the Measures from the available table columns
- Click "Step 5" (we skipped the "Extra Dimensions" step)
- Add any Variable Prompts
- Click "Step 6"
- Define any Table Joins
- Click "Review"
- Review you semantic layer view and click "Save"
With the Semantic Layer View created, you are ready to access your Vercel data through the APOS Live Data Gateway, enabling real-time data connectivity to Vercel 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 [email protected] for more information on working with your live Vercel data in APOS Live Data Gateway.