ProductVisibilityMonitoring

https://gitlab.creativestyle.pl/magesuite/product-visibility-monitoring

A module allows to monitor number of products in categories and alert if it is improper.

 

Installation

This module is required by core metapackage.

Installation if metapackage is not used:

composer require "creativestyle/magesuite-product-visibility-monitoring" ^1.0.0

This module requires NotificationDashboard:

NotificationDashboard (optional)

Admin settings

Module has dedicated notification collector in Notification Dashboard, called Products in Categories.

 

image-20240508-065952.png

Notification is send in 2 cases:

  • If category has 0 products, and should have more than 0

  • If category has more than 0 products, and should have 0

Both conditions are to be configured in Stores -> Configuration -> MageSuite -> Product Visibility Monitoring.

Configuration details

General

image-20240508-070152.png

Switcher allows to turn on or off every feature implemented in this module.

By default it is turned on.

Data Logs

This section is responsible for logging historical data about number of products in categories.

Disabling it will results in not having past data about number of products, which will make it harder to detect important changes and analyzing trend in the future. Do not turn it off if you are not sure that you really want to do it.

If you are not using some categories, you can exclude them for logging. Remember to remove them from excluded list if they are going live.

Notifications

In order to prevent flooding, there is an option to determine minimal time between notifications.

Also, it is possible to exclude specific categories if notifying about incorrect number for them is not needed.

If some category is expected to has 0 products, it can be selected - then admin will be notified if there are more than 0 products in specific category.

Queue

Disabling queue will results in not processing notifications.

Backend

Add BE documentation

 

Frontend

No frontend code in the module.