Activating your Magento BI Account for Cloud Starter Subscriptions

To activate Magento BI for Cloud Starter projects, first create a Magento BI account, then create a SSH key, then finally connect to your Magento database. Click here for activating on-premise subscriptions.

For help activating Magento BI for Cloud Pro projects, contact your Magento Customer Success Manager or Customer Technical Advisor.

  1. Create your Magento BI Account.

    • Go to

    • Go to My AccountMy 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 your email address.


    • Create your password.


    • After creating your account you will then 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 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 dedicated MBI User.

    • Create a new user on

    • Why a new user? Magento BI needs a user added to the project to continuously fetch new data to be transferred to the account’s MBI 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 MBI user is to prevent the added user from inadvertently being deactivated or deleted and stopping the MBI connection.

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


  5. Get your MBI SSH keys.

    • Go to the Connect your database page of the MBI set up user interface and scroll down to Encryption settings.

    • For the field Encryption Type chose 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 MBI user created in Step 5.

    • Go to Sign in with your account log in information for the new MBI 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 Magento Business Intelligence Essentials MySQL credentials.

    • Update your .magento/services.yaml
         type: mysql:10.0
         disk: 2048
                 - main
                     default_schema: main
                         main: admin
                     default_schema: main
                         main: ro
    • Update your
                 database: "mysql:mysql"
                 mbi: "mysql:mbi"
                 redis: "redis:redis"
  8. Get information for connecting your database to Magento Business 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" : "",
                      "path" : "main",
                      "host" : "mbi.internal",
                      "hostname" : "",
                      "username" : "mbi",
                      "service" : "mysql",
                      "port" : 3306,
                      "password" : "[password]"
  9. Connect your Magento Database


    • 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.


    • 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



    • Encryption Type: SSH Tunnel

    • Remote Address:

    • Username: vfbfui4vmfez6-master-7rqtwti--mymagento

    • Port: 22

  13. Click Save Integration.

  14. You have now successfully connected to your Magento BI Essentials account.

  15. If you are a Magento BI Pro customer, contact your Customer Success Manager or Customer Technical Advisor to coordinate the next steps.