Introduction
With this module, you can connect Microsoft Azure Blob Storage with Akeneo. You can save your product assets on the cloud. Azure Blob storage is Microsoft’s object storage solution for the cloud. Blob storage helps in storing massive amounts of unstructured data.
Please Note: Akeneo Microsoft Azure Blob Storage Integration module is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.
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 and 3.2.x. Download Akeneo from here
- Node and Yarn packages need to be installed.
Features
- Integrate Akeneo catalog storage to use Microsoft Azure Storage Blob or File storage
- Migrate existing files data from storage on the server to Azure Storage Blob
- Show viewable Azure Storage Blob URL on product page
- Support Akeneo EE Assets, Asset move from local storage to Azure Storage Blob.
Installing Module
Please follow these steps for installing the Akeneo Azure Blob Storage Integration module in Akeneo.
1 – First of all, the user has to install the Azure Storage Blob php client package and dependency.
2 – Goto your Akeneo Installation Directory then open the “composer.lock” file and change the following package version.
Search for the key “league/flysystem” then update the version to the 1.0.50.
"league/flysystem": "1.0.50",
Search for the key “oneup/flysystem-bundle” and then update the version to the 3.2.
"oneup/flysystem-bundle": "3.2",
3 – 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 -d memory_limit=3G ../composer.phar require microsoft/azure-storage-Blob; php -d memory_limit=3G ../composer.phar require league/flysystem-azure-blob-storage;
4 – Unzip the respective extension zip and then merge the “src” folder into the Akeneo project root directory.
5 – Goto app/AppKernel.php then add the line in function registerProjectBundles()
new Webkul\AzureBlobIntegrationBundle\AzureBlobIntegrationBundle(),
6 – Goto app/config/routing.yml then add these lines at top of the file
azure_integration: resource: "@AzureBlobIntegrationBundle/Resources/config/routing.yml" prefix: /
7 – Goto app/config/config.yml then add these lines after imports.
- { resource: "@AzureBlobIntegrationBundle/Resources/config/config.yml" }
8 – After that, run this command after ssh to your akeneo server by the terminal then navigate to the pim installation directory (don’t run this command directly after ssh, first navigate to pim installation directory using cd command ex. cd /opt/bitnami/apps/akeneo/htdocs)
rm -rf ./var/cache/** && php bin/console pim:install:asset --env=prod && php bin/console assets:install web --symlink --relative && yarn run webpack && php bin/console d:s:u --force
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 the web pack is not installed in your system then you have to run the following commands:
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.
Create and Setup Azure Credential in Akeneo
After installing the Module in Akeneo, the user has to set the configuration of Azure in Akeneo. The user can navigate to “/src/Webkul/AzureBlobIntegrationBundle/Resources/config.yml” to add the credentials.
Step 1: Update the value of the key then add the container name. For example:
azureblob_container_name: 'Test' #container_name
Step 2: Update the value of the connection string. Here, you have to enter further details:
- Default End Point Protocol
- Account Name
- Account Key
- End Point Suffix
You can find further details on your Azure server. For example:
azure_blob_storage_connection_string: "DefaultEndpointsProtocol=https;AccountName=Test;AccountKey=d1PTfAjsRYMk2dozqYmfIjCQFkEJ3yhToEl==;EndpointSuffix=core.windows.net"
Step 3: Run the command to clear the cache:
php bin/console cache:clear --env=prod
After finish the configuration if you will upload the new images and file in Akeneo then it will automatically be stored in Azure Blob.
Media Migration
With this module, the user can migrate existing and new media files both.
1 – If the users have already existing product media data then they can run the following command from the terminal to move files to Azure Blob Storage.
php bin/console azure_integration:move_existing_files
2 – Similarly, if the users have Akeneo Enterprise Edition and want to export all the product assets to Azure Blob Storage then run this command.
php bin/console azure_integration:move_existing_asset_files
3 – If the users have the Webkul DAM module then the user can move assets to Azure Blob Storage after running this command.
php bin/console azure_integration:move_existing_dam_asset_files
Create Products in Akeneo
To create a product in Akeneo, navigate to Products then click the Create button. Now, you need to choose the product type – as Product or Product Model.
Product – Select this type for creating simple and virtual products.
Product Model – Select this type for creating a configurable product with variations.
If you want to know furthermore details of Akeneo products and product variants then follow this blog – https://webkul.com/blog/create-product-and-product-model-in-akeneo/
Now enter the required SKU, choose a family, after that 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. The product family represents product type, imposes product information structure also defines the list of attributes for a product that it belongs to.
Add Product Details
Now you need to provide information about the product. Here you have to enter further details of the product like quantity, price, size, and description.
Upload the Images
Click on the upload image section or drag and drop feature then add an image.
After uploading the images, you can see the thumbnail of the images.
As a result, the user can see further icons after uploading the images.
- Preview Image
- Download Image
- Delete Image
- Generate the Azure Link
After that, if you will click on the Link button then you will be able to generate the Azure link in Akeneo.
Finally, you can copy the Azure Blob images link in the browser to see the image.
Support
For any issues related to this module, please create a support ticket at- https://webkul.uvdesk.com/en/customer/create-ticket Also, for any pre-sales queries or customization discussion, please drop an email to support@webkul.com