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.
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
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.
The Upgrade 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?¶
To make sure everything is OK, you can run the following commands:
cd /path/to/your/pim/ rm -rf ./public/bundles/* ./public/css/* ./public/js/* php bin/console pim:install:assets 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?¶
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?¶
If the previous steps failed to solve the bug, try this one.
Disable all custom developments by commenting them in the “AppKernel.php” file
// your app bundles should be registered here // new YourCompagny\Bundle\AppBundle\YourCompagnyCustomBundle(),
Alternatively, you can check if the issue is reproducible on Demo website (only for the latest PIM version).
Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!