• v4.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
    • How to customize the Dataset
    • How to Add Translation Packs
  • Migrate Akeneo PIM projects
    • How to apply a patch?
      • How to apply a patch - Community Edition
      • How to apply a patch - Enterprise Edition - Flexibility Cloud offer
      • How to apply a patch - Enterprise Edition - On Premise offer
    • Where is the Changelog?
    • How to upgrade to a minor version?
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
  • Import and Export data
    • How import works
    • Understanding the Product Import
    • Understanding the Product Export
    • Formats
      • Localized labels
      • Scopable labels
      • Association types data structure
      • Attribute data structure
      • Category data structure
      • Family data structure
      • Family variant data structure
      • Group data structure
      • Options data structure
      • Product data structure
      • Product model data structure
    • Akeneo Connectors
    • How to Customize Import / Export
      • How to create a new Connector
      • How to import Products from a XML file
      • How to clean a CSV file during a Product import
      • How to automate imports/exports
  • Manipulate the Akeneo PIM data
    • How to Customize Mass Edit Operations
      • How to register a new bulk action
      • How to Register a New Mass Edit Action on Products
    • How to Manipulate Products
      • How to Query Products
      • How to Create Products
      • How to Update Products
      • How to Validate Products
      • How to Save Products
      • How to Remove Products
    • How to Manipulate Non-Product Objects
      • How to Query Non-Product Objects
      • How to Create Non-Product Objects
      • How to Update Non-Product Objects
      • How to Validate Non-Product Objects
      • How to Save Non-Product Objects
      • How to Remove Non-Product Objects
    • How to add a custom action rule
      • General information about rule format
      • How to add a custom action in the rule engine
    • How to Define Access Control List
    • How to Customize the Catalog Structure
      • How to Create a Reference Data
      • How to add a custom unit of measure
      • How to Add New Properties to a Category
    • How To Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
  • Design the user interfaces
    • How to customize any frontend part of the application
    • How to add an action button or meta data to the product edit form
    • How to add a tab to a form
    • How to add a new tab in System / Configuration
    • How to add custom information to a field
    • How to add a new field type
    • Create a custom product export builder filter
    • How to create the UI to manage a Reference Data
    • How to add a new page
    • How to customize the main menu
    • Styleguide
  • Maintain Akeneo PIM projects
    • First aid kit
    • Bug qualification
    • Common issues
    • Scalability Guide
      • Audit with 3 Representative Catalogs
      • More than 10k attributes?
      • More than 10k families?
      • More than 10k categories?
      • More than 500 attributes usable in the product grids?
      • More than 100k products to export?
      • More than 1GB of product media to export?
    • How to purge history
      • How to Purge jobs executions
      • How to adapt the version purger to your needs
  • Contribute to Akeneo PIM
    • How to report an issue?
    • How to translate the user interface?
    • How to enhance the documentation?
    • How to contribute to a Connector?
    • How to submit a patch to the PIM?
    • How to contribute to the frontend part of the application
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Use SSO authentication locally
  • Reference Entities (beta)
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • Technical overview
    • Product Information
    • Teamwork Assistant (Enterprise Edition)
      • Project creation
      • Project completeness
      • Project Completeness widget
      • Catalog update impact
      • Scalability guide
      • Users permission summary for Behat tests
    • Collaborative workflow
      • Simple workflow
      • Partial workflow
  • Technical architecture
    • Best Practices
      • Create a project
      • Create a reusable bundle
      • Setup Behat
      • Code Conventions
      • Coding Standards
    • How to implement your business logic using the event system
    • Events
      • Storage events
      • Workflow events (Enterprise Edition only)
    • How to Localize your data
      • How to change the PIM locale
      • How to Use Localizers
      • How to use Presenters
    • How to Add a Notification
    • Performances Guide
      • Memory usage of rules execution (Enterprise Edition)
      • Memory leak fix in Rules Engine (ORM)
      • More than 100 WYSIWYG editors in a page
      • PHP7 and HHVM Compatibility?
      • Job product batch size
    • How to Use the Web REST API
    • Standard format
      • Products
      • Other entities
      • Usage
    • Application Technical Information
      • Application Technical Dependencies
      • Server side set up for hosting
      • System Requirements
      • Recommended configuration
      • Client side configuration and compatibilities
      • Operation processes
      • Flow Matrix
  • Akeneo Cloud Edition
    • Flexibility
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Migrate Akeneo Onboarder projects
      • How to update a minor version or to apply a patch?
        • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
        • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
      • How to upgrade to a major version?
    • Synchronization
    • Troubleshooting
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

How to install the Onboarder bundle¶

Warning

Before starting the installation process, make sure you’ve fulfilled all the prerequisites

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" "^4.2"

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
bin/console pim:installer:assets --clean --env=prod && yarn run webpack

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 this file is shipped 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).

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

Warning

All the following variables must be set in order to configure the Onboarder correctly for all entrypoints, all processes that runs the PIM code source.

Variables provided by the Akeneo team

GOOGLE_APPLICATION_CREDENTIALS Absolute filesystem path to the serviceAccount.json file provided by the Akeneo team. We advise to use it only in production.
ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_MIDDLEWARE Pub/Sub topic name to send messages to the middleware.
ONBOARDER_TOPIC_NAME_FOR_PUBLICATION_TO_ONBOARDER Pub/Sub topic name to send messages to the supplier Onboarder.
ONBOARDER_TOPIC_NAME_FOR_CONSUMPTION Pub/Sub topic name to receive messages from the middleware.
ONBOARDER_QUEUE_NAME Pub/Sub queue name.
ONBOARDER_CLOUD_STORAGE_BUCKET_NAME Identifier of the bucket used to share files between your PIM and the middleware.

Optional variables

PUBSUB_EMULATOR_HOST Use this if you want to use a Pub/Sub emulator during development. In this case you don’t need the serviceAccount.json file neither set the GOOGLE_APPLICATION_CREDENTIALS variable.

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

Warning

Once the installation done, please read the documentation about the synchronization.

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

Warning

You do not need to reindex anything at this point, even if the reset-indexes command proposes you to do so.


Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!