Setup

Once the Makaira application is ready, the OXID Connect module, which connects the Makaira to your store, can be installed.

Please perform the following three steps:

  1. Installation of the Connect module
  2. Configuration of the Connect module
  3. Prepare first import (Touch all)

1. Installation of Connect-Moduls

The Connect module can be easily installed via composer. If you need the Connect module as a package, please contact our support.

Note: For OXID versions prior to 6.2, an additional compatibility module is required.

Versions before OXID 6.0

Add the OXID Connect and OXID Connect Compat module to your composer.json and adjust <SHOP-ROOT>> according to your setup (for OXID 6.x replace <SHOP-ROOT> with source).

{
  "require": {
    "makaira/oxid-connect": "^2.0",
    "makaira/oxid-connect-compat": "^2.0"
  },
  "scripts": {
    "pre-install-cmd": ["mkdir -p <SHOP-ROOT>/modules/makaira/", "touch <SHOP-ROOT>/modules/makaira/vendormetadata.php"],
    "pre-update-cmd": ["mkdir -p <SHOP-ROOT>/modules/makaira/", "touch <SHOP-ROOT>/modules/makaira/vendormetadata.php"],
    "post-install-cmd": ["test -d <SHOP-ROOT>/modules/makaira/connect || cp -r vendor/makaira/oxid-connect <SHOP-ROOT>/modules/makaira/connect"],
    "post-update-cmd": ["test -d <SHOP-ROOT>/modules/makaira/connect || cp -r vendor/makaira/oxid-connect <SHOP-ROOT>/modules/makaira/connect"]
  }
}

After the adjustment composer update must be executed. After the completion the module can now be activated in the store.

For OXID versions prior to 6.0, it may still be necessary to include vendor/autoload.php.
Note: The vendor directory is located on the same directory level as composer.json.

Then follow the Next Steps at the bottom of this page.

OXID 6.0 and 6.1 versions

The installation is very similar to the one before OXID 6.0. However, the scripts part is no longer needed because the vendormetadata.php is ignored from OXID 6.0. The compatibility module is still required.
This results in the following configuration for composer.json:

{
  "require": {
    "makaira/oxid-connect": "^2.0",
    "makaira/oxid-connect-compat": "^2.0"
  },
  "extra": {
    "installer-paths": {
      "<SHOP-ROOT>/modules/makaira/connect": ["makaira/oxid-connect"]
    }
  }
}

After the adjustment composer update must be executed. After the completion the module can now be activated in the store.

Then follow the Next Steps at the bottom of this page.

From OXID 6.2

With OXID 6.2 the compatibility module is omitted and the Connect module can be used directly.

{
  "require": {
    "makaira/oxid-connect": "^2.0"
  },
  "extra": {
    "installer-paths": {
      "<SHOP-ROOT>/modules/makaira/connect": ["makaira/oxid-connect"]
    }
  }
}

After the adjustment composer update must be executed. After the completion the module can now be activated in the store.

Then follow the Next Steps at the bottom of this page.

2. Configuration of the Connect Module

For the configuration of the Connect module, all relevant information (Makaira Secret, Makaira Instance and Makaira URL) can be found under the route <SUBDOMAIN>.makaira.io/#/install or via the "Profile Screen" -> "Installation".

Enter this data - possibly separately for each subshop - in the module configuration of the Connect module in OXID.

3. First preparing the data import

Afterwards it is necessary to mark the data for the initial import into Makaira. We call this process "Touch of all documents" - For this purpose the Connect module provides a corresponding console command:

OXID version from (>=) 6.2
php vendor/bin/oe-console makaira:touch-all

Finally, in consultation with Makaira support, the first import for the data in Makaira can be started.

OXID version before (<) 6.2
php vendor/bin/makaira-connect makaira:touch-all

Finally, in consultation with Makaira support, the first import for the data in Makaira can be started.