Menu Close
    Searching for an experienced Akeneo Development Company ?

    VirtueMart Akeneo Connector

    Introduction

    VirtueMart is an open-source eCommerce solution eCommerce designed as an extension of the Mambo or Joomla! Content management systems.

    VirtueMart is written in PHP and requires the MySQL database environment for storage. It is best suited for low to medium-level traffic websites.

    Basic Requirement

    Before you begin, please see the minimum requirements for using this module:

    • 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. and 5.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

    • Export category from Akeneo to VirtueMart
    • Select locale and currency for product export jobs
    • Export Custom-field from Akeneo to VirtueMart
    • Upload multiple images of a product
    • VirtueMart Akeneo Connector is compatible with latest Akeneo version 5.0.x
    • Export any specific product(s) using its SKU value in the identifier
    • Filter products for export based on -category, family, completeness, time conditions
    • Export Product and product model from Akeneo to VirtueMart

    Installing Module for Version 4.0.x to 5.0.x

    To know how to install VirtueMart Akeneo Connector module in Akeneo, please follow the below steps:

    1. First of all, unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.

    src-cms-1

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

    Webkul\AkeneoVirtuemartBundle\AkeneoVirtuemartBundle::class => ['all' => true],
    virtue-mart

    in return array.

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

    conf-cms-1

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

    php bin/console ca:cl --env=prod && php bin/console virtuemart: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;
    

    Installing Module for Version 2.x to 3.x

    To know how to install VirtueMart Akeneo Connector module in Akeneo, please follow the below steps:

    1. First of all, unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.

    src-cms-1-1

    2. Goto app/AppKernel.php then add line

    appkernel
    new Webkul\AkeneoVirtuemartBundle\AkeneoVirtuemartBundle(),

    in function registerProjectBundles()
    3. Goto app/config/routing.yml and add these lines at top of the file.

    Approuting.yml
    akeneo_virtuermart:
       resource: "@AkeneoVirtuemartBundle/Resources/config/routing.yml"
       prefix: /

    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 ca:cl --env=prod && php bin/console virtuemart:setup:install --env=prod

    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.
    common issue

    It means that webpack 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.

    VirtueMart API Integration

    Before creating the API key admin have to create a user group. For this, the admin will navigate to Users>>Manage>>Add new user.

    Add new user

    After that fill the details to create a new user

    Account Details: In this admin enter the name, login name, password, and mail.

    Account details

    Assigned User Group: In this admin have to select a group.

    super user

    Basic Setting: In this admin select the Backend Template Style, Backend Language, Frontend Language, Editor, and Time Zone. Then after filling the details click to Save button.

    Basic setting

    After creating the user admin can easily generate API keys from the VirtueMart Admin backend. For this, the admin will navigate to Components>>Joomapi>>API Keys as per the below image.

    Navigate to API Key

    Then select the user to create an API key.

    click select user
    select user

    Click to Save button.

    Save key
    API Key

    VirtueMart Configration

    After installing the module in Akeneo, you need to set up the VirtueMart API keys in Akeneo. For this, log into Akeneo then navigate to VirtueMart Connector>Credentials. Then enter the following details –

    • Shop URL
    • Shop API Key
    • User Id
    Add credentials

    Then click to the Save button.

    credentials

    After creating the credentials you have to map the attribute click to Attribute Mapping.

    attribute mapping

    Other Mapping:

    other mapping

    Attributes to be used as Images – The selected Akeneo image attributes will be visible as VirtueMart product gallery images. Please note – The images will export in sorting order they are selected here.

    Attributes to be used as Export Custom Attributes – When you are going to export the product from Akeneo to VirtueMart. The selected Akeneo attributes will be visible as custom attributes in VirtueMart. They will appear on the storefront under the ‘More Information’ tab.

    Product Creation

    You can also create a product in Akeneo. For this, navigate to the Products>>Create. 

    Now, you need to choose your action – as Product or Product Model as per the below image. You can either select-

    • Product – If you want to create simple products.
    • Product Model –  If you want to create a variable product with variations
    Select product

    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.

    Therefore, the product family represents product type, imposes product information structure then defines the list of attributes for a product that it belongs to.

    create product

    Add Product Details

    After that, you need to provide product information according to the VirtueMart requirements. Then enter basic product details such as Product name, SKU, image, etc.

    Product details

    Select Attributes

    While adding product information, select the attribute options you require. Then you can also create new options for the attribute.

    Following Attributes from Akeneo are supported for export:

    • Text
    • Text Area
    • Number
    • Date
    • Boolean
    • Select
    • Price
    • Metric
    • Image
    • File

    You can also add a product description, stock, visibility, and price.

    Product detail

    Provide SEO information with your product like mention Meta title, Meta keywords and Meta description.

    SEO Information

    New Attribute Option

    If you require some additional attribute option or an attribute option is missing for a select attribute type. Then, in that case, you can create/add new options for the attribute.
    For this, enter a Code and Label, proceed further by clicking the Save button.

    screenshot-192.168.1.74_8082-2021.08.03-18_24_50

    Upload Images

    Upload multiple images of a product before that make sure you have mentioned the image attributes code in module configuration.

    Add multiple images

    Select Category

    After that enter all the product information, you can also select Categories for the created product.

    Add category

    VirtueMart Export Job

    To export the products, you first need to create the Export Profile. For this, navigate to Exports -> Create Export Profile as per the below image.

    Create export profile

    In this module, you will find the following types of export jobs for exporting catalog information to VirtueMart.

    To export the product first you have to export the category then custom field.

    Category Export:

    To create a category export profile, you have to fill the code, label, and job.

    screenshot-192.168.1.74_8082-2021.08.03-18_28_59

    After filling the details click to Save button. Then run the export job click to Export Now.

    screenshot-192.168.1.74_8082-2021.08.03-18_30_02

    After running the export job you can see the export details.

    EXport category

    Custom Field:

    To create a custom field export profile, you have to fill the code, label, and job.

    Export profile custom field

    After filling the details click to Save button. Then run the export job click to Export Now.

    screenshot-192.168.1.74_8082-2021.08.03-18_37_27

    After running the export job you can see the export details.

    Export custom field

    Product Export:

    To create a product export profile you have to fill the code, label, and job.

    create export profile


    After filling the details click to Save button. Then go to the Content section then select your channel, locales, currency, and attributes.

    screenshot-192.168.1.74_8082-2021.08.03-18_45_10

    You can use various filters for deciding which products to export. Then you can even export some specific products using their SKU values to use commas for more than one SKU.

    screenshot-192.168.1.74_8082-2021.08.03-18_46_35

    After filling the details run the export job click to Export Now.

    screenshot-192.168.1.74_8082-2021.08.03-18_47_54

    After that running the export job, you can see the export details.

    Export detail

    Once the export process is finished, you can see the new products in VirtueMart backend.

    Product backend
    Product detail

    After this VirtueMart frontend appears on the product page. Then you can see the product name, description, multiple images, availability label.

    Store view

    Support

    Thank you for reading this documentation. In case you find anything missing or not explained correctly, or you have any customization needs.

    Please feel free to send a mail to [email protected] or raise a ticket at HelpDesk Support.


    Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    Current Product Version - 3.0

    Supported Framework Version - Akeneo PIM 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

    Blog Version - Akeneo PIM 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 PIM 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 PIM 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 3.2.x
    . . .
    Discuss on Helpdesk

    Leave a Comment

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


    Be the first to comment.

    Back to Top

    Table of Content

    Hide Index