Configuring Adobe Commerce Intelligence connection for existing Cloud Starter projects

This article provides a solution for when you want to configure Adobe Commerce Intelligence connection for an existing Cloud Starter project.

Affected products and versions

Adobe Commerce on cloud starter (all versions)

Issue

You want to configure Commerce Intelligence connection for an existing Cloud Starter project.

Solution

To activate Commerce Intelligence for Cloud Starter projects, create a Commerce Intelligence account, create an SSH key, and finally connect to your Adobe Commerce database.

Follow these steps:

1. Create your Adobe Commerce Intelligence Account:

   • Go to accounts.magento.com/customer/account/login.
   • Navigate to My Account > My MBI Instances.
   • Click the Create Instance. If you do not see this button, contact your Customer Success Manager or Customer Technical Advisor.
   • Select your Cloud Starter subscription. If you only have a Cloud Starter subscription, this will automatically be selected.
   • Click Continue.
   • Input your information to create your account.

   

   • Go to your inbox and verify the email address.

   

   • Create a password.

   

   • After creating your account, you will have the option to add users to your new account. Technical admins can now be added to carry out the following steps.

   

2. Input information about your store to set your preferences.

   

   There is some information you will need to gather before you can connect your database for the third step in the onboarding flow. You will be filling in the Connect your database page in step 9.

3. Create a dedicated Commerce Intelligence user.

   • Create a new user on account.adobe.com.
   • Go to https://accounts.magento.com/customer/account/ to generate your Adobe Commerce account.
   • Why a new user? Adobe Commerce Intelligence needs a user added to the project to continuously fetch new data to be transferred to the account’s Commerce Intelligence data warehouse. This user will serve as that connection. Adding this user to the project will come in step 4.
   • The reason for having a dedicated Commerce Intelligence user is to prevent the added user from inadvertently being deactivated or deleted and stopping the Commerce Intelligence connection.

4. Add the newly created user to the project’s primary environment as a Contributor.

   

5. Get your Commerce Intelligence SSH keys.

   • Go to the Connect your database page of the Commerce Intelligence set up user interface and scroll down to Encryption settings.
   • For the field, Encryption Type, choose SSH Tunnel.
   • From the dropdown, you can copy and paste the provided Magento BI Essentials Public Key.

   

6. Add your new Magento BI Essentials Public key to the Commerce Intelligence user created in step 5.

   • Go to accounts.magento.com/customer/account/login. Sign in with your account login information for the new Commerce Intelligence user created. Then go to the Account Settings tab.
   • Scroll down the page and expand the drop-down for SSH keys. Then click Add a public key.

   

   • Add the Magento MBI Essentials SSH Public Key from above.

   

7. Provide Business Intelligence Essentials MySQL credentials.

   • Update your .magento/services.yaml.

   mysql:
    type: mysql:10.0
    disk: 2048
    configuration:
        schemas:
            - main
        endpoints:
            mysql:
                default_schema: main
                privileges:
                    main: admin
            mbi:
                default_schema: main
                privileges:
                    main: ro
   

   • Update your .magento.app.yaml.

   relationships:
            database: "mysql:mysql"
            mbi: "mysql:mbi"
            redis: "redis:redis"
   

8. Get information for connecting your database to Commerce Intelligence.

   Run echo $MAGENTO_CLOUD_RELATIONSHIPS | base64 --decode | json_pp to get information on connecting your database.

   You should receive information similar to the output below:

   "mbi" : [
              {
                 "scheme" : "mysql",
                 "rel" : "mbi",
                 "cluster" : "vfbfui4vmfez6-master-7rqtwti",
                 "query" : {
                    "is_master" : true
                 },
                 "ip" : "169.254.169.143",
                 "path" : "main",
                 "host" : "mbi.internal",
                 "hostname" : "3m7xizydbomhnulyglx2ku4wpq.mysql.service._.magentosite.cloud",
                 "username" : "mbi",
                 "service" : "mysql",
                 "port" : 3306,
                 "password" : "[password]"
              }
           ],
   

9. Connect your Adobe Commerce Database.

   

   Inputs:

   • Integration Name: [Choose a name for your integration.]
   • Host: mbi.internal
   • Port: 3306
   • Username: mbi
   • Password: [input password provided in Step 8’s output.]
   • Database Name: main
   • Table Prefixes: [leave blank if there are no table prefixes]

10. Set your Timezone Settings.

    

    Inputs

    • Database: Timezone: UTC
    • Desired Timezone: [Choose the time zone you want your data to display in.]

11. Get information for your encryption settings.

    • The project UI provides an SSH access string. This string can be used for gathering the information needed for the Remote Address and Username in setting up your **Encryption settings. Use the SSH Access string found by clicking the access site button on your Master branch of your Project UI and find your User Name and Remote Address as shown below.

    

    

12. Input information for your Encryption Settings.

    

    Inputs

    • Encryption Type: SSH Tunnel
    • Remote Address: ssh.us-3.magento.cloud
    • Username: vfbfui4vmfez6-master-7rqtwti–mymagento
    • Port: 22

13. Click Save Integration.

14. You have now successfully connected to your Commerce Intelligence Essentials account.

15. If you are an Adobe Commerce Intelligence Pro customer, contact your Customer Success Manager or Customer Technical Advisor to coordinate the next steps.