• v2.0
    • Versions
    • master
    • v3.2
    • v3.1
    • v3.0
    • v2.3
    • v2.2
    • v2.1
    • v2.0
    • v1.7
    • v1.6
    • v1.5
    • v1.4
    • v1.3
    • v1.2
    • v1.1
    • v1.0
Caution! You are browsing the documentation for Akeneo in version 2.0, which is not maintained anymore.
Consider upgrading to the latest version.

 

  • Install Akeneo PIM
    • Install Akeneo PIM with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 9 (Stretch)
      • System installation on Ubuntu 16.04 (Xenial Xerus)
      • Installing Akeneo PIM Community Edition (CE) with the Archive
      • 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
  • 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 Avoid Rules Execution on Mass Edit Actions
    • 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 Product Assets
      • How to Add a New Transformation
      • How to Add a Default Thumbnail For Unknown File Types
      • How to connect to an external server for storage
      • How to change the validation rule to match a reference file to an asset
      • How to Mass Import Assets
    • 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
  • 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 behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • 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
    • Bundles
    • Components
    • 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?
    • 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 Mode
      • Overview
      • Partners Starterkit
      • Environments Access
      • Composer settings
      • Periodic tasks / Crontab settings
      • PIM Application
      • PIM Updates and Migrations
      • Data File Transfer
      • Backups management
      • Partners
      • Queue management
      • System Components
      • Disk Usage
    • Serenity Mode
      • Overview
      • PIM Updates and Migrations

Common issues¶

Tip

Feel free to improve this documentation by clicking on the “Edit on GitHub” link on the top right corner. You can also have a look at our “Contribute to documentation” guide.

I have an error when I upload large files¶

If you upload a file in an image or a file attribute, check the “max file size” parameter inside the attribute itself.

In order to achieve this, follow these steps:

  • Go to Settings > Attributes, then open your image or file attribute type.
  • Increase the value of the “max file size” parameter or set it to blank for an unlimited file size.

If you perform a file upload in the asset module, be aware there is no limitation inside Akeneo PIM.

In addition, your local installation can set limitations in several places:

  • Check the “upload_max_filesize” and “post_max_size” parameters inside your php.ini configuration file.
  • If you are using a nginx server, check the “client_max_body_size” parameter of your server configuration.

Some translations are missing¶

In some cases, you might see technical codes instead of the correct tab or button labels.

To fix this issue, just run the following commands:

cd /path/to/your/pim/
rm -rf web/translations/*
php bin/console oro:translation:dump
yarn run webpack

Some Javascript, CSS or media files are not taken into account¶

In this case, you just have to redeploy them by running the following commands:

cd /path/to/your/pim/
rm -rf ./web/bundles/* ./web/css/* ./web/js/*
php bin/console pim:install:assets --env=prod
php bin/console assets:install --symlink web
yarn run webpack

Also, don’t forget to clear your browser’s cache:

  • If you use Chrome, see: Chrome documentation: Clear cache and cookies.
  • If you use Firefox, see: Firefox documentation: How to clear the Firefox cache.
  • If you use another browser, be aware this one isn’t officially supported.

I minified and merged all javascript files with the Oro command¶

This feature is not supported yet by the PIM.

You can revert this operation by running the following commands:

cd /path/to/your/pim/
rm ./web/js/oro.min.js
rm -rf ./var/cache/*
php bin/console pim:install:asset --env=prod
php bin/console assets:install --symlink web
yarn run webpack

I cannot export my products “An exception occurred during the export”¶

If you have thousands of products to export with the native CSV and XSLX connector and if the job finishes or fails with the error: “An exception occured during the export”. If the error message is not explicit enough, you can launch it in dev mode, also check the logs to have more information.

If the system mentions an error like “CRITICAL: Fatal Error: Allowed memory size of bytes exhausted (tried to allocate XXXXXXXX bytes)” it means that there is a memory leak and it might be linked to the media archiving. We have noticed that exporting more than 1 GB of medias could lead to a memory leak More than 1GB of product media to export?

First step is to disable the media archiving in the job’s properties (Export files and medias set to No) and then try again.

If it works and if you do not need the medias in the export file, you can keep this configuration.

If you need to export medias, unfortunately there is no out of the box solution to archive large volumes of media on a classic PIM installation, so you will have to write your own archiver, you can find an example here: More than 1GB of product media to export?

If the issue remains, you need to follow our qualification guide: Bug qualification.

Regarding data export volumetry, please note that we have clients exporting more than 270K at once and the PIM handles such exports. See our Scalability guide for more informations about our tests: Scalability Guide

The limit of total fields is reached in Elasticsearch¶

Elasticsearch defines a index.mapping.total_fields.limit parameter. You can increase this setting in case you encounter the following error:

{
   "error":{
      "root_cause":[
         {
            "type":"illegal_argument_exception",
            "reason":"Limit of total fields [5000] in index [akeneo_pim_product_and_product_model] has been exceeded"
         }
      ],
      "type":"illegal_argument_exception",
      "reason":"Limit of total fields [5000] in index [akeneo_pim_product_and_product_model] has been exceeded"
   },
   "status":400
}

To do so, create a my_index_configuration.yml file with the following content:

settings:
    mapping:
        total_fields:
            limit: 6000 # fix your own limit here

Then, load the my_index_configuration.yml by adding it to the Symfony elasticsearch_index_configuration_files parameter that is present in the file parameters.yml or pim_parameters.yml.

For instance, if you have a Community edition:

# parameters.yml
# ...
elasticsearch_index_configuration_files:
    - '%kernel.root_dir%/../vendor/akeneo/pim-community-dev/src/Pim/Bundle/CatalogBundle/Resources/elasticsearch/index_configuration.yml'
    - '/path/to/my_index_configuration.yml'

If you have the Enterprise edition:

# parameters.yml
# ...
elasticsearch_index_configuration_files:
    - '%kernel.root_dir%/../vendor/akeneo/pim-community-dev/src/Pim/Bundle/CatalogBundle/Resources/elasticsearch/index_configuration.yml'
    - '%kernel.root_dir%/../vendor/akeneo/pim-enterprise-dev/src/PimEnterprise/Bundle/WorkflowBundle/Resources/elasticsearch/index_configuration.yml'
    - '/path/to/my_index_configuration.yml'

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