Read More
Read More
Menu Close

    Akeneo Table Attribute Extension

    Introduction

    Akeneo Table Attribute: With the help of the Akeneo Table Attribute extension, you can create product table attributes. Table attribute allows multi-dimensional presentation of product data in the form of a table. It is very useful for managing multiple data entries of a product. Add customizable rows and columns to a table.

    Please Note

    • 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

    • Support text, select, image reference select, date, boolean, and file types.
    • Added API to add, edit, and delete a column to an attribute.
    • Support column level validation (Not Blank, URL, Email, Number)
    • Added API to get all columns and to get specific columns of an attribute.
    • Multi-channel and language support
    • Support Import/Export for CSV and XLSX
    • Attribute Columns Import/export jobs for CSV and XLSX
    • Also compatible with the latest version of Akeneo 6.0.x

    Composer Installation

    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 as well as the installation script.

    Searching for an experienced
    Akeneo Company ?
    Read More

    For Akeneo 6.x 

    {	
      "scripts": {	
            "post-update-cmd": [	
               "vendor/webkul/tableattributebundle/src/Webkul/TableAttributeBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
            ],	
            "post-install-cmd": [	
               "vendor/webkul/tableattributebundle/src/Webkul/TableAttributeBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
            ],	
            "post-create-project-cmd": [	
              "vendor/webkul/tableattributebundle/src/Webkul/TableAttributeBundle/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/tableattribute/composer_install.sh"
            ],
            "post-install-cmd": [
               
    "vendor/webkul/tableattribute/composer_install.sh"
            ],
            "post-create-project-cmd": [
             
    "vendor/webkul/tableattribute/composer_install.sh"
           ]
       },
      "repositories": [{
        "type": "composer",
        "url": "https://akeneorepo.webkul.com/"
      }]
    }
    

    3: Use composer to install the extension.

             composer require webkul/tableattributebundle
    

    4: Complete the authentication form.
    5: Send a Message of Success
    6: Delete your browser’s cache.

    Manual Installation For Akeneo 6

    •  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.
    ./src/Webkul/TableAttributeBundle/install/config.sh COMPOSER=false NO_DOCKER=true
    
    •  Run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/TableAttributeBundle/install/config.sh COMPOSER=false NO_DOCKER=false
    

    Installation for Version 4.0.x to 5.0.x

    Follow the installation steps:-

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

    src-table-attrib-ute

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

    Webkul\TableAttributeBundle\WebkulTableAttributeBundle::class => ['all' => true],

    table-attribute

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

    conf-table

    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 cache:clear --no-warmup --env=prod && php bin/console table-attribute:setup:install --env=prod
    

    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;

    Installation for Version 2.x to 3.x

    Follow the installation steps:-

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

    src-table-attrib-ute

    2. Goto app/AppKernel.php and add the following line in function registerProjectBundles()

    Code in Appkernel.php file

    new Webkul\TableAttributeBundle\WebkulTableAttributeBundle(),

    3. Now Goto app/config/routing.yml and add these lines at top of the file.

    Code in Routing.yml

    webkul_table_attribute:
        resource: "@WebkulTableAttributeBundle/Resources/config/routing.yml"
        prefix:   /
    

    4. Goto app/config/config.yml and add the following line under ‘imports:’

    Write code in Config.yml file

    For Akeneo 2.x.x, you have to add this line.

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

    For Akeneo 3.x.x and < 4.0.x, you have to add this line.

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

    5. You have to navigate first to the 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 cache:clear --no-warmup --env=prod && php bin/console table-attribute:setup:install --env=prod
    

    6. If you are using php-fpm. Then you need to restart the php-fpm services.

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

    Uninstall Module: For Akeneo 6

    • From the PIM directory, run the command below over the NO-DOCKER Instance.
    ./src/Webkul/TableAttributeBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
    • Run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/TableAttributeBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

    Run this command to remove added table attributes from your database:

        php bin/console d:q:s "delete from pim_catalog_attribute where attribute_type='pim_catalog_table'"

    Uninstall the Connector for Version 4.0.x to 2.x

    If you want to uninstall the Table Attribute Akeneo Connector then you need to follow the steps given below: (Run the following command after ssh to your akeneo server by terminal)

    Step 1

    Run this command to remove added table attriutes from your database:

        php bin/console d:q:s "delete from pim_catalog_attribute where attribute_type='pim_catalog_table'"

    Step 2

    Run this command to remove this connector from your installed Akeneo:

        php bin/console cache:clear --no-warmup --env=prod && php bin/console table-attribute:setup:uninstall

    Step 3

    Remove all the files/ settings which you have done while installing, that is,

    For Akeneo Version 4:

    • Goto config/Bundles.php and remove line:
        Webkul\TableAttributeBundle\WebkulTableAttributeBundle::class => ['all' => true],
    • Goto config/services and delete wk_table_config.yml file.

    • Goto config and delete routes folder.

    • Run cache clear command and restart the apache.

    For Akeneo Version 3:

    • Goto app/AppKernel.php and remove following line in function registerProjectBundles()
        new Webkul\TableAttributeBundle\WebkulTableAttributeBundle(),
    • Goto app/config/routing.yml and remove these lines at top of file
        webkul_table_attribute:
            resource: "@WebkulTableAttributeBundle/Resources/config/routing.yml"
            prefix:   /        
    • Goto app/config/config.yml and remove following line under ‘imports:’
    - { resource: "@WebkulTableAttributeBundle/Resources/config/3.x/config.yml" }       
    • Run cache clear command and restart the apache.

    Create Table Attribute

    Table attribute has many use cases, you can create a table for managing product information in an organized manner. In the following screenshots, I’m using table attributes for creating a size chart.

    So, once you have installed the Akeneo Table Attribute module, log in to your Akeneo platform. Go to Settings>Attributes.

    Settings-2

    After that click on Create Attribute to create new attributes.

    Attributes-6

    After that click Create Attribute button, and a pop-up window will appear, select the Table option.

    Attributes-7

    To create a new attribute you have to add the attribute code and label.

    Attributes-8

    In the Properties section, enter any value in Code then select any Attribute Group in which you want to assign this new table attribute.

    Attributes-_-Create-1

    Enter the table attribute label with translations and click the Save button.

    Attributes-_-Create-2

    After that, you can create columns in the table and provide column code, labels with translations.

    Attribute-Table-Attribute-_-Edit

    Type

    Select what kind of value will be entered in the table grid.

    • Text
    • Select
    • Boolean
    • Image
    • File
    • Reference select type
    • Date

    Screenshot-from-2022-06-24-13-24-41

    Reference Select Type:

    The reference select attribute is a simple select. Now you can use the reference data attribute in this module.

    For it, You have to choose the Reference Select and then you will find the option for the simple select attribute.

    Attribute-Table-Attribute-_-Edit-1

    Validation

    Set validation for the input values of rows.

    • Email
    • URL
    • Number
    • Not Blank

    Attribute-Table-Attribute-_-Edit-2

    Configuration

    If you are using Select Type values, you can add options in the Configuration.

    Screenshot-from-2022-06-24-13-34-02

    When you have mentioned all the column information, you can save the attribute and view it. Then you can also make any changes if you want to do it.

    Attribute-Table-Attribute-_-Edit-4

    Using Table Attribute

    For using table attributes, you need to assign them to a Family first. After that go to Settings>Families>Edit>Add Attributes.

    Family-Accessories-_-Edit-11

    Select your new attribute then click the Save button.

    Family-Accessories-_-Edit-12

    After that go to Products and create a product. Click Add Row button and enter values and then click Save.

    Product-Sunglasses-_-Edit-8

    Export CSV/XLSX

    You can export table attribute data in CSV and XLSX formats.

    Export-profiles-management-8

    Once you have created the export profile, in the Global Settings you can mention the following

    • File path
    • Delimiter
    • Enclosure
    • With header

    Export-profile-Attribute-Column-export-in-CSV-_-Edit

    Once the export execution process is finished.  All the attribute columns will be exported. Process-tracker-_-Show-job-13

    Import

    You have to create an import profile to import columns in Akeneo. For that, you have to navigate to Import>>Create Import Profile. 

    Import-profiles-management-3

    After that fill the code, label, and job to create a new import profile

    Import-profiles-management-4

    Then select the CSV  file and drag the file to import.

    Import-profile-Attribute-Column-import-in-CSV-_-Show

    Support

    Thank you for reading this documentation, 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 - Akeneo 3 to 5 ||3.0.0 and Akeneo 6 || 4.0.0

    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, 4.0.x, 5.0.x and 6.0.x

    Blog Version - 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
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x
    • Version 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
    • Version 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 and 5.0.x
    • 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
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x
    . . .
    Discuss on Helpdesk

    Leave a Comment

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


    2 comments

  • Johan Hanekom
    Hi there,

    We are using the table extension module on v3.2. We want to upgrade to Akeneo v4. From the above we can do the upgrade?

    • Adarsh Shukla (Moderator)
      Hello Johan,
      Please create a ticket at our Helpdesk system along with the order id. We will update the latest version of the connector on your order id compatible with Akeneo version 4.0.x. https://webkul.uvdesk.com/en/
      Thanks for contacting us!!!
  • Back to Top

    Table of Content