Upgrading to version 25.1.0

Summary

tarting from version 25.1.0, the Akeneo connector introduces a major structural change from previous versions.

Key Changes in Version 25.1.0

The previously single bm_akeneo connector has now been split into two parts:

bm_akeneo: Contains job step files and a new Business Manager module with a graphical interface to simplify complex site preference configuration.

int_akeneo: Holds the core integration logic previously included in bm_akeneo, enabling easier customization of the connector functionality.

 

Upgrade Steps

1. Code Update

If using Salesforce's recommended project structure (each package in its own subfolder):

  • Remove the existing packedge folder.
  • Replace it with the new packedge folder from the updated connector package.

If using a unified project structure (all connectors in a common cartridges folder):

  • Delete the existing bm_akeneo connector.
  1. Add both bm_akeneo and int_akeneo connectors from the new version.

 

2. Connector Frontend Code Compilation

With the introduction of the Business Manager module, building the connector now requires JS and SCSS compilation, where previously only linting was necessary.

Execute the following commands in the connector’s subfolder:

bash
npm install
npm run build

 

If using a unified structure without the provided build system:

Ensure your project’s existing build system is updated to include JS and SCSS builds for the bm_akeneo connector.

3. Business Manager Updates

Once the updated connectors are uploaded:

  1. Add int_akeneo to both the Business Manager and Storefront paths.
  2. Enable the new Business Manager module.

Refer to the documentation folder inside the connector package for setup instructions.

 

4. Metadata Update

The connector includes a metadata folder structured for site import.

Zip the entire metadata folder.

Upload the archive to WebDAV using Business Manager:

Go to: Administration > Site Development > Site Import & Export

Select and import the archive.

⚠️ Note: Importing this metadata will override existing job configurations with default values.

After import:

  1. Go to Administration > Operations > Jobs.
  2. Update the site context from RefArch to your specific site.
  3. Review and adjust step parameters as needed.

It is highly recommended to back up your current job configuration before importing.

 

5. Job and OCAPI Configuration

New jobs were introduced in version 24.2.0. If upgrading from an older version, refer to the documentation folder for setup and functional details.

The connector relies heavily on Open Commerce API (OCAPI) since version 24.2.0.

No additional changes to OCAPI permissions were made in 25.1.0.

If upgrading from a version earlier than 24.2.0, a sample configuration file can be found in:

documentation/Akeneo-OCAPI-Data-Config.txt

Please consult the full documentation included in the connector package for detailed instructions and guidance.