Akeneo Category Image and Description

With the help of the Akeneo Category Image and Description module, you can extend as well as 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 a different language for the description. Akeneo Category Image and Description module will also work with CSV connector by 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, 4.0.x,5.0.x and 6.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.

• Works with all types of categories at any level – main category, sub-category
• Export categories data with the image as well as description fields in Akeneo CSV Connector
• Import categories data with the image as well as 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 the latest Akeneo version 6.0.x
• The source code is fully open for customization
• Export and import description fields in multilanguage.
• The image and Description module will also work with CSV connector and using Akeneo API.

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]

2: In Akeneo composer.json, add our repository and the installation script.

For Akeneo 6.x 

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/categoryextendbundle/src/Webkul/CategoryExtendBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/categoryextendbundle/src/Webkul/CategoryExtendBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/categoryextendbundle/src/Webkul/CategoryExtendBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

For Akeneo <=5.x 

{
  "scripts": {
        "post-update-cmd": [
           
"vendor/webkul/categoryextendbundle/composer_install.sh"
        ],
        "post-install-cmd": [
           
"vendor/webkul/categoryextendbundle/composer_install.sh"
        ],
        "post-create-project-cmd": [
         
"vendor/webkul/categoryextendbundle/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension.

<span id="LC1" class="line" lang="plaintext">        composer require webkul/categoryextendbundle</span>

•  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
• From the PIM directory, run the following command over the NO-DOCKER Instance.

<span id="LC1" class="line" lang="plaintext">./src/Webkul/CategoryExtendBundle/install/config.sh COMPOSER=false NO_DOCKER=true</span>

•  Run the command below over the PIM directory’s DOCKER instance.

<span id="LC1" class="line" lang="plaintext">./src/Webkul/CategoryExtendBundle/install/config.sh COMPOSER=false NO_DOCKER=false</span>

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

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 -After that goto config/Bundles.php then add line

<span id="LC1" class="line" lang="shell">Webkul<span class="se">\C</span>ategoryExtendBundle<span class="se">\C</span>ategoryExtendBundle::class <span class="o">=></span> <span class="o">[</span><span class="s1">'all'</span> <span class="o">=></span> <span class="nb">true</span><span class="o">]</span></span>

in return array.

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

4 – After that 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.

<span id="LC1" class="line" lang="plaintext">php bin/console category_extend:setup:install</span>

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

sudo service php-fpm7.4 restart

sudo service php-fpm7.3 restart

new Webkul<span class="se">\C</span>ategoryExtendBundle<span class="se">\C</span>ategoryExtendBundle<span class="o">()</span>,

<span id="LC1" class="line" lang="plaintext">- { resource: "@CategoryExtendBundle/Resources/config/config.yml" }</span>

<span id="LC1" class="line" lang="plaintext">- { resource: "@CategoryExtendBundle/Resources/config/3.x/config.yml" }</span>

php bin/console category_extend:setup:install

sudo service php-fpm7.2 restart

<span id="LC1" class="line" lang="plaintext">./src/Webkul/CategoryExtendBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true</span>

<span id="LC1" class="line" lang="plaintext">./src/Webkul/CategoryExtendBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false</span>

Once you installed the module, after that you can add images as well as descriptions to your categories.

Then go to Settings>Categories.

You’ll then get a list of all root categories and a create button to add a new root category.

After that, in the Properties section, then you will find Image as well as Description fields.

Then simply upload an image from your computer after that some description content.

With the icon shown below in the image, you may download the image or view it on fullscreen.

Fullscreen category image.

After that, you must provide multilingual category description translations.

After you’ve finished adding the information, click Save to save your changes.

So, that was much about the User Guide of Akeneo Category Image and Description 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.