• v2.3
    • 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

 

  • 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
    • 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?
  • 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 to contribute to the frontend part of the application
    • 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?
      • 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 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
  • Akeneo Onboarder
    • Prerequisites
    • Installation
    • Synchronization
    • Troubleshooting
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

First aid kit¶

Here is our first aid kit if you encounter a bug on your PIM project.

Step 1: are you sure that it’s a bug?¶

Sometimes, it’s quite clear that the behaviour you experience is a bug. But it is not always the case. Some behaviours can occur because you missed something (for instance a permissions misconfiguration), and the PIM just works as designed.

If you have doubts, please have a look at the following resources. If not, go to the next step.

  • The PIM Help Center
  • The PIM online API documentation

Tip

Help Center can be accessed at any moment from the (?) Help icon on the bottom left corner of the PIM.

Step 2: is your computer ready to use the PIM?¶

There are some client side requirements to use the PIM. Please check that everything is OK by looking at Client side configuration and compatibilities.

Step 3: are the system requirements still OK?¶

Maybe something has been changed in your server. You can check that by running the following command:

cd /path/to/your/pim/
php bin/console pim:installer:check-requirements

Note

All our system requirements can also be found in this documentation: System Requirements.

In addition, check that:

  • The Xdebug PHP extension is well deactivated.
  • The PIM commands are well run in prod mode instead of dev mode (See: Symfony documentation: Selecting the Environment for Console Commands)
  • Your crontab scheduled PIM commands are not launched too frequently

Step 4: what about your infrastructure?¶

Depending on your infrastructure, you may need to check some points:

  • Make sure you are not experiencing latency issues on your local network.
  • Make sure you don’t have an issue with one of your network equipments. For instance with a proxy server.

Step 5: is your PIM up-to-date?¶

Make sure that you applied the latest patches available for your PIM version. You can check your current PIM version at the bottom of the PIM login or dashboard pages.

Tip

The Migrate Akeneo PIM projects documentation explains how to update your PIM to the most recent minor version.

Step 6: are your additional bundles up-to-date?¶

As for the PIM it’s important to check that the additional bundles you use are up-to-date.

If you need assistance, please refer to each bundle’s documentation.

Step 7: are your assets properly deployed?¶

Tip

This step is recommended if you encounter user interface issues like javascript errors or display problems.

From a technical point of view, assets are all the javascript, css and media files used by the PIM itself, by its dependencies, and eventually by your custom developments.

To make sure everything is OK, you can run 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

One last thing, 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.

Step 8: did you clear the cache?¶

Clear the PIM cache (also known as “Symfony cache”) by running the following commands:

cd /path/to/your/pim/
php bin/console cache:clear --env=prod --no-warmup

Step 9: did you consider the volume of your catalog?¶

Tip

This step is recommended if you encounter performances issues.

Each catalog is unique. How many channels, locales, attributes, families, categories, products and users do you have? These values may had increased drastically since you began using your PIM.

Most of this information can be found on the PIM under System > System information. Since 2.3 version, you have a dedicated page available under Activity menu, called Catalog Volume Monitoring, see our _Help Center article for more information about this page and how to read it.

You can also read this Medium article _Because your product catalog typology matters to see the impacts catalog modeling can have on PIM performances.

Step 10: did you customize your PIM?¶

Warning

If the previous steps failed to solve the bug, try this one.

Disable all custom developments by commenting them in the “AppKernel.php” file /path/to/your/pim/app/AppKernel.php.

// your app bundles should be registered here
// new YourCompagny\Bundle\AppBundle\YourCompagnyCustomBundle(),

And then, re-apply Step 7: are your assets properly deployed? and Step 8: did you clear the cache?

Alternatively, you can check if the issue is reproducible on Demo website (only for the latest PIM version).

Does the bug persist?¶

Sorry to hear that. It seems it’s Bug qualification time.


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