Akeneo Sylius Connector

Akeneo Sylius Connector helps you can connect your Sylius store with the Akeneo PIM software and manage thousands of products easily. Once you import all the catalog data in Akeneo you can push that data into the Sylius store. It works with simple, and configurable types of products. The Akeneo admin can export information about the categories, attributes, products, and much more.

Check a brief overview of the plugin –

Please Note –

• This module works with Akeneo 3.0.x, 3.1.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.

• Connect Multiple Sylius Instances By providing Credential in Jobs.
• Mapping for images
• Export Attributes and Attribute options from Akeneo to Sylius
• Mapping for attributes
• Modify the attribute option code.
• Export products using quick export
• A simple select attribute can be exported along with the product.
• Select the main / variant type of images.
• Single-level multi-option attribute product is supported.
• Mapping for attribute options
• Export Categories from Akeneo to Sylius
• Export Products, Product Models, and Product Variant from Akeneo to Sylius

1- Composer Installation for Akeneo Version 4.0.x to 5.0.x

Read This Blog

Composer Installation of Akeneo Version 6.0.x

1: GET the ACCESS KEYS [Raise a Support Ticket]

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

Akeneo 6:

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

3: Use the composer to install the extension

     composer require webkul/syliusconnector

4: Fill in the authentication form

5: Send a Success Message

6: Clear your Browser’s cache

For Akeneo 6

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

2 – Run the below command over the NO-DOCKER Instance from the PIM directory

./src/Webkul/SyliusConnectorBundle/install/config.sh COMPOSER=false NO_DOCKER=true

3 – Run the below command over the docker instance from the PIM directory

./src/Webkul/SyliusConnectorBundle/install/config.sh COMPOSER=false NO_DOCKER=false

1 – Run the below command over the NO-DOCKER Instance from the PIM directory

./src/Webkul/SyliusConnectorBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

2 – Run the below command over the docker instance from the PIM directory

./src/Webkul/SyliusConnectorBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

Please follow these steps for installing the Sylius Akeneo Connector module in your Akeneo PIM platform.

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

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

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

in return array.

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

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

php bin/console ca:cl --env=prod && php bin/console syliusconnector:setup:install

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

To run the Quick export in Akeneo 5.0.x, you need to run the below command.

Install composer dependency

php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require navneetbhardwaj/akeneo-quickexport-configurator;

After that, register the bundle in config/bundles.php

return [
    \WebkulQuickExportConfiguratorBundle\QuickExportConfiguratorBundle::class => ['all' => true],
];

Define routing to create a file in the config/routes/wk_quick_export.yml

wk_quick_expoort:
    resource: "@QuickExportConfiguratorBundle/Resources/config/routing.yml"
    prefix: /

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;

Please follow these steps for installing Sylius Akeneo Connector module in your Akeneo PIM platform.

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

2 – Goto app/AppKernel.php then add line

new Webkul\SyliusConnectorBundle\SyliusConnectorBundle(),

3 – Goto app/config/routing.yml then add these lines at top of file Sylius: resource:

wk_sylius:
   resource: "@SyliusConnectorBundle/Resources/config/routing.yml"
   prefix: /

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

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

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

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

The admin can easily generate API keys. For this, the admin will navigate to your Store terminal then run this command in your store terminal as per the below image.

$ php bin/console sylius:oauth-server:create-client --grant-type='password' --grant-type='refresh_token' --grant-type='token'.

Copy the client id and client secret  in Sylius Connection Credentials Section. 

After that to activate this client id and client secret key you have navigate to the Sylius database

a:2:{i:0;s:26:"ROLE_ADMINISTRATION_ACCESS";i:1;s:15:"ROLE_API_ACCESS";}

After installing the module in Akeneo, you need to set up the Sylius API keys in Akeneo. For this, log into Akeneo then navigate to Sylius Connector>Setup Credentials.

• Shop URL
• Client Id
• Client Secret Key
• Username
• Password

Channel And Locale Mapping

In the channel mapping section, you set the default channel which will be exported to the Sylius store.

In the Locale Mapping section, you can add locales for your Sylius store. 

After setting up the Sylius API keys in Akeneo, Therefor you need to map the product fields between Sylius and Akeneo as per the below image.

Image Mapping

The selected Akeneo image attributes will be visible as Sylius product gallery images with an image type.

Sylius backend:

Other Mapping:

Attribute Mapping: In this, you can map all simple select and multi-select type attributes.

Option Mapping: In this, you can map all the options of the multi and simple select type attribute.

Modify option code in case of duplicate error: In this, if you select yes the option which is already present at Sylius will be updated with the Akeneo option code. If you select no then it will show warring “The option with the given code already exists” because the option code is already existing at Sylius.

You can also create a product in Akeneo. Therefore, navigate to Products. Then click the  Create button.

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

• Product – if you want to create simple products.

Enter the SKU, choose a family, then click the Save button as per the below image.

Product Family – This is a set of attributes that will be the same for all products belonging to a family.

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

Add Product Details

Now you need to provide information about the product.

Enter the details like name, description etc.

Select Attribute

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

Following Attributes from Akeneo are supported for export:

• Text
• Text Area
• Number
• Date
• Yes/No
• Select
• Price
• Metric
• Image

You can also add a product details like price, design, manufacturing color etc.

Upload Image

Click the upload picture section or use the drag and drop feature to add a product image.

Select Category

After entering all the product information. Then you can also select Categories for the created product.

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

This will redirect you to the Export Profile page. Therefore, you will enter a unique code, label and select a job profile.

Then click Save.

Filter The Data

You can export the filtered data. Therefore, navigate to the Content section as per the below image.

You can filter the data as per-

• Channel – This selects the relevant channel of products to export.
• Locales – Depending as per your choice multiple locals can be selected.
• Attributes – select the product attributes which you want to export. You can either select all attributes else click the edit button to select the attributes.

You will be navigated to the “Attribute” page when clicking the edit button as per the below image.

Here, click on the left side to select a specific attribute group. Then select the displayed attributes as per the choice.

Filter The Products.

Akeneo enables you to decide which products to export on Sylius.

Family

Select one or more product families to export to Sylius. If you want to export products belonging to specific families, click on the drop-down list then click on the families to add in the field like clothing, shoes, t-shirts

Time Condition

You can now export your product on a specific time condition.

• No date condition (default option) – Products are not filtered using time conditions.
• Updated products over the last n days (e.g. 6) – This filter the products that were updated during the last six days, enter 6 value.
• Updated products since this date – To filter the products that were updated during a specific date, select a date.
• Products updated since last export –The products that were updated during the last update will be filtered.

Category

You can configure the categories of the channel tree you want to export. For example, you want to export clothing products to update.

By default, all categories are exported. To select a category, then click the Edit button the categories of the channel tree are displayed.

Identifier

You can select product identifiers to export the product. Therefore, you can select multiple product identifiers that should be separated by a comma, space, or line breaks.

Properties

You have to select a credential in which the product will be exported.

After that click the  Save button.

Export Now

After creating the export profile, click on the Export Now button as per the below image.

Execution Process

After the execution of the export process, you can check the process summary and errors if present.

After the completion of the export process, you can check the products in the Sylius catalog. The admin can view the products so if there will be any changes in the product edit form of Sylius as per the below image.

Store View

Exported  Akeneo products will appear on the storefront as per the image.

This was all about the Sylius Akeneo Connector. I hope you must have the got the idea of our module. Thanks for taking the time in reading this blog. And also, please doesn’t forget to share your feedback and suggestions under the comment box given below.

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.