A Complete Guide to Akeneo Notification Manager

Akeneo Notification Manager: Admin and user can use this module to produce a notification for the actions of saving and deleting operations, as well as saving and deleting Family, Attribute, Group, Category, and Channel.

When saving and deleting operations, the admin can assign users and groups to get the notification through email. The user sets up roles and permissions for other users to control notifications.

Basic Requirement

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

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

Check a brief overview of the plugin in the video mentioned below –

• Users receive email notifications at the moment of action.
• Notifications that are triggered by an activity are created.
• Users with certain permissions can save and delete notifications.
• If both the admin and the user have access, they can edit and create the notification.

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

1. Composer Installation
2. Manual Installation

Composer Installation

Read This Blog

Before beginning the composer installation

1: GET the Access Keys Raise a ticket

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

Akeneo 6 and 7 :

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

3: Install the extension using composer.

composer require webkul/notificationbundle

4: Fill in the authentication.

5: Success Message

6: Clear Browser cache

2 – Manual Installation for Version 6. x and 7.x

• Run the below command over the NO-DOCKER Instance from the PIM directory.

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

• Run the below command over the docker Instance from the PIM directory.

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

Note: You have to configure the “Mailer URL” in the .env file to receive a notification

1- Composer Installation

Run the composer install command:

composer require webkul/notificationbundle:1.0.0

2- Manual Installation

Please follow these steps for installing the Akeneo Notification Manager module in your Akeneo PIM platform.

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

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

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

in return array.

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

4 – Then run this command after ssh to your akeneo server by the terminal

rm -rf ./var/cache/** && php bin/console cache:clear && php bin/console pim:installer:assets --symlink --clean && php bin/console d:s:u --force && yarn run webpack && yarnpkg run less && yarnpkg run update-extensions

5. After you’ve installed the Connector, run this command. Install the Actions command

php bin/console wk.notification.create_actions

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

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 Akeneo Notification Manager 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\NotificationBundle\WebkulNotificationBundle(),

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

wk_WebkulNotification_connector:
  resource:
"@WebkulNotificationBundle/Resources/config/routing.yml" prefix: /

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

rm -rf ./var/cache/** && php bin/console cache:clear && php bin/console pim:installer:assets --symlink --clean && php bin/console d:s:u --force && yarn run webpack && yarnpkg run less && yarnpkg run update-extensions

5. After you’ve installed the Connector, run this command. Install the Actions command

php bin/console wk.notification.create_actions

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

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

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

• Run the below command over the docker Instance from the PIM directory

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

Step 1:- Goto .env File in the root directory of the project. (hint: If not found choose to show hidden files in file explorer settings) then open the .env file and search for MAILER_URL.

Step 2:- It Will Look Like :- MAILER_URL=null:/ /localhost?encryption=tls&auth_mode=login & username=foo&password=bar&[email protected].

3:- Now You Need SMTP_HOSTNAME, SMTP_PORT, Encryption = none, Auth_mode = login, USERNAME, PASSWORD, SENDER ADDRESS.

Important Note:- Interchange the position of sender_address and password with one another. (Sometimes an error occurs because of the password string containing special symbols like ‘#’. Because ‘#’ is used to make single-line comments in a .env file)_

Step 4:- Your Final URL Will Look Like:- MAILER_URL=smtp://SMTP_HOSTNAME: SMTP_PORT?encryption=none&auth_mode=login&username=USERNAME&sender_address=USERNAME&password=PASSWORD.

For Akeneo 7 only

Step 5:-MAILER_FROM=”Akeneo [email protected]“(You have to add the SENDER ADDRESS)”

Step 6:- Now save the .env file.

Setup Completed

The Notification Manager icon will appear on the left side of the dashboard after the module has been successfully installed, as illustrated below:

Before you can create the notification, you must first create a user group and users.

After that check/uncheck the permissions you want to set permissions for the role, as seen in the image below:

To make a new notification, go to the Configuration tab and click the Create button.

After that, you’ll be taken to a new screen where you’ll have to enter the details like:

• Name – Enter the notification’s name here.
• Actions – In this part, you must specify which action of the information you wish to receive a mail notification for the action performed.
• User Group – You must choose the user group for which you wish to configure the notification.
• User – Choose the user to whom you’d like to grant notification access. Users who have been added to a user group can be selected and perform the action.
• Message – In this message box, type the message that will be sent as a notification after the action is completed.

Note: In order to view the action, you must first run command 5 otherwise action section will be blank.

At the moment of save and delete actions, the Admin can receive notification of the Product, Family, Attribute, Group, Category, and Channel.

After that, click the Save option.

If you wish to make changes to the notification you’ve made, click the edit button or click the notification itself.

Then you can edit the notification

After you’ve created the notification, go to Product and click on the product you wish to update or perform the action on.

Then make any necessary changes to the product and click the Save button.

When you click the save button, the user you specified in the notification will receive an email at the email you provided.

Thank you for taking the time to read this information. So, that was the User Guide for the Akeneo Notification Manager. If you have any questions or concerns, please contact us at [email protected].  You can also use our  HelpDesk System to submit a ticket.

Please take a look at our Akeneo Development Services as well as our Quality Akeneo Extensions.