Guide for Akeneo URL Media Attribute

Akeneo URL Media Attribute: The “URL media attribute” attribute type can be created in this module and used as a new attribute type in products in Akeneo.

Users are able to add public media/file URLs and even view a preview of the media file for the URL. The user will benefit from this functionality by having less storage space required.

Users can use the Akeneo Shareable Product URL Generator to create readread-only product view for public users.

Check a brief overview of the module:

Basic Requirements

• This module works with Akeneo 7.0.x. Download Akeneo from here
• Node and Yarn packages need to be installed.
• Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo

• You can add the URL for the public file or media.
• Using this module, you can preview the media.
• Users can download the media/file.
• You can create the Localizable and Scopable URL media attributes in this module.
• In the product grid filter, you can use the attribute.
• By using the CSV/XLSX and Akeneo API, users can add media.
• Support media file types are gif, jpeg, jpg, png, psd, jfif, jif, tif, tiff, csv, pdf, xlsx, doc, docx, ppt, pptx, mp3, svg, txt, wav, rtf, xml, zip, tar, mp4, mov, flv, webm, ogv, 3gp.

Note – CLI User must be the same as the FPM user. A good practice is to use the FPM user for installation. Also, ownership/permissions for the Akeneo directory must be assigned to the FPM user. Otherwise, you will face permission issues during installation.

Two different types of module installation processes are available for the module.

1. Composer Installation
2. Manual 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.

For Akeneo 6 and 7

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

3: Use composer to install the extension.

         composer require webkul/urlmediabundle

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

•  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/UrlMediaBundle/install/config.sh COMPOSER=false NO_DOCKER=true

• After that run the command below over the PIM directory’s DOCKER instance.

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

To install this module in Akeneo, please follow the further steps:

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

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

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

in the return array.

For = Akeneo 5

• copy the “config” folder into the Akeneo project root directory for routing.
• Run the Elasticsearch command after installation

php bin/console akeneo:elasticsearch:reset-indexes --env=prod && php bin/console pim:product:index --all --env=prod && php bin/console pim:product-model:index --all --env=prod

For = Akeneo 4

Note: No Need to add the service folder

• copy the “config/routes” folder into the Akeneo project root directory for routing.

3 – Run this command after ssh to your akeneo server by terminal and navigating to 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)

For non-docker instance:

rm -rf var/cache && php bin/console ca:warmup && php bin/console urlmedia:setup:install

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;

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.

After uninstalling the URL Media Attribute Connector then you need to run the below command: (Run the following command after ssh to your akeneo server by terminal).

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

• From the PIM directory, run the command below over the NO-DOCKER Instance.

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

• Run the command below over the PIM directory’s DOCKER instance.

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

So, once you have installed the Akeneo URL Media Attribute module, log in to your Akeneo dashboard. Then go to Settings>Attributes.

After that, click on Create Attribute to create new attributes.

After that, click Create Attribute button, and a pop-up window will appear, select the URL Media attribute type.

Once you choose the URL Media Attribute type, then you fill up some other details like Label & Code.

Once you confirm it, then it will redirect to the Properties section, where you can enter any value in Code then select any Attribute Group in which you want to assign this new URL media attribute.

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

As soon as you click the save button, the attribute will be created and you can edit it to your needs.

You must first assign them to a Family in order to use URL media attributes. The next step is to navigate to Settings>Families>Edit>Add Attributes.

Click the Save button after selecting your new attribute.

You can go to Products and create a product with the same family in which you have added the URL media attribute.

After that, click on the link icon to add the link to the product image in the product.

After clicking on the icon, you will add the public media/file URL in the box.

Once you’re finished, the image will be added to the product as shown in the images. Similarly, you can add PDF links as well.

If you have enabled the URL media attribute for use in the grid, then you can check the attribute in the filter section.

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.