Guide for Akeneo Shareable Product URL Generator

Akeneo Shareable Product URL Generator allows Akeneo users to create shareable product views for public users, providing a read-only experience.

Users have the ability to set a view password, determine the expiration time of the shared link, and apply filters to display specific products.

Users can filter products and view them in different languages. Check out our Akeneo URL Media Attribute to add public URLs for media files and preview them.

For a brief overview check the video below –

Basic Requirements

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

• Share product links with others easily.
• Users have the ability to copy the catalog link for sharing.
• Set a password to control access to the product view.
• Apply filters to customize which products are displayed.
• Set an expiration time for the shared link.
• View products in multiple languages as desired.

Before installing the module via Composer or manually, follow these steps:

• To configure a firewall in config/packages/security.yml file

firewalls:
    wk_shareable:
        pattern:                        ^/wk-shareable/login
        security:                       false

Access control requiring ROLE_SHAREABLE_URL is defined before more general access controls such as IS_AUTHENTICATED_REMEMBERED

access_control:
    - { path: ^/wk-shareable/view/ , roles: ROLE_SHAREABLE_URL }

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

1. Composer Installation
2. Manual Installation

Installation using Composer 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 7

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

3: Add our repository and installation script in your Akeneo package.json

{
  "scripts": {
       "generate-webkul-shareable-models": "NODE_PATH=node_modules webpack --config vendor/webkul/shareable-catalog/src/Webkul/ShareableProductViewBundle/webpack.config.js"
   }
}

4: Use composer to install the extension.

        composer require webkul/shareable-catalog

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

Manual Installation for Version 7.x

•  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
• Add our repository and installation script in your Akeneo package.json

{
  "scripts": {
       "generate-webkul-shareable-models": "NODE_PATH=node_modules webpack --config src/Webkul/ShareableProductViewBundle/webpack.config.js"
   }
}

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

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

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

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

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

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

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

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

Shareable Product URL API Connection:

After installing the module, please verify in the connection settings whether the Webkul Shareable Product URL API is properly created, which helps manage your Akeneo product data.

Admin can give ACL permission to different users for the Akeneo Shareable Product URL Generator, edit, list, remove, shareable product view, and toggle URL according to the requirements.

So, once you have installed the Akeneo Shareable Product URL Generator module, log in to your Akeneo dashboard. Then you see the icon “Share URL.”.

After that to create a shareable URL, you need to go to “Share URL” and then select “Shareable URL,” and click on “Create”.

Now you have to add the following details for the shareable URL:

• Code: Here you need to enter the code of the shareable URL
• Generated Shareable URL: This URL will be generated automatically when you create the shareable URL, which will be a unique URL.
• Enable Shareable URL: If you want, you can enable and disable the URL generated.
• Password (optional): To access the URL, Akeneo user can set the password
• Expire in (optional): Also, the Akeneo user can set the expiration date and time of the URL.

After that, the user can filter the data by choosing the default channel and locales as needed.

Then, using the selected channel and locales, the user can choose the language for the Shareable URL interface.

Changing the UI locale will update the language shown on the Shareable URL interface.

Then you can decide which products you want to share in the URL and filter them using various options, like:

• Family
• Status
• Completeness
• Time condition

After that, if you want a specific product to be shared, you can enter its SKU in the identifier.

After that, click the save button, and you can copy the URL to share it publicly. Once you copy the URL, you’ll receive a notification that, the URL has been copied to the clipboard.

Then open the URL in your browser. If the Akeneo user has set a password, you will need to enter the password to access the URL.

If no password is set, you can simply open the URL in your browser, and the list of products will be visible.

Next, click on any product to view its information. You can only read the product details and cannot edit them.

Then you can also choose the language (locale) in which you want to see the product details.

After that, if you wish, you can copy the URL, enable/disable the shareable URL, edit, or delete it.

So, that was all about the User Guide to the Akeneo Shareable Product URL Generator. 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.