Golden EDI message errors and monitoring documentation
This documentation describes the different message errors and monitoring features in the Golden EDI platform.
Introduction
The Golden EDI Cloud Integration Platform can send two types of error notifications: message errors that occur when a message fails for some reason and monitoring failures that occur when a Job Queue Entry heartbeat hasn't been sent in a specific time interval or if a ERP connection monitoring is not responding during a specified time interval.
When a message error or monitoring error occurs our system can send a direct notification by email to your configured recipient(s) or we can send a daily message or monitoring report to you. You can also choose to have both options enabled (this is the default setting).
Message error
Message errors occur when a message receives an error in the Golden EDI Cloud Integration Platform. These are some situations that can generate message errors:
There is a problem delivering the message through the specific communication provider for the EDI connection
Mandatory information is missing for creating the message
The receiving party has declined the message for some reason
We could not parse the message sent from the other party
When a message error occurs the message will be marked as error (red background color) in our web portal. A notification about the error can be sent directly by email to the configured recipient(s) or you can choose to receive a daily message report by email with all your unhandled message problems.
As a Golden EDI customer you are responsible for keeping track of message problems and request support from our support team if you can't handle the error yourself.
Direct message error notification
When a message fails for some reason, we can send you a direct notification of the error. You can easily request support from this notification by clicking the Request Support button (marked with red square) from the email. The image below shows an error from a connection to a WooCommerce web shop that is unavailable for the moment.
Message report
We provide possibility to get a message report with all of your connections and their message unhandled errors. You can easily request support if you need help fixing the error or choose to ignore the error.
The image shows two invoices with errors on the connection CRONUS-OUTGOING-INVOICE. You can open the message in our Portal (if you have an account) by clicking the unique message id (WI2420105D0MO). You can also ignore or request support for the error.
Message Report - Request Support
You can request support directly from the message report by clicking the support button to the far right on the message row. Click the support button and fill out the form with additional information on how we can help you.
Message Report - Ignore Message
Ignore means that you are aware of the error but you have solved the error in some other way or decided that this error can't or won't be solved with this message and you don't want to see it in the report anymore. Simple click the Ignore button from message report and confirm.
Message Report - Change Notification Settings
You can change your notifications settings for your message errors. When and how often do you want a report? Do you want direct notifications when a message error occurs? Do you want both report and direct notification or just the other? Do you want a report even if everything looks good or only when there are errors?
You can change your settings by clicking the Change Schedule link at the very end of the message report.
Schedule and notification settings will affect all email recipients for a connection. The email recipients are edited in Business Central or Dynamics NAV, or for other ERP systems in the Golden EDI Web Portal.
Click on the desired connection to edit its notification settings. In this example, we´re choosing to edit CRONUS-OUTGOING-INVOICE.
From here we can select if we want Direct Notifications or not (Turn off direct error notifications) and if we want a message report (Turn off message report). See next section for more detailed information.
Turn off direct error notifications Direct Notifications will be sent as soon as a message stops in our Cloud Integration Platform. Direct notifications contain one message error. This feature suits you when you have a time critical integration that requires getting some type of messages in at a certain time and you want to be notified immediately if something has stopped.
Turn off message report You can specify when and how often you want a message report by selecting days and hours. You can also specify if you only want a report if you have any message errors (Only send report if problem exists). Otherwise the report will be sent every selected day regardless if you have message errors or not. Turn off message report if you don´t want it and instead get direct error notifications.
You can´t turn off both Direct Error Notifications and Message Report. At least one must be selected
Ignore message in the Web Portal
You can also ignore a message error from our Web Portal by clicking the Ignore button. Ignore means that you are aware of the error but you have decided that this error can't or won't be solved with this message. Ignore the message to make it disappear from future message reports and from being shown in the dashboard in our web portal.
Monitoring
Monitoring is the feature in the Golden EDI Cloud Integration Platform that checks that the connection to your ERP system (usually Microsoft Dynamics 365 Business Central) is working as it should. These are the parts that we monitor:
We monitor that the "Job Queue Entry" (for Business Central and NAV customers) that is being used to process the message queue inside Business Central/NAV is running as expected. This is done by sending out heartbeat messages to our Cloud Integration Platform. Every heartbeat contains a date/time for the next expected heartbeat, if no new heartbeat is detected until this next expected date/time + approximately 15 minutes our system sets the specific "Job Queue Entry" heartbeat monitoring to an error state. As soon as we receive a new valid heartbeat the monitoring is set to a success state.
We monitor that our Cloud Integration Platform can connect to your ERP system (usually Microsoft Dynamics 365 Business Central). If we cannot connect at all to your ERP system during a time span of approximately 15 minutes the ERP monitoring for the specific connection is set to an error state.
We also monitor that our Cloud Integration Platform can reach the connected party on the configured communication provider. Error notifications for this monitoring are sent to the Golden EDI support team, but the monitor state is visible for you as Golden EDI customer in our web portal and in the monitoring report sent by email.
As a Golden EDI customer you are responsible for keeping track of the job queue entry status and take action if the job queue has stopped and needs to be restarted.
When a monitoring error occurs a notification about the error can be directly sent by email to the configured recipient(s) or you can choose to receive a daily monitoring report by email showing the current status of all monitoring entries. The current monitoring state can always be inspected in our web portal.
Monitoring error notification
When a job queue fails for some reason, we can send you a direct notification of the error. You can easily request support from this notification by clicking the Request Support button (marked with a red square in the image) from the email.
Monitoring report
We provide possibility to get a monitoring report with the status of all of your ERP connections, communication providers and job queues statuses. You can easily request support if you need help fixing the problem by clicking the Support button. The support button is only visible where there are monitoring errors.
Job Queue Entries In the upper section of the report the monitored "Job Queue Entries" are listed with their status. There is usually one job queue entry monitoring per ERP environment. The color green indicates everything is fine while the color red indicates there is a monitoring problem along with a Request support button (marked with a red square in the image).
ERP and communication provider statuses The next section in the report shows all your Golden EDI connections. The upper row for each connection contains the status for the ERP connection and the bottom row shows the communication provider status. The color green indicates everything is fine while the color red indicates there is a monitoring problem along with a Request support button (marked with a red square in the image).
Monitoring report - Request support
You can request support directly from the monitoring report by clicking the support button (only visible if there are errors) to the far right on the message row. When you click on the support button you will come to a web page where you can request support. Fill out the form with additional information on how we can help you. You do not need to login to the Web Portal to request support. The links in the email are unique for you and the error and valid for 7 days from the moment we sent the report.
Monitoring Report - Change Notification Settings
You can change your notifications settings for your monitoring errors. When and how often do you want a monitoring report? Do you want direct notifications when a error occur? Do you want both report and direct notification or just the other? Do you want a report even if everything looks good or only when there are errors?
You can change your settings by clicking the Change Schedule link (marked with a red square in the image) at the very end of the message report.
Schedule and notification settings will affect all email recipients for an environment. The email recipients are edited in Business Central or Dynamics NAV.
Click on the desired environment to edit its notification settings. In this example, we only have one so we're selecting GEDI AB.
From here we can select if we want Direct Notifications or not (Turn off direct error notifications) and if we want a report (Turn off report). See next section for more detailed information.
Turn off direct error notifications Direct Notifications will be sent as soon as our Cloud Integration Platform detects a communication problem with your ERP or a job queue entry heartbeat error. This feature suits you when you have a time critical integration and you want to be notified immediately if something is wrong.
Turn off report You can specify when and how often you want a report by selecting days and hours. You can also specify if you only want a report if you have any errors (Only send report if problem exists). Otherwise the report will only be sent to you when you have errors. Turn off report if you don't want it and instead get direct error notifications.
You can't turn off both Direct Error Notifications and Report. At least one must be selected.
Web portal
You can also see your monitoring status from the Web Portal under menu option Monitoring
Configuration options
Message error configuration options
When you click on the Change Schedule link in the bottom of the report mail you open up a web page that shows the connections your are getting notifications or reports for. The links in the email are unique for you and the report and valid for 7 days from the moment we sent the report. When you click a connection you can edit the settings for that connection. Please be aware that when you edit the settings all recipients will be affected because the settings are not per recipient, they are per connection.
Turn off Direct Error Notifications will disable direct email notifications when an error occurs.
Turn off Message Report will disable the message report
Message Report Schedule Settings will let you choose on which days of the week you want a report and on what time (whole hour). The time setting will be active for all selected days (you can't have different times on different days) and you can select multiple times if you want multiple reports during the day.
Only send report if problem exists If you have this setting enabled you will just get a report when there is one or more monitor problems. Sometimes you want to have an report even if there are no errors to ease you mind, the just disable this setting.
You need to have at least one of Direct Error Notifications or Message Report enabled because as a Golden EDI customer you are responsible for keeping track of message problems and request support from our support team if you can't handle the error yourself.
How to edit email addresses for the recipients
Email addresses are configured in different ways depending on the ERP system.
For BC/NAV (except Basic Invoice Customers) - configuration is done on the specific GEDI Profile. See https://docs.goldenedi.com/golden-edi-support-and-monitoring-documentation/edit-recipients-of-notifications-in-business-central-nav
For other ERP systems (and Basic Invoice Customers) - the email address can be changed in the Golden EDI Web Portal. On connection settings page you can edit the report settings for that connection.
Monitoring error configuration options
When you click on the Change Schedule link in the bottom of the report mail you open up a web page that shows the environments your are getting monitor reports for. The links in the email are unique for you and the report and valid for 7 days from the moment we sent the report. When you click an Environment you can edit the settings for that environment. Please be aware that when you edit the settings all recipients will be affected because the settings are not per recipient, they are per environment.
Turn off Direct Error Notifications will disable direct email notifications when an monitor error occurs.
Turn off Message Report will disable the monitoring report
Monitoring Report Schedule Settings will let you choose on which days of the week you want a report and on what time (whole hour). The time setting will be active for all selected days (you can't have different times on different days) and you can select multiple times if you want multiple reports during the day.
Only send report if problem exists If you have this setting enabled you will just get an report when there is one or more monitor problems. Sometimes you want to have an report even if there are no errors to ease you mind, the just disable this setting.
You need to have at least one of Direct Error Notifications or Message Report enabled because a Golden EDI customer you are responsible for keeping track of the job queue entry status and take action if the job queue has stopped and needs to be restarted. If you need support you should click on the request support link in the notification or report.
How to edit email addresses for the recipients
Email addresses are configured in different ways depending on the ERP system.
For BC/NAV (except Basic Invoice Customers) - configuration is done on the specific GEDI Profile. See https://docs.goldenedi.com/golden-edi-support-and-monitoring-documentation/edit-recipients-of-notifications-in-business-central-nav
For other ERP systems (and Basic Invoice Customers) - the email address can be changed in the Golden EDI Web Portal. On a connection you can edit the report settings for that connection:
Default settings
The default settings for both message errors and monitoring errors are specified below:
Direct notifications are enabled
Reports are enabled and scheduled to run weekdays (Monday to Friday) at 08:00 local time. Reports are only sent if problems exist.
Last updated