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-Module

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

composer.json

{
...
  "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"]
  }
...
}

Installation: 

cd <SHOP_ROOT>
composer require --no-update makaira/oxid-connect-compat:^2.0
composer require --no-update makaira/oxid-connect:^2.0
composer update --no-dev

After the successful installation the module can 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 step 2 Configuration 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.

Installation:

cd <SHOP_ROOT>
composer config extra.installer-paths.source/modules/makaira/connect: ["makaira/oxid-connect"]
composer require --no-update makaira/oxid-connect-compat:^2.0
composer require --no-update makaira/oxid-connect:^2.0
composer update --no-dev

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.

Installation:

cd <SHOP_ROOT>
composer config extra.installer-paths.source/modules/makaira/connect: ["makaira/oxid-connect"]
composer require --no-update makaira/oxid-connect:^2.0
composer update --no-dev

After the successful installation the module can 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/admin/<instance>/installation/ or via the "Profile" -> "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
OXID version before (<) 6.2
php vendor/bin/makaira-connect makaira:touch-all

4. Contact Makaira Support

Finally please contact the Makaira Support via support@makaira.io or Slack, we configure your importer and start a first import for the data into Makaira.