Build Semantic Layer Views for RabbitMQ 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 RabbitMQ data, enabling real-time analytics on RabbitMQ just like working with a relational database.

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

Download and Install the Connector Files

In order to access RabbitMQ 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 RabbitMQ Connection String

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

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, use the connection string designer built into the RabbitMQ 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.

About RabbitMQ Management HTTP API

RabbitMQ is an open-source message broker that supports multiple messaging protocols. The RabbitMQ Management HTTP API provides HTTP-based access to management and monitoring data for a RabbitMQ server. The API exposes information about virtual hosts, exchanges, queues, bindings, connections, channels, consumers, users, permissions, policies, and cluster-wide statistics.

The Management plugin must be enabled on the RabbitMQ server for the HTTP API to be available. By default, the management interface listens on port 15672.

Using Basic Authentication

RabbitMQ Management HTTP API uses HTTP Basic authentication. You must supply the username and password of a RabbitMQ management user.

To enable access to the management API:

1. Ensure the RabbitMQ Management plugin is enabled on your server (rabbitmq-plugins enable rabbitmq_management).
2. Use an existing management user or create one with the appropriate management tag (management, policymaker, monitoring, or administrator).
3. Note the full base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).

After configuring your RabbitMQ server, set the following connection properties to connect:

• AuthScheme: Set this to Basic.
• URL: Set this to the base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).
• User: Set this to your RabbitMQ management username (e.g., guest).
• Password: Set this to your RabbitMQ management password.

Example connection string:

Profile=C:\profiles\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;

Available Tables

The RabbitMQ profile provides access to the following tables:

• Overview - Cluster-wide statistics and information about the RabbitMQ node
• Nodes - Information about individual nodes in the RabbitMQ cluster
• NodeMemory - Detailed memory usage breakdown for a specific cluster node
• Connections - List of all open AMQP connections to the broker
• Channels - List of all open AMQP channels across all connections
• Consumers - List of all consumers registered across all queues
• Exchanges - List of exchanges declared across all virtual hosts
• Queues - List of queues declared across all virtual hosts
• Bindings - List of all bindings between exchanges and queues
• VirtualHosts - List of virtual hosts configured on the broker
• VhostPermissions - User permissions within a specific virtual host
• Users - List of all RabbitMQ users
• Permissions - Permission records for all users across all virtual hosts
• TopicPermissions - Topic-level permission records for all users
• Policies - List of policies applied to queues and exchanges in virtual hosts
• OperatorPolicies - List of operator policies applied to queues in virtual hosts
• Parameters - List of component parameters (e.g., federation, shovel) per virtual host
• GlobalParameters - List of global parameters that apply across all virtual hosts
• VhostLimits - Resource limits configured for specific virtual hosts
• UserLimits - Resource limits configured for specific users
• FeatureFlags - List of feature flags and their enabled/disabled state on the node
• DeprecatedFeatures - List of deprecated features and their usage state
• AuthAttempts - Authentication attempt statistics for the node
• ClusterName - The name of the RabbitMQ cluster
• WhoAmI - Information about the currently authenticated management user
• ExchangeBindingsSource - Bindings for which a specific exchange is the source
• ExchangeBindingsDestination - Bindings for which a specific exchange is the destination
• QueueBindings - Bindings for a specific queue within a virtual host

Your connection string will look similar to the following:

jdbc:API:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;

Connecting to RabbitMQ & Creating a Semantic Layer View

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

Configuring the Connection to RabbitMQ

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 "RabbitMQ"
   • Set Connection String to the connection string configured earlier (e.g.:

     jdbc:API:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;

   • Set Driver Class to "cdata.jdbc.api.APIDriver" (this should be set by default)
   
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "api")
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. "api")
3. Set User Name and Password to the User and Password properties for RabbitMQ.
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 RabbitMQ data through the APOS Live Data Gateway, enabling real-time data connectivity to RabbitMQ 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 RabbitMQ data in APOS Live Data Gateway.