Back to Top

Akeneo Queue Manager

Updated 28 October 2022

Akeneo Queue Manager allows the store owner to manage the entire queue list of import, export, and quick export jobs. The admin can easily identify job details through – job name, job code, connector name, and status of the job. The admin can even delete any job if it is not required or if the job is not in a running state. This extension works with multiple connectors.

Check a brief overview of the module –

AW9MQAcVfoE

Basic Requirement

  • Akeneo Queue Manager module works with Akeneo 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x.
  • This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
  • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.

Features

  • Manages the list of export/import jobs.
  • Shows the details of a job like a job name, code, connector, and status of the job.
  • Works with multiple connectors.
  • Provide permission to view the jobs on the grid list.
  • Shows the list of jobs that are in pending state or in running state.
  • Provide permission to delete jobs on the grid list.
  •  Show all the user by whom the job has been executed
  • Can delete a job if the consumer is not assigned to the job.
  • Show all the status types of job execution.
  • Support for Akeneo version 3.x 4.x and 5.x.

Installing Module for Version 4.0.x to 5.0.x:

1- Composer Installation

Read This Blog

2- Manual Installation

Please follow these steps for installing Akeneo Queue Manager module in your Akeneo PIM platform.

1 – Unzip the respective extension zip  then merge the “src” folder into akeneo project root directory.

Searching for an experienced
Akeneo Company ?
Find out More
Screenshot-by-Lightshot-1200x414-1

2 – Goto config/Bundles.php then add line:

Screenshot-from-2020-11-23-16-25-22
Webkul\JobQueueManagerBundle\JobQueueManagerBundle::class => ['all' => true],

in return array.

3 – Copy the “config” folder into akeneo project root directory for routing.

Screenshot-by-Lightshot-1-1200x414-1

– Run this command after ssh to your akeneo server by the terminal.

php bin/console ca:cl --env=prod && php bin/console queue-manager:setup:install

5– If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

For Akeneo 5

sudo service php-fpm7.4 restart

For Akeneo 4

sudo service php-fpm7.3 restart

Docker Installation Command :

For Akeneo 5

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run update-extensions;
docker_yarn run less;

For Akeneo 4

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run less;

Installing Module For Version 3.x

Please follow these steps for installing Akeneo Queue Manager module in your Akeneo PIM platform.

1 – Unzip the respective extension zip  then merge the “src” folder into akeneo project root directory.

src-magento-2-1-1200x404-1

2 – Goto app/AppKernel.php then add line.

Screenshot-from-2020-11-23-16-24-47
new Webkul\JobQueueManagerBundle\JobQueueManagerBundle(),

3 – Goto app/config/routing.yml then add these lines at top of file Syndication: resource:

Screenshot-from-2020-11-23-16-29-04
wk_queue_route:
  resource: "@JobQueueManagerBundle/Resources/config/routing.yml"
  prefix: /

– Run this command after ssh to your akeneo server by the terminal.

php bin/console ca:cl --env=prod && php bin/console queue-manager:setup:install

5 – If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

sudo service php-fpm7.2 restart

Common Issues After Installation

It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

  • Webpack Installation: If you get the below error
Webpack-error-2

Akeneo Queue Manager – Workflow

After installing the module in Akeneo on the left side of the dashboard there will be an icon Webkul job queue manager.

Dashboard-3

Create Product In Akeneo

To create a product in Akeneo, go to navigate to Products then click the Create button. Now, you need to choose the product type – as Product or Product Model.

Product – Select this type for creating simple and virtual products.

Product Model – Select this type for creating a configurable product with variations.

create the product in Akeneo

Now enter the required SKU, choose a family, then click the Save button.

Product Family – A family is a set of attributes that will be the same for all products belonging to a family. The product family represents products type, imposes product information structure and defines the list of attributes for a product that it belongs.

Create the product family

Product List

After creating the product in Akeneo you can check the product list. You will found all the product list created by you or exported from any channel.

Create Jobs

After that to export the products, first of all, you need to create the Export Profile. Therefore, navigate to Exports -> Create Export Profile as per the below image.

Export-profiles-management-7

This will redirect you to the Export Profile page. Therefore, you will enter a unique code, label, then select a job profile.

Export-profiles-management-8

Export Now

After creating the export profile, click on the Export button as per the below image.

Export-profile-export-Show-1

Queue Manager

To provide the permission to view and delete the jobs on the grid list. You need to give permission to the users.

For that you need to navigate to System>>Roles. Then create new role and the allow the permission.

Roles-4
  • Delete Job from Grid List – Click on the check box to delete jobs on the grid list.
  • Show Queue List – Click on the check box to view the queue job list on the grid list.
Role-Demo-Roles-Edit-1

After that navigate to System>>Users then select the user to allow the permission.

Users-6

Then click on the tab Group and roles select the role to allow the user for the permission.

User-demo-Edit

After that to check the execution of the export process in the Akeneo Queue Manager into Akeneo then navigate to Webkul job queue manager>Job Queue.

Webkul-Job-Queue-Manager-7

Then you can delete any completed job if it is not required or if the job is not in running state by the delete button.

Webkul-Job-Queue-Manager-4

Support

So, that was much about the User Guide of Akeneo Queue Manager for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Current Product Version - 2.0.0

Supported Framework Version - 3.0.x, 3.1.x, 3.2.x, 4.0.x & 5.0.x

Blog Version - 3.0.x, 3.1.x, 3.2.x, 4.0.x & 5.0.x
  • Version 3.0.x, 3.1.x, 3.2.x, 4.0.x
  • Version 3.0.x, 3.1.x, 3.2.x, 4.0.x & 5.0.x
. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content