VOOZH about

URL: https://www.cdata.com/kb/tech/adobecommerce-cloud-metabase.rst

⇱ How to integrate Metabase with Adobe Commerce Data


How to integrate Metabase with Adobe Commerce Data

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to live Adobe Commerce data and create an interactive dashboard in Metabase from Adobe Commerce data.

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live Adobe Commerce data. This article describes how to connect to Adobe Commerce and build a simple visualization using Adobe Commerce data.

CData Connect provides a pure cloud-to-cloud interface for Adobe Commerce, allowing you to easily integrate with live Adobe Commerce data in Metabase β€” without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to Adobe Commerce, leveraging server-side processing to quickly return Adobe Commerce data.

Configure Adobe Commerce Connectivity for Metabase

Connectivity to Adobe Commerce from Metabase is made possible through CData Connect AI. To work with Adobe Commerce data from Metabase, we start by creating and configuring a Adobe Commerce connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "Adobe Commerce" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to Adobe Commerce.

    Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

    • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

    • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

    πŸ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Adobe Commerce Connection page and update the User-based permissions. πŸ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. πŸ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Adobe Commerce data from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

  1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab πŸ‘ Adding a new database connection to Metabase.
  2. Configure the connection to Connect AI and click "Save"
    • Database type: Select "SQL Server"
    • Name: Name the connection (e.g. "Adobe Commerce (Connect AI)")
    • Host: tds.cdata.com
    • Port: 14333
    • Database name: The name of the connection you just created (e.g. Adobe Commerce1)
    • Username: A Connect AI username (e.g. [email protected])
    • Password: The PAT previously created
    • Click to Use a secure connection (SSL)
    πŸ‘ Configuring the connection to Connect AI.

Execute Adobe Commerce Data with Metabase

Once you configure the connection to Connect AI, you can query Adobe Commerce and build visualizations.

  1. Use the "Write SQL" tool to retrieve the Adobe Commerce data πŸ‘ Click the 'Write SQL' button.
  2. Write a SQL query based on the Adobe Commerce connection in CData Connect AI, e.g.

    SELECT Name, Price FROM Products
    πŸ‘ Collected data (Salesforce is shown).
  3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization πŸ‘ Collected data (Salesforce is shown).

More Information & Free Trial

At this point, you have built a simple visualization from Adobe Commerce data in Metabase. You can continue to work with live Adobe Commerce data in Metabase just like you would any SQL Server database. For more information on creating a live connection to Adobe Commerce (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Adobe Commerce data in Metabase today.