Add the extension dependency to your PIM¶

Execute the following composer commands to require the bundle:

composer config repositories.onboarder '{"type": "vcs", "url": "ssh://git@distribution.akeneo.com:443/pim-onboarder"}'
composer require "akeneo/pim-onboarder" "^5.0"

Then add the following to your composer.json “scripts” part:

{
"post-update-cmd": [
    "Akeneo\\Onboarder\\Setup\\OnboarderComposerScripts::copyUpgradesFiles"
],
"post-install-cmd": [
    "Akeneo\\Onboarder\\Setup\\OnboarderComposerScripts::copyUpgradesFiles"
]
}

Enable the extension¶

Register the newly installed PIM Onboarder bundle in your config/bundles.php

return [
    // Add your bundles here with the associated env.
    // Ex:
    // Acme\Bundle\AppBundle\AcmeAppBundle::class => ['dev' => true, 'test' => true, 'prod' => true]
    Akeneo\Onboarder\Bundle\PimOnboarderBundle::class => ['all' => true],
];

Build the UI¶

Clear the Symfony cache and execute the following command to build the UI:

rm -rf var/cache/*
bin/console cache:warmup --env=prod
rm -rf public/bundles public/js
bin/console pim:installer:assets --clean --env=prod
rm -rf public/css
yarn run less
rm -rf public/dist
yarn run webpack
yarn run update-extensions

Make the credential files accessible to Akeneo PIM software¶

In the parameters package the Akeneo team put a serviceAccount.json credential file used for Google Cloud PubSub and Google Cloud Storage authentication.

Make sure to rename the file from serviceAccount.json to onboarderServiceAccount.json and upload it to the server which is hosting your PIM.

This file must be accessible (read rights) by the system user that runs the pim (example: www-data).

Check your .env file¶

APP_ENV=prod
AKENEO_PIM_URL=<URL of the pim>
APP_DATABASE_HOST=<database host>
APP_DATABASE_NAME=<database name>
APP_DATABASE_PASSWORD=<database password>
APP_DATABASE_PORT=<database port>
APP_DATABASE_USER=<database user>
APP_INDEX_HOSTS=localhost:9200

Set the configuration values¶

To configure your PIM to work with the Onboarder, we use environment variables.

How to define environment variables

Here are two examples in order to define environment variables:

• Using Dotenv symfony component

• Using system environment variables

Variables provided by the Akeneo team

Optional variables

Setup database tables¶

Before setup the database, please run the following command to clear your cache and install new assets:

$ rm -rf var/cache; bin/console pim:install:asset --env=prod; yarn run webpack

The akeneo/pim-onboarder extension needs some extra tables. Please run the following command to install them:

$ php bin/console akeneo:onboarder:setup-database --env=prod

Create Elasticsearch index for pre ref products¶

A new Elasticsearch index is needed for pre ref products. In order to create it, please run the following command:

$ bin/console akeneo:elasticsearch:reset-indexes --index pim_onboarder_pre_ref_product --env=prod

Setup synchronization¶

Now that you have a working Onboarder bundle, you have to setup synchronization