Ready to get started?

Download a free trial of the AlloyDB Driver to get started:

 Download Now

Learn more:

AlloyDB Icon AlloyDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with AlloyDB.

Build Semantic Layer Views for AlloyDB Data in APOS Live Data Gateway



Use the CData Connector for AlloyDB in APOS Live Data Gateway to build Semantic Layer Views for AlloyDB data.

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 AlloyDB data, enabling real-time analytics on AlloyDB just like working with a relational database.

With built-in optimized data processing, the CData Connector offers unmatched performance for interacting with live AlloyDB data. When you issue complex SQL queries to AlloyDB, the driver pushes supported SQL operations, like filters and aggregations, directly to AlloyDB 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 AlloyDB data using native data types.

Download and Install the Connector Files

In order to access AlloyDB 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.AlloyDB.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.alloydb.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.alloydb.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the AlloyDB Connection String

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

Built-in Connection String Designer

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

java -jar cdata.jdbc.alloydb.jar

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

The following connection properties are usually required in order to connect to AlloyDB.

  • Server: The host name or IP of the server hosting the AlloyDB database.
  • User: The user which will be used to authenticate with the AlloyDB server.
  • Password: The password which will be used to authenticate with the AlloyDB server.

You can also optionally set the following:

  • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
  • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

Authenticating with Standard Authentication

Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

No further action is required to leverage Standard Authentication to connect.

Authenticating with pg_hba.conf Auth Schemes

There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

Find instructions about authentication setup on the AlloyDB Server here.

Authenticating with MD5 Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

Authenticating with SASL Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

Authenticating with Kerberos

The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

Your connection string will look similar to the following:

jdbc:AlloyDB:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432

Connecting to AlloyDB & Creating a Semantic Layer View

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

Configuring the Connection to AlloyDB

  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 "AlloyDB"
    • Set Connection String to the connection string configured earlier (e.g.: jdbc:AlloyDB:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432
    • Set Driver Class to "cdata.jdbc.alloydb.AlloyDBDriver" (this should be set by default)
  5. Click Test Connection
  6. Click Save
  7. Give your connection a unique prefix (e.g. "alloydb")
  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. "alloydb")
  3. Set User Name and Password to the User and Password properties for AlloyDB.
  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 AlloyDB data through the APOS Live Data Gateway, enabling real-time data connectivity to AlloyDB 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 AlloyDB data in APOS Live Data Gateway.