• v5.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • System installation on Ubuntu 20.04 (Focal Fossa)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the Events API
    • How to customize the Dataset
    • How to Add Translation Packs
  • Upgrade 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?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
  • 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 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 Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
    • How to Configure Measurement Limits
  • 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
  • Use SSO authentication locally
  • Reference Entities
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • Troubleshooting guide
  • 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
      • Code Conventions
      • Coding Standards
    • 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
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Synchronization
    • How to update a minor version or to apply a patch
      • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
      • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
    • How to upgrade to a major version
    • Troubleshooting
    • How to uninstall the Onboarder bundle
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

Bug qualification¶

Bug qualification is a very important step. The more relevant information you will provide, the more valuable help you will get.

Warning

  • If you are an Enterprise Edition Client, be aware that the bug qualification is required when you submit a ticket on our helpdesk.

  • This step is important as well if you are a Community Edition user and if you decide to share your issue on our Slack user group or our GitHub repository.

Frontend bugs¶

Frontend bugs are JavaScript or display related issues.

What to do?

  • Use your browser buit-in developer tools to get more precise error messages and to debug javascript code step by step.

  • A frontend error can occur because the backend encountered an error, use the network tab of the developer tools to see if it’s the case or not.

  • The PIM can send many types of AJAX requests (GET, POST, PUT, DELETE…), make sure the server is configured to accept all of them.

Backend bugs¶

Backend bugs are issues which occur on the server side (PHP/Symfony code, database…).

What to do?

  • Use the Symfony buit-in developer tools (the debug toolbar and the profiler).

  • Use the Symfony and PIM built-in debug commands (to see them, use the command php bin/console without any arguments).

  • Use the tools of your integrated development environment to debug the code step by step.

  • Analyze the error messages provided in the Symfony’s log files /path/to/your/pim/var/logs/prod.log or /path/to/your/pim/var/logs/dev.log

  • Take a look at the PHP error log file.

Note

If the web debug toolbar is not displayed in dev environment, you can retrieve the link in X-Debug-Token-Link header of request.

Tasks bugs¶

Tasks bugs are issues which occur when running the PIM jobs, like mass edit, import, export… (The way to qualify could be a bit different than pure backend bugs).

What to do?

  • Analyze the error messages provided in the following file /path/to/your/pim/var/logs/batch_execute.log

  • Launch the command out of the PIM with the tools of your integrated development environment php bin/console akeneo:batch:job <batch_name> <additional_params>

  • Check the to do list of the “Backend bugs” section.

Performances issues¶

When you notice slownesses, displaying pages and/or during import/exports, you are probably experiencing a performance issue.

What to do?

  • Use the Symfony’s profiler timeline tab to identify what part of the execution takes most of the time.

  • Use blackfire.io in order to profile the requests which take too much time.

  • Use MySQL built in “SHOW PROCESSLIST” query to identify queries which take too long to run (See: MySQL documentation: SHOW PROCESSLIST Syntax).

  • Use MEMINFO to analyse memory leak issues (See: MEMINFO GitHub repository).

Reporting the bug¶

With the information you have gathered, you can now Report a bug.


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