Akeneo DAM (Digital Asset Management) Extension
Table of Content
Akeneo DAM (Digital Asset Management) Extension extension allows you to centrally manage all your media files using the DAM (Digital Asset Management) solution in Akeneo.
Now, you can add/upload/edit/delete various types of media assets such as images, pdf, doc, etc within the Akeneo PIM platform.
You can provide detailed information about your media files for enrichment.
Also, for importing and exporting downloadable products between Magento 2 and Akeneo and create downloadable products in Akeneo, check the Magento 2 Downloadable Product Akeneo Add-on.
For a open source DAM solution, UnoPIM provides a flexible and powerful way to manage your digital assets.
Please Note –
- Akeneo DAM Extension is compatible with Akeneo Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition.
- This module is also Compatible with Akeneo Microsoft Azure Blob Storage Integration.
Basic Requirements of Akeneo Digital Asset Management
- This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1, 3.2.x, 4.0.x, 5.0.x, 6.0.x and 7.0.x.Download Akeneo from here
- Node and Yarn packages need to be installed. Click Here
- Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo
Features of Akeneo Digital Asset Management
- With Akeneo DAM software, you can assign/upload/remove digital assets by UI.
- Akeneo DAM helps in storing the product media data and removing duplicity
- You can store Photos and Files with content in Akeneo
- Support all file assets including images and other files like PDF, DOC, and all others.
- An asset can be exported in the CSV file.
- You can import assets with FTP.
- With the help of FTP, data can be added.
- For asset attributes, the main media image will be the same as the Thumbnail.
- You can export/import assets.
- With this, you can upload bulk data.
-
You will be able to create, edit, retrieve, and delete your DAM (Digital Asset Management) data from the external store using REST APIs.
- With Akeneo DAM, you can work time and cost-efficiently.
- You can create and assign categories to the assets.
- Various digital asset management actions for delete, and edit.
- You can reuse the same image in different products
- Can filter the digital assets using the different filter option
- You can edit the asset with this Digital Asset Management software.
- Suitable for both applications – Enterprise DAM and Open Source DAM.
- You can add additional information assets that can be created on behalf of the family.
- Additional information can be added locally and channel-wise.
- Akeneo digital asset management software is compatible with the latest Akeneo version 7.0.x.
Video Tutorials
Check out the following video tutorials below:
How to set up DAM in Akeneo?
How to create Assets in Akeneo?
Composer Installation
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.
For Akeneo 6 and 7:
{
"scripts": {
"post-update-cmd": [
"vendor/webkul/dambundle/src/Webkul/DamBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
],
"post-install-cmd": [
"vendor/webkul/dambundle/src/Webkul/DamBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
],
"post-create-project-cmd": [
"vendor/webkul/dambundle/src/Webkul/DamBundle/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/dambundle/composer_install.sh"
],
"post-install-cmd": [
"vendor/webkul/dambundle/composer_install.sh"
],
"post-create-project-cmd": [
"vendor/webkul/dambundle/composer_install.sh"
]
},
"repositories": [{
"type": "composer",
"url": "https://akeneorepo.webkul.com/"
}]
}
3: Use composer to install the extension.
composer require webkul/dambundle
4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.
Installing Module for Version 6.0.x and 7.0.x
- 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/DamBundle/install/config.sh COMPOSER=false NO_DOCKER=true
- Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/DamBundle/install/config.sh COMPOSER=false NO_DOCKER=false
Module Installation 4.0.x to 5.0.x
Please follow these steps for installing Akeneo DAM (Digital Asset Management) Extension in your Akeneo PIM platform.
- Unzip the respective extension zip and then merge “src” folder into the akeneo project root directory.
- After that goto config/Bundles.php then add the line:
Webkul\DamBundle\WebkulDamBundle::class => ['all' => true], Ijanki\Bundle\FtpBundle\IjankiFtpBundle::class => ['all' => true],
in return array.
- Then copy the “config/routes/webkul_dambundle.yml“folder into the akeneo project root directory for routing.
- 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.
php -d memory_limit=3G /usr/local/bin/composer require ijanki/ftp-bundle --no-scripts
rm -rf ./var/cache/ && php bin/console cache:warmup && php bin/console wk_dam:setup:install && php bin/console dam:asset:category
- If you are using php-fpm. Then you need to restart the php-fpm services.
For Akeneo 4
sudo service php7.3-fpm restart
For Akeneo 5
sudo service php7.4-fpm 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;
Module Installation 2.x to 3.x
Please follow these steps for installing Akeneo DAM [ Digital Asset Management software ] in your Akeneo PIM platform.
-
- Unzip the respective extension zip and then merge “src” folder into the akeneo project root directory.
- After that goto app/AppKernel.php and add the following line in function registerProjectBundles()
new Webkul\DamBundle\WebkulDamBundle(),
new Ijanki\Bundle\FtpBundle\IjankiFtpBundle(),
- Then goto app/config/routing.yml and add these lines at top of the file
webkul_dam:
resource: "@WebkulDamBundle/Resources/config/routing.yml"
prefix: /
- 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 /usr/local/bin/composer require ijanki/ftp-bundle --no-scripts
rm -rf ./var/cache/ && php bin/console cache:warmup && php bin/console wk_dam:setup:install && php bin/console dam:asset:category
-
If you are using php-fpm. Then you need to restart the php-fpm services..
sudo service php7.2-fpm restart
Common Issue 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 a 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.
Uninstalling Module
For Akeneo Version >= 5.0.x:
Please follow for uninstalling the Akeneo DAM (Digital Asset Management) Extension. Run this command after ssh to your akeneo server by the terminal
php bin/console dam:asset:uninstall --env=prod && php bin/console cache:clear --env=prod;php bin/console pim:installer:assets --symlink --clean --env=prod;yarn run webpack;yarnpkg run update-extensions;yarnpkg run less;
For Akeneo Version >= 4.0.x:
Please follow for uninstalling the Akeneo DAM (Digital Asset Management) Extension. Run this command after ssh to your akeneo server by the terminal
php bin/console dam:asset:uninstall --env=prod && rm -rf var/cache && php bin/console cache:warmup && rm -rf public/bundles public/js && php bin/console pim:installer:assets --symlink --clean && rm -rf public/css && yarnpkg run less && rm -rf public/dist && yarnpkg run webpack-dev && php bin/console d:s:update -f
Akeneo Version <= 3.2.x:
Follow for uninstalling the Akeneo DAM (Digital Asset Management) Extension. Run this command after ssh to your akeneo server by the terminal
php bin/console dam:asset:uninstall --env=prod && rm -rf ./var/cache/** && php bin/console pim:install:asset --env=prod && php bin/console assets:install web --symlink && yarn run webpack
Uninstall Module: For Akeneo 6 and 7
- From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/DamBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
- Then run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/DamBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false
Set up in Akeneo
After installation of the module in Akeneo, You have to edit the user role in Akeneo. Then you have to navigate System -> Roles-> Permission and then enable Webkul Digital Asset Management.
After that, you have to create the Asset Group attributes.
After that, navigate to Settings >> Attribute. The attribute list will appear, and you can also add a new attribute from there.
Next, you can create a new attribute by clicking on Create Attribute. Then select Asset Group.
When you click on Asset Group, then Create Attribute page will open.
After confirming the attribute, you need to enter the attribute details:
After that, you can proceed to add the created attribute to the family. Navigate Setting>> Product setting > family.
For creating the product in Akeneo, you have to choose the family in which you want to add an attribute.
Now, you can select the created attribute from the dropdown option in Attribute used as the main picture.
After that, while creating a new family you can choose an asset attribute as the main picture in the family.
Note: The first image that is selected as a thumbnail in the asset will appear as the main picture.
Create Digital Asset in Akeneo
Then after the installation in Akeneo, you will find the DAM media icon.
Go to Settings > Asset Settings to configure the Asset settings.
In the Asset Setting, you can create digital asset attributes for media and assign them to a family and category.
Asset Attribute of Akeneo Digital Asset Management
First, you can create a digital asset for media by navigating to Settings > Asset Setting > Asset Attribute.
Now, you can create a new attribute for media by clicking on Create Attribute. After that, you can choose the asset attribute type.
After selecting the attribute type, you can proceed with creating the attribute.
You can also set the language for the asset attribute in the Label Translation section.
Therefore, any changes or updates made to the asset attribute will be recorded in the history for tracking purposes.
Asset Family
Secondly, you can navigate to Settings > Asset Family and assign an attribute to the existing Asset family.
Additionally, you can add a new Asset Family by clicking on Create Family and then saving the family.
After that, you can add asset attributes to the asset family from the Attribute section within the asset family.
Once an asset attribute is added to the asset family, it will become visible in the Attribute section.
Once you save the asset attribute, it will be updated in the history, and the added asset attribute will be saved.
Asset Category
You can add a digital asset category in Akeneo.
Now, you can add the asset to a category and subcategory. For creating the category, you have to click on the Setting -> Asset categories.
Additionally, if you want to add a new asset category, click on Create to create a new asset category tree.
After that, a new asset category tree will be visible in the list.
Media – Digital Asset
After that, you have to click on the Media Icon and the Akeneo DAM page will open.
Then you will find the Add Asset icon at the right of the screen. After that, you have to click on the Add Asset button.
A new page will be open where you have to enter the Asset code and Asset family. Asset code is a unique code for a group of products and files.
After clicking on the save button, the Asset Management page will open. Here, you can upload the files and media.
Once it is saved then it will appear in the list
You can list it in the list display by clicking on display >> list.
Once you click on the list the media will show in list form.
Additionally, you can edit an existing asset in the media by clicking on the asset. The asset will open, allowing you to upload files and media.
Note: The main image will be a thumbnail image and it will be always required.
Preview Media: Clicking on the preview icon then you can view the icon on the same page.
Download Media: you can download the image by clicking on download and it will be downloaded.
Public Media URL : By clicking on the public media URL, the image will open in another tab.
Edit Media: You can edit assets by clicking the Edit button, which opens the image edit page.
Remove Media: you can delete the image from the media by clicking on remove.
After that, you can upload the files and media. The main image will be a thumbnail for the asset.
Additional Informaiton
Then you can also add information about the assets.
- Title – The asset title explains the assets.
- Alt – You can add further information about the assets with an alternative text.
- Description – It describes the product asset.
- Starred -The asset can be starred using a Yes/No option.
- Tags -These asset tags will help you while filtering the products.
- Shirt: You can add asset value that you have created for your media.
Note: Any new created asset can be added to the media like the shirt.
Additionally, you can change the Asset Family from Asset info as per the below image :
After that, it will be changed as per your selected asset family in the media.
Asset Category
After submitting these details, you can assign the Categories to these assets. You can assign a single asset category or multiple asset categories.
Then you can click on the save button on the right corner of your page. Now you can see the asset is added to the Asset list.
After saving the assets in the Asset list, you can edit and delete the asset.
Lastly, every change and update you make will be saved in the history.
Filter the Assets in Akeneo DAM
In the Akeneo DAM module, You can filter the assets with the
- Code
- Family
- Created at
- Updated at
Filter the Assets with Code:
In this module, You can filter the asset with a description. For this, you have to choose the operator.
- Contains – The asset code contains the text you entered.
- Does not contain – The asset code doesn’t contain text entered by you.
- Is equal to – The asset code is equal to the text entered by you.
- Starts with – The asset code starts with the text entered by you.
- In List : The asset code can be searched by entering the new created asset.
- Is Empty – The asset code is empty.
- Is not Empty – The asset code is not empty.
Filter the Family:
In this module, you can set the Family Asset, allowing you to filter products based on the asset family. There are three options available for this setting.
- In List – The asset family can be searched by entering the new created asset.
- Is Empty – The asset family is empty.
- Is not Empty – The asset family is not empty.
Filter the Asset with Created At:
After that in this module, You can filter the asset with created At. For this, you have to choose the operators.
- Between – You can filter the asset that you have created between two dates.
- Not Between – You can filter the asset that you have not created between two dates.
- More than – You can filter the asset after the selected date.
- Less than – You can filter the asset before the selected date.
Filter the Asset with Updated At:
Then you can filter the asset with updated At. For this, you have to choose the operators.
- Between – You can filter the assets that you have updated between two dates.
- Not Between – You can filter the assets that you have not updated between two dates.
- More than – You can filter the asset after the selected date.
- Less than – You can filter the asset before the selected date.
You can also select the Master Asset – All Assets, apply filters, and then choose the appropriate asset category.
The product creates in Akeneo with Akeneo DAM Module
To create a product in Akeneo, go to navigate to Products and click the Create button. Now, you need to choose the product type – Product or Product Model.
Once you have selected your action for the product then you need to select the Family.
After that, you have to enter the required SKU to choose a family, then click the Save button.
After that, product have been created with family and SKU.
Once your product is created, you can change or update the family for the created product.
Update Product Family in the product
Now, you can search for the product family that you want to update in the product.
After that, you can select the product family and click on save. Then it will appear on the product page.
Update the product
You can change the locale and channel for the product.
After that, the product will be available in the selected locale.
You can also add/upload an asset to the product with the asset group attribute.
You can also review the product media to check or update it accordingly. As you can preview, download, or remove the image from the media section, as shown below:
In the product, you can set a filter for the Attribute Group to easy view. 
Now, you can view the selected Attribute Group and then update the attribute group as needed.
Assign Asset
Here, you can assign the asset with category time by clicking on Assign Asset. For this, you have to choose the operators.
Now, you can select the assets that you want to add to the product as per the below category :
- Basket: You can select the Image that is appearing because of all assets.
- Master Asset: You can select and choose all classified assets as needed.
- Asset_Category : You can filter the asset based on the asset category, family, created date, and updated date.
- Unclassified Category : You can filter the asset based on the asset category, family, created, and updated.
- All Assets: You can select all assets for the product.
Also, you can use the filter for assets.
After adding the asset, click on the confirm button. Your product details will be shown on the product page.
Upload Asset
Now, you can upload the asset to the product by clicking on Upload Asset. The new screen appears for uploading assets as below image :
After uploading the image, all details in the asset files will be automatically filled in. You can modify the code as needed.
After that, it will be uploaded to the product asset successfully.
When you upload the asset in the product then it will be created and sync the Media.
Remove All
Here, you can remove all uploaded and assigned assets by clicking on Remove All.
Export Asset
Create Export Job Profile
You can export assets using the Akeneo DAM Extension. Existing export profiles can be viewed under Exports.
- DAM Asset Attributes Export in CSV: Export asset attributes into a CSV file for easy management.
- DAM Asset Category Export in CSV: Export asset categories into a CSV file for organized review.
- DAM Asset Export in CSV: Export all digital assets into a CSV file for a complete overview.
- DAM Asset Family Export in CSV: Export asset families into a CSV file for better organization.
- DAM Attribute Option Export in CSV: Export asset attribute options into a CSV file for tracking and updates.
Additionally, you can create a new export profile by navigating from Exports>Create Export Profile.
When creating a new profile, you need to provide details such as the Code, Label, and Job.
After that, you can save the profile, an exporting profile is created.
Also, you can edit the existing export job from the list for updates.
After that, you can click the export job profile that you want to update.
Now, click on edit button.
After that, you can edit the selected Export profile – DAM asset export in CSV with properties and storage type from No Storage configure to Local .
Global setting
Now, you can set the global setting to allow import files with delimiter and Enclosure.
- Decimal separator: you can determine the decimal separator.
- Date format: You can determine the format of date fields.
- Delimiter: you can use the one character to set the delimiter.
- Enclosure: you can use the one character to set the enclosure.
- With header: you can select yes/no to print the column name.
- Export media: you can select yes/no to print the export name.
- With labels: you can define the export file displays values’ labels instead of values’ codes.
Asset Export filter
You can review the content and apply filters for exporting product assets.
- Filter The Data
- Channel – Each export job can only be linked to one channel, please select the relevant channel of products to export.
- Locales – Select one or more Locales depending on your requirements.
- Filter the Asset:
- Family: After that one or more asset families to export in the CSV file.
- Identifier: You can select identifiers to export by adding them to the asset code (identifier) field. You can copy and paste a list of identifiers, and separate them by using commas, space, or line breaks.
- You can use the filter in the Export job profile and select the asset family.
- 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, and t-shirts.
Now, every change and update will be updated in the history.
After that, you can click on save and click on export now.
After clicking on export now, there will be the option Download Generated File click on that to create a CSV file. You can generate a file or zip.
After that, click on Other Actions from 3 Dots(…) near to Download Generated Files. Then you will have two options :
- Show Profile: You will be back to the export profile by clicking on Show Profile.
- Download log: By clicking on the download log, you will have details of the downloaded file.
Import Asset
Now, you can import Asset in Akeneo DAM Extension. There are two jobs to import assets in Akeneo DAM Extension.
- DAM Asset Attribute Option Import in CSV: Allows importing asset attribute options using a CSV file.
- DAM Asset Attributes Import in CSV: Facilitates the bulk import of asset attributes from a CSV file.
- Also, DAM Asset Category Import in CSV: Enables the import of asset categories through a CSV file.
- DAM Asset Family Import in CSV: Supports the import of asset families using a CSV file.
- DAM Asset Import in CSV: Permits the bulk import of assets via a CSV file.
- DAM Asset Import via FTP: Allows the import of assets through FTP for enhanced data transfer.
DAM Asset import via FTP
You can edit the DAM Asser import job profile by clicking on EDIT in DAM Asset import via FTP.
After that, you can edit the DAM Asset import via FTP with properties and other settings.
Then next FTP settings, you need to mention the FTP detail to connect via FTP:
- Directory Path: here we have to add an asset directory where we have to import assets.
- Host Name: Enter the FTP hostname.
- Port: Provide a port number to connect via FTP. The port by the default port 21.
- User Name: Enter the username of the FTP account.
- User Password: Enter the password of the FTP account.
Note: After completing all the settings, you need to validate the FTP details by clicking the Validate button.
Asset Setting
After that, you can set up the asset import :
- Import Images/Files as a single Asset: Upload images or files together and group them as one asset.
- Import Directory as Asset and it’s files as asset Images/Files: Select directories which you want to import as asset and it’s files as asset image/files.
- Import Images/Files in an Asset: Upload multiple images or files into a single asset.
- Extensions: Add the type of extension to import the asset.
When you select the Import Directory as Asset and it’s files as asset Images/Files then you can select the directory for the import directory as an asset and its files as asset images/files.
If you select the Import Images/Files in an Asset then you can select the file for the asset.
You can enter the extension type to import the asset.
Asset Setting
In the Asset setting, you can select the asset family and category.
Every change and update will be updated in the history.
DAM Asset Import
To create a new import job profile, go to Imports>Create Import Profile. After that enter a code, label, then select the job type to create the import job.
After that, click on the Save button to create an import profile.
Next, you can set the global setting to allow import files with delimiter and Enclosure.
Now, you can check all your setup and updates in history.
Now, your import job profile is successfully created. Also, there will be two options –
- Import Now – In this, you can enter the file path to import the asset.
- Upload a file – In this, you can drag the file to import the asset.
Once you have uploaded the file click to Upload and Import Now option.
Now, after uploading and running the export job you can check the execution details.
After that, the export job you can check the execution details.
Support
So, that was much about the User Guide of the Akeneo DAM module for any queries or doubts reach out to us at support@webkul.com. You can also raise a ticket at our HelpDesk System.
Please explore our Akeneo Development Services and Quality Akeneo Extensions.