Getting Started with the CData Excel Add-In for RabbitMQ
This guide explains everything you need to get started with the CData API Driver for Excel. You will learn how to install the add-in, understand licensing behavior, configure your first connection, and import real-time RabbitMQ data directly into Excel for analysis, reporting, and automation.
Installation & Licensing
System Requirements
- Windows: Windows 10/11 or Windows Server 2016+
- Microsoft Excel: Excel 2016 or later, Excel for Microsoft 365
- .NET Framework: .NET Framework 4.0 or later
Installing the Excel Add-In
Download and install the Excel Add-In from the CData website by visiting the Excel Add-In download page. Fill in the appropriate contact information when prompted.
Note: If you are downloading a licensed installer, use your company email address and license key.
- Run the installer and follow the setup wizard
- Once installation is complete, open Excel and verify that the CData tab appears in the Excel ribbon
Licensing the Excel Add-In
The Excel Add-In handles licensing during installation. When running the installer, you can choose to:
- Use the trial license, or
- Install a licensed build provided by CData
If you require a subscription license, contact the CData Orders Team at [email protected] to obtain your license key. Once the add-in is installed, it is ready for use.
Common Licensing Questions
Can I install the add-in on multiple machines?
Your subscription tier determines how many activations are included. Contact [email protected] for details.
I lost my license key. How do I retrieve it?
Email [email protected] with your order number, and we'll resend your license key.
How do I transfer my license?
To transfer the license to a different machine, you will need to submit a License Transfer Request on our site linked below:
https://www.cdata.com/lic/transfer/
After the License Transfer Request is submitted and successfully processed, an activation will be added to your Product Key and you will be able to activate the full license on the other machine. Once this process is finished, the license on the previous machine will be invalid.
For additional licensing questions, contact [email protected]. Viewing and upgrading your license can now be done through our self-service portal at portal.cdata.com.
Connection Configuration
Once the add-in is installed, you can configure a secure connection to RabbitMQ directly from the Excel ribbon. The add-in stores connection settings inside the Excel environment and uses them to fetch live RabbitMQ data.
Creating a New Connection
- Open Excel and navigate to the CData tab in the ribbon
- Click Get Data > From RabbitMQ. Then, click New API Connection to create a new connection
- Provide a name for your connection and enable Update, Insert, or Delete operations as required
- The CData Connection dialog opens. Enter the authentication details required for RabbitMQ (OAuth, API token, credentials, etc.)
Configuring Connection Properties
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:
- Ensure the RabbitMQ Management plugin is enabled on your server (rabbitmq-plugins enable rabbitmq_management).
- Use an existing management user or create one with the appropriate management tag (management, policymaker, monitoring, or administrator).
- 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
Testing your Connection
- Click Test Connection to validate your input
- Click OK to save the connection
Importing Data into Excel
After creating a connection, you can import RabbitMQ data into Excel using the built-in query interface.
Selecting Tables and Views
- From the CData ribbon, click Get Data > From RabbitMQ and choose the connection you just made
- The CData Query window opens. Click Select to choose a table or view
- Select your desired table and click OK
Running the Query
- A SQL query is automatically generated for your selected table
- Review the query (optional), then click OK to run it
- The results populate directly into your Excel worksheet
You can now build pivot tables, charts, or use Excel formulas to analyze your RabbitMQ data.
Common Connection Issues
Authentication Failed
Solution: Verify your credentials or OAuth configuration. Ensure that your RabbitMQ account has the required API permissions.
Cannot Connect to RabbitMQ
Solution: Check your internet connection, firewall settings, or proxy configuration. Contact [email protected] for specific port requirements.
Table Not Found
Solution: Confirm your account has access to the selected RabbitMQ data object. Use the table selector in the Query window to browse available resources.
Query Returned No Results
Solution: Verify any filters or WHERE clauses in the generated SQL. Remove or adjust filters to broaden your query.
What's Next
Now that you have installed, licensed, and configured the Excel Add-In, explore how to automate reporting, refresh live dashboards, and build advanced queries using SQL or Excel functions.
| Excel Add-In | Article Title |
|---|
Get Support
If you need assistance at any point:
- Technical Support: [email protected]
- Community Forum: CData Community Site
- Help Documentation: Installed locally and available online
FAQs
Installation & Licensing
- Does Excel require administrator rights to install the add-in?
Administrative privileges are required for installation. - How do I activate a license?
Licensing occurs during installation. Licensed installers automatically apply subscription keys.
Connecting
- Can I use multiple RabbitMQ accounts?
Each time you click Get Data, you can configure a new connection. - Can I connect through a proxy?
You can configure proxy settings in the Connection dialog.
Performance & Troubleshooting
- Why is my query slow?
Add filters using the query editor or narrow the selected fields. - How do I enable logging?
Add the following to your connection manager:
- Logfile: /path/to/logfile.log
- Verbosity: 3
Be prepared to securely upload the log file upon request when reaching out to [email protected] for troubleshooting analysis.
- How do I refresh data?
Select the imported table and click Refresh from the CData ribbon.
For questions not covered in this FAQ, contact [email protected].