Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Under SYSTEM / NOTIFICATION DASHBOARD / DASHBOARD we have a space (a dashboard) in the admin panel, where all notifications related to the ERP connector will be stored.

We want to store e.g.:

  • when was the last import/export

  • how many orders were exported (and how many weren't)

  • how many products were imported (and how many weren’t)

  • stock changes

  • how many fails on a given day

  • some statistics about import/export

...

ERP Connector

The two most important things we want to test are connectors and schedulers.

Connectors

Allows setting the connection to external services, e.g. FTP/SFTP, Soap, HTTP endpoints.
In each provider, we can have several connectors and we are able to check the connection status for FTP/SFTP and Soap (maybe there is a possibility to test the connection to HTTP and E-mail - it needs to be checked).

It would be good to have:

  • Listing of all connectors that we are able to test

  • Logic to test them e.g. every hour (there should be an option to set interval in the admin panel)

  • Information about connector connection status on the listing (we should store the test result, in this way we will be able to monitor e.g. which connector (if any) does not work at night)

Schedulers

They allow setting how often a given action should be executed, e.g. order export.
When configuring the scheduler, the administrator sets cron_schedule, on the basis of which we determine when exactly the specified action should be performed.
For example, if he sets */15 * * * *, action should be executed every 15 minutes.

It would be good to have:

  • Listing of all schedulers grouped by providers

  • Listing when a given scheduler should be executed (e.g. range one day backwards and one day forward)

  • Status information (e.g. at 03:15 scheduler was executed and everything was ok, or it did not execute at the specified time, or it was executed, but there were errors)

  • Possibility to check the result - why it failed or what was exported/imported

Monitoring

Based on the collected data, the system should be able to notice changes. For example:

  • If we have > 100 exported orders every day and one day we have only 5 exported orders, notification should be sent

  • if the import process should be executed every day around 5 a.m., the notification should be sent if the import process wasn’t executed or was executed around 10 a.m

There should be the possibility to manually configure the monitoring system.
And it would be nice if the system would be able to find dependencies on its own and inform about changes.

Notifications

There should be also a possibility to set the notifications:

  • in the message inbox in the admin panel

  • set the notifications to specific e-mail addresses

  • slack

There should be a possibility to configure the notification system in the admin panel only for specific admin groups. But there should be an option to configure notifications in the code, so they cannot be disabled in the admin panel or directly in the database.

The administrator should be able to configure notifications to specific groups or specific tasks (e.g. if order export to a specific provider doesn’t work, an e-mail with propel information should be sent to admin/developer e-mail, or notification should be sent to slack channel).

Reports

It would be good to have some reports

...

global statistics for each day

...

statistics for each provider for each day

...

MageSuite offers solution for quick reporting of potential issues in the project.

Issues can occur in any project and can be caused by various factors, such as incorrect configuration, mistakes in code, new versions of external modules and others.

MageSuite provides many tools that help to keep it under control, Notification Dashboard is one of them.
This tool allows quickly notify about issues, which makes a much faster reaction possible.

The notification Dashboard is composed of three parts.

Users

Under SYSTEM / NOTIFICATION DASHBOARD / USERS we have a list of users, who can get notifications. For each user, we can specify the name and e-mail address to which notifications will be sent.

...

Notifications

Under SYSTEM / NOTIFICATION DASHBOARD / NOTIFICATIONS we have a list of all notifications that have been sent.
The list includes such information as Severity, title and message of notification and creation data.

...

In addition to this list, we also have a dashboard, under SYSTEM / NOTIFICATION DASHBOARD / DASHBOARD

On this list, we can display the most important notifications to make sure they do not go unnoticed.
In the collector configuration we can decide which messages should be visible here.

...

Collectors

Under SYSTEM / NOTIFICATION DASHBOARD / COLLECTORS we have a list of collectors.

Collectors are the core, the most important part of the Notification Dashboard.
They allow you to set in which situations notifications should be sent and to whom.
See: Collectors

...