Compatibility and Pre-requisites

Summary

Connector Compatibility

Before proceeding with the installation of the connector, it's essential to verify that the Akeneo Connector for Adobe Commerce is compatible with your specific versions of Akeneo PIM and Adobe Commerce.

Maintaining compatibility as you transition from one version to another is a key focus for us. Thanks to the flexibility of the Akeneo API, the Akeneo Connector for Adobe Commerce is inherently compatible with new versions of Akeneo PIM. Please note that while this compatibility ensures seamless operation, it may not always encompass the very latest features. To gain insights into our product roadmap and discover more about compatibility, we encourage you to reach out to Akeneo for further information.

 

PIM compatibility

Akeneo Connector for Adobe Commerce Enterprise Edition is compatible with:

  • All supported PIM versions (CE, EE - SaaS, v6, v7 - GE). Benefit from SaaS features compliancy and access to support to address your connector-related inquiries and resolve any potential issues or bugs that may arise during your integration process.

Akeneo Connector for Adobe Commerce Community Edition is compatible with:

  • All supported PIM versions (CE & EE) but Akeneo PIM EE features are not included and there is no access to support available.

Please have a look to our App store to view all our supported PIM versions and to understand the differences between Akeneo Connector for Adobe Commerce Community and Enterprise Edition.

The Customer acknowledges and agrees that the support and maintenance of the subscribed Akeneo Products are contingent upon the Customer running a version of Akeneo PIM that is officially supported by Akeneo. Any issues or disruptions arising from unsupported versions shall not be covered under Akeneo’s terms of support and maintenance. It is the Customer’s responsibility to ensure compliance with the specified supported versions for continued access to support services.

 

Migrating from Akeneo PaaS to SaaS?

You have the Akeneo connector enterprise edition and you are on Akeneo PaaS? The migration to SaaS is possible:

  • No theoretical compatibility break: please check the compatibility table bellow and choose between the connector version 104.X.X or 105.X.X
  • Before migrating, please upgrade to the latest version if possible 
  • Evaluate the impact of customizations that will be removed from Akeneo on the connector and Adobe commerce
  • Test the synchronization as soon as possible: the results might be different (asset for instance).
 

Adobe Commerce and PHP Compatibility

Akeneo Connector for Adobe Commerce Enterprise Edition Version Adobe Commerce Version (Community and Commerce) PHP
105.X.X \>= 2.4.7 \>= 8.2
104.X.X → in maintenance mode \>= 2.4.4 && < 2.4.7 \>= 8.0
104.0.0  2.4.0 and 2.4.12.4.22.4.32.4.42.4.52.4.6, 2.4.7 >= 8.0

104.X.X and 105.X.X - compatibility breaker

Adobe Commerce 2.4.7 is the first version fully compatible with Library Symphony PHP Message 2.0. Previous versions, including 2.4.6, still rely on elements from versions 1.1 and 1.0.

The Akeneo PHP client version 11.4.0 supports PHP 8.2 and higher, and is therefore compatible with Library Symphony PHP Message 2.0.

Please note that version 104.X.X of the connector, which supports Adobe Commerce versions prior to 2.4.7, is now in maintenance-only mode.

All future developments are focused on Adobe Commerce 2.4.7 and above, with the latest connector version 105.X.X supporting PHP 8.2 and newer.

 

Connector community edition compatibility

Akeneo Connector for Adobe Commerce Community Edition Version Adobe Commerce Version (Community and Commerce) PHP
Lower than 100.4.16 2.3.X >= 7.1
100.4.16 and greater 2.3.X and 2.4.02.4.12.4.22.4.3 >= 7.1
103.0.0 2.3.7 and 2.4.0, 2.4.12.4.22.4.32.4.42.4.5 7.4, 8.1
103.1.0 and greater 2.4.0 and 2.4.12.4.22.4.32.4.42.4.5 7.4, 8.1
 103.4.02 and greater 2.4.0 and 2.4.12.4.22.4.32.4.42.4.52.4.6 7.4, 8.1
