• v7.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 11 (Buster)
      • System installation on Ubuntu 22.04 (Jammy Jellyfish)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the job scheduling
      • Setting up the Events API
    • How to customize the Dataset
    • How to Add Translation Packs
  • Upgrade 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 major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
      • Upgrade from 5.0 to 6.0
      • Upgrade from 6.0 to 7.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
  • 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 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
    • How to Configure Measurement Limits
    • How to Configure the Event Subscription network restrictions
  • 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
      • How to purge events API logs
  • 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
    • 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
  • Troubleshooting guide
  • 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
      • 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 & Consumers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Synchronization
    • 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
    • Troubleshooting
    • How to uninstall the Onboarder bundle
    • Environment variables
      • Using the DotEnv file
      • Using environment variables
  • About Log4Shell Vulnerability for SaaS Users
  • About Log4Shell Vulnerability for Flexibility v5 Users
  • About Log4Shell Vulnerability for Flexibility users below v5.0
  • About CVE-2022-46157

Upgrade from 5.0 to 6.0¶

Use this documentation to upgrade projects based on Akeneo PIM Community Edition or Enterprise Edition 5.0 to 6.0.

Disclaimer¶

Warning

Make sure your production database is backed-up and the queue daemon(s) have been stopped before performing any data migration.

Prepare your project for the new technical stack¶

Note

Your 5.0 application must be on the latest patch and migrations must be up-to-date before migrating to the new technical stack.

If you do not apply the most recent patch and migrations, you may experience problems upgrading.

Check the most recent patch version here:
  • Enterprise Edition

  • Community Edition

You can check your current patch version with the following command: composer licenses | grep akeneo/pim

To install the most recent patch, use the instructions in How to apply a patch?

The directory at the root of your current installation is referred to as $INSTALLATION_DIR.

Warning

Please note that this part of the migration needs to be executed on your PIM 5.0 before upgrading your technical stack.

$ export APP_ENV=prod
$ cd $INSTALLATION_DIR
$ cp -R ./vendor/akeneo/pim-community-dev/upgrades/* ./upgrades/
$ cp -R ./vendor/akeneo/pim-enterprise-dev/upgrades/* ./upgrades/
$ php bin/console doctrine:migrations:migrate
$ rm -rf var/cache/

If you are updating an Enterprise Edition instance and are working with Akeneo Support, please run the following command (after executing doctrine:migrations:migrate) and provide us with the output so that we can quickly check for any database issues:

$ php bin/console doctrine:migration:status

Requirements¶

Updated System components¶

Note

If you are using Enterprise Edition on the Akeneo Cloud Flexibility offering, Akeneo will handle the component upgrades if you open a ticket with our Support team.

Your system components must be updated to the versions required for Akeneo PIM:
  • PHP 8.0

  • MySQL 8.0

  • Elasticsearch 7.16

Note

Elasticsearch supports in-place update.

Elasticsearch 7.16 will be able to use indexes created by previous versions of Elasticsearch 7.x.

This means there’s no need to export and reimport data for this update.

Updated System dependencies¶

Check your system dependencies are in sync with the System Requirements

Updated crontab definition¶

Check that your crontab is in sync with Periodic tasks & Crontab configuration

Upgraded Virtual Host configuration¶

OnPremise only¶

Akeneo PIM uses one fpm pool each for the API and the UI.

You can check the VirtualHost configuration for 6.0 on your system: Install Akeneo PIM manually

Prepare your project¶

Akeneo PIM composer.json¶

Community Edition¶

You can download the composer.json file directly from the Github repository:

$  curl https://raw.githubusercontent.com/akeneo/pim-community-standard/6.0/composer.json > $INSTALLATION_DIR/composer.json

Enterprise Edition¶

Please visit your Akeneo Portal to download the archive, then expand it to the installation directory on your host:

$ tar xvzf pim-enterprise-standard-<ARCHIVE-SUFFIX>.tar.gz -C $INSTALLATION_DIR --strip-components 1 pim-enterprise-standard/composer.json

Load your PIM Enterprise dependencies¶

$ composer update

Note

You may need to temporarily increase the memory provided to composer, as this step can be very memory consuming:

$ php  -d memory_limit=4G <COMPOSER PATH>/composer update

Let Akeneo PIM continue the preparation for you¶

Warning

Do not skip this step

This script overwrites several configuration files, but it is necessary for the upgrade to succeed.

If you have customized your PIM (for example, by adding custom bundles), we suggest saving a backup copy of your configuration files, and you will need to resolve any conflicts.

Community Edition¶

$ export APP_ENV=prod
$ vendor/akeneo/pim-community-dev/std-build/migration/prepare_50_to_60.sh

Enterprise Edition¶

$ export APP_ENV=prod
$ vendor/akeneo/pim-enterprise-dev/std-build/upgrade/prepare_50_to_60.sh

Make sure your environment is ready to be migrated¶

$ rm -Rf var/cache
$ bin/console pim:installer:check-requirements

If this command detects something not working or not properly configured, please fix the problem before continuing.

Prepare the front-end¶

$ make upgrade-front

Migrate your data¶

$ bin/console doctrine:migrations:migrate
$ bin/console pimee:data-quality-insights:migrate-product-criterion-evaluation
$ bin/console pim:data-quality-insights:recompute-product-scores

Note

You may receive the following warning:

WARNING! You have [a number of] previously executed migrations in the database that are not registered migrations.

This can be safely ignored. The message means that your database is up to date, but that Doctrine did not find the migration files corresponding to some prviously-run migrations.

Note

You may also receive:

Migration _X_Y_ZZZZ was executed but did not result in any SQL statements

If a migration only affects the Elasticsearch index or does not apply because no data associated with the migration were found, this can be safely ignored.

Note

The following message can also be safely ignored if it concerns the data-quality-insights migration:

The migration has already been performed.

Migrate the job queue¶

In 6.0 we set up a new job queue (also known as job consumers). If you have jobs awaiting execution in the old queue, they must be migrated to the new queue.

$ bin/console akeneo:batch:migrate-job-messages-from-old-queue

(Use the --no-interaction flag if you want to skip the interactive question and want to migrate directly.)

Migrating your custom code¶

Note

Each Akeneo PIM version brings brand new features, so please check if you still need each custom bundle, as we may have incorporated the same or similar functionality into the PIM.

You can check for new features and changes in the changelog: Where is the Changelog?

Applying automatic fixes¶

Some changes we made in the code of Akeneo PIM can be automatically applied to your own code.

In order to make this process easier and more error proof, we decided to use PHP Rector. to apply these changes.

Installing Rector¶

composer require --dev rector/rector-prefixed

Applying automatic fixes¶

vendor/bin/rector process src/

Note

This will use the rector.yaml file created by the prepare.sh above. Feel free to add your own refactoring rules inside it. More information on getrector.org.

Identifying broken code¶

You can use PHPStan to help you identify broken code:

composer require --dev phpstan/phpstan
vendor/bin/phpstan analyse src/

For more information, please check the PhpStan documentation.

You should migrate your bundles one by one to avoid problems and locate any bugs.


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