• v7.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 11 (Buster)
      • System installation on Ubuntu 22.04 (Jammy Jellyfish)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the job scheduling
      • 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 major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
      • Upgrade from 5.0 to 6.0
      • Upgrade from 6.0 to 7.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
  • 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
    • How to Configure the Event Subscription network restrictions
  • 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
      • How to purge events API logs
  • 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 & Consumers
      • 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
  • About Log4Shell Vulnerability for SaaS Users
  • About Log4Shell Vulnerability for Flexibility v5 Users
  • About Log4Shell Vulnerability for Flexibility users below v5.0
  • About CVE-2022-46157

Queue Management & Consumers¶

Job consumers¶

Processes¶

Akeneo PIM uses daemons to execute jobs (i.e: imports, exports, etc.) from a queue.

Job daemons are managed by systemd which allows multiple operations such as:

  • start/stop/restart a daemon,

  • enable/disable a daemon,

  • check the status/see logs of a daemon.

Warning

Please note that, while the number of running job consumers is not enforced, it is not recommended to increase it above the server capability. Between 1 and 3 consumers is recommended.

To see how and which commands are available, please refer to Privilege escalation

Configuration¶

Configurations of daemons are stored under /home/akeneo/.systemd/pim_job_consumer. The name of the file is the daemon identifier. Make it simple and use only integer numbers.

As of PIM 3.1, each daemon can be dedicated to run certain job(s), hence making sure the jobs will be executed in a timely manner, and that their execution will not interfere with other business operations.

Warning

As of PIM 6.0, job queues have been reworked. Previous daemon configuration files are deprecated. During the technological stack upgrade from a PIM 5.0 to PIM 6.0, configuration folder /home/akeneo/.systemd/pim_job_queue will be removed. Please refer to the information below to set up job configuration.

Daemons files can be configured following this documentation.

Once their configuration files are created, you can manipulate these daemons through our “partners_systemctl” alias as you would do with systemctl.

Examples¶

  • Create a new daemon which handles all type of jobs:
    1# Create a file for the new daemon and keep it empty to handle all jobs
    2touch /home/akeneo/.systemd/pim_job_consumer/3.conf
    3
    4# Start the consumer with its name (configuration filename without extension)
    5partners_systemctl pim_job_consumer@3 start
    6
    7# Enable the consumer to be started automatically at instance boot up
    8partners_systemctl pim_job_consumer@3 enable
    
  • Create a new daemon which handles specific jobs:
     1# Create a file with specific jobs
     2echo -e "data_maintenance_job\nimport_export_job" > /home/akeneo/.systemd/pim_job_consumer/4.conf
     3
     4cat /home/akeneo/.systemd/pim_job_consumer/4.conf
     5data_maintenance_job
     6import_export_job
     7
     8# Start the consumer with its name (configuration filename without extension)
     9partners_systemctl pim_job_consumer@4 start
    10
    11# Enable the consumer to be started automatically at instance boot up
    12partners_systemctl pim_job_consumer@4 enable
    
  • Remove an existing daemon (not possible on Akeneo default ones):
    1# Stop the consumer with its name (configuration filename without extension)
    2partners_systemctl pim_job_consumer@7 stop
    3
    4# Disable the consumer not to be started automatically at instance boot up
    5partners_systemctl pim_job_consumer@7 disable
    6
    7# Delete its configuration file
    8rm /home/akeneo/.systemd/pim_job_consumer/7.conf
    
  • Remove default PIM webhook consumer:
    1# Stop the consumer with its name (configuration filename without extension)
    2partners_systemctl pim_webhook_consumer stop
    3
    4# Disable the consumer not to be started automatically at instance boot up
    5partners_systemctl pim_webhook_consumer disable
    

Onboarder¶

While Onboarder requires consumers to run at all times, those are disabled by default since some customers do not use Onboarder.

Learn more about Onboarder and its configuration in the PIM in the dedicated section Akeneo Onboarder.

Examples¶

Similarly to PIM job consumers, here is how you can manipulate Onboarder daemons:

 1# Start the consumer
 2partners_systemctl pim_onboarder_consumer@1 start
 3
 4# Enable consumer #1 to be started at instance boot
 5partners_systemctl pim_onboarder_consumer@1 enable
 6
 7# Enable worker #1 to be started at instance boot
 8partners_systemctl pim_onboarder_worker@1 enable
 9
10# Check the status of the daemon #1
11partners_systemctl pim_onboarder_consumer@1 status
12
13# Stop daemon #1
14partners_systemctl pim_onboarder_consumer@1 stop

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