104.0.0 and greater 2.4.0 and 2.4.12.4.22.4.32.4.42.4.5,2.4.6, 2.4.7 >= 8.0
 
 

Adobe Connector 103.X.X compatibility: not supported by Akeneo

Akeneo Connector for Adobe Commerce Enterprise Edition Version Adobe Commerce Version (Community and Commerce) PHP
 103.4.02 and greater 2.4.0 and 2.4.12.4.22.4.32.4.42.4.52.4.6 7.4, 8.1
103.0.0 2.3.7 and 2.4.0, 2.4.12.4.22.4.32.4.42.4.5 7.4, 8.1
100.6.2 and greater 2.3.X and 2.4.02.4.12.4.22.4.3 >= 7.1
103.1.0 and greater 2.4.0 and 2.4.12.4.22.4.32.4.42.4.5 7.4, 8.1
Lower than 100.6.2 2.3.X  >= 7.1
 
 

Compatibility with Visual Merchandiser

If you use automatic rules or manual position change of a product with Visual Merchandiser, Akeneo Connector for Adobe Commerce import does not reset these changes. The data assignement is not overwritten by the synchronization. 

The association between products and categories will be overwritten by the Connector but the positioning will be preserved.

 

Pre-requisites to use the connector

 

Understanding the connector fundamentals 

Start by reading the section about  what you need to know before using the connector  

Involving the right team 

Getting the assistance of Akeneo Professional services and an integrator who knows SFCC, Akeneo, and the integration are key success factors for the implementation. Contact your CSM for more information.

 

Involving the right team 

Getting the assistance of Akeneo Professional services and an integrator who knows SFCC, Akeneo, and the integration are key success factors for the implementation. Contact your CSM for more information.

Configure your Akeneo PIM

If you need help setting up your Akeneo PIM, please refer to our PIM Help Center or contact your Customer Success Manager for more guidance.

If you have a pre-existing Adobe Commerce, please make sure to read the section about how to configure the PIM with a Pre-existing Adobe Commerce.

Configure your Adobe Commerce

Before you can effectively utilize the Akeneo Connector for Adobe Commerce, it is crucial to configure the following components within Adobe Commerce and Akeneo PIM systems:

  1. Websites and Stores: Define and set up your websites and stores within Adobe Commerce, aligning them with your business structure and requirements. Ensure that the configurations accurately represent your online presence.
  2. Store Languages and Currencies: Configure the languages and currencies applicable to your online stores on both systems. Ensure that these settings match your target audience and are aligned with your business strategy. On Akeneo PIM, translate labels for your product families, attributes, and attribute options into all languages supported by your Adobe Commerce. This ensures that product data is effectively localized and presented in the desired languages.
  3. Set Your API User Credentials following our configuration guide: Establish API user credentials with appropriate permissions. Ensure that this API user has full access to view, edit, and manage product data.
  4. CRON Job Setup: verify that the Adobe Commerce CRON jobs are correctly configured and running as scheduled. CRON jobs play a vital role in executing various automated tasks within Adobe Commerce. Refer to the CRON documentation for guidance on setting up and managing these jobs effectively.
  5. Root Category Assignment: after importing categories, ensure that you specify the "Root Category" for your Adobe Commerce stores. This setting can typically be found in "Stores > Settings > All Stores" within the Adobe Commerce admin interface. Assigning the root category correctly is essential for organizing and displaying your products within the store.

By configuring these key elements, you will pave the way for a smooth and efficient integration of Akeneo Connector for Adobe Commerce with your Akeneo PIM, allowing for the seamless exchange of product information and data between the two systems.

If you need help setting up your Adobe Commerce, please refer to Adobe Commerce documentation.

 

Installing the connector

The installation of the Akeneo Connector for Adobe Commerce is a technical process that should be handled by individuals or teams with a strong technical background and experience in setting up software integrations. Please refer to this article on installation.