Akeneo Category Image and Description

Introduction

With the help of Akeneo Category Image and Description module, you can extend and enrich your Akeneo category entity. So now instead of just adding a name and translations in a category, you will be able to upload an image and add a text description also.

You can select the different language for the description. Akeneo Category Image and Description module will also work with CSV connector and using Akeneo API which will basically allow you to import/export/update rich category information easily.

Basic Requirements:

This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x Download Akeneo from here

Features

Works with all types of categories at any levels – main category, sub-category
Export categories data with image and description fields in Akeneo CSV Connector
Import categories data with image and description fields in Akeneo CSV Connector
Update and add image and description for existing category tree
Rich text editor enabled for the Description field.
Supports various image file extensions such as – jpg, jpeg, png, gif
This module is compatible with latest Akeneo version 4.0.x
The source code is fully open for customization
Export and import description fields in multilanguage.
Image and Description module will also work with CSV connector and using Akeneo API.

Videos

Check out the following video tutorials below:

How can add category image and description

Us59u_U3npQ

Module Installation for Version 2.x to 3.x

Please follow the steps below for installing Akeneo Category Image and Description module:

1 – Once you have downloaded the module zip file, extract it. Then, find the “src” folder and merge it with Akeneo project root directory.

2 – Go to app/AppKernel.php and add the following line:

    new Webkul\CategoryExtendBundle\CategoryExtendBundle(),

1	new Webkul\CategoryExtendBundle\CategoryExtendBundle(),

in function registerProjectBundles()

3 – Go to app/config/config.yml and add these lines in the import section.

For version Akeneo 2.x

- { resource: "@CategoryExtendBundle/Resources/config/config.yml" }

For version Akeneo 3.x

- { resource: "@CategoryExtendBundle/Resources/config/3.x/config.yml" }

For version Akeneo 2.x

- { resource: "@CategoryExtendBundle/Resources/config/config.yml" }

For version Akeneo 3.x

- { resource: "@CategoryExtendBundle/Resources/config/3.x/config.yml" }

4 – You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

php bin/console category_extend:setup:install

1	php bin/console category_extend: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

1	sudo service php-fpm7.2 restart

Module Installation for Version 4.0.x

Please follow the steps below for installing Akeneo Category Image and Description module:

1 – Once you have downloaded the module zip file, extract it. Then, find the “src” folder and merge it with Akeneo project root directory.

2 -Goto config/Bundles.php and add line:

Webkul\CategoryExtendBundle\CategoryExtendBundle::class => ['all' => true]

1	Webkul\CategoryExtendBundle\CategoryExtendBundle::class => ['all' => true]

in return array.

3 – copy the “config” folder into akeneo project root directory for configuration.

4 – You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

php bin/console category_extend:setup:install

1	php bin/console category_extend: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.3 restart

1	sudo service php-fpm7.3 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 It means that web pack is not installed in your system. Run the following command

npm install --save-prod webpack npm install

1
2

npm install --save-prod webpack
npm install
Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
Clear your browser cache.

Managing Category

Once you installed the module, you can now you can add image and description to your categories. Go to Settings>Categories.

In the Properties section, you will find Image and Description fields. Simply upload an image from your computer and some description content.

Once you have added the information, click Save to apply your changes.

In the category properties section, we can add the description translations in multi-languages.

Support

For further queries or customization requirements, please send an email to support@webkul.com If you find any issues in this module, please create a support ticket at- https://webkul.uvdesk.com/en/customer/create-ticket/

Current Product Version - 2.1

Supported Framework Version - Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x