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
- 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
- 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
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 then merge it with Akeneo project root directory.
2 – Go to app/AppKernel.php then add the following line:
1 |
new Webkul\CategoryExtendBundle\CategoryExtendBundle(), |
in function registerProjectBundles()
3 – Go to app/config/config.yml then add these lines in the import section.
1 2 3 4 5 6 7 |
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.
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.
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 then merge it with Akeneo project root directory.
2 -Goto config/Bundles.php then add line:
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.
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.
1 |
sudo service php-fpm7.3 restart |
Uninstalling Module Version 4.0.X
Please follow these steps for uninstalling the Akeneo Category Image and Description.
1 – Goto config/Bundles.php then remove this line.
1
|
Webkul\CategoryExtendBundle\CategoryExtendBundle::class => [‘all’ => true]
|
2 –Goto config/routes then remove wk_.yml file.
3 – Run this command after ssh to your akeneo server by the terminal
1
|
php bin/console category_extend:setup:install
|
Uninstalling Module Version 2.X To 3.X
Please follow these steps for uninstalling the Akeneo Category Image and Description.
1 – Goto app/AppKernel.php then comment or remove this line.
1
|
new Webkul\CategoryExtendBundle\CategoryExtendBundle(),
|
2 – Goto app/config/routing.yml then comment or remove these lines.
1
2
3
|
For version Akeneo 2.x
– { resource: “@CategoryExtendBundle/Resources/config/config.yml” }
For version Akeneo 3.x
– { resource: “@CategoryExtendBundle/Resources/config/3.x/config.yml” }
|
3 – Run this command after ssh to your akeneo server by the terminal
1
|
php bin/console ca:warmup && php bin/console shopify:setup:install
|
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
12npm install --save-prod webpacknpm 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
Be the first to comment